tencent cloud

PrevNext

文档反馈

请输入关键字

Recent Pages

文档
实时音视频
    文档
    Download PDF

    TUIRoomEngine

    最后更新时间：2023-10-20 10:13:17
    下载PDF

      TUIRoomEngine API 简介

      TUIRoomEngine API 是音视频通话组件的无 UI 接口，您可以使用这套 API 根据您的业务需求自定义封装。

      init

      创建 TUIRoomEngine 实例
      TUIRoomEngine *roomEngine = [[TUIRoomEngine alloc] init];

      login

      登录接口，您需要先初始化用户信息后才能进入房间，并进行一系列的操作。
      说明：v1.0.0 该接口命名为 setup，v1.0.1 及其以上版本请使用 TUIRoomEnine.login 登录 TUIRoomEngine。
      + (void)loginWithSDKAppId:(NSInteger)sdkAppId 
                         userId:(NSString *)userId 
                        userSig:(NSString *)userSig 
                      onSuccess:(TUISuccessBlock)onSuccess 
                        onError:(TUIErrorBlock)onError;
      参数如下表所示：
      参数
      类型
      含义
      sdkAppId
      NSInteger
      云通信应用的 SDKAppID
      userId
      NSString *
      用户 ID，用于区分不同用户
      userSig
      NSString *
      用户签名，用于腾讯云流量的认证
      onSuccess
      TUISuccessBlock
      成功回调
      onError
      TUIErrorBlock
      失败回调

      logout

      退出登录接口，会有主动离开房间操作、销毁资源
      + (void)logout:(TUISuccessBlock)onSuccess 
             onError:(TUIErrorBlock)onError;
      参数如下表所示：
      参数
      类型
      含义
      onSuccess
      TUISuccessBlock
      成功回调
      onError
      TUIErrorBlock
      失败回调

      setSelfInfo

      设置本地用户名称和头像。
      + (void)setSelfInfoWithUserName:(NSString *)userName
                            avatarUrl:(NSString *)avatarUrl
                            onSuccess:(TUISuccessBlock)onSuccess
                              onError:(TUIErrorBlock)onError;
      参数如下表所示：
      参数
      类型
      含义
      userName
      NSString *
      用户名称
      avatarUrl
      NSString *
      用户头像 URL 地址
      onSuccess
      TUISuccessBlock
      成功回调
      onError
      TUIErrorBlock
      失败回调

      getSelfInfo

      获取本地用户登录的基本信息。
      + (TUILoginUserInfo *)getSelfInfo;
      参数如下表所示：
      返回值
      类型
      含义
      selfInfo
      本地用户登录的基本信息，详细定义可以参考 TUIRoomDefine.h 中的TUILoginUserInfo。

      addObserver

      设置事件回调。
      - (void)addObserver:(id<TUIRoomObserver>)observer;
      参数如下表所示：
      参数
      类型
      含义
      observer
      TUIRoomObserver *
      回调实例的指针，您可以通过 TUIRoomObserver 获得各类事件通知（比如：错误码，远端用户进房，音视频状态参数等）

      removeObserver

      移除事件回调。
      - (void)removeObserver:(id<TUIRoomObserver>)observer;
      参数如下表所示：
      参数
      类型
      含义
      observer
      TUIRoomObserver *
      回调实例的指针

      createRoom

      创建房间。
      - (void)createRoom:(TUIRoomInfo *)roomInfo
               onSuccess:(TUISuccessBlock)onSuccess
                 onError:(TUIErrorBlock)onError;
      参数如下表所示：
      参数
      类型
      含义
      roomInfo
      房间信息，可以初始化房间的一些设置
      onSuccess
      TUISuccessBlock
      成功回调
      onError
      TUIErrorBlock
      失败回调

      destroyRoom

      解散房间。
      - (void)destroyRoom:(TUISuccessBlock)onSuccess onError:(TUIErrorBlock)onError;
      参数如下表所示：
      参数
      类型
      含义
      onSuccess
      TUISuccessBlock
      成功回调
      onError
      TUIErrorBlock
      失败回调

      enterRoom

      进入房间。
      - (void)enterRoom:(NSString *)roomId
              onSuccess:(TUIRoomInfoBlock)onSuccess
                onError:(TUIErrorBlock)onError;
      参数如下表所示：
      参数
      类型
      含义
      roomId
      NSString *
      房间 ID
      onSuccess
      TUIRoomInfoBlock
      成功回调
      onError
      TUIErrorBlock
      失败回调

      exitRoom

      离开房间。
      - (void)exitRoom:(BOOL)syncWaiting
             onSuccess:(TUISuccessBlock)onSuccess
               onError:(TUIErrorBlock)onError;
      参数如下表所示：
      参数
      类型
      含义
      syncWaiting
      BOOL
      是否同步等待接口返回
      onSuccess
      TUISuccessBlock
      成功回调
      onError
      TUIErrorBlock
      失败回调

      connectOtherRoom

      连接其他房间（用于直播场景下的申请跨房连麦）。
      - (TUIRequest *)connectOtherRoom:(NSString *)roomId
                              userId:(NSString *)userId
                             timeout:(NSTimeInterval)timeout
                          onAccepted:(TUIRequestAcceptedBlock)onAccepted
                          onRejected:(TUIRequestRejectedBlock)onRejected      
                         onCancelled:(TUIRequestCancelledBlock)onCancelled
                           onTimeout:(TUIRequestTimeoutBlock)onTimeout
                            onError:(TUIRequestErrorBlock)onError;
      参数如下表所示：
      参数
      类型
      含义
      roomId
      NSString *
      房间 ID
      userId
      NSString *
      用户 ID
      timeout
      NSTimeInterval
      超时时间（单位秒，如果设置为 0，SDK 不会做超时检测，也不会触发超时回调）
      onAccepted
      TUIRequestAcceptedBlock
      邀请被接受的回调
      onRejected
      TUIRequestRejectedBlock
      邀请被拒绝的回调
      onCancelled
      TUIRequestCancelledBlock
      邀请被取消的回调
      onTimeout
      TUIRequestTimeoutBlock
      邀请超时未处理的回调
      onError
      TUIRequestErrorBlock
      邀请发生错误的回调
      返回值
      类型
      含义
      request
      TUIRequest
      请求体

      disconnectOtherRoom

      断开与其他房间的连接（用于直播场景下的断开跨房连麦）。
      - (void)disconnectOtherRoom:(TUISuccessBlock)onSuccess onError:(TUIErrorBlock)onError;
      参数如下表所示：
      参数
      类型
      含义
      onSuccess
      TUISuccessBlock
      成功回调
      onError
      TUIErrorBlock
      失败回调

      fetchRoomInfo

      获取房间信息。
      - (void)fetchRoomInfo:(TUIRoomInfoBlock)onSuccess onError:(TUIErrorBlock)onError;
      参数如下表所示：
      参数
      类型
      含义
      onSuccess
      TUIRoomInfoBlock
      成功获取到房间信息回调，回调会包含 TUIRoomInfo 房间信息
      onError
      TUIErrorBlock
      失败回调

      updateRoomNameByAdmin

      更新房间名称（只有管理员或群主能够调用）。
      - (void)updateRoomNameByAdmin:(NSString *)roomName 
                          onSuccess:(TUISuccessBlock)onSuccess 
                            onError:(TUIErrorBlock)onError;
      参数如下表所示：
      参数
      类型
      含义
      roomName
      NSString *
      房间名称
      onSuccess
      TUISuccessBlock
      成功回调
      onError
      TUIErrorBlock
      失败回调

      updateRoomSpeechModeByAdmin

      设置房间麦控模式（只有管理员或群主能够调用）。
      - (void)updateRoomSpeechModeByAdmin:(TUISpeechMode)mode 
                                onSuccess:(TUISuccessBlock)onSuccess 
                                  onError:(TUIErrorBlock)onError;
      参数如下表所示：
      参数
      类型
      含义
      mode
      麦控模式,详细定义可以参考 TUIRoomDefine.h 文件的 TUISpeechMode。
      onSuccess
      TUISuccessBlock
      成功回调
      onError
      TUIErrorBlock
      失败回调

      setLocalVideoView

      设置本地用户视频渲染的控件。
      - (void)setLocalVideoView:(TUIVideoStreamType)streamType view:(TUIVideoView *)view;
      参数如下表所示：
      参数
      类型
      含义
      streamType
      视频流类型，详细定义可以参考 TUIRoomDefine.h 中 TUIVideoStreamType 的定义
      view
      TUIVideoView *
      视频渲染视图

      setRemoteVideoView

      设置远端用户视频渲染的控件。
      - (void)setRemoteVideoView:(NSString *)userId
                      streamType:(TUIVideoStreamType)streamType
                            view:(TUIVideoView * __nullable)view;
      参数如下表所示：
      参数
      类型
      含义
      userId
      NSString
      远端用户ID
      streamType
      视频流类型，详细定义可以参考 TUIRoomDefine.h 中 TUIVideoStreamType的定义
      view
      TUIVideoView *
      视频渲染视图

      openLocalCamera

      打开本地摄像头。
      - (void)openLocalCamera:(BOOL)isFront  
                      quality:(TUIVideoQuality)quality                 
                    onSuccess:(TUISuccessBlock)onSuccess
                      onError:(TUIErrorBlock)onError;
      参数
      类型
      含义
      isFront
      BOOL
      是否为前置
      quality
      视频质量，详细定义可以参考TUIRoomDefine.h 中 TUIVideoQuality 的定义
      onSuccess
      TUISuccessBlock
      成功回调
      onError
      TUIErrorBlock
      失败回调

      closeLocalCamera

      关闭本地摄像头。
      - (void)closeLocalCamera;

      updateVideoQuality

      更新本地视频编码质量设置。
      - (void)updateVideoQuality:(TUIVideoQuality)quality;
      参数
      类型
      含义
      quality
      视频质量

      openLocalMicrophone

      打开本地麦克风。
      - (void)openLocalMicrophone:(TUIAudioQuality)quality
                        onSuccess:(TUISuccessBlock)onSuccess
                          onError:(TUIErrorBlock)onError;
      参数
      类型
      含义
      quality
      音频质量，详细定义可以参考 TUIRoomDefine.h 中TUIAudioQuality 的定义
      onSuccess
      TUISuccessBlock
      成功回调
      onError
      TUIErrorBlock
      失败回调

      closeLocalMicrophone

      关闭本地麦克风。
      - (void)closeLocalMicrophone;

      updateAudioQuality

      更新本地音频编码质量设置。
      - (void)updateAudioQuality:(TUIAudioQuality)quality;
      参数
      类型
      含义
      quality
      音频质量

      startScreenCapture

      开始屏幕分享（仅支持移动端 iOS 11.0 及以上系统）
      该接口支持抓取整个 iOS 系统的屏幕，可以实现类似腾讯会议的全系统级的屏幕分享。
      - (void)startScreenCaptureByReplaykit:(NSString *)appGroup API_AVAILABLE(ios(11.0));
      参数如下表所示：
      参数
      类型
      含义
      appGroup
      NSString *
      用于指定您的应用与录屏进程共享的 Application Group Identifier，您可以指定该参数为 nil，但推荐您按照文档指示进行设置，从而获得更好的可靠性。

      startScreenCapture

      开始屏幕分享（该接口仅支持桌面端 Mac OS系统）
      该接口可以抓取整个 Mac OS 系统的屏幕内容，或抓取您指定的某个应用的窗口内容，并将其分享给同房间中的其他用户。
      - (void)startScreenCapture:(TUIVideoView *)view
                       onSuccess:(TUISuccessBlock)onSuccess
                         onError:(TUIErrorBlock)onError;
      参数如下表所示：
      参数
      类型
      含义
      view
      TUIVideoView *
      渲染控件所在的父控件，可以设置为空值，表示不显示屏幕分享的预览效果。
      onSuccess
      TUISuccessBlock
      成功回调
      onError
      TUIErrorBlock
      失败回调

      stopScreenCapture

      结束屏幕分享。
      - (void)stopScreenCapture;

      getScreenCaptureSources

      枚举可分享的屏幕和窗口（该接口仅支持 Mac OS 系统）
      当您在对接桌面端系统的屏幕分享功能时，一般都需要展示一个选择分享目标的界面，这样用户能够使用这个界面选择是分享整个屏幕还是某个窗口。
      通过本接口，您就可以查询到当前系统中可用于分享的窗口的 ID、名称以及缩略图。我们在 Demo 中提供了一份默认的界面实现供您参考。
      - (NSArray<TUIShareTarget *> *)getScreenCaptureSources;
      返回值
      类型
      含义
      screenCaptureSources
      NSArray<TUIShareTarget *> *
      窗口列表包括屏幕

      selectScreenCaptureTarget

      选择屏幕分享对象。
      - (void)selectScreenCaptureTarget:(NSString *)targetId;
      参数如下表所示：
      参数
      类型
      含义
      targetId
      NSString *
      指定分享源

      startPushLocalVideo

      开始推送本地视频。
      - (void)startPushLocalVideo;

      stopPushLocalVideo

      停止推送本地视频。
      - (void)stopPushLocalVideo;

      startPushLocalAudio

      开始推送本地音频。
      - (void)startPushLocalAudio;

      stopPushLocalAudio

      停止推送本地音频。
      - (void)stopPushLocalAudio;

      startPlayRemoteVideo

      开始播放远端用户视频。
      - (void)startPlayRemoteVideo:(NSString *)userId
                        streamType:(TUIVideoStreamType)streamType
                         onPlaying:(TUIPlayOnPlayingBlock)onPlaying
                         onLoading:(TUIPlayOnLoadingBlock)onLoading
                           onError:(TUIPlayOnErrorBlock)onError;
      参数如下表所示：
      参数
      类型
      含义
      userId
      NSString *
      用户 ID
      streamType
      视频流的类型。详细定义可以参考 TUIRoomDefine.h 中 TUIVideoStreamType 的定义
      onPlaying
      TUIPlayOnPlayingBlock
      播放回调
      onLoading
      TUIPlayOnLoadingBlock
      加载回调
      onError
      TUIPlayOnErrorBlock
      错误回调

      stopPlayRemoteVideo

      停止播放远端用户视频。
      - (void)stopPlayRemoteVideo:(NSString *)userId streamType:(TUIVideoStreamType)streamType;
      参数如下表所示：
      参数
      类型
      含义
      userId
      NSString *
      用户 ID
      streamType
      视频流的类型。详细定义可以参考 TUIRoomDefine.h 中 TUIVideoStreamType 的定义

      muteRemoteAudioStream

      将远端用户禁音
      - (void)muteRemoteAudioStream:(NSString *)userId isMute:(BOOL)isMute;
      参数
      类型
      含义
      userId
      NSString *
      用户 ID
      isMute
      BOOL
      是否禁音

      getUserList

      获取房间内的成员列表。
      - (void)getUserList:(NSInteger)nextSequence
                onSuccess:(TUIUserListResponseBlock)onSuccess
                  onError:(TUIErrorBlock)onError;
      参数如下表所示：
      参数
      类型
      含义
      nextSequence
      NSInteger
      分页拉取标志，第一次拉取填0，回调成功如果 callback 返回 TUIUserListResult 中 next_sequence 不为零，需要分页，传入再次拉取，直至为0
      onSuccess
      TUIUserListResponseBlock
      成功回调。详细定义可以参考 TUIRoomDefine.h 中 TUIUserListResponseBlock 的定义
      onError
      TUIErrorBlock
      错误回调

      getUserInfo

      获取成员信息。
      - (void)getUserInfo:(NSString *)userId
                onSuccess:(TUIUserInfoBlock)onSuccess
                  onError:(TUIErrorBlock)onError;
      参数如下表所示：
      参数
      类型
      含义
      userId
      NSString *
      用户 ID
      onSuccess
      TUIUserInfoBlock
      成功回调。详细定义可以参考 TUIRoomDefine.h 中 TUIUserInfoBlock 定义
      onError
      TUIErrorBlock
      错误回调

      changeUserRole

      修改用户角色（只有管理员或群主能够调用）。
      - (void)changeUserRoleWithUserId:(NSString *)userId
                                  role:(TUIRole)role
                             onSuccess:(TUISuccessBlock)onSuccess
                               onError:(TUIErrorBlock)onError;
      参数如下表所示：
      参数
      类型
      含义
      userId
      NSString *
      用户 ID
      role
      TUIRole
      需要切换的用户角色
      onSuccess
      TUISuccessBlock
      成功回调
      onError
      TUIErrorBlock
      失败回调

      kickRemoteUserOutOfRoom

      - (void)kickRemoteUserOutOfRoom:(NSString *)userId 
                            onSuccess:(TUISuccessBlock)onSuccess 
                              onError:(TUIErrorBlock)onError;
      将远端用户踢出房间（只有管理员或群主能够调用）。
      参数
      类型
      含义
      userId
      NSString *
      用户 ID
      onSuccess
      TUISuccessBlock
      成功回调
      onError
      TUIErrorBlock
      失败回调

      disableDeviceForAllUserByAdmin

      控制当前房间内所有用户是否可打开音频流、视频流采集设备的权限状态，例如：全员禁止打开麦克风、全员禁止打开摄像头、全员禁止打开屏幕分享
      （目前仅会议场景下可用，并且只有管理员或群主能够调用）。
      
      - (void)disableDeviceForAllUserByAdmin:(TUIMediaDevice)device 
                                   isDisable:(BOOL)isDisable
                                   onSuccess:(TUISuccessBlock)onSuccess 
                                     onError:(TUIErrorBlock)onError;
      参数
      类型
      含义
      device
      设备类型
      isDisable
      BOOL
      是否禁用
      onSuccess
      TUISuccessBlock
      操作成功回调
      onError
      TUIErrorBlock
      操作失败回调

      openRemoteDeviceByAdmin

      请求远端用户打开媒体设备（只有管理员或群主能够调用）。
      
      - (TUIRequest *)openRemoteDeviceByAdmin:(NSString *)userId
                                       device:(TUIMediaDevice)device
                                      timeout:(NSTimeInterval)timeout
                                   onAccepted:(nullable TUIRequestAcceptedBlock)onAccepted
                                   onRejected:(nullable TUIRequestRejectedBlock)onRejected
                                  onCancelled:(nullable TUIRequestCancelledBlock)onCancelled
                                    onTimeout:(nullable TUIRequestTimeoutBlock)onTimeout
                                      onError:(nullable TUIRequestErrorBlock)onError;
      参数
      类型
      含义
      userId
      NSString *
      用户 ID
      device
      媒体设备
      timeout
      NSTimeInterval
      超时时间，单位秒，如果设置为 0，SDK 不会做超时检测，也不会触发超时回调
      onAccepted
      nullable TUIRequestAcceptedBlock
      邀请被接受的回调
      onRejected
      nullable TUIRequestRejectedBlock
      邀请被拒绝的回调
      onCancelled
      nullable TUIRequestCancelledBlock
      邀请被取消的回调
      onTimeout
      nullable TUIRequestTimeoutBlock
      邀请超时未处理的回调
      onError
      nullable TUIRequestErrorBlock
      邀请发生错误的回调
      返回值
      类型
      含义
      request
      请求体

      closeRemoteDeviceByAdmin

      关闭远端用户媒体设备（只有管理员或群主能够调用）。
      
      - (void)closeRemoteDeviceByAdmin:(NSString *)userId 
                                device:(TUIMediaDevice)device 
                             onSuccess:(TUISuccessBlock)onSuccess 
                               onError:(TUIErrorBlock)onError;
      参数
      类型
      含义
      userId
      NSString *
      用户 ID
      device
      媒体设备
      onSuccess
      TUISuccessBlock
      调用成功回调
      onError
      TUIErrorBlock
      调用失败回调

      applyToAdminToOpenLocalDevice

      请求打开本地媒体设备（普通用户可用）。
      
      - (TUIRequest *)applyToAdminToOpenLocalDevice:(TUIMediaDevice)device
                                            timeout:(NSTimeInterval)timeout
                                         onAccepted:(nullable TUIRequestAcceptedBlock)onAccepted
                                         onRejected:(nullable TUIRequestRejectedBlock)onRejected
                                        onCancelled:(nullable TUIRequestCancelledBlock)onCancelled
                                          onTimeout:(nullable TUIRequestTimeoutBlock)onTimeout
                                            onError:(nullable TUIRequestErrorBlock)onError;
      参数
      类型
      含义
      device
      媒体设备
      timeout
      NSTimeInterval
      超时时间，单位秒，如果设置为 0，SDK 不会做超时检测，也不会触发超时回调
      onAccepted
      nullable TUIRequestAcceptedBlock
      邀请被接受的回调
      onRejected
      nullable TUIRequestRejectedBlock
      邀请被拒绝的回调
      onCancelled
      nullable TUIRequestCancelledBlock
      邀请被取消的回调
      onTimeout
      nullable TUIRequestTimeoutBlock
      邀请超时未处理的回调
      onError
      nullable TUIRequestErrorBlock
      邀请发生错误的回调
      返回值
      类型
      含义
      request
      请求体

      setMaxSeatCount

      设置最大麦位数（仅支持进房前和创建房间时设置）。
      roomType 为 TUIRoomTypeConference (教育及会议场景) 时，maxSeatCount 值不做限制；
      roomType 为 TUIRoomTypeLivingRoom (直播场景) 时，maxSeatCount 最大限制为 16；
      
      - (void)setMaxSeatCount:(NSUInteger)maxSeatCount 
                    onSuccess:(TUISuccessBlock)onSuccess 
                      onError:(TUIErrorBlock)onError;
      参数
      类型
      含义
      maxSeatCount
      NSUInteger
      最大麦位数
      onSuccess
      TUISuccessBlock
      成功回调
      onError
      TUIErrorBlock
      错误回调

      getSeatList

      获取麦位列表。
      - (void)getSeatList:(TUISeatListResponseBlock)onSuccess
                  onError:(TUIErrorBlock)onError;
      参数如下表所示：
      参数
      类型
      含义
      onSuccess
      TUISeatListResponseBlock
      成功回调。详细定义可以参考 TUIRoomDefine.h 中 TUISeatListResponseBlock 和 TUISeatInfo 的定义
      onError
      TUIErrorBlock
      失败回调

      lockSeatByAdmin

      锁定麦位（只有管理员或群主能够调用，包括位置锁定、音频状态锁定和视频状态锁定）。
      - (void)lockSeatByAdmin:(NSInteger)seatIndex 
                     lockMode:(TUISeatLockParams *)lockParams 
                    onSuccess:(TUISuccessBlock)onSuccess 
                      onError:(TUIErrorBlock)onError;
      参数如下表所示：
      参数
      类型
      含义
      seatIndex
      NSInteger
      麦位编号
      lockParams
      锁麦参数，详细定义可以参考TUIRoomDefine.h 中 TUISeatLockParams的定义
      onSuccess
      TUISuccessBlock
      成功回调
      onError
      TUIErrorBlock
      失败回调

      takeSeat

      本地用户上麦（自由发言模式下，不需要申请，开启麦控模式时，需要向主持人或管理员发起申请才允许上麦开启自由发言模式，直播场景可以自由上麦，上麦后开麦发言，会议场景无需调用该接口，即可开麦发言）。
      - (TUIRequest *)takeSeat:(NSInteger)seatIndex
                       timeout:(NSTimeInterval)timeout
                    onAccepted:(TUIRequestAcceptedBlock)onAccepted
                    onRejected:(TUIRequestRejectedBlock)onRejected        
                   onCancelled:(TUIRequestCancelledBlock)onCancelled
                     onTimeout:(TUIRequestTimeoutBlock)onTimeout
                       onError:(TUIRequestErrorBlock)onError;
      参数如下表所示：
      参数
      类型
      含义
      seatIndex
      NSInteger
      麦位编号
      timeout
      NSTimeInterval
      超时时间
      onAccepted
      TUIRequestAcceptedBlock
      信令被接受回调
      onRejected
      TUIRequestRejectedBlock
      信令被拒绝回调
      onCancelled
      TUIRequestCancelledBlock
      信令被取消回调
      onTimeout
      TUIRequestTimeoutBlock
      信令超时回调
      onError
      TUIRequestErrorBlock
      错误回调
      返回值
      类型
      含义
      request
      请求体

      leaveSeat

      本地用户下麦（自由发言模式下，不需要申请）。
      - (void)leaveSeat:(TUISuccessBlock)onSuccess
                onError:(TUIErrorBlock)onError;
      参数如下表所示：
      参数
      类型
      含义
      onSuccess
      TUISuccessBlock
      成功回调
      onError
      TUIErrorBlock
      失败回调

      takeUserOnSeatByAdmin

      主持人/管理员 邀请用户上麦。
      - (TUIRequest *)takeUserOnSeatByAdmin:(NSInteger)seatIndex
                                     userId:(NSString *)userId
                                    timeout:(NSTimeInterval)timeout
                                 onAccepted:(TUIRequestAcceptedBlock)onAccepted
                                 onRejected:(TUIRequestRejectedBlock)onRejected                         
                                onCancelled:(TUIRequestCancelledBlock)onCancelled
                                  onTimeout:(TUIRequestTimeoutBlock)onTimeout
                                    onError:(TUIRequestErrorBlock)onError;
      参数如下表所示：
      参数
      类型
      含义
      seatIndex
      NSInteger
      麦位编号
      userId
      NSString *
      用户 ID
      timeout
      NSTimeInterval
      超时时间（单位秒，如果设置为 0，SDK 不会做超时检测，也不会触发超时回调）
      onAccepted
      TUIRequestAcceptedBlock
      邀请被接受的回调
      onRejected
      TUIRequestRejectedBlock
      邀请被拒绝的回调
      onCancelled
      TUIRequestCancelledBlock
      邀请被取消的回调
      onTimeout
      TUIRequestTimeoutBlock
      邀请超时未处理的回调
      onError
      TUIRequestErrorBlock
      邀请发生错误的回调
      返回值
      类型
      含义
      request
      请求体

      kickUserOffSeatByAdmin

      主持人/管理员 将用户踢下麦。
      - (void)kickUserOffSeatByAdmin:(NSInteger)seatIndex
                              userId:(NSString *)userId
                           onSuccess:(TUISuccessBlock)onSuccess
                             onError:(TUIErrorBlock)onError;
      参数如下表所示：
      参数
      类型
      含义
      seatIndex
      NSInteger
      麦位编号
      userId
      NSString *
      用户 ID
      onSuccess
      TUISuccessBlock
      成功回调
      onError
      TUIErrorBlock
      错误回调

      cancelRequest

      取消请求。
      - (void)cancelRequest:(NSInteger)requestId
                        onSuccess:(TUISuccessBlock)onSuccess
                          onError:(TUIErrorBlock)onError;
      参数如下表所示：
      参数
      类型
      含义
      requestId
      NSString *
      请求 ID。发送请求的接口返回
      onSuccess
      TUISuccessBlock
      成功回调
      onError
      TUIErrorBlock
      失败回调

      responseRemoteRequest

      回复请求。
      - (void)responseRemoteRequest:(NSString *)requestId
                              agree:(BOOL)agree
                          onSuccess:(TUISuccessBlock)onSuccess
                            onError:(TUIErrorBlock)onError;
      参数如下表所示：
      参数
      类型
      含义
      requestId
      NSString *
      请求ID。发送请求的接口返回或者 OnRequestReceived 事件通知
      agree
      BOOL
      是否同意。YES：同意，NO：拒绝
      onSuccess
      TUISuccessBlock
      成功回调
      onError
      TUIErrorBlock
      失败回调

      sendTextMessage

      发送本文消息。
      - (void)sendTextMessage:(NSString *)message
                    onSuccess:(TUISuccessBlock)onSuccess
                      onError:(TUIErrorBlock)onError;
      参数如下表所示：
      参数
      类型
      含义
      message
      NSString *
      消息内容
      onSuccess
      TUISuccessBlock
      成功回调
      onError
      TUIErrorBlock
      错误回调

      sendCustomMessage

      发送自定义消息。
      - (void)sendCustomMessage:(NSString *)message
                      onSuccess:(TUISuccessBlock)onSuccess
                        onError:(TUIErrorBlock)onError;
      参数如下表所示：
      参数
      类型
      含义
      message
      NSString *
      消息内容
      onSuccess
      TUISuccessBlock
      成功回调
      onError
      TUIErrorBlock
      错误回调

      disableSendingMessageByAdmin

      禁用远端用户的发送文本消息能力（只有管理员或群主能够调用）。
      - (void)disableSendingMessageByAdmin:(NSString *)userId 
                                 isDisable:(BOOL)isDisable 
                                 onSuccess:(TUISuccessBlock)onSuccess 
                                   onError:(TUIErrorBlock)onError;
      参数
      类型
      含义
      userId
      NSString *
      用户 ID
      isDisable
      BOOL
      是否禁用
      onSuccess
      TUISuccessBlock
      成功回调
      onError
      TUIErrorBlock
      错误回调

      disableSendingMessageForAllUser

      禁用所有用户的发送文本消息能力（只有管理员或群主能够调用）。
      - (void)disableSendingMessageForAllUser:(BOOL)isDisable 
                                    onSuccess:(TUISuccessBlock)onSuccess 
                                      onError:(TUIErrorBlock)onError;
      参数
      类型
      含义
      isDisable
      BOOL
      是否禁用
      onSuccess
      TUISuccessBlock
      成功回调
      onError
      TUIErrorBlock
      错误回调

      getDeviceManager

      获得设备管理对象。
      - (TXDeviceManager *)getDeviceManager;
      返回值
      类型
      含义
      manager
      TXDeviceManager *
      TXDeviceManager 对象

      getBeautyManager

      获得音效管理对象。
      - (TXBeautyManager *)getBeautyManager;
      返回值
      类型
      含义
      manager
      TXBeautyManager *
      TXBeautyManager 对象

      getAudioEffectManager

      获得音效管理对象。
      - (TXAudioEffectManager *)getAudioEffectManager;
      返回值
      类型
      含义
      manager
      TXAudioEffectManager *
      TXAudioEffectManager 对象

      getTRTCCloud

      获得 TRTC 实例对象。
      - (TRTCCloud *)getTRTCCloud;
      返回值
      类型
      含义
      manager
      TRTCCloud *
      TRTCCloud 对象
      
      联系我们

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

      联系我们
      技术支持

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

      提交工单
      7x24 电话支持
      Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
      隐私条款服务条款缓存条款