tencent cloud

文档反馈

最后更新时间:2024-01-17 11:58:53
    本文将介绍如何用最短的时间完成 TUICallKit 组件的接入,跟随本文档,您将在一个小时的时间内完成如下几个关键步骤,并最终得到一个包含完备 UI 界面的视频通话功能。

    环境准备

    iOS 9.0 (API level 16) 及更高。

    步骤一:开通服务

    TUICallKit 是基于腾讯云 即时通信 IM实时音视频 TRTC 两项付费 PaaS 服务构建出的音视频通信组件,您可以按照如下步骤开通相关的服务并体验 7 天的免费试用服务。
    1. 登录到 实时音视频 TRTC 控制台,点击 Create application,在浮窗中选择 Call 并输入应用名称,并点击 Create
    
    
    
    2. 完成应用创建后将默认进入应用详情页,在浮窗中选择 Free Trial,并点击 Get started for free。
    
    
    
    3. 确认弹窗内容后,单击 Free Trial,即可成功开通音视频通话体验版。
    
    
    
    4. 完成应用创建后将默认进入刚才创建的应用详情页,这里的 SDKAppIDSDKSecretKey 会在 登录 TUI 组件 时用到。
    
    
    

    步骤二:导入组件

    推荐使用 CocoaPods 导入组件,具体步骤如下:
    1. 在您的 Podfile 文件中添加以下依赖。
    pod 'TUICallKit'
    2. 执行以下命令,安装组件。
    pod install
    如果无法安装 TUICallKit 最新版本,执行以下命令更新本地的 CocoaPods 仓库列表。
    pod repo update
    之后执行以下命令,更新组件库的 Pod 版本。
    pod update

    步骤三:完成工程配置

    使用音视频功能,需要授权麦克风和摄像头的使用权限。在 App 的 Info.plist 中添加以下两项,分别对应麦克风和摄像头在系统弹出授权对话框时的提示信息。
    <key>NSCameraUsageDescription</key>
    <string>CallingApp 需要访问您的相机权限,开启后录制的视频才会有画面</string>
    <key>NSMicrophoneUsageDescription</key>
    <string>CallingApp 需要访问您的麦克风权限,开启后录制的视频才会有声音</string>
    
    img
    
    

    步骤四:登录 TUI 组件

    在您的项目中添加如下代码,它的作用是通过调用 TUICore 中的相关接口完成 TUI 组件的登录。这个步骤异常关键,因为只有在登录成功后才能正常使用 TUICallKit 的各项功能,故请您耐心检查相关参数是否配置正确:
    Objective-C
    Swift
    #import <TUICore/TUILogin.h>
    
    // 组件登录
    [TUILogin login:1400000001 // 请替换为步骤一取到的 SDKAppID
    userID:@"denny" // 请替换为您的 UserID
    userSig:@"xxxxxxxxxxx" // 您可以在控制台中计算一个 UserSig 并填在这个位置
    succ:^{
    NSLog(@"login success");
    } fail:^(int code, NSString *msg) {
    NSLog(@"login failed, code: %d, error: %@", code, msg);
    }
    import TUICore
    
    // 组件登录
    TUILogin.login(1400000001, // 请替换为步骤一取到的 SDKAppID
    userID: "denny", // 请替换为您的 UserID
    userSig: "xxxxxxxxxxx") { // 您可以在控制台中计算一个 UserSig 并填在这个位置
    print("login success")
    } fail: { (code, message) in
    print("login failed, code: \\(code), error: \\(message ?? "nil")")
    }
    
    参数说明: 这里详细介绍一下 login 函数中所需要用到的几个关键参数:
    sdkAppId:在步骤一中的最后一步中您已经获取到,这里不再赘述。
    userId:当前用户的 ID,字符串类型,只允许包含英文字母(a-z 和 A-Z)、数字(0-9)、连词符(-)和下划线(_)。
    userSig:使用 SDKSecretKeySDKAppIDUserID 等信息进行加密,就可以得到 UserSig,它是一个鉴权用的票据,用于腾讯云识别当前用户是否能够使用 TRTC 的服务。您可以访问 实时音视频 TRTC 控制台 -> UserSig Tools, 得到一个临时可用的 UserSig。
    
    
    
    更多信息请请参见 如何计算及使用 UserSig
    注意:
    这个步骤也是目前我们收到的开发者反馈最多的步骤,常见问题如下:
    SDKAppID 设置错误。
    UserSig 被错配成了加密密钥(Secretkey),userSig 是用 SecretKey 把 SDKAppID、UserID 以及过期时间等信息加密得来的,而不是直接把 SecretKey 配置成 UserSig。
    UserSig 被设置成“1”、“123”、“111”等简单字符串,由于 TRTC 不支持同一个 UserID 多端登录,所以在多人协作开发时,形如 “1”、“123”、“111” 这样的 UserID 很容易被您的同事占用,导致登录失败,因此我们建议您在调试的时候设置一些辨识度高的 UserID。
    Github 中的示例代码使用了 genTestUserSig 函数在本地计算 UserSig 是为了更快地让您跑通当前的接入流程,但该方案会将您的 SecretKey 暴露在 App 的代码当中,这并不利于您后续升级和保护您的 SecretKey,所以我们强烈建议您将 UserSig 的计算逻辑放在服务端进行,并由 App 在每次使用 TUICallKit 组件时向您的服务器请求实时计算出的 UserSig。

    步骤五:拨打通话

    1对1视频通话

    通过调用 TUICallKit 的 call 函数并指定通话类型和被叫方的 userId,就可以发起语音或者视频通话。
    Objective-C
    Swift
    #import <TUICallKit/TUICallKit.h>
    
    // 发起1对1视频通话(假设 userId 为 mike)
    [[TUICallKit createInstance] call:@"mike" callMediaType:TUICallMediaTypeVideo];
    import TUICallKit
    
    // 发起1对1视频通话(假设 userId 为 mike)
    TUICallKit.createInstance().call(userId: "mike", callMediaType: .video)
    
    参数
    类型
    含义
    userId
    String
    目标用户的 UserID:"mike"
    callMediaType
    TUICallMediaType
    通话的媒体类型,示例:TUICallMediaTypeVideo

    群内视频通话

    通过调用 TUICallKit 的 groupCall 函数并指定通话类型和被叫方的 UserID 列表,就可以发起群内的语音或者视频通话。
    Objective-C
    Swift
    #import <TUICallKit/TUICallKit.h>
    
    [[TUICallKit createInstance] groupCall:@"12345678" userIdList:@[@"denny", @"mike", @"tommy"] callMediaType:TUICallMediaTypeVideo];
    import TUICallKit
    
    TUICallKit.createInstance().groupCall(groupId: "12345678", userIdList: ["denny", "mike", "tommy"], callMediaType: .video)
    参数
    类型
    含义
    groupId
    String
    群组 ID,示例:@"12345678"
    userIdList
    Array
    目标用户的userId 列表,示例:@[@"denny", @"mike", @"tommy"]
    callMediaType
    TUICallMediaType
    通话的媒体类型,示例:TUICallMediaTypeVideo
    注意
    群组的创建详见: IM 群组管理 ,或者您也可以直接使用 IM TUIKit,一站式集成聊天、通话等场景。
    TUICallKit 目前还不支持发起非群组的多人视频通话,您可以联系:colleenyu@tencent.com。

    步骤六:接听通话

    步骤四 完成后,收到来电请求后,TUICallKit 组件会自动启动相应的接听界面。

    步骤七:更多特性

    一、设置昵称&头像

    如果您需要自定义昵称或头像,可以使用如下接口进行更新:
    Objective-C
    Swift
    [[TUICallKit createInstance] setSelfInfo:@"jack" avatar:@"https:/****/user_avatar.png" succ:^{
    
    } fail:^(int code, NSString *errMsg) {
    
    }];
    TUICallKit.createInstance().setSelfInfo(nickname: "jack", avatar: "https:/****/user_avatar.png", succ: {
    
    }) { code, desc in
    
    }
    
    注意
    因为用户隐私限制,非好友之间的通话,被叫的昵称和头像更新可能会有延迟,一次通话成功后就会顺利更新。

    二、离线唤醒

    完成以上步骤,就可以实现音视频通话的拨打和接通,但如果您的业务场景需要在 App 的进程被杀死后或者APP 退到后台后,还可以正常接收到音视频通话请求,就需要增加离线唤醒功能,详情见 离线唤醒(iOS)

    三、悬浮窗功能

    如果您的业务需要开启悬浮窗功能,您可以在 TUICallKit 组件初始化时调用以下接口开启该功能:
    Objective-C
    Swift
    [[TUICallKit createInstance] enableFloatWindow:YES];
    TUICallKit.createInstance().enableFloatWindow(true)
    

    四、通话状态监听

    如果您的业务需要 监听通话的状态,例如通话开始、结束,以及通话过程中的网络质量等等,可以监听以下事件:
    Objective-C
    Swift
    #import <TUICallEngine/TUICallEngine.h>
    
    [[TUICallEngine createInstance] addObserver:self];
    
    - (void)onCallBegin:(TUIRoomId *)roomId callMediaType:(TUICallMediaType)callMediaType callRole:(TUICallRole)callRole {
    
    }
    - (void)onCallEnd:(TUIRoomId *)roomId callMediaType:(TUICallMediaType)callMediaType callRole:(TUICallRole)callRole totalTime:(float)totalTime {
    
    }
    - (void)onUserNetworkQualityChanged:(NSArray<TUINetworkQualityInfo *> *)networkQualityList {
    
    }
    import TUICallEngine
    
    TUICallEngine.createInstance().add(self)
    
    public func onCallBegin(roomId: TUIRoomId, callMediaType: TUICallMediaType, callRole: TUICallRole) {
    
    }
    public func onCallEnd(roomId: TUIRoomId, callMediaType: TUICallMediaType, callRole: TUICallRole, totalTime: Float) {
    
    }
    public func onUserNetworkQualityChanged(networkQualityList: [TUINetworkQualityInfo]) {
    
    }
    

    五、自定义铃音

    如果您需要自定义来电铃音,可以通过如下接口进行设置:
    Objective-C
    Swift
    [[TUICallKit createInstance] setCallingBell:filePath];
    
    TUICallKit.createInstance().setCallingBell(filePath: filePath)
    

    六、自定义通话超时时间

    如果您需要自定义通话的超时时间,可以在调用 callgroupCallinviteUser 方法的时候修改 TUICallParams 参数进行设置:
    Objective-C
    Swift
    TUICallParams *callParams = [TUICallParams new];
    callParams.offlinePushInfo = [TUIOfflinePushInfo new];
    callParams.timeout = 30;
    callParams.userData = @"user data";
    [[TUICallKit createInstance] call:@"mike" callMediaType:TUICallMediaTypeVideo params:callParams succ:nil fail:nil];
    let callParams = TUICallParams()
    let offlinePushInfo = TUIOfflinePushInfo()
    callParams.offlinePushInfo = offlinePushInfo
    callParams.timeout = 30
    callParams.userData = "user data"
    TUICallKit.createInstance().call(userId: "mike", callMediaType: .video, params: callParams) {
    
    }

    

    常见问题

    1、错误提示“The package you purchased does not support this ability”怎么处理?

    如遇以上错误提示,是由于您当前应用的音视频通话能力包过期或未开通,请参见 步骤一:开通服务,领取或者开通音视频通话能力,进而继续使用 TUICallKit 组件。

    2、如何修改 TUICallKit 源码?

    使用 CocoaPods 导入组件,具体步骤如下:
    1. 在您的工程 Podfile 文件同一级目录下创建 TUICallKit 文件夹。
    2. 单击进入 Github/TUICallKit ,选择克隆/下载代码,然后将 iOS 目录下的 TUICallKitResources 文件夹 和 TUICallKit.podspec 文件拷贝到您在 步骤1 创建的 TUICallKit 文件夹下。
    3. 在您的 Podfile 文件中添加以下依赖。
    # :path => "指向TUICallKit.podspec 的相对路径"
    pod 'TUICallKit', :path => "TUICallKit/TUICallKit.podspec"
    4. 执行 pod install 命令,完成导入。
    注意
    TUICallKitResources 文件夹 和TUICallKit.podspec文件必需在同一目录下。
    TUICallKit 组件集成后效果
    
    
    
    说明
    TUICallKit 组件集成后支持文件夹分层显示,方便您阅读和修改源代码。

    2、如何购买套餐?

    请参考购买链接 购买正式版

    交流与反馈

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

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

    技术支持

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

    7x24 电话支持