tencent cloud

PrevNext

文档反馈

请输入关键字

Recent Pages

文档
实时音视频
    文档
    Download PDF

    TUIRoomObserver

    最后更新时间：2023-10-30 10:55:55
    下载PDF

      TUIRoomObserver 回调事件详情

      TUIRoomObserver 类是 TUIRoomEngine 对应的回调事件类，您可以通过此回调接口，监听自己感兴趣的回调事件。

      onError

      错误信息事件。
      virtual void onError(TUIError errorCode, const char* message) = 0;
      参数如下表所示：
      参数
      类型
      含义
      errorCode
      TUIError
      错误码
      message
      const char*
      错误信息

      onKickedOffLine

      用户被踢下线事件。
      virtual void onKickedOffLine(const char* message) = 0;
      参数如下表所示：
      参数
      类型
      含义
      message
      const char*
      被踢下线的描述

      onUserSigExpired

      用户凭证超时事件。
      virtual void onUserSigExpired() = 0;

      onRoomNameChanged

      房间名称更改事件。
      virtual void onRoomNameChanged(const char* roomId, const char* roomName) = 0;
      参数如下表所示：
      参数
      类型
      含义
      roomId
      const char*
      房间 ID
      roomName
      const char*
      房间名称

      onAllUserMicrophoneDisableChanged

      房间内所有用户麦克风被禁用事件。
      virtual void onAllUserMicrophoneDisableChanged(const char* roomId, bool isDisable) = 0;
      参数如下表所示：
      参数
      类型
      含义
      roomId
      const char*
      房间 ID
      isDisable
      bool
      是否被禁用

      onAllUserCameraDisableChanged

      房间内所有用户摄像头被禁用事件。
      virtual void onAllUserCameraDisableChanged(const char* roomId, bool isDisable) = 0;
      参数如下表所示：
      参数
      类型
      含义
      roomId
      const char*
      房间 ID
      isDisable
      bool
      是否被禁用

      onSendMessageForAllUserDisableChanged

      房间内用户发送文本消息被禁用事件。
      virtual void onSendMessageForAllUserDisableChanged(const char* roomId, bool isDisable) = 0;
      参数如下表所示：
      参数
      类型
      含义
      roomId
      const char*
      房间 ID
      isDisable
      bool
      是否被禁用

      onRoomDismissed

      房间被解散事件。
      virtual void onRoomDismissed(const char* roomId) = 0;
      参数如下表所示：
      参数
      类型
      含义
      roomId
      const char*
      房间 ID

      onKickedOutOfRoom

      被踢出房间事件。
      virtual void onKickedOutOfRoom(const char* roomId, const char* message) = 0;
      参数如下表所示：
      参数
      类型
      含义
      roomId
      const char*
      房间 ID
      message
      const char*
      被踢出的描述

      onRoomSpeechModeChanged

      房间发言模式更改事件。
      virtual void onRoomSpeechModeChanged(const char* roomId, TUISpeechMode speechMode) = 0;
      参数如下表所示：
      参数
      类型
      含义
      roomId
      const char*
      房间 ID
      speechMode
      TUISpeechMode
      发言模式

      onRemoteUserEnterRoom

      远端用户进房事件。
      virtual void onRemoteUserEnterRoom(const char* roomId, const TUIUserInfo& userInfo) = 0;
      参数如下表所示：
      参数
      类型
      含义
      roomId
      const char*
      房间 ID
      userInfo
      const TUIUserInfo&
      用户信息

      onRemoteUserLeaveRoom

      远端用户离开房间事件。
      virtual void OnRemoteUserLeaveRoom(const char* roomId, const TUIUserInfo& userInfo) = 0;
      参数如下表所示：
      参数
      类型
      含义
      roomId
      const char*
      房间 ID
      userInfo
      const TUIUserInfo&
      用户信息

      onUserRoleChanged

      用户角色发生变化事件。
      virtual void onUserRoleChanged(const char* userId, const TUIRole& userRole) = 0;
      参数如下表所示：
      参数
      类型
      含义
      userId
      const char*
      用户 ID
      userRole
      const TUIRole&
      用户角色

      onUserVideoStateChanged

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

      onUserAudioStateChanged

      用户音频状态发生变化事件。
      virtual void onUserAudioStateChanged(const char* userId, bool hasAudio, TUIChangeReason reason) = 0;
      参数如下表所示：
      参数
      类型
      含义
      userId
      const char*
      用户 ID
      hasAudio
      bool
      是否有音频流
      reason
      TUIChangeReason
      音频流发生变化原因

      onUserVoiceVolumeChanged

      用户音量变化事件。
      virtual void onUserVoiceVolumeChanged(TUIMap<const char*, int>* volumeMap) = 0;
      参数如下表所示：
      参数
      类型
      含义
      volumeMap
      TUIMap<const char*, int>*
      用户音量 map

      onSendMessageForUserDisableChanged

      用户文本消息发送能力发生变化事件。
      virtual void onSendMessageForUserDisableChanged(const char* roomId, const char* userId, bool isDisable) = 0;
      参数如下表所示：
      参数
      类型
      含义
      roomId
      const char*
      房间 ID
      userId
      const char*
      用户 ID
      isDisable
      bool
      是否被禁止发送消息，true : 用户被禁止发送文本和自定义消息；false : 用户被解除禁止，可以发送文本和自定义消息

      onUserNetworkQualityChanged

      用户网络状态变化事件。
      virtual void onUserNetworkQualityChanged(TUIList<TUINetwork>* networkList) = 0;
      参数如下表所示：
      参数
      类型
      含义
      networkList
      TUIList<TUINetwork>*
      用户网络状态 list

      onUserScreenCaptureStopped

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

      onRoomMaxSeatCountChanged

      上麦控制发生变化事件。
      virtual void onRoomMaxSeatCountChanged(const char* roomId, int maxSeatCount) = 0;
      参数如下表所示：
      参数
      类型
      含义
      roomId
      const char*
      房间 ID
      maxSeatCount
      int
      最大麦上用户数量

      onSeatListChanged

      麦位列表发生变化事件。
      virtual void onSeatListChanged(TUIList<TUISeatInfo>* seatList, TUIList<TUISeatInfo>* usersSeated, TUIList<TUISeatInfo>* usersLeft) = 0;
      参数如下表所示：
      参数
      类型
      含义
      seatList
      TUIList<TUISeatInfo>*
      目前麦上最新的用户列表，包含新上麦的用户
      usersSeated
      TUIList<TUISeatInfo>*
      新上麦的用户列表
      usersLeft
      TUIList<TUISeatInfo>*
      新下麦的用户列表

      onKickedOffSeat

      被踢下麦位事件。
      virtual void onKickedOffSeat(const char* userId) = 0;
      参数如下表所示：
      参数
      类型
      含义
      userId
      const char*
      用户 ID

      onRequestReceived

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

      onRequestCancelled

      收到请求被取消的事件。
      virtual void OnRequestCancelled(const char* requestId, const char* userId) = 0;
      参数如下表所示：
      参数
      类型
      含义
      requestId
      const char*
      请求 ID
      userId
      const char*
      用户 ID

      onReceiveTextMessage

      收到文本消息事件。
      virtual void onReceiveTextMessage(const char* roomId, const TUIMessage& message) = 0;
      参数如下表所示：
      参数
      类型
      含义
      roomId
      const char*
      房间 ID
      message
      const TUIMessage&
      消息内容

      onReceiveCustomMessage

      收到自定义消息事件。
      virtual void onReceiveCustomMessage(const char* roomId, const TUIMessage& message) = 0;
      参数如下表所示：
      参数
      类型
      含义
      roomId
      const char*
      房间 ID
      message
      const TUIMessage&
      消息内容
      
      联系我们

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

      联系我们
      技术支持

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

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