tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Tencent Real-Time Communication
    Documentation
    Download PDF

    TUIRoomObserver

    Last updated: 2024-12-20 16:11:45
    Download PDF
      Copyright (c) 2024 Tencent. All rights reserved.
      Module: TUIRoomObserver @ TUIKitEngine.
      Function: TUIRoomEngine event callback APIs.
      
      TUIRoomObserver

      TUIRoomObserver

      FuncList
      DESC
      Error event callback.
      The current user was kicked offline.
      The current user signature is expired.
      The name of the room has changed.
      The status of disabling to open microphone has changed for all users.
      The status of disabling to open camera has changed for all users.
      The status of disabling to open screen sharing has changed for all users.
      The status of disabling to send message has changed for all users.
      Room was dismissed.
      The current user has been kicked off from the room.
      The room seat mode has changed.
      The count of user in the room has changed.
      The key-value of room metadata has changed.
      Remote user entered room.
      Remote user left room.
      User information has changed in the room.
      The status of the user has video stream changed.
      The status of the user has audio stream changed.
      User volume changed.
      The status of disabling to send message has changed for user.
      The User network status changed.
      Screen sharing stopped.
      The maximum count of seats in the room changed (only available in conference rooms)
      Seat list changed.
      The user was kicked off the seat.
      Receive a request message.
      Received a cancelled request.
      Receive a request to be processed by other administrator/owner.
      Room was dismissed.
      User role changed.
      User role changed.
      Recevied user was kicked off the seat.
      Received a cancelled request.
      Receive a request to be processed by other administrator/owner.

      onError

      onError
      void onError
      (TUICommonDefine.Error errorCode
      
      String message)

      Error event callback.

      The function supports the CONFERENCE and LIVE room types.
      Callback error events when entering a room or opening a device.
      Param
      DESC
      errorCode
      Error code. More details, see: Error.
      message
      Error message.

      onKickedOffLine

      onKickedOffLine
      void onKickedOffLine
      (String message)

      The current user was kicked offline.

      The function supports the CONFERENCE and LIVE room types.
      Called when a user is kicked offline.
      Param
      DESC
      message
      Description of being kicked off.

      onUserSigExpired

      onUserSigExpired

      The current user signature is expired.

      The function supports the CONFERENCE and LIVE room types.
      Called when a user's signature expires.

      onRoomNameChanged

      onRoomNameChanged
      void onRoomNameChanged
      (String roomId
      
      String roomName)

      The name of the room has changed.

      The function supports the CONFERENCE and LIVE room types.
      Called when the room name changes.
      Param
      DESC
      roomId
      Room ID.
      roomName
      Room name.

      onAllUserMicrophoneDisableChanged

      onAllUserMicrophoneDisableChanged
      void onAllUserMicrophoneDisableChanged
      (String roomId
      
      boolean isDisable)

      The status of disabling to open microphone has changed for all users.

      Param
      DESC
      isDisable
      true: disable user to open microphone false: enable user to open microphone.
      roomId
      Room ID.
      Note
      The function only supports the CONFERENCE room type..
      Called when the microphone disable status changes for all users.

      onAllUserCameraDisableChanged

      onAllUserCameraDisableChanged
      void onAllUserCameraDisableChanged
      (String roomId
      
      boolean isDisable)

      The status of disabling to open camera has changed for all users.

      Param
      DESC
      isDisable
      true: disable user to open camera false: enable user to open camera.
      roomId
      Room ID.
      Note
      The function only supports the CONFERENCE room type..
      Called when the camera disable status changes for all users.

      onScreenShareForAllUserDisableChanged

      onScreenShareForAllUserDisableChanged
      void onScreenShareForAllUserDisableChanged
      (String roomId
      
      boolean isDisable)

      The status of disabling to open screen sharing has changed for all users.

      Param
      DESC
      isDisable
      true: disable user to open screen sharing false: enable user to open screen sharing.
      roomId
      Room ID.
      Note
      The function only supports the CONFERENCE room type..
      Called when the screen sharing permissions change for all users.

      onSendMessageForAllUserDisableChanged

      onSendMessageForAllUserDisableChanged
      void onSendMessageForAllUserDisableChanged
      (String roomId
      
      boolean isDisable)

      The status of disabling to send message has changed for all users.

      Param
      DESC
      isDisable
      true: disable user to send message false: enable user to send message.
      roomId
      Room ID.
      Note
      The function only supports the CONFERENCE room type..
      Called when the message sending permissions change for all users.

      onRoomDismissed

      onRoomDismissed
      void onRoomDismissed
      (String roomId
      
      TUIRoomDefine.RoomDismissedReason reason)

      Room was dismissed.

      Param
      DESC
      reason
      The reason why the room was dismissed. More details, see: RoomDismissedReason.
      roomId
      Room ID.
      Note
      The function only supports the CONFERENCE room type..
      Called when the room is dismissed.

      onKickedOutOfRoom

      onKickedOutOfRoom
      void onKickedOutOfRoom
      (String roomId
      
      TUIRoomDefine.KickedOutOfRoomReason reason
      
      String message)

      The current user has been kicked off from the room.

      The function supports the CONFERENCE and LIVE room types.
      Called when a user is kicked out of the room.
      Param
      DESC
      message
      Description of being kicked off.
      reason
      Reason for being kicked off.
      roomId
      Room ID.

      onRoomSeatModeChanged

      onRoomSeatModeChanged
      void onRoomSeatModeChanged
      (String roomId
      
      TUIRoomDefine.SeatMode seatMode)

      The room seat mode has changed.

      Param
      DESC
      roomId
      : Room ID.
      seatMode
      : Seat mode. More details, see TUISeatMode.
      #### [REMARK]
      The function supports the CONFERENCE and LIVE room types.
      Called when the seat mode of the room changes.

      onRoomUserCountChanged

      onRoomUserCountChanged
      void onRoomUserCountChanged
      (String roomId
      
      int userCount)

      The count of user in the room has changed.

      Param
      DESC
      roomId
      Room ID.
      userCount
      Count of user.
      #### [REMARK]
      The function supports the CONFERENCE and LIVE room types.
      Called when the user count of the room changes.

      onRoomMetadataChanged

      onRoomMetadataChanged
      void onRoomMetadataChanged
      (String key
      
      String value)

      The key-value of room metadata has changed.

      Param
      DESC
      key
      The key of room metadata.
      value
      The value of room metadata.
      #### [REMARK]
      The function supports the CONFERENCE and LIVE room types.
      Called when the custom information of the room changes.

      onRemoteUserEnterRoom

      onRemoteUserEnterRoom
      void onRemoteUserEnterRoom
      (String roomId
      
      TUIRoomDefine.UserInfo userInfo)

      Remote user entered room.

      The function supports the CONFERENCE and LIVE room types.
      Called when a remote user enters the room.
      Param
      DESC
      roomId
      Room ID.
      userInfo
      User information. More details, see TUIUserInfo.

      onRemoteUserLeaveRoom

      onRemoteUserLeaveRoom
      void onRemoteUserLeaveRoom
      (String roomId
      
      TUIRoomDefine.UserInfo userInfo)

      Remote user left room.

      The function supports the CONFERENCE and LIVE room types.
      Called when a remote user leaves the room.
      Param
      DESC
      roomId
      Room ID.
      userInfo
      User information. More details, see TUIUserInfo.

      onUserInfoChanged

      onUserInfoChanged
      void onUserInfoChanged
      (TUIRoomDefine.UserInfo userInfo
      
      List<TUIRoomDefine.UserInfoModifyFlag> modifyFlag)

      User information has changed in the room.

      The function supports the CONFERENCE and LIVE room types.
      Called when a user's information changes.
      Param
      DESC
      modifyFlag
      Modifiable parameter. More details, see UserInfoModifyFlag.
      userInfo
      User information. More details, see TUIUserInfo.

      onUserVideoStateChanged

      onUserVideoStateChanged
      void onUserVideoStateChanged
      (String userId
      
      TUIRoomDefine.VideoStreamType streamType
      
      boolean hasVideo
      
      TUIRoomDefine.ChangeReason reason)

      The status of the user has video stream changed.

      The function supports the CONFERENCE and LIVE room types.
      Called when a user's video state changes.
      Param
      DESC
      hasVideo
      The current user whether has video stream.
      reason
      The reason why the video stream changed: BY_SELF: Changed by self BY_ADMIN: Changed by administrator.
      streamType
      Video stream type. More details, see TUIVideoStreamType.
      userId
      User ID.

      onUserAudioStateChanged

      onUserAudioStateChanged
      void onUserAudioStateChanged
      (String userId
      
      boolean hasAudio
      
      TUIRoomDefine.ChangeReason reason)

      The status of the user has audio stream changed.

      The function supports the CONFERENCE and LIVE room types.
      Called when a user's audio state changes.
      Param
      DESC
      hasAudio
      The current user whether has audio stream.
      reason
      The reason why the video stream changed: BY_SELF: Changed by self BY_ADMIN: Changed by administrator.
      userId
      User ID.

      onUserVoiceVolumeChanged

      onUserVoiceVolumeChanged
      void onUserVoiceVolumeChanged
      (Map<String, Integer> volumeMap)

      User volume changed.

      The function supports the CONFERENCE and LIVE room types.
      Called when a user's voice volume changes.
      Param
      DESC
      volumeMap
      : User volume dictionary key: userId, value: the volume of all speaking users, with a value range of 0 - 100.

      onSendMessageForUserDisableChanged

      onSendMessageForUserDisableChanged
      void onSendMessageForUserDisableChanged
      (String roomId
      
      String userId
      
      boolean isDisable)

      The status of disabling to send message has changed for user.

      The function supports the CONFERENCE and LIVE room types.
      Called when a user's message sending permissions change.
      Param
      DESC
      isDisable
      true: disable user to send message false: enable user to send message.
      userId
      User ID.

      onUserNetworkQualityChanged

      onUserNetworkQualityChanged
      void onUserNetworkQualityChanged
      (Map<String, TUICommonDefine.NetworkInfo> networkMap)

      The User network status changed.

      The function supports the CONFERENCE and LIVE room types.
      Called when a user's network quality changes.
      Param
      DESC
      networkMap
      User network status Map. More details, see NetworkInfo.

      onUserScreenCaptureStopped

      onUserScreenCaptureStopped
      void onUserScreenCaptureStopped
      (int reason)

      Screen sharing stopped.

      The function supports the CONFERENCE and LIVE room types.
      Called when a user's screen capture stops.
      Param
      DESC
      reason
      Stop reason, 0: user actively stops; 1: the screen or the window is closed ; 2: the status of the screen or the window has changed (such as device disconnect).

      onRoomMaxSeatCountChanged

      onRoomMaxSeatCountChanged
      void onRoomMaxSeatCountChanged
      (String roomId
      
      int maxSeatCount)

      The maximum count of seats in the room changed (only available in conference rooms)

      Param
      DESC
      maxSeatCount
      The maximum count of seat in the room.
      roomId
      Room ID.

      onSeatListChanged

      onSeatListChanged
      void onSeatListChanged
      (List<TUIRoomDefine.SeatInfo> seatList
      
      List<TUIRoomDefine.SeatInfo> seatedList
      
      List<TUIRoomDefine.SeatInfo> leftList)

      Seat list changed.

      The function supports the CONFERENCE and LIVE room types.
      Called when the seat list changes.
      Param
      DESC
      leftList
      List of newly leave-seat users.
      seatList
      The latest user list on seat, including new users.
      seatedList
      List of newly take-seat users.

      onKickedOffSeat

      onKickedOffSeat
      void onKickedOffSeat
      (int seatIndex
      
      TUIRoomDefine.UserInfo operateUser)

      The user was kicked off the seat.

      The function supports the CONFERENCE and LIVE room types.
      Called when a user is kicked off a seat.
      Param
      DESC
      operateUser
      User information of the owner/administrator who kicked the user.
      seatIndex
      Seat index.

      onRequestReceived

      onRequestReceived
      void onRequestReceived
      (TUIRoomDefine.Request request)

      Receive a request message.

      The function supports the CONFERENCE and LIVE room types.
      Called when a request is received.
      Param
      DESC
      request
      Request content. More details, see Request.

      onRequestCancelled

      onRequestCancelled
      void onRequestCancelled
      (TUIRoomDefine.Request request
      
      TUIRoomDefine.UserInfo operateUser)

      Received a cancelled request.

      The function supports the CONFERENCE and LIVE room types.
      Called when a request is cancelled.
      Param
      DESC
      operateUser
      Operator information.
      request
      Request content. More details, see Request.

      onRequestProcessed

      onRequestProcessed
      void onRequestProcessed
      (TUIRoomDefine.Request request
      
      TUIRoomDefine.UserInfo operateUser)

      Receive a request to be processed by other administrator/owner.

      The function supports the CONFERENCE and LIVE room types.
      Called when a request is processed.
      Param
      DESC
      operateUser
      Operator information.
      request
      Request content. More details, see Request.

      onRoomDismissed

      onRoomDismissed
      void onRoomDismissed
      (String roomId)

      Room was dismissed.

      The function supports the CONFERENCE and LIVE room types.
      Called when the room is dismissed.
      @deprecated It is not recommended to use this function since version v2.3.0. It is recommended to use onRoomDismissed with RoomDismissedReason instead.
      Param
      DESC
      roomId
      Room ID.
      Note
      This callback will be deleted in version v2.8.0. It is recommended that you use the new callback instead.

      onUserRoleChanged

      onUserRoleChanged
      void onUserRoleChanged
      (TUIRoomDefine.UserInfo userInfo)

      User role changed.

      The function supports the CONFERENCE and LIVE room types.
      Called when a user's role changes.
      Param
      DESC
      userInfo
      User information.

      onUserRoleChanged

      onUserRoleChanged
      void onUserRoleChanged
      (String userId
      
      TUIRoomDefine.Role user)

      User role changed.

      The function supports the CONFERENCE and LIVE room types.
      Called when a user's role changes.
      @deprecated It is not recommended to use since version v2.3.0. It is recommended to use onUserRoleChanged with UserInfo instead.
      Param
      DESC
      userId
      Room ID.
      userRole
      User roles. More details, see Role.
      Note
      This callback will be deleted in version v2.8.0. It is recommended that you use the new callback instead.

      onKickedOffSeat

      onKickedOffSeat
      void onKickedOffSeat
      (String userId)

      Recevied user was kicked off the seat.

      The function supports the CONFERENCE and LIVE room types.
      Called when a user is kicked off a seat.
      @deprecated It is not recommended to use since version v2.3.0. It is recommended to use onKickedOffSeat with UserInfo instead.
      Param
      DESC
      userId
      Operator ID.
      Note
      This callback will be deleted in version v2.8.0. It is recommended that you use the new callback instead.

      onRequestCancelled

      onRequestCancelled
      void onRequestCancelled
      (String requestId
      
      String userId)

      Received a cancelled request.

      The function supports the CONFERENCE and LIVE room types.
      Called when a request is cancelled.
      @deprecated It is not recommended to use since version v2.3.0. It is recommended to use onRequestCancelled with Request instead.
      Param
      DESC
      requestId
      Request ID.
      userId
      Operator ID.
      Note
      This callback will be deleted in version v2.8.0. It is recommended that you use the new callback instead.

      onRequestProcessed

      onRequestProcessed
      void onRequestProcessed
      (String requestId
      
      String userId)

      Receive a request to be processed by other administrator/owner.

      The function supports the CONFERENCE and LIVE room types.
      Called when a request is processed.
      @deprecated It is not recommended to use since version v2.3.0. It is recommended to use onRequestProcessed with Request instead.
      Param
      DESC
      requestId
      Request ID.
      userId
      Operator ID.
      Note
      This callback will be deleted in version v2.8.0. It is recommended that you use the new callback instead.
      Contact Us

      Contact our sales team or business advisors to help your business.

      Contact Us
      Technical Support

      Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

      Submit a Ticket
      7x24 Phone Support
      Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
      Privacy PolicyLegalCookie Policy