tencent cloud

文档反馈

TUIRoomObserver

最后更新时间:2024-08-30 16:43:19
    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
    房间名称。

    onRoomDismissed:reason:

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

    房间被解散事件

    参数
    描述
    reason
    房间解散原因,请参见:TUIRoomDismissedReason
    roomId
    房间ID。

    onKickedOutOfRoom:reason:message:

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

    被踢出房间事件

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

    onRoomSeatModeChanged:seatMode:

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

    房间上麦模式发生变化

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

    onRoomUserCountChanged:userCount:

    onRoomUserCountChanged:userCount:
    - (void)onRoomUserCountChanged:
    (NSString *)roomId
    userCount:
    (NSInteger)userCount

    房间内人员数量发生变化

    参数
    描述
    roomId
    房间ID。
    userCount
    人员数量。

    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
    用户信息。

    onUserInfoChanged:modifyFlag:

    onUserInfoChanged:modifyFlag:
    - (void)onUserInfoChanged:
    (TUIUserInfo *)userInfo
    modifyFlag:
    (TUIUserInfoModifyFlag)modifyFlag

    房间内用户信息发生变化事件。

    参数
    描述
    modifyFlag
    用户信息参数变更Key, 可参考TUIUserInfoModifyFlag
    userInfo
    用户信息。

    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:operateUser:

    onKickedOffSeat:operateUser:
    - (void)onKickedOffSeat:
    (NSInteger)seatIndex
    operateUser:
    (TUIUserInfo *)operateUser

    收到用户被踢下麦事件

    参数
    描述
    operateUser
    操作踢人的(主持人/管理员)用户信息。
    seatIndex
    麦位编号。

    onRequestReceived:

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

    收到请求消息事件

    参数
    描述
    request
    请求内容,可参见 TUIRequest 对象。

    onRequestCancelled:operateUser:

    onRequestCancelled:operateUser:
    - (void)onRequestCancelled:
    (TUIRequest *)request
    operateUser:
    (TUIUserInfo *)operateUser

    收到请求被取消的事件

    参数
    描述
    operateUser
    取消信令的用户信息。
    request
    请求内容,可参见 TUIRequest 对象。

    onRequestProcessed:operateUser:

    onRequestProcessed:operateUser:
    - (void)onRequestProcessed:
    (TUIRequest *)request
    operateUser:
    (TUIUserInfo *)operateUser

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

    参数
    描述
    operateUser
    取消信令的用户信息。
    request
    请求内容,可参见 TUIRequest 对象。
    联系我们

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

    技术支持

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

    7x24 电话支持