函数列表 | 描述 |
创建 TUIRoomEngine 实例(单例模式) | |
销毁 TUIRoomEngine 实例(单例模式) | |
登录接口,您需要先初始化用户信息后才能进入房间,并进行一系列的操作 | |
退出登录接口,会有主动离开房间操作、销毁资源 | |
设置本地用户名称和头像 | |
获取本地用户登录的基本信息 | |
设置本地用户信息 | |
设置事件回调 | |
移除事件回调 | |
创建房间 | |
解散房间 | |
进入房间 | |
进入房间 | |
进入房间 | |
离开房间 | |
获取当前进入的房间信息 | |
获取房间信息 | |
更新房间名称(只有管理员或房主能够调用) | |
更新房间麦位模式(只有管理员或房主能够调用) | |
更新房间密码 | |
获取房间自定义信息 | |
设置房间自定义信息,已有该属性则更新其 value 值,没有则添加该属性 | |
设置本地用户视频渲染的视图控件 | |
打开本地摄像头 | |
关闭本地摄像头 | |
开始推送本地视频。默认开启 | |
停止推送本地视频 | |
更新本地视频编码质量设置 | |
设置视频编码器的编码参数 | |
设置视频编码器分辨率模式(横屏分辨率 or 竖屏分辨率) | |
开启重力感应模式 | |
开始屏幕分享(该接口仅支持移动端) | |
开始屏幕分享(该接口仅支持桌面端 Mac OS 系统) | |
结束屏幕分享 | |
枚举可分享的屏幕和窗口(该接口仅支持 Mac OS 系统) | |
选取要分享的屏幕或窗口(该接口仅支持 Mac OS 系统) | |
打开本地麦克风 | |
关闭本地麦克风 | |
更新本地音频编码质量设置 | |
暂停发布本地的音频流 | |
恢复发布本地的音频流 | |
开启系统声音分享 | |
设置远端用户视频渲染的视图控件 | |
开始播放远端用户视频 | |
停止播放远端用户视频 | |
将远端用户静音 | |
获取房间内的成员列表 | |
获取成员信息 | |
修改用户角色(只有管理员或房主能够调用) | |
修改用户房间内昵称 | |
将远端用户踢出房间(只有管理员或房主能够调用) | |
为用户增加标记(只有房主能够调用) | |
为用户移除标记(只有房主能够调用) | |
根据标记获取房间内用户信息 | |
设置房间内成员自定义信息 | |
控制当前房间内所有用户是否可打开音频流、视频流采集设备的权限状态,例如:全员禁止打开麦克风、全员禁止打开摄像头(目前仅会议场景下可用,并且只有管理员或房主能够调用) | |
请求远端用户打开媒体设备(只有管理员或房主能够调用,device类型不支持SCREEN_SHARING) | |
关闭远端用户媒体设备(只有管理员或房主能够调用) | |
请求打开本地媒体设备(普通用户可用,device类型不支持SCREEN_SHARING) | |
设置最大麦位数(仅支持进房前和创建房间时设置) | |
获取麦位列表 | |
锁定麦位(只有管理员或房主能够调用,包括位置锁定、音频状态锁定和视频状态锁定) | |
上麦(上麦发言模式下,需要申请) | |
下麦 | |
移麦 | |
主持人/管理员 邀请用户上麦 | |
主持人/管理员 将用户踢下麦 | |
主持人/管理员 获取房间内申请上麦用户的请求列表 | |
禁用远端用户的发送文本消息能力(只有管理员或房主能够调用) | |
禁用所有用户的发送文本消息能力(只有管理员或房主能够调用) | |
取消请求 | |
回复请求 | |
设置美颜级别 | |
设置美白级别 | |
获取插件 | |
获取设备管理类 | |
获取连线管理类 | |
获取 Battle 管理类 | |
调用实验性接口 |
+ (void)loginWithSDKAppId: | (NSInteger)sdkAppId |
userId: | (NSString *)userId |
userSig: | (NSString *)userSig |
onSuccess: | (TUISuccessBlock)onSuccess |
onError: | (TUIErrorBlock)onError |
参数 | 描述 |
onError | 失败回调。 |
onSuccess | 成功回调。 |
sdkAppId | 它是腾讯云用于区分客户的唯一标识,进入腾讯云实时音视频 控制台创建应用,即可看到SDKAppId。 |
userId | 用户ID,用于区分不同用户。 |
userSig | 用户签名,用于腾讯云流量的认证。 |
+ (void)logout: | (TUISuccessBlock)onSuccess |
onError: | (TUIErrorBlock)onError |
参数 | 描述 |
onError | 失败回调。 |
onSuccess | 成功回调。 |
+ (void)setSelfInfoWithUserName: | (NSString *)userName |
avatarUrl: | (NSString *)avatarURL |
onSuccess: | (TUISuccessBlock)onSuccess |
onError: | (TUIErrorBlock)onError |
参数 | 描述 |
avatarURL | 用户头像URL地址。 |
onError | 失败回调。 |
onSuccess | 成功回调。 |
userName | 用户名称。 |
+ (void)setSelfInfo: | |
onSuccess: | (TUISuccessBlock)onSuccess |
onError: | (TUIErrorBlock)onError |
参数 | 描述 |
onError | 失败回调。 |
onSuccess | 成功回调。 |
userInfo | 本地用户信息。 |
- (void)addObserver: |
参数 | 描述 |
observer | 监听的实例。 |
- (void)removeObserver: |
- (void)createRoom: | |
onSuccess: | (TUISuccessBlock)onSuccess |
onError: | (TUIErrorBlock)onError |
参数 | 描述 |
onError | 失败回调。 |
onSuccess | 成功回调。 |
roomInfo | 房间信息,可以初始化房间的一些设置。 |
- (void)destroyRoom: | (TUISuccessBlock)onSuccess |
onError: | (TUIErrorBlock)onError |
参数 | 描述 |
onError | 失败回调。 |
onSuccess | 成功回调。 |
- (void)enterRoom: | (NSString *)roomId |
onSuccess: | (TUIRoomInfoBlock)onSuccess |
onError: | (TUIErrorBlock)onError |
参数 | 描述 |
onError | 失败回调。 |
onSuccess | 成功回调。 |
roomId | 房间ID。 |
- (void)enterRoom: | (NSString *)roomId |
roomType: | |
onSuccess: | (TUIRoomInfoBlock)onSuccess |
onError: | (TUIErrorBlock)onError |
参数 | 描述 |
onError | 失败回调。 |
onSuccess | 成功回调。 |
roomId | 房间ID。 |
roomType | 房间类型。 |
- (void)enterRoom: | (NSString *)roomId |
roomType: | |
options: | |
onSuccess: | (TUIRoomInfoBlock)onSuccess |
onError: | (TUIErrorBlock)onError |
参数 | 描述 |
options | 进房参数。 |
roomId | 房间ID。 |
roomType | 房间类型。 |
- (void)exitRoom: | (BOOL)syncWaiting |
onSuccess: | (TUISuccessBlock)onSuccess |
onError: | (TUIErrorBlock)onError |
参数 | 描述 |
onError | 失败回调。 |
onSuccess | 成功回调。 |
syncWaiting | 是否同步等待接口返回。 |
- (void)fetchRoomInfo: | (TUIRoomInfoBlock)onSuccess |
onError: | (TUIErrorBlock)onError |
- (void)fetchRoomInfo: | (NSString*)roomId |
roomType: | |
onSuccess: | (TUIRoomInfoBlock)onSuccess |
onError: | (TUIErrorBlock)onError |
参数 | 描述 |
roomId | 房间Id。 |
roomType |
- (void)updateRoomNameByAdmin: | (NSString *)roomName |
onSuccess: | (TUISuccessBlock)onSuccess |
onError: | (TUIErrorBlock)onError |
参数 | 描述 |
roomName | 房间名称。 |
- (void)updateRoomSeatModeByAdmin: | |
onSuccess: | (TUISuccessBlock)onSuccess |
onError: | (TUIErrorBlock)onError |
参数 | 描述 |
seatMode |
- (void)updateRoomPasswordByAdmin: | (NSString *)password |
onSuccess: | (TUISuccessBlock)onSuccess |
onError: | (TUIErrorBlock)onError |
- (void)getRoomMetadata: | (NSArray<NSString *> *)keys |
onSuccess: | (TUIRoomMetadataResponseBlock)onSuccess |
onError: | (TUIErrorBlock)onError |
- (void)setLocalVideoView: | (TUIVideoView *__nullable)view |
- (void)openLocalCamera: | (BOOL)isFront |
quality: | |
onSuccess: | (TUISuccessBlock)onSuccess |
onError: | (TUIErrorBlock)onError |
参数 | 描述 |
isFront | YES: 前置 NO: 后置。 |
onError | 失败回调。 |
onSuccess | 成功回调。 |
- (void)updateVideoQuality: |
- (void)updateVideoQualityEx: | |
params: |
参数 | 描述 |
params | |
streamType |
- (void)setVideoResolutionMode: | |
resolutionMode: |
参数 | 描述 |
resolutionMode | |
streamType |
- (void)enableGravitySensor: | (BOOL)enable |
参数 | 描述 |
enable | YES: 开启 NO: 关闭 |
- (void)startScreenCaptureByReplaykit: | (NSString *)appGroup |
- (void)startScreenCapture: | (TUIVideoView *)view |
onSuccess: | (TUISuccessBlock)onSuccess |
onError: | (TUIErrorBlock)onError |
参数 | 描述 |
onError | 错误回调。 |
onSuccess | 成功回调。 |
view | 渲染控件所在的父控件,可以设置为空值,表示不显示屏幕分享的预览效果。 |
- (void)selectScreenCaptureTarget: | (NSString *)targetId |
参数 | 描述 |
targetId | 指定分享源 |
- (void)openLocalMicrophone: | |
onSuccess: | (TUISuccessBlock)onSuccess |
onError: | (TUIErrorBlock)onError |
参数 | 描述 |
onError | 失败回调。 |
onSuccess | 成功回调。 |
quality | 音频质量。 |
- (void)updateAudioQuality: |
- (void)unmuteLocalAudio: | (TUISuccessBlock)onSuccess |
onError: | (TUIErrorBlock)onError |
参数 | 描述 |
onError | 失败回调。 |
onSuccess | 成功回调。 |
- (void)enableSystemAudioSharing: | (BOOL)enable |
- (void)setRemoteVideoView: | (NSString *)userId |
streamType: | |
view: | (TUIVideoView *__nullable)view |
参数 | 描述 |
streamType | |
userId | 远端用户ID。 |
view | 视频渲染视图。 |
- (void)startPlayRemoteVideo: | (NSString *)userId |
streamType: | |
onPlaying: | (TUIPlayOnPlayingBlock)onPlaying |
onLoading: | (TUIPlayOnLoadingBlock)onLoading |
onError: | (TUIPlayOnErrorBlock)onError |
参数 | 描述 |
onError | 错误回调。 |
onLoading | 加载回调。 |
onPlaying | 播放回调。 |
streamType | |
userId | 用户ID。 |
- (void)stopPlayRemoteVideo: | (NSString *)userId |
streamType: |
参数 | 描述 |
streamType | |
userId | 用户ID。 |
- (void)muteRemoteAudioStream: | (NSString *)userId |
isMute: | (BOOL)isMute |
- (void)getUserList: | (NSInteger)nextSequence |
onSuccess: | (TUIUserListResponseBlock)onSuccess |
onError: | (TUIErrorBlock)onError |
参数 | 描述 |
nextSequence | 分页拉取标志,第一次拉取填0,回调成功 如果callback返回的数据中 nextSequence 不为零,需要分页,传入再次拉取,直至为0。 |
onError | 错误回调。 |
onSuccess |
- (void)getUserInfo: | (NSString *)userId |
onSuccess: | (TUIUserInfoBlock)onSuccess |
onError: | (TUIErrorBlock)onError |
参数 | 描述 |
onError | 错误回调。 |
onSuccess | |
userId | 用户ID。 |
- (void)changeUserRole: | (NSString *)userId |
role: | |
onSuccess: | (TUISuccessBlock)onSuccess |
onError: | (TUIErrorBlock)onError |
参数 | 描述 |
role | |
userId | 用户ID。 |
- (void)changeUserNameCard: | (NSString *)userId |
nameCard: | (NSString *)nameCard |
onSuccess: | (TUISuccessBlock)onSuccess |
onError: | (TUIErrorBlock)onError |
参数 | 描述 |
nameCard | 房间内用户昵称,最大支持32个字节。。 |
userId | 要修改的用户ID。 |
- (void)kickRemoteUserOutOfRoom: | (NSString *)userId |
onSuccess: | (TUISuccessBlock)onSuccess |
onError: | (TUIErrorBlock)onError |
参数 | 描述 |
onError | 错误回调。 |
onSuccess | 成功回调。 |
userId | 用户ID。 |
- (void)addCategoryTagForUsers: | (NSInteger)tag |
userList: | (NSArray<NSString *> *)userList |
onSuccess: | (TUISuccessBlock)onSuccess |
onError: | (TUIErrorBlock)onError |
参数 | 描述 |
onError | 错误回调。 |
onSuccess | 成功回调。 |
tag | 标记类型。数字类型,大于等于 1000,您可以自定义。 |
userList | 用户列表。 |
- (void)removeCategoryTagForUsers: | (NSInteger)tag |
userList: | (NSArray<NSString *> *)userList |
onSuccess: | (TUISuccessBlock)onSuccess |
onError: | (TUIErrorBlock)onError |
参数 | 描述 |
onError | 错误回调。 |
onSuccess | 成功回调。 |
tag | 标记类型。数字类型,大于等于 1000,您可以自定义。 |
userList | 用户列表。 |
- (void)getUserListByTag: | (NSInteger)tag |
nextSequence: | (NSInteger)nextSequence |
onSuccess: | (TUIUserListResponseBlock)onSuccess |
onError: | (TUIErrorBlock)onError |
参数 | 描述 |
nextSequence | 分页拉取标志,第一次拉取填0,回调成功 如果callback返回的数据中 nextSequence 不为零,需要分页,传入再次拉取,直至为0。 |
onError | 错误回调。 |
onSuccess | 成功回调。 |
tag | 标记类型。数字类型,大于等于 1000,您可以自定义。 |
- (void)setCustomInfoForUser: | (NSString *)userId |
onSuccess: | (TUISuccessBlock)onSuccess |
onError: | (TUIErrorBlock)onError |
- (void)disableDeviceForAllUserByAdmin: | |
isDisable: | (BOOL)isDisable |
onSuccess: | (TUISuccessBlock)onSuccess |
onError: | (TUIErrorBlock)onError |
参数 | 描述 |
device | |
isDisable | 是否禁用 。 |
onError | 操作失败回调。 |
onSuccess | 操作成功回调。 |
- (TUIRequest *)openRemoteDeviceByAdmin: | (NSString *)userId |
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 | |
onAccepted | 邀请被接受的回调。 |
onCancelled | 邀请被取消的回调。 |
onError | 邀请发生错误的回调。 |
onRejected | 邀请被拒绝的回调。 |
onTimeout | 邀请超时未处理的回调。 |
timeout | 超时时间,单位秒,如果设置为 0,SDK 不会做超时检测,也不会触发超时回调。 |
userId | 用户ID。 |
- (void)closeRemoteDeviceByAdmin: | (NSString *)userId |
device: | |
onSuccess: | (TUISuccessBlock)onSuccess |
onError: | (TUIErrorBlock)onError |
参数 | 描述 |
device | |
onError | 调用失败回调。 |
onSuccess | 调用成功回调。 |
userId | 用户ID。 |
- (TUIRequest *)applyToAdminToOpenLocalDevice: | |
timeout: | (NSTimeInterval)timeout |
onAccepted: | (nullable TUIRequestAcceptedBlock)onAccepted |
onRejected: | (nullable TUIRequestRejectedBlock)onRejected |
onCancelled: | (nullable TUIRequestCancelledBlock)onCancelled |
onTimeout: | (nullable TUIRequestTimeoutBlock)onTimeout |
onError: | (nullable TUIRequestErrorBlock)onError |
参数 | 描述 |
device | |
onAccepted | 邀请被接受的回调。 |
onCancelled | 邀请被取消的回调。 |
onError | 邀请发生错误的回调。 |
onRejected | 邀请被拒绝的回调。 |
onTimeout | 邀请超时未处理的回调。 |
timeout | 超时时间,单位秒,如果设置为 0,SDK 不会做超时检测,也不会触发超时回调。 |
- (void)setMaxSeatCount: | (NSUInteger)maxSeatCount |
onSuccess: | (TUISuccessBlock)onSuccess |
onError: | (TUIErrorBlock)onError |
参数 | 描述 |
maxSeatCount | 最大麦位数。 |
onError | 错误回调。 |
onSuccess | 成功回调。 |
- (void)getSeatList: | (TUISeatListResponseBlock)onSuccess |
onError: | (TUIErrorBlock)onError |
参数 | 描述 |
onError | 错误回调。 |
onSuccess | 成功回调。 |
- (void)lockSeatByAdmin: | (NSInteger)seatIndex |
lockMode: | |
onSuccess: | (TUISuccessBlock)onSuccess |
onError: | (TUIErrorBlock)onError |
参数 | 描述 |
lockParams | 锁麦参数。详情参见:$TUISeatLockParam$。 |
onError | 错误回调。 |
onSuccess | 成功回调。 |
seatIndex | 麦位编号。 |
- (TUIRequest *)takeSeat: | (NSInteger)seatIndex |
timeout: | (NSTimeInterval)timeout |
onAccepted: | (TUIRequestAcceptedBlock)onAccepted |
onRejected: | (TUIRequestRejectedBlock)onRejected |
onCancelled: | (TUIRequestCancelledBlock)onCancelled |
onTimeout: | (TUIRequestTimeoutBlock)onTimeout |
onError: | (TUIRequestErrorBlock)onError |
参数 | 描述 |
onAccepted | 邀请被接受的回调。 |
onCancelled | 邀请被取消的回调。 |
onError | 邀请发生错误的回调。 |
onRejected | 邀请被拒绝的回调。 |
onTimeout | 邀请超时未处理的回调。 |
seatIndex | 麦位编号。未开启麦位,不关心麦位序列的情况下,填-1即可。 |
timeout | 超时时间,单位秒,如果设置为 0,SDK 不会做超时检测,也不会触发超时回调。 |
- (void)leaveSeat: | (TUISuccessBlock)onSuccess |
onError: | (TUIErrorBlock)onError |
参数 | 描述 |
onError | 错误回调。 |
onSuccess | 成功回调。 |
- (void)moveToSeat: | (NSInteger)targetSeatIndex |
onSuccess: | (TUISuccessBlock)onSuccess |
onError: | (TUIErrorBlock)onError |
- (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 |
参数 | 描述 |
onAccepted | 邀请被接受的回调。 |
onCancelled | 邀请被取消的回调。 |
onError | 邀请发生错误的回调。 |
onRejected | 邀请被拒绝的回调。 |
onTimeout | 邀请超时未处理的回调。 |
seatIndex | 麦位编号。未开启麦位、无需麦位场景下无需关心,填-1即可。 |
timeout | 超时时间,单位秒,如果设置为 0,SDK 不会做超时检测,也不会触发超时回调。 |
userId | 用户ID。 |
- (void)kickUserOffSeatByAdmin: | (NSInteger)seatIndex |
userId: | (NSString *)userId |
onSuccess: | (TUISuccessBlock)onSuccess |
onError: | (TUIErrorBlock)onError |
参数 | 描述 |
onError | 失败回调。 |
onSuccess | 成功回调。 |
seatIndex | 麦位编号。未开启麦位,不关心麦位序列的情况下,填-1即可。 |
userId | 用户ID。 |
- (void)getSeatApplicationList: | (TUIRequestListResponseBlock)onSuccess |
onError: | (TUIErrorBlock)onError |
- (void)disableSendingMessageByAdmin: | (NSString *)userId |
isDisable: | (BOOL)isDisable |
onSuccess: | (TUISuccessBlock)onSuccess |
onError: | (TUIErrorBlock)onError |
参数 | 描述 |
isDisable | 是否禁用。 |
onError | 错误回调。 |
onSuccess | 成功回调。 |
userId | 用户ID。 |
- (void)disableSendingMessageForAllUser: | (BOOL)isDisable |
onSuccess: | (TUISuccessBlock)onSuccess |
onError: | (TUIErrorBlock)onError |
参数 | 描述 |
isDisable | 是否禁用。 |
onError | 错误回调。 |
onSuccess | 成功回调。 |
- (void)cancelRequest: | (NSString *)requestId |
onSuccess: | (TUISuccessBlock)onSuccess |
onError: | (TUIErrorBlock)onError |
参数 | 描述 |
onError | 失败回调。 |
onSuccess | 成功回调。 |
requestId | 请求ID(发送请求的接口返回或者OnRequestReceived事件通知)。 |
- (void)responseRemoteRequest: | (NSString *)requestId |
agree: | (BOOL)agree |
onSuccess: | (TUISuccessBlock)onSuccess |
onError: | (TUIErrorBlock)onError |
参数 | 描述 |
agree | 是否同意 YES: 同意请求, NO: 拒绝请求。 |
onError | 失败回调。 |
onSuccess | 成功回调。 |
requestId | 请求ID(发送请求的接口返回或者OnRequestReceived事件通知)。 |
- (void)setBeautyLevel: | (NSInteger)beautyStyle |
beautyLevel: | (float)beautyLevel |
参数 | 描述 |
beautyLevel | 美颜级别,取值范围 0 - 9; 0 表示关闭,9 表示效果最明显。 |
beautyStyle | 美颜风格,TXBeautyStyleSmooth:光滑;TXBeautyStyleNature:自然;TXBeautyStylePitu:优图。 |
- (void)setWhitenessLevel: | (float)whitenessLevel |
参数 | 描述 |
whitenessLevel | 美白级别,取值范围 0 - 9;0 表示关闭,9 表示效果最明显。 |
- (id) getExtension: |
+ (id)callExperimentalAPI: | (NSString *)jsonStr |
本页内容是否解决了您的问题?