tencent cloud

文档反馈

最后更新时间:2024-05-20 16:37:08
    本文将介绍如何用最短的时间完成 TUICallKit 组件的接入,跟随本文档,您可以在10分钟内完成接入工作,并最终得到一个包含完备 UI 界面的音视频通话功能。

    环境准备

    Flutter 3.0及更高版本。

    步骤一:开通服务

    在使用腾讯云提供的音视频服务前,您需要前往控制台,为应用开通音视频服务。具体步骤请参见 开通服务。

    步骤二:导入TUICallKit组件

    在命令行执行以下命令安装组件 tencent_calls_uikit 插件。
    flutter pub add tencent_calls_uikit

    步骤三:完成工程配置

    1. 将 TUICallKit的navigatorObserver 添加到 App组件中,以MateriaApp为例,代码如下:
    import 'package:tencent_calls_uikit/tuicall_kit.dart';
    
    MaterialApp
         navigatorObservers: [TUICallKit.navigatorObserver],
         ...
    2. 如果您需要编译运行在 Android 平台,由于我们在 SDK 内部使用了Java 的反射特性,需要将 SDK 中的部分类加入不混淆名单。
    首先,需要在 app 目录下的 build.gradle 文件中配置并开启混淆规则:
    android {
    ...
    buildTypes {
    release {
    minifyEnabled true
    proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'
    }
    }
    }
    在您的 app 目录下创建 proguard-rules.pro 文件,并 proguard-rules.pro 文件中添加如下代码:
    -keep class com.tencent.** { *; }
    3. 如果您的工程需要在iOS 模拟器上调试,您需要在工程的/ios/Podfile文件中添加以下代码:
    post_install do |installer|
    installer.pods_project.targets.each do |target|
    flutter_additional_ios_build_settings(target)
    target.build_configurations.each do |config|
    config.build_settings['VALID_ARCHS'] = 'arm64 arm64e x86_64'
    config.build_settings['VALID_ARCHS[sdk=iphonesimulator*]'] = 'x86_64'
    end
    end
    end
    4. 由于 TUICallKit 会使用 iOS 的音视频功能,您需要授权麦克风和摄像头的使用权限。
    授权操作方法:在您的 iOS 工程的 Info.plist 的第一级<dict>目录下添加以下两项,分别对应麦克风和摄像头在系统弹出授权对话框时的提示信息。
    <key>NSCameraUsageDescription</key>
    <string>CallingApp需要访问您的相机权限,开启后录制的视频才会有画面</string>
    <key>NSMicrophoneUsageDescription</key>
    <string>CallingApp需要访问您的麦克风权限,开启后录制的视频才会有声音</string>
    添加后,您可以通过 XCode 打开 Info.plist 文件并看到以下结果:
    
    
    

    步骤四:登录 TUICallKit 组件

    在您的项目中添加如下代码,这个步骤异常关键,因为只有在登录成功后才能正常使用 TUICallKit 的各项功能,故请您耐心检查相关参数是否配置正确:
    TUIResult result = await TUICallKit.instance.login(SDKAppID, // 请替换为第一步得到的SDKAppID
    'userId', // 请替换为您的User ID
    'userSig'); // 您可以在控制台计算一个UserSig并填到该位置
    参数说明: 这里详细介绍一下 login 函数中所需要用到的几个关键参数:
    sdkAppId:在步骤一中的最后一步中您已经获取到,这里不再赘述。
    userId:当前用户的 ID,字符串类型,只允许包含英文字母(a-z 和 A-Z)、数字(0-9)、连词符(-)和下划线(_)。
    userSig:使用 SDKSecretKeySDKAppIDUserID 等信息进行加密,就可以得到 UserSig,它是一个鉴权用的票据,用于腾讯云识别当前用户是否能够使用 TRTC 的服务。您可以访问 实时音视频 TRTC 控制台 > UserSig Tools, 得到一个临时可用的 UserSig。
    
    
    
    更多信息请参见 如何计算及使用 UserSig
    调试跑通阶段,您可以在本地计算 UserSig,具体计算代码可以参考我们 github 中给出的 GenerateTestUserSig.dart。如果您使用了我们的GenerateTestUserSig.dart,请在命令行执行以下命令安装 dart 官方提供的加密组件 crypto
    flutter pub add crypto
    注意:
    这个步骤也是目前我们收到的开发者反馈最多的步骤,常见问题如下:
    SDKAppID 设置错误。
    UserSig 被错配成了加密密钥(Secretkey),userSig 是用 SecretKey 把 SDKAppID、UserID 以及过期时间等信息加密得来的,而不是直接把 SecretKey 配置成 UserSig。
    UserID 被设置成“1”、“123”、“111”等简单字符串,由于 TRTC 不支持同一个 UserID 多端登录,所以在多人协作开发时,形如 “1”、“123”、“111” 这样的 UserID 很容易被您的同事占用,导致登录失败,因此我们建议您在调试的时候设置一些辨识度高的 UserID。
    Github 中的示例代码使用了 genTestUserSig 函数在本地计算 UserSig 是为了更快地让您跑通当前的接入流程,但该方案会将您的 SecretKey 暴露在 App 的代码当中,这并不利于您后续升级和保护您的 SecretKey,所以我们强烈建议您将 UserSig 的计算逻辑放在服务端进行,并由 App 在每次使用 TUICallKit 组件时向您的服务器请求实时计算出的 UserSig。

    步骤五:拨打您的第一通电话

    主叫方与被叫方登录成功后,主叫方通过调用 TUICallKit 的 call 方法并指定通话类型和被叫方的 userId,就可以发起语音或者视频通话,被叫方此时就可接受到来电邀请。
    // 假设给mike拨打语音电话
    TUICallKit.instance.call('mike', TUICallMediaType.audio);
    
    
    
    
    
    
    主叫方
    被叫方

    更多特性

    悬浮窗

    常见问题

    如果您的接入和使用中遇到问题,请参见 常见问题

    交流与反馈

    如果有任何需要或者反馈,您可以联系:info_rtc@tencent.com。
    联系我们

    联系我们,为您的业务提供专属服务。

    技术支持

    如果你想寻求进一步的帮助,通过工单与我们进行联络。我们提供7x24的工单服务。

    7x24 电话支持