多人音视频房间 SDK
有奖捉虫：办公协同&微信生态&物联网文档专题 HOT
文档中心 > 多人音视频房间 SDK > 客户端 API > iOS&Mac > TUIRoomObserver

TUIRoomObserver

最近更新时间：2024-03-26 16:30:41

我的收藏

本页目录：

Copyright (c) 2024 Tencent. All rights reserved.
Module: TUIRoomObserver @ TUIKitEngine
Function: TUIRoomEngine的事件回调接口

TUIRoomObserver

TUIRoomObserver

函数列表
描述
错误事件回调
用户被踢下线
用户凭证超时事件
房间名称更改事件
房间内所有用户麦克风被禁用事件
房间内所有用户摄像头被禁用事件
房间内所有用户屏幕分享被禁用事件
房间内用户发送文本消息被禁用事件
房间被解散事件
被踢出房间事件
房间麦控模式发生变化
房间上麦模式发生变化
远端用户进房事件
远端用户离开房间事件
用户角色发生变化事件
用户视频状态发生变化事件
用户音频状态发生变化事件
用户音量变化事件
用户文本消息发送能力发生变化事件
用户网络状态变化事件
屏幕分享结束
房间内最大麦位数发生变化事件（仅在会议类型房间生效）
麦位列表发生变化事件
收到用户被踢下麦事件
收到请求消息事件
收到请求被取消的事件
收到请求被其他 管理员/房主 处理事件
收到普通文本消息事件
收到自定义消息事件
本地设备添加事件

onError:message:

onError:message:
- (void)onError:
(TUIError)errorCode
message:
(NSString *)message

错误事件回调

错误事件，表示 SDK 抛出的不可恢复的错误，例如进入房间失败或设备开启失败等。
参数
描述
errorCode
错误码，请参考：TUIError
message
错误信息

onKickedOffLine:

onKickedOffLine:
- (void)onKickedOffLine:
(NSString *)message

用户被踢下线

参数
描述
message
被踢下线的描述

onUserSigExpired

onUserSigExpired

用户凭证超时事件

onRoomNameChanged:roomName:

onRoomNameChanged:roomName:
- (void)onRoomNameChanged:
(NSString *)roomId
roomName:
(NSString *)roomName

房间名称更改事件

参数
描述
roomId
房间ID
roomName
房间名称

onAllUserMicrophoneDisableChanged:isDisable:

onAllUserMicrophoneDisableChanged:isDisable:
- (void)onAllUserMicrophoneDisableChanged:
(NSString *)roomId
isDisable:
(BOOL)isDisable

房间内所有用户麦克风被禁用事件

参数
描述
isDisable
是否被禁用
roomId
房间ID

onAllUserCameraDisableChanged:isDisable:

onAllUserCameraDisableChanged:isDisable:
- (void)onAllUserCameraDisableChanged:
(NSString *)roomId
isDisable:
(BOOL)isDisable

房间内所有用户摄像头被禁用事件

参数
描述
isDisable
是否被禁用
roomId
房间ID

onScreenShareForAllUserDisableChanged:isDisable:

onScreenShareForAllUserDisableChanged:isDisable:
- (void)onScreenShareForAllUserDisableChanged:
(NSString *)roomId
isDisable:
(BOOL)isDisable

房间内所有用户屏幕分享被禁用事件

参数
描述
isDisable
是否被禁用
roomId
房间ID

onSendMessageForAllUserDisableChanged:isDisable:

onSendMessageForAllUserDisableChanged:isDisable:
- (void)onSendMessageForAllUserDisableChanged:
(NSString *)roomId
isDisable:
(BOOL)isDisable

房间内用户发送文本消息被禁用事件

参数
描述
isDisable
是否被禁用
roomId
房间ID

onRoomDismissed:

onRoomDismissed:
- (void)onRoomDismissed:
(NSString *)roomId

房间被解散事件

参数
描述
roomId
房间ID

onKickedOutOfRoom:reason:message:

onKickedOutOfRoom:reason:message:
- (void)onKickedOutOfRoom:
(NSString *)roomId
reason:
message:
(NSString *)message

被踢出房间事件

参数
描述
message
被踢出的描述
reason
被踢出原因
roomId
房间ID

onRoomSpeechModeChanged:speechMode:

onRoomSpeechModeChanged:speechMode:
- (void)onRoomSpeechModeChanged:
(NSString *)roomId
speechMode:
(TUISpeechMode)mode

房间麦控模式发生变化

@deprecated v2.0 版本开始，该功能已废弃，建议使用isSeatEnabled代替
参数
描述
mode
房间模式
roomId
房间ID

onRoomSeatModeChanged:seatMode:

onRoomSeatModeChanged:seatMode:
- (void)onRoomSeatModeChanged:
(NSString *)roomId
seatMode:
(TUISeatMode)seatMode

房间上麦模式发生变化

参数
描述
roomId
房间ID
seatMode
上麦模式

onRemoteUserEnterRoom:userInfo:

onRemoteUserEnterRoom:userInfo:
- (void)onRemoteUserEnterRoom:
(NSString *)roomId
userInfo:
(TUIUserInfo *)userInfo

远端用户进房事件

参数
描述
roomId
房间ID
userInfo
用户信息

onRemoteUserLeaveRoom:userInfo:

onRemoteUserLeaveRoom:userInfo:
- (void)onRemoteUserLeaveRoom:
(NSString *)roomId
userInfo:
(TUIUserInfo *)userInfo

远端用户离开房间事件

参数
描述
roomId
房间ID
userInfo
用户信息

onUserRoleChanged:userRole:

onUserRoleChanged:userRole:
- (void)onUserRoleChanged:
(NSString *)userId
userRole:
(TUIRole)userRole

用户角色发生变化事件

参数
描述
userId
用户ID
userRole
用户角色 可参考 TUIRole 枚举定义

onUserVideoStateChanged:streamType:hasVideo:reason:

onUserVideoStateChanged:streamType:hasVideo:reason:
- (void)onUserVideoStateChanged:
(NSString *)userId
streamType:
(TUIVideoStreamType)streamType
hasVideo:
(BOOL)hasVideo
reason:
(TUIChangeReason)reason

用户视频状态发生变化事件

参数
描述
hasVideo
是否有视频流
reason
视频流发生变化原因 TUIChangeReasonBySelf: 自己切换 TUIChangeReasonByAdmin: 被管理员切换
streamType
视频流类型
userId
用户ID

onUserAudioStateChanged:hasAudio:reason:

onUserAudioStateChanged:hasAudio:reason:
- (void)onUserAudioStateChanged:
(NSString *)userId
hasAudio:
(BOOL)hasAudio
reason:
(TUIChangeReason)reason

用户音频状态发生变化事件

参数
描述
hasAudio
是否有音频流
reason
视频流发生变化原因 TUIChangeReasonBySelf: 自己切换 TUIChangeReasonByAdmin: 被管理员切换
userId
用户ID

onUserVoiceVolumeChanged

onUserVoiceVolumeChanged

用户音量变化事件

参数
描述
volumeMap
用户音量字典 key: userId, value: 用于承载所有正在说话的用户的音量大小，取值范围 0 - 100。

onSendMessageForUserDisableChanged:userId:isDisable:

onSendMessageForUserDisableChanged:userId:isDisable:
- (void)onSendMessageForUserDisableChanged:
(NSString *)roomId
userId:
(NSString *)userId
isDisable:
(BOOL)muted

用户文本消息发送能力发生变化事件

参数
描述
isDisable
是否被禁止发送文本消息 YES: 用户被禁止发送消息 NO: 用户被解除禁止，可以发送消息
userId
用户ID

onUserNetworkQualityChanged:

onUserNetworkQualityChanged:
- (void)onUserNetworkQualityChanged:
(NSArray<TUINetworkInfo *> *)networkList

用户网络状态变化事件

参数
描述
networkList
用户网络状态数组，可参考 TUINetworkInfo 对象

onUserScreenCaptureStopped:

onUserScreenCaptureStopped:
- (void)onUserScreenCaptureStopped:
(NSInteger)reason

屏幕分享结束

参数
描述
reason
停止原因，0：用户主动停止；1：屏幕窗口关闭导致停止；2：表示屏幕分享的显示屏状态变更（如接口被拔出、投影模式变更等）

onRoomMaxSeatCountChanged:maxSeatNumber:

onRoomMaxSeatCountChanged:maxSeatNumber:
- (void)onRoomMaxSeatCountChanged:
(NSString *)roomId
maxSeatNumber:
(NSInteger)maxSeatNumber

房间内最大麦位数发生变化事件（仅在会议类型房间生效）

参数
描述
maxSeatCount
房间内最大麦位数量
roomId
房间ID

onSeatListChanged:seated:left:

onSeatListChanged:seated:left:
- (void)onSeatListChanged:
(NSArray<TUISeatInfo *> *)seatList
seated:
(NSArray<TUISeatInfo *> *)seatedList
left:
(NSArray<TUISeatInfo *> *)leftList

麦位列表发生变化事件

参数
描述
leftList
新下麦的用户列表
seatList
目前麦上最新的用户列表，包含新上麦的用户
seatedList
新上麦的用户列表

onKickedOffSeat:

onKickedOffSeat:
- (void)onKickedOffSeat:
(NSString *)userId

收到用户被踢下麦事件

参数
描述
userId
操作踢人的（主持人/管理员）用户id

onRequestReceived:

onRequestReceived:
- (void)onRequestReceived:
(TUIRequest *)request

收到请求消息事件

参数
描述
request
请求内容，可参考 TUIRequest 对象

onRequestCancelled:userId:

onRequestCancelled:userId:
- (void)onRequestCancelled:
(NSString *)requestId
userId:
(NSString *)userId

收到请求被取消的事件

参数
描述
requestId
请求ID
userId
取消信令的用户ID

onRequestProcessed:userId:

onRequestProcessed:userId:
- (void)onRequestProcessed:
(NSString *)requestId
userId:
(NSString *)userId

收到请求被其他 管理员/房主 处理事件

参数
描述
requestId
请求ID
userId
管理员/房主 的用户ID

onReceiveTextMessage:message:

onReceiveTextMessage:message:
- (void)onReceiveTextMessage:
(NSString *)roomId
message:
(TUIMessage *)message

收到普通文本消息事件

参数
描述
message
消息内容, 请参考: TUIMessage 定义
roomId
房间ID

onReceiveCustomMessage:message:

onReceiveCustomMessage:message:
- (void)onReceiveCustomMessage:
(NSString *)roomId
message:
(TUIMessage *)message

收到自定义消息事件

参数
描述
message
消息内容, 请参考: TUIMessage 定义
roomId
房间ID

onDeviceChanged:type:state:

onDeviceChanged:type:state:
- (void)onDeviceChanged:
(NSString *)deviceId
type:
(TUIMediaDeviceType)type
state:
(TUIMediaDeviceState)state

本地设备添加事件

@deprecated v2.0 版本开始不推荐使用,建议使用{$TUIRoomDeviceManager$}中的onDeviceChanged代替。
参数
描述
deviceId
设备 ID。
state
通断状态，0：设备已添加；1：设备已被移除；2：设备已启用
type
设备类型。
注意
当本地设备（包括摄像头、麦克风以及扬声器）添加时，SDK 便会抛出此事件回调
中国站