TUIRoom API（iOS）

TUIRoom 是基于腾讯云实时音视频（TRTC）和即时通信 IM 服务组合而成的，支持以下功能：

• 主持人创建房间，进入房间人员输入房间号后进入房间。
• 进入房间人员之间进行屏幕分享。
• 支持发送各种文本消息和自定义消息。

说明：

TUIKit 系列组件同时使用了腾讯云 实时音视频 TRTC 和 即时通信 IM 两个基础 PaaS 服务，开通实时音视频后会同步开通即时通信IM服务。即时通信 IM 服务详细计费规则请参见 即时通信 - 价格说明，TRTC 开通会默认关联开通 IM SDK 的体验版，仅支持100个 DAU。

TUIRoom 是一个开源的 Class，依赖腾讯云的两个闭源 SDK，具体的实现过程请参见 多人音视频房间(iOS)。

• TRTC SDK：使用 TRTC SDK 作为低延时音视频房间组件。
• IM SDK：使用 IM SDK 实现聊天室的功能（IM SDK 使用 iOS 版本）。

TUIRoom API 概览

TUIRoomCore 基础函数

房间相关接口函数

本地音视频操作接口

远端用户相关接口

发送聊天消息接口

场控相关接口

屏幕分享接口

美颜滤镜相关接口函数

相关设置接口

获取 SDK 版本接口函数

TUIRoomCoreDelegate API 概览

错误事件回调

基础事件回调

远端用户事件回调

消息事件回调

场控事件回调

统计和质量回调

屏幕分享相关回调

TUIRoomCore 基础函数

getInstance

获取 TUIRoomCore 单例对象。

+ (instancetype)shareInstance;

destroyInstance

+ (void)destroyInstance;

setDelegate

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

- (void)setDelegate:(id<TUIRoomCoreDelegate>)delegate;

参数如下表所示：

createRoom

创建房间（主持人调用）。

- (void)createRoom:(NSString *)roomId
        speechMode:(TUIRoomSpeechMode)speechMode
        callback:(TUIRoomActionCallback)callback;

参数如下表所示：

主持人正常调用流程如下：

1. 主持人调用 createRoom() 创建房间，房间创建成功与否会通过 TUIRoomActionCallback 通知给主持人。
2. 主持人调用 startCameraPreview() 打开摄像头采集和预览。
3. 主持人调用 startLocalAudio() 打开本地麦克风。

destroyRoom

销毁房间房间（主持人调用）。主持人在创建房间后，可以调用该函数来销毁房间。

- (void)destroyRoom:(TUIRoomActionCallback)callback;

参数如下表所示：

enterRoom

进入房间（加入房间成员调用）。

- (void)enterRoom:(NSString *)roomId
        callback:(TUIRoomActionCallback)callback;

参数如下表所示：

加入房间成员进入房间的正常调用流程如下：

1. 进入房间成员调用enterRoom并传入 roomId 即可进入房间房间。
2. 进入房间成员调用 startCameraPreview() 打开摄像头预览，调用 startLocalAudio() 打开麦克风采集。
3. 进入房间成员收到onRemoteUserCameraAvailable的事件，调用startRemoteView()开始播放视频。

leaveRoom

离开房间（进入房间成员调用）。

 - (void)leaveRoom:(TUIRoomActionCallback)callback;

参数如下表所示：

getRoomInfo

获取房间信息。

- (nullable TUIRoomInfo *)getRoomInfo;

getRoomUsers

获取房间所有成员信息。

 - (nullable NSArray<TUIRoomUserInfo *> *)getRoomUsers;

getUserInfo

获取房间成员信息。

- (void)getUserInfo:(NSString *)userId
           callback:(TUIRoomUserInfoCallback)callback;

参数如下表所示：

setSelfProfile

设置用户信息。

- (void)setSelfProfile:(NSString *)userName
        avatarURL:(NSString *)avatarURL
        callback:(TUIRoomActionCallback)callback;

参数如下表所示：

transferRoomMaster

将群转交给其他用户。

 - (void)transferRoomMaster:(NSString *)userId
                  callback:(TUIRoomActionCallback)callback;

参数如下表所示：

本地推流接口

startCameraPreview

开始本地摄像头预览。

- (void)startCameraPreview:(BOOL)isFront
                      view:(UIView *)view;

参数如下表所示：

stopCameraPreview

停止本地摄像头预览。

- (void)stopCameraPreview;

startLocalAudio

开启麦克风采集。

- (void)startLocalAudio:(TRTCAudioQuality)quality;

参数如下表所示：

stopLocalAudio

停止麦克风采集

- (void)stopLocalAudio;

setVideoMirror

设置本地画面镜像预览模式。

 - (void)setVideoMirror:(TRTCVideoMirrorType)type;

参数如下表所示：

setSpeaker

设置开启扬声器。

 - (void)setSpeaker:(BOOL)isUseSpeaker;

参数如下表所示：

远端用户相关接口

startRemoteView

订阅远端用户的视频流。

- (void)startRemoteView:(NSString *)userId
                   view:(UIView *)view
             streamType:(TUIRoomStreamType)streamType
               callback:(TUIRoomActionCallback)callback;

参数如下表所示：

stopRemoteView

取消订阅并停止播放远端视频画面。

- (void)stopRemoteView:(NSString *)userId
            streamType:(TUIRoomStreamType)streamType
              callback:(TUIRoomActionCallback)callback;

参数如下表所示：

switchCamera

切换前后摄像头。

- (void)switchCamera:(BOOL)isFront;

参数如下表所示：

发送消息接口

sendChatMessage

在房间中广播文本消息，一般用于文本聊天。

- (void)sendChatMessage:(NSString *)message
               callback:(TUIRoomActionCallback)callback;

参数如下表所示：

场控相关接口

muteUserMicrophone

禁用/恢复某用户的麦克风。

- (void)muteUserMicrophone:(NSString *)userId
                      mute:(BOOL)mute
                  callback:(TUIRoomActionCallback)callback;

参数如下表所示：

muteAllUsersMicrophone

禁用/恢复所有用户的麦克风。

- (void)muteAllUsersMicrophone:(BOOL)mute
                      callback:(TUIRoomActionCallback)callback;

参数如下表所示：

muteUserCamera

禁用/恢复某用户的摄像头。

- (void)muteUserCamera:(NSString *)userId
                  mute:(BOOL)mute
              callback:(TUIRoomActionCallback)callback;

参数如下表所示：

muteAllUsersCamera

禁用/恢复所有用户的摄像头。

- (void)muteAllUsersCamera:(BOOL)mute
                  callback:(TUIRoomActionCallback)callback;

参数如下表所示：

muteChatRoom

禁言/恢复文字聊天。

- (void)muteChatRoom:(BOOL)mute
            callback:(TUIRoomActionCallback)callback;

参数如下表所示：

kickOffUser

主持人踢人。

- (void)kickOffUser:(NSString *)userId
           callback:(TUIRoomActionCallback)callback;

参数如下表所示：

startCallingRoll

主持人开始点名。

 - (void)startCallingRoll:(TUIRoomActionCallback)callback;

stopCallingRoll

主持人结束点名。

- (void)stopCallingRoll:(TUIRoomActionCallback)callback;

replyCallingRoll

成员回复主持人点名。

- (void)replyCallingRoll:(TUIRoomActionCallback)callback;

sendSpeechInvitation

主持人邀请成员发言。

- (void)sendSpeechInvitation:(NSString *)userId
                    callback:(TUIRoomInviteeCallback)callback

参数如下表所示：

cancelSpeechInvitation

主持人取消邀请成员发言。

- (void)cancelSpeechInvitation:(NSString *)userId
                      callback:(TUIRoomActionCallback)callback;

参数如下表所示：

replySpeechInvitation

成员同意/拒绝主持人的发言邀请。

- (void)replySpeechInvitation:(BOOL)agree
                     callback:(TUIRoomActionCallback)callback;

参数如下表所示：

sendSpeechApplication

成员申请发言。

- (void)sendSpeechApplication:(TUIRoomInviteeCallback)callback;

参数如下表所示：

cancelSpeechApplication

成员取消申请发言。

- (void)cancelSpeechApplication:(TUIRoomActionCallback)callback;

参数如下表所示：

replySpeechApplication

主持人同意/拒绝成员的申请发言。

- (void)replySpeechApplication:(BOOL)agree
                        userId:(NSString *)userId
                      callback:(TUIRoomActionCallback)callback;

参数如下表所示：

forbidSpeechApplication

主持人禁止申请发言。

- (void)forbidSpeechApplication:(BOOL)forbid
                       callback:(TUIRoomActionCallback)callback;

参数如下表所示：

sendOffSpeaker

主持人令成员停止发言。

- (void)sendOffSpeaker:(NSString *)userId
              callback:(TUIRoomInviteeCallback)callback;

参数如下表所示：

sendOffAllSpeakers

主持人令所有成员停止发言。

- (void)sendOffAllSpeakers:(TUIRoomInviteeCallback)callback;

参数如下表所示：

exitSpeechState

成员停止发言，转变为观众。

- (void)exitSpeechState:(TUIRoomActionCallback)callback;

屏幕分享接口

startScreenCapture

启动屏幕分享。

- (void)startScreenCapture:(TRTCVideoEncParam *)encParam API_AVAILABLE(ios(11.0));

参数如下表所示：

说明：

详情请参见 TRTC SDK

stopScreenCapture

停止屏幕采集。

- (void)stopScreenCapture API_AVAILABLE(ios(11.0));

美颜滤镜相关接口函数

getBeautyManager

获取美颜管理对象 TXBeautyManager。

- (TXBeautyManager *)getBeautyManager;

通过美颜管理，您可以使用以下功能：

• 设置“美颜风格”、“美白”、“红润”、“大眼”、“瘦脸”、“V脸”、“下巴”、“短脸”、“小鼻”、“亮眼”、“白牙”、“祛眼袋”、“祛皱纹”、“祛法令纹”等美容效果。
• 调整“发际线”、“眼间距”、“眼角”、“嘴形”、“鼻翼”、“鼻子位置”、“嘴唇厚度”、“脸型”。
• 设置人脸挂件（素材）等动态效果。
• 添加美妆。
• 进行手势识别。

相关设置接口

setVideoQosPreference

设置网络流控相关参数。

- (void)setVideoQosPreference:(TRTCNetworkQosParam *)preference;

参数如下表所示：

setAudioQuality

设置音质

- (void)setAudioQuality:(TRTCAudioQuality)quality;

参数如下表所示：

setVideoResolution

设置分辨率。

- (void)setVideoResolution:(TRTCVideoResolution)resolution;

参数如下表所示：

setVideoFps

设置帧率。

- (void)setVideoFps:(int)fps;

参数如下表所示：

说明：

推荐取值：15fps或20fps，5fps以下，卡顿感明显。10fps以下，会有轻微卡顿感。20fps以上，则过于浪费（电影的帧率为24fps）。

setVideoBitrate

设置码率。

- (void)setVideoBitrate:(int)bitrate;

参数如下表所示：

说明：

推荐取值：请参考 TRTCVideoResolution 在各档位注释的最佳码率，也可以在此基础上适当调高。 例如 TRTC_VIDEO_RESOLUTION_1280_720 对应1200kbps的目标码率，您也可以设置为1500kbps以便获得更好的清晰度观感。

enableAudioEvaluation

启用音量大小提示。

- (void)enableAudioEvaluation:(BOOL)enable;

参数如下表所示：

说明：

开启后会在 onUserVolumeUpdate 中获取到 SDK 对音量大小值的评估。

setAudioPlayVolume

设置播放音量。

- (void)setAudioPlayVolume:(NSInteger)volume;

参数如下表所示：

setAudioCaptureVolume

设置麦克风采集音量。

- (void)setAudioCaptureVolume:(NSInteger)volume;

参数如下表所示：

startFileDumping

开始录音。

- (void)startFileDumping:(TRTCAudioRecordingParams *)params;

参数如下表所示：

说明：

该方法调用后， SDK 会将通话过程中的所有音频（包括本地音频，远端音频，BGM 等）录制到一个文件里。无论是否进房，调用该接口都生效。如果调用 leaveRoom 时还在录音，录音会自动停止。

stopFileDumping

停止录音。

- (void)stopFileDumping;

获取 SDK 版本接口

getSdkVersion

获取 SDK 版本信息。

- (NSInteger)getSdkVersion;

错误事件回调

onError

- (void)onError:(NSInteger)code message:(NSString *)message;

参数如下表所示：

基础事件回调

onDestroyRoom

房间解散回调。

- (void)onDestroyRoom;

onUserVoiceVolume

用户音量大小回调。

- (void)onUserVoiceVolume:(NSString *)userId volume:(NSInteger)volume;

参数如下表所示：

onRoomMasterChanged

主持人更改回调。

- (void)onRoomMasterChanged:(NSString *)previousUserId
              currentUserId:(NSString *)currentUserId;

参数如下表所示：

远端用户回调事件

onRemoteUserEnter

远端用户进入房间回调。

- (void)onRemoteUserEnter:(NSString *)userId;

参数如下表所示：

onRemoteUserLeave

远端用户离开房间回调。

- (void)onRemoteUserLeave:(NSString *)userId;

参数如下表所示：

onRemoteUserCameraAvailable

远端用户是否开启摄像头视频。

- (void)onRemoteUserCameraAvailable:(NSString *)userId
                          available:(BOOL)available;

参数如下表所示：

onRemoteUserScreenVideoAvailable

成员开启/关闭视频分享的通知。

- (void)onRemoteUserScreenVideoAvailable:(NSString *)userId
                               available:(BOOL)available;

参数如下表所示：

onRemoteUserAudioAvailable

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

- (void)onRemoteUserAudioAvailable:(NSString *)userId
                         available:(BOOL)available;

参数如下表所示：

onRemoteUserEnterSpeechState

远端用户开始发言。

- (void)onRemoteUserEnterSpeechState:(NSString *)userId;

参数如下表所示：

onRemoteUserExitSpeechState

远端用户结束发言。

- (void)onRemoteUserExitSpeechState:(NSString *)userId;

参数如下表所示：

聊天室消息事件回调

onReceiveChatMessage

收到文本消息。

- (void)onReceiveChatMessage:(NSString *)userId message:(NSString *)message;

参数如下表所示：

场控消息回调

onReceiveSpeechInvitation

用户收到主持人发言邀请回调。

- (void)onReceiveSpeechInvitation:(NSString *)userId;

参数如下表所示：

onReceiveInvitationCancelled

用户收到主持人取消发言邀请回调。

- (void)onReceiveInvitationCancelled:(NSString *)userId;

参数如下表所示：

OnReceiveSpeechApplication

主持人收到用户发言申请的回调。

void onReceiveSpeechApplication(String userId);

参数如下表所示：

onSpeechApplicationCancelled

用户取消申请发言回调。

- (void)onSpeechApplicationCancelled:(NSString *)userId;

参数如下表所示：

onSpeechApplicationForbidden

主持人禁止申请发言回调。

- (void)onSpeechApplicationForbidden:(BOOL)isForbidden userId:(NSString *)userId;

参数如下表所示：

onOrderedToExitSpeechState

成员被请求停止发言的回调。

- (void)onOrderedToExitSpeechState:(NSString *)userId;

参数如下表所示：

onCallingRollStarted

主持人开始点名，成员收到的回调。

- (void)onCallingRollStarted:(NSString *)userId;

参数如下表所示：

onCallingRollStopped

主持人结束点名，成员收到的回调。

- (void)onCallingRollStopped:(NSString *)userId;

参数如下表所示：

onMemberReplyCallingRoll

成员回复点名，主持人收到的回调。

- (void)onMemberReplyCallingRoll:(NSString *)userId;

参数如下表所示：

onChatRoomMuted

主持人更改聊天室是否禁言回调。

- (void)onChatRoomMuted:(BOOL)muted userId:(NSString *)userId;

参数如下表所示：

onMicrophoneMuted

主持人设置禁用麦克风回调。

- (void)onMicrophoneMuted:(BOOL)muted userId:(NSString *)userId;

参数如下表所示：

onCameraMuted

主持人设置禁用摄像头回调。

- (void)onCameraMuted:(BOOL)muted userId:(NSString *)userId;

参数如下表所示：

onReceiveKickedOff

主持人踢人的回调。

- (void)onReceiveKickedOff:(NSString *)userId;

参数如下表所示：

统计和质量回调

onStatistics

技术指标统计回调。

- (void)onStatistics:(TRTCStatistics *)statistics;

参数如下表所示：

onNetworkQuality

网络状况回调。

- (void)onNetworkQuality:(TRTCQualityInfo *)localQuality remoteQuality:(NSArray<TRTCQualityInfo *> *)remoteQuality;

参数如下表所示：

说明：

详情请参见 TRTC SDK。

屏幕分享事件回调

onScreenCaptureStarted

开始屏幕分享回调。

 - (void)onScreenCaptureStarted;

onScreenCaptureStopped

停止屏幕分享回调。

- (void)onScreenCaptureStopped:(NSInteger)reason;

参数如下表所示：