TRTCCalling 是基于腾讯云实时音视频（TRTC）和即时通信 IM 服务组合而成的，支持1v1和多人视频/语音通话。TRTCCalling 是一个开源的 Class，依赖腾讯云的两个闭源 SDK，具体的实现过程请参见 实时视频通话（iOS）。

• TRTC SDK：使用 TRTC SDK 作为低延时音视频通话组件。
• IM SDK：使用 IM SDK 发送和处理信令消息。

TRTCCalling API 概览

SDK 基础函数

通话操作相关接口函数

推拉流相关接口函数

音视频控制相关接口函数

TRTCCallingDelegate API 概览

通用事件回调

邀请方回调

被邀请方回调

通用回调

SDK 基础函数

shareInstance

shareInstance 是 TRTCCalling 的组件单例。

/// 单例对象
+ (TRTCCalling *)shareInstance;

addDelegate

TRTCCalling 事件回调，您可以通过 TRTCCallingDelegate 获得 TRTCCalling 的各种状态通知。

/// 设置TRTCCallingDelegate回调
/// @param delegate 回调实例
- (void)addDelegate:(id<TRTCCallingDelegate>)delegate;

login

登录组件。

typedef void(^CallingActionCallback)(void);
typedef void(^ErrorCallback)(int code, NSString *des);
/// 登录接口
/// @param sdkAppID SDK ID，可在腾讯云控制台获取
/// @param userID 用户ID
/// @param userSig 用户签名
/// @param success 成功回调
/// @param failed 失败回调
- (void)login:(UInt32)sdkAppID
       user:(NSString *)userID
    userSig:(NSString *)userSig
    success:(CallingActionCallback)success
     failed:(ErrorCallback)failed
NS_SWIFT_NAME(login(sdkAppID:user:userSig:success:failed:));

参数如下表所示：

logout

登出组件。

/// 登出接口
/// @param success 成功回调
/// @param failed 失败回调
- (void)logout:(CallingActionCallback)success
      failed:(ErrorCallback)failed
NS_SWIFT_NAME(logout(success:failed:));

参数如下表所示：

通话操作相关接口函数

call

单人通话邀请，当前处于通话中也可继续调用邀请他人。

/// 发起1v1通话接口
/// @param userID 被邀请方ID
/// @param type 通话类型：视频/语音
- (void)call:(NSString *)userID
      type:(CallType)type
NS_SWIFT_NAME(call(userID:type:));

参数如下表所示：

groupCall

IM 群组邀请通话，被邀请方会收到 onInvited 回调。如果当前处于通话中，可以继续调用该函数继续邀请他人进入通话，同时正在通话的用户会收到 onGroupCallInviteeListUpdate 回调。

/// 发起多人通话
/// @param userIDs 被邀请方ID列表
/// @param type 通话类型:视频/语音
/// @param groupID 群组ID，可选参数
- (void)groupCall:(NSArray *)userIDs
           type:(CallType)type
        groupID:(NSString * _Nullable)groupID
NS_SWIFT_NAME(groupCall(userIDs:type:groupID:));

参数如下表所示：

accept

接受当前通话。当您作为被邀请方收到 onInvited 的回调时，可以调用该函数接听来电。

/// 接受当前通话
- (void)accept;

reject

拒绝当前通话。当您作为被邀请方收到 onInvited 的回调时，可以调用该函数拒绝来电。

/// 拒绝当前通话
- (void)reject;

hangup

挂断当前通话。当您处于通话中，可以调用该函数结束通话。

/// 主动挂断通话
- (void)hangup;

推拉流相关接口函数

startRemoteView

远端用户的摄像头数据渲染到指定的 UIView 中。

///开启远程用户视频渲染
- (void)startRemoteView:(NSString *)userId view:(UIView *)view
NS_SWIFT_NAME(startRemoteView(userId:view:));

参数如下表所示：

stopRemoteView

停止渲染远端数据。

///关闭远程用户视频渲染
- (void)stopRemoteView:(NSString *)userId
NS_SWIFT_NAME(stopRemoteView(userId:));

参数如下表所示：

音视频控制相关接口函数

openCamera

开启摄像头，并渲染在指定的 UIView 中。

///打开摄像头
- (void)openCamera:(BOOL)frontCamera view:(UIView *)view
NS_SWIFT_NAME(openCamera(frontCamera:view:));

参数如下表所示：

switchCamera

切换前后摄像头。

///切换摄像头
- (void)switchCamera:(BOOL)frontCamera;

参数如下表所示：

closeCamara

关闭摄像头。

///关闭摄像头
- (void)closeCamara;

setMicMute

静音本地音频采集。

///静音操作
- (void)setMicMute:(BOOL)isMute;

参数如下表所示：

setHandsFree

开启免提。

///免提操作
- (void)setHandsFree:(BOOL)isHandsFree;

参数如下表所示：

TRTCCallingDelegate事件回调

通用事件回调

onError

错误回调。

说明：

SDK 不可恢复的错误，一定要监听，并分情况给用户适当的界面提示。

/// sdk内部发生了错误 | sdk error
/// - Parameters:
///   - code: 错误码
///   - msg: 错误消息
-(void)onError:(int)code msg:(NSString * _Nullable)msg
NS_SWIFT_NAME(onError(code:msg:));

参数如下表所示：

邀请方回调

onReject

拒绝通话回调。

/// 拒绝通话回调-仅邀请者受到通知，其他用户应使用 onUserEnter |
/// reject callback only worked for Sponsor, others should use onUserEnter)
/// - Parameter uid: userid
-(void)onReject:(NSString *)uid
NS_SWIFT_NAME(onReject(uid:));

参数如下表所示：

onNoResp

对方无回应回调。

/// 无回应回调-仅邀请者受到通知，其他用户应使用 onUserEnter |
/// no response callback only worked for Sponsor, others should use onUserEnter)
/// - Parameter uid: userid
-(void)onNoResp:(NSString *)uid
NS_SWIFT_NAME(onNoResp(uid:));

参数如下表所示：

onLineBusy

通话忙线回调。

/// 通话占线回调-仅邀请者受到通知，其他用户应使用 onUserEnter |
/// linebusy callback only worked for Sponsor, others should use onUserEnter
/// - Parameter uid: userid
-(void)onLineBusy:(NSString *)uid
NS_SWIFT_NAME(onLineBusy(uid:));

参数如下表所示：

被邀请方回调

onInvited

被邀请通话回调。

/// 被邀请通话回调 | invitee callback
/// - Parameter userIds: 邀请列表 (invited list)
-(void)onInvited:(NSString *)sponsor
       userIds:(NSArray<NSString *> *)userIds
   isFromGroup:(BOOL)isFromGroup
      callType:(CallType)callType
NS_SWIFT_NAME(onInvited(sponsor:userIds:isFromGroup:callType:));

参数如下表所示：

onCallingCancel

当前通话被取消回调。接收方未处理请求，邀请方取消后会收到此回调。

/// 当前通话被取消回调 | current call had been canceled callback
-(void)onCallingCancel:(NSString *)uid
NS_SWIFT_NAME(onCallingCancel(uid:));

onCallingTimeOut

当前通话超时回调。

/// 通话超时的回调 | timeout callback
-(void)onCallingTimeOut;

通用回调

onGroupCallInviteeListUpdate

群聊更新邀请列表回调。

/// 群聊更新邀请列表回调 | update current inviteeList in group calling
/// - Parameter userIds: 邀请列表 | inviteeList
-(void)onGroupCallInviteeListUpdate:(NSArray *)userIds
NS_SWIFT_NAME(onGroupCallInviteeListUpdate(userIds:));

参数如下表所示：

onUserEnter

用户进入通话回调。

/// 进入通话回调 | user enter room callback
/// - Parameter uid: userid
-(void)onUserEnter:(NSString *)uid
NS_SWIFT_NAME(onUserEnter(uid:));

参数如下表所示：

onUserLeave

用户离开通话回调。

/// 离开通话回调 | user leave room callback
/// - Parameter uid: userid
-(void)onUserLeave:(NSString *)uid
NS_SWIFT_NAME(onUserLeave(uid:));

参数如下表所示：

onUserAudioAvailable

用户是否开启音频上行回调。

/// 用户是否开启音频上行回调 | is user audio available callback
/// - Parameters:
///   - uid: 用户ID | userID
///   - available: 是否有效 | available
-(void)onUserAudioAvailable:(NSString *)uid available:(BOOL)available
NS_SWIFT_NAME(onUserAudioAvailable(uid:available:));

参数如下表所示：

onUserVideoAvailable

用户是否开启视频上行回调。收到通知后，用户可调用 startRemoteView 渲染远端视频。

/// 用户是否开启视频上行回调 | is user video available callback
/// - Parameters:
///   - uid: 用户ID | userID
///   - available: 是否有效 | available
-(void)onUserVideoAvailable:(NSString *)uid available:(BOOL)available
NS_SWIFT_NAME(onUserVideoAvailable(uid:available:));

参数如下表所示：

onUserVoiceVolume

用户通话音量回调。

/// 用户音量回调
/// - Parameter uid: 用户ID | userID
/// - Parameter volume: 说话者的音量, 取值范围0 - 100
-(void)onUserVoiceVolume:(NSString *)uid volume:(UInt32)volume
NS_SWIFT_NAME(onUserVoiceVolume(uid:volume:));

参数如下表所示：

onCallEnd

通话结束回调。

/// 通话结束 | end callback
-(void)onCallEnd;