tencent cloud

PrevNext

文档反馈

请输入关键字

Recent Pages

文档
实时音视频
    文档
    Download PDF

    TUIRoomObserver

    最后更新时间：2023-10-19 17:35:51
    下载PDF
      TUIRoomObserver 类是 TUIRoomEngine 对应的回调事件类，您可以通过此回调接口，监听自己感兴趣的回调事件。

      onError

      错误事件回调。
      - (void)onError:(TUIError)error message:(NSString *)message;
      参数如下表所示：
      参数
      类型
      含义
      error
      TUIError
      错误码
      message
      NSString *
      错误信息

      onKickedOffLine

      其他终端登录被踢下线事件。
      - (void)onKickedOffLine:(NSString *)message;
      参数如下表所示：
      参数
      类型
      含义
      message
      NSString *
      被踢出的描述

      onUserSigExpired

      用户凭证超时事件。
      - (void)onUserSigExpired;

      onRoomNameChanged

      房间名称更改事件。
      - (void)onRoomNameChanged:(NSString *)roomId roomName:(NSString *)roomName;
      参数
      类型
      含义
      roomId
      NSString *
      房间 ID
      roomName
      NSString *
      房间名称

      onAllUserMicrophoneDisableChanged

      房间内所有用户麦克风被禁用事件。
      - (void)onAllUserMicrophoneDisableChanged:(NSString *)roomId isDisable:(BOOL)isDisable;
      参数
      类型
      含义
      roomId
      NSString *
      房间 ID
      isDisable
      BOOL
      是否被禁用

      onAllUserCameraDisableChanged

      房间内所有用户摄像头被禁用事件。
      - (void)onAllUserCameraDisableChanged:(NSString *)roomId isDisable:(BOOL)isDisable;
      参数
      类型
      含义
      roomId
      NSString *
      房间 ID
      isDisable
      BOOL
      是否被禁用

      onSendMessageForAllUserDisableChanged

      房间内所有用户发送文本消息被禁用事件。
      - (void)onSendMessageForAllUserDisableChanged:(NSString *)roomId isDisable:(BOOL)isDisable;
      

      onKickedOutOfRoom

      被踢出房间事件。
      - (void)onKickedOutOfRoom:(NSString *)roomId message:(NSString *)message;
      参数如下表所示：
      参数
      类型
      含义
      roomId
      NSString *
      房间 ID
      message
      NSString *
      被踢出的描述

      onRoomDismissed

      房间被解散事件。
      - (void)onRoomDismissed:(NSString *)roomId;
      参数如下表所示：
      参数
      类型
      含义
      roomId
      NSString *
      房间 ID

      onRoomSpeechModeChanged

      房间麦控模式发生变化。
      - (void)onRoomSpeechModeChanged:(NSString *)roomId speechMode:(TUISpeechMode)mode;
      参数
      类型
      含义
      roomId
      NSString *
      房间 ID
      mode
      麦控模式

      onRemoteUserEnterRoom

      远端用户进房事件。
      - (void)onRemoteUserEnterRoom:(NSString *)roomId userInfo:(TUIUserInfo *)userInfo;
      参数如下表所示：
      参数
      类型
      含义
      roomId
      NSString *
      房间 ID
      userInfo
      用户信息

      onRemoteUserLeaveRoom

      远端用户离开房间事件。
      - (void)onRemoteUserLeaveRoom:(NSString *)roomId userInfo:(TUIUserInfo *)userInfo;
      参数如下表所示：
      参数
      类型
      含义
      roomId
      NSString *
      房间 ID
      userInfo
      用户信息

      onUserRoleChanged

      用户角色发生变化事件。
      - (void)onUserRoleChanged:(NSString *)userId userRole:(TUIRole)userRole;
      参数如下表所示：
      参数
      类型
      含义
      userId
      NSString *
      用户 ID
      userRole
      TUIRole
      用户角色

      onUserVideoStateChanged

      用户视频状态发生变化事件。
      - (void)onUserVideoStateChanged:(NSString *)userId
                           streamType:(TUIVideoStreamType)streamType
                             hasVideo:(BOOL)hasVideo
                               reason:(TUIChangeReason)reason;
      参数如下表所示：
      参数
      类型
      含义
      userId
      NSString *
      用户 ID
      streamType
      视频流类型
      hasVideo
      BOOL
      是否有视频流
      reason
      视频流发生变化原因

      onUserAudioStateChanged

      用户音频状态发生变化事件。
      - (void)onUserAudioStateChanged:(NSString *)userId
                             hasAudio:(BOOL)hasAudio
                               reason:(TUIChangeReason)reason;
      参数如下表所示：
      参数
      类型
      含义
      userId
      NSString *
      用户 ID
      hasAudio
      BOOL
      是否有音频流
      reason
      音频流发生变化原因

      onUserScreenCaptureStopped

      屏幕分享停止的事件回调。
      - (void)onUserScreenCaptureStopped:(NSInteger)reason;
      参数如下表所示：
      参数
      类型
      含义
      reason
      NSInteger
      停止原因：
      0：用户主动停止
      1：屏幕窗口关闭导致停止
      2：表示屏幕分享的显示屏状态变更（如接口被拔出、投影模式变更等）

      onRoomMaxSeatCountChanged

      房间内最大麦位数发生变化事件（仅在会议类型房间生效）。
      - (void)onRoomMaxSeatCountChanged:(NSString *)roomId maxSeatNumber:(NSInteger)maxSeatNumber;
      参数
      类型
      含义
      roomId
      NSString *
      房间 ID
      maxSeatNumber
      NSInteger
      房间内最大麦位数量

      onUserVoiceVolumeChanged

      用户音量变化事件。
      - (void)onUserVoiceVolumeChanged:(NSDictionary<NSString *, NSNumber *> *)volumeMap;
      参数如下表所示：
      参数
      类型
      含义
      volumeMap
      NSDictionary<NSString *, NSNumber *> *
      用户音量 map

      onSendMessageForUserDisableChanged

      用户文本消息发送能力发生变化事件。
      - (void)onSendMessageForUserDisableChanged:(NSString *)roomId 
                                          userId:(NSString *)userId 
                                       isDisable:(BOOL)muted;
      参数
      类型
      含义
      roomId
      NSString *
      房间 ID
      userId
      NSString *
      用户 ID
      muted
      BOOL
      是否被禁止发送文本消息

      onUserNetworkQualityChanged

      用户网络状态变化事件。
      - (void)onUserNetworkQualityChanged:(NSArray<TUINetworkInfo *> *)networkList;
      参数如下表所示：
      参数
      类型
      含义
      networkList
      NSArray<TUINetworkInfo>*
      用户网络状态数组，可以参考TUINetworkInfo对象

      onSeatListChanged

      麦位列表发生变化事件。
      - (void)onSeatListChanged:(NSArray<TUISeatInfo *> *)seatList
                         seated:(NSArray<TUISeatInfo *> *)seatedList
                           left:(NSArray<TUISeatInfo *> *)leftList;
      参数如下表所示：
      参数
      类型
      含义
      seatList
      NSArray<TUISeatInfo *> *
      目前麦上最新的用户列表，包含新上麦的用户
      seatedList
      NSArray<TUISeatInfo *> *
      新上麦的用户列表
      leftList
      NSArray<TUISeatInfo *> *
      新下麦的用户列表

      onKickedOffSeat

      收到用户被踢下麦事件。
      - (void)onKickedOffSeat:(NSString *)userId;
      参数
      类型
      含义
      userId
      NSString *
      用户 ID

      onRequestReceived

      收到请求消息事件。
      - (void)onRequestReceived:(TUIRequest *)request;
      参数如下表所示：
      参数
      类型
      含义
      request
      请求内容

      onRequestCancelled

      收到请求被取消的事件。
      - (void)onRequestCancelled:(NSString *)requestId;
      参数如下表所示：
      参数
      类型
      含义
      requestId
      NSString *
      请求 ID

      onReceiveTextMessage

      收到普通文本消息事件。
      - (void)onReceiveTextMessage:(NSString *)roomId
                           message:(TUIMessage *)message;
      参数如下表所示：
      参数
      类型
      含义
      roomId
      NSString *
      房间 ID
      message
      消息内容，详细定义可以参考TUIRoomDefine.h文件中TUIMessage的定义

      onReceiveCustomMessage

      收到自定义消息事件。
      - (void)onReceiveCustomMessage:(NSString *)roomId
                             message:(TUIMessage *)message;
      参数如下表所示：
      参数
      类型
      含义
      roomId
      NSString *
      房间 ID
      message
      消息内容
      
      联系我们

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

      联系我们
      技术支持

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

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