tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Tencent Real-Time Communication
    Documentation
    Download PDF

    TUIRoom (Android)

    Last updated: 2024-09-14 16:38:21
    Download PDF
      TUIRoom is based on Tencent Real-Time Communication (TRTC) and Tencent Cloud Chat. With TUIRooom:
      A host can create a room, and users can enter the room ID to join the room.
      Participants can share their screens with each other.
      All room members can send text chat messages and custom messages.
      Note:
      All components of TUIKit use two basic PaaS services of Tencent Cloud, namely TRTC and Chat. When you activate TRTC, Chat and the trial edition of the Chat SDK (which supports up to 100 DAUs) will be activated automatically. For the billing details of Chat, see Pricing.
      TUIRoom is an open-source class depending on two closed-source Tencent Cloud SDKs. For the specific implementation process, see Integrating TUIRoom (Android).
      The TRTC SDK is used as a low-latency audio/video room component.
      The Chat SDK (Android edition) is used to implement chat messages.

      TUIRoom API Overview

      TUIRoomCore Basic APIs

      API
      Description
      Gets a singleton object.
      Terminates a singleton object.
      Sets event callbacks.

      Room APIs

      API
      Description
      Creates a room (called by host).
      Closes the room (called by host).
      enterRoom
      Enters a room (called by participant)
      LeaveRoom
      Leaves a room (called by participant).
      Gets the room information.
      Gets the information of all users in the room.
      Gets the information of a user.
      Transfers the host permissions to another user (called by host).

      Local audio/video operation APIs

      API
      Description
      Enables preview of the local video.
      Stops local video capturing and preview.
      Enables mic capturing.
      Stops mic capturing.
      Sets the mirror mode for local video preview.
      Sets whether to play sound from the device’s speaker or receiver.

      Remote user APIs

      API
      Description
      Subscribes to and plays back the remote video image of a specified member.
      Unsubscribes from and stops the playback of a remote video image.

      Chat message sending APIs

      API
      Description
      Sends a chat message.
      Sends a custom message.

      Room control APIs

      API
      Description
      Enables/Disables the mic of a specified user.
      Enables/Disables the mics of all users and syncs the status to room information.
      Enables/Disables the camera of a specified user.
      Enables/Disables the cameras of all users and syncs the status to room information.
      Disables/Enables chat messages (called by host).
      Removes a specified user from the room (called by host).
      Starts a roll call (called by host).
      Stops a roll call (called by host).
      Replies to a roll call (called by participant).
      Sends a speech invitation to a participant (called by host).
      Cancels a speech invitation sent to a participant (called by host).
      Accepts/Rejects the speech invitation of the host (called by participant).
      Sends a speech request (called by participant).
      Approves/Rejects the speech request of a participant (called by host).
      Disables requests to speak (called by host).
      Stops the speech of a participant (called by host).
      Stops the speech of all members in the room (called by host).
      Exits the speaker mode (called by participant).

      Screen sharing APIs

      API
      Description
      Starts screen sharing.
      Stops screen sharing.

      Beauty filter APIs

      API
      Description
      Gets the beauty filter management object TXBeautyManager.

      Settings APIs

      API
      Description
      Sets network QoS control parameters.

      SDK version APIs

      API
      Description
      Gets the SDK version.

      TUIRoomCoreListener API Overview

      Callbacks for error events

      API
      Description
      onError
      Callback for error.

      Basic event callbacks

      API
      Description
      The room was closed.
      The audio volume of a user.
      The host changed.

      Remote user event callbacks

      API
      Description
      A remote user entered the room.
      A remote user exited the room.
      A remote user turned on/off their camera.
      A remote user started/stopped screen sharing.
      A remote user turned on/off their mic.
      A remote user started speaking.
      A remote user stopped speaking.

      Message event callback APIs

      API
      Description
      A text chat message was received.
      A custom message was received.

      Room control event callbacks

      API
      Description
      A participant received a speech invitation from the host.
      The speech invitation sent to a participant was canceled by the host.
      The host received a speech request from a participant.
      A participant canceled a speech request.
      The host disabled requests to speak.
      A participant was asked to stop speaking.
      The host started a roll call (received by participants)
      The host stopped a roll call (received by participants).
      A participant replied to the roll call (received by the host).
      The host disabled/enabled chat messages.
      The host disabled mic use.
      The host disabled camera use.
      The host removed a participant from the room (received by the participant).

      Callback of statistics on network quality and technical metrics

      API
      Description
      Statistics on technical metrics.
      Network quality.

      Screen sharing event callbacks

      API
      Description
      Screen sharing started.
      Screen sharing stopped.

      TUIRoomCore Basic APIs

      getInstance

      This API is used to get a TUIRoomCore singleton object.
      public static TUIRoomCore getInstance(Context context);
      The parameters are described below:
      Parameter
      Type
      Description
      context
      Context
      Android context, which will be converted to ApplicationContext for the calling of system APIs.

      destroyInstance

      void destroyInstance();

      setListener

      This API is used to set the event callbacks of TUIRoomCore. You can use TUIRoomCoreListener to get the callbacks.
      void setListener(TUIRoomCoreListener listener);
      The parameters are described below:
      Parameter
      Type
      Description
      listener
      TUIRoomCoreListener
      The event callback class.

      createRoom

      This API is used to create a room (called by the host).
      void createRoom(String roomId, TUIRoomCoreDef.SpeechMode speechMode, TUIRoomCoreCallback.ActionCallback callback);
      The parameters are described below:
      Parameter
      Type
      Description
      roomId
      String
      The room ID. You need to assign and manage the IDs in a centralized manner.
      speechMode
      TUIRoomCoreDef.SpeechMode
      The speech mode.
      callback
      TUIRoomCoreCallback.ActionCallback
      The result of room creation.
      Generally, a host may need to call the following APIs:
      1. The host calls createRoom() to create a room, the result of which is returned via TUIRoomCoreCallback.ActionCallback.
      2. The host calls startCameraPreview() to enable camera capturing and preview.
      3. The host calls startLocalAudio() to enable the local mic.

      destroyRoom

      This API is used to close a room (called by the host).
      void destroyRoom(TUIRoomCoreCallback.ActionCallback callback);
      The parameters are described below:
      Parameter
      Type
      Description
      callback
      UIRoomCoreCallback.ActionCallback
      The room closing result.

      enterRoom

      This API is used to leave a room (called by a participant).
      void enterRoom(String roomId, TUIRoomCoreCallback.ActionCallback callback);
      The parameters are described below:
      Parameter
      Type
      Description
      roomId
      String
      The room ID.
      callback
      UIRoomCoreCallback.ActionCallback
      The result.
      Generally, a participant joins a room in the following steps:
      1. The participant calls enterRoom (passing in roomId) to enter the room.
      2. The participant calls startCameraPreview() to enable camera preview and calls startLocalAudio() to enable mic capturing.
      3. The participant receives the onRemoteUserCameraAvailable callback and calls startRemoteView() to start playback.

      leaveRoom

      This API is used to leave a room (called by a participant).
       void leaveRoom(TUIRoomCoreCallback.ActionCallback callback);
      The parameters are described below:
      Parameter
      Type
      Description
      callback
      UIRoomCoreCallback.ActionCallback
      The result.

      getRoomInfo

      This API is used to get the room information.
      TUIRoomCoreDef.RoomInfo getRoomInfo();

      getRoomUsers

      This API is used to get the information of all users in the room.
       List<TUIRoomCoreDef.UserInfo> getRoomUsers();

      getUserInfo

      This API is used to get the information of a specified room member.
      void getUserInfo(String userId, TUIRoomCoreCallback.UserInfoCallback callback);
      The parameters are described below:
      Parameter
      Type
      Description
      userId
      String
      The user ID.
      callback
      UIRoomCoreCallback.UserInfoCallback
      The room member details.

      setSelfProfile

      Set User Info
      void setSelfProfile(String userName, String avatarURL, TUIRoomCoreCallback.ActionCallback callback);
      The parameters are described below:
      Parameter
      Type
      Description
      userName
      String
      The username.
      avatarURL
      String
      The URL of the user profile photo.
      callback
      TUIRoomCoreCallback.ActionCallback
      Whether the setting succeeded.

      transferRoomMaster

      This API is used to transfer host permissions to another user.
       void transferRoomMaster(String userId, TUIRoomCoreCallback.ActionCallback callback);
      The parameters are described below:
      Parameter
      Type
      Description
      userId
      String
      The user ID.
      callback
      TUIRoomCoreCallback.ActionCallback
      The result.

      Local Push APIs

      startCameraPreview

      This API is used to start the preview of the local camera.
      void startCameraPreview(boolean isFront, TXCloudVideoView view);
      The parameters are described below:
      Parameter
      Type
      Description
      isFront
      boolean
      true: Front camera; false: Rear camera
      view
      TXCloudVideoView
      The view that loads video images.

      stopCameraPreview

      This API is used to stop the preview of the local camera.
       void stopCameraPreview();

      startLocalAudio

      This API is used to start mic capturing.
       void startLocalAudio(int quality);
      The parameters are described below:
      Parameter
      Type
      Description
      quality
      int
      The audio quality. Valid values:
      TRTC_AUDIO_QUALITY_MUSIC
      TRTC_AUDIO_QUALITY_DEFAULT
      TRTC_AUDIO_QUALITY_SPEECH.

      stopLocalAudio

      This API is used to stop mic capturing.
      void stopLocalAudio();

      setVideoMirror

      This API is used to set the mirror mode for local video preview.
       void setVideoMirror(int type);
      The parameters are described below:
      Parameter
      Type
      Description
      type
      int
      The mirror mode.

      setSpeaker

      This API is used to set whether to play sound from the device’s speaker or receiver.
       void setSpeaker(boolean isUseSpeaker);
      The parameters are described below:
      Parameter
      Type
      Description
      isUseSpeaker
      boolean
      true: Speaker; false: Receiver.

      Remote User APIs

      startRemoteView

      This API is used to subscribe to a remote user's video stream.
      void startRemoteView(String userId, TXCloudVideoView view, TUIRoomCoreDef.SteamType streamType, TUIRoomCoreCallback.ActionCallback callback);
      The parameters are described below:
      Parameter
      Type
      Description
      userId
      String
      The ID of the user whose video image is to be played back.
      view
      TXCloudVideoView
      The view that loads video images
      streamType
      TUIRoomCoreDef.SteamType
      The stream type.
      callback
      TUIRoomCoreCallback.ActionCallback
      The result.

      stopRemoteView

      This API is used to unsubscribe from and stop the playback of a remote video image.
      void stopRemoteView(String userId, TUIRoomCoreCallback.ActionCallback callback);
      
      The parameters are described below:
      Parameter
      Type
      Description
      userId
      String
      The ID of the user whose video image is to be stopped.
      callback
      TUIRoomCoreCallback.ActionCallback
      The result.

      switchCamera

      This API is used to switch between the front and rear cameras.
      void switchCamera(boolean isFront);
      
      The parameters are described below:
      Parameter
      Type
      Description
      isFront
      boolean
      true: Front camera; false: Rear camera.

      Message Sending APIs

      sendChatMessage

      This API is used to broadcast a text chat message in the room.
      void sendChatMessage(String message, TUIRoomCoreCallback.ActionCallback callback);
      The parameters are described below:
      Parameter
      Type
      Description
      message
      String
      The message content.
      callback
      TUIRoomCoreCallback.ActionCallback
      The result.

      sendCustomMessage

      This API is used to send a custom message.
      void sendCustomMessage(String data, TUIRoomCoreCallback.ActionCallback callback);
      The parameters are described below:
      Parameter
      Type
      Description
      data
      String
      The message content.
      callback
      TUIRoomCoreCallback.ActionCallback
      The result.

      Room Control APIs

      muteUserMicrophone

      This API is used to enable/disable the mic of the specified user.
      void muteUserMicrophone(String userId, boolean mute, TUIRoomCoreCallback.ActionCallback callback);
      The parameters are described below:
      Parameter
      Type
      Description
      userId
      String
      The user ID.
      mute
      boolean
      Whether to disable.
      callback
      TUIRoomCoreCallback.ActionCallback
      The result.

      muteAllUsersMicrophone

      This API is used to enable/disable the mics of all users.
      void muteAllUsersMicrophone(boolean mute, TUIRoomCoreCallback.ActionCallback callback);
      The parameters are described below:
      Parameter
      Type
      Description
      mute
      boolean
      Whether to disable.
      callback
      TUIRoomCoreCallback.ActionCallback
      The result.

      muteUserCamera

      This API is used to enable/disable the camera of the specified user.
      void muteUserCamera(String userId, boolean mute, TUIRoomCoreCallback.ActionCallback callback);
      The parameters are described below:
      Parameter
      Type
      Description
      userId
      String
      The user ID.
      mute
      boolean
      Whether to disable.
      callback
      TUIRoomCoreCallback.ActionCallback
      The result.

      muteAllUsersCamera

      This API is used to enable/disable the cameras of all users.
      void muteAllUsersCamera(boolean mute, TUIRoomCoreCallback.ActionCallback callback);
      The parameters are described below:
      Parameter
      Type
      Description
      mute
      boolean
      Whether to disable.
      callback
      TUIRoomCoreCallback.ActionCallback
      Callback of the result.

      muteChatRoom

      This API is used to disable/enable chat messages.
      void muteChatRoom(boolean mute, TUIRoomCoreCallback.ActionCallback callback);
      The parameters are described below:
      Parameter
      Type
      Description
      mute
      boolean
      Whether to disable.
      callback
      TUIRoomCoreCallback.ActionCallback
      The result.

      kickOffUser

      This API is used by the host to remove a member from the room.
      void kickOffUser(String userId, TUIRoomCoreCallback.ActionCallback callback);
      The parameters are described below:
      Parameter
      Type
      Description
      userId
      String
      The user ID.
      callback
      TUIRoomCoreCallback.ActionCallback
      The result.

      startCallingRoll

      This API is used by the host to start a roll call.
       void startCallingRoll(TUIRoomCoreCallback.ActionCallback callback);
      The parameters are described below:
      Parameter
      Type
      Description
      callback
      TUIRoomCoreCallback.ActionCallback
      The result.

      stopCallingRoll

      This API is used by the host to stop a roll call.
       void stopCallingRoll(TUIRoomCoreCallback.ActionCallback callback);
      
      The parameters are described below:
      Parameter
      Type
      Description
      callback
      TUIRoomCoreCallback.ActionCallback
      The result.

      replyCallingRoll

      This API is used by a participant to reply to a roll call.
      void replyCallingRoll(TUIRoomCoreCallback.ActionCallback callback);
      The parameters are described below:
      Parameter
      Type
      Description
      callback
      TUIRoomCoreCallback.ActionCallback
      The result.

      sendSpeechInvitation

      This API is used by the host to invite a participant to speak.
      void sendSpeechInvitation(String userId, TUIRoomCoreCallback.InvitationCallback callback);
      The parameters are described below:
      Parameter
      Type
      Description
      userId
      String
      The user ID.
      callback
      TUIRoomCoreCallback.InvitationCallback
      The result.

      cancelSpeechInvitation

      This API is used by the host to cancel a speech invitation.
       void cancelSpeechInvitation(String userId, TUIRoomCoreCallback.ActionCallback callback);
      The parameters are described below:
      Parameter
      Type
      Description
      userId
      String
      The user ID.
      callback
      TUIRoomCoreCallback.ActionCallback
      The result.

      replySpeechInvitation

      This API is used by a participant to accept/reject the host’s invitation to speak.
      void replySpeechInvitation(boolean agree, TUIRoomCoreCallback.ActionCallback callback);
      The parameters are described below:
      Parameter
      Type
      Description
      agree
      bool
      Whether to accept.
      callback
      TUIRoomCoreCallback.ActionCallback
      The result.

      sendSpeechApplication

      This API is used by a participant to send a request to speak.
      void sendSpeechApplication(TUIRoomCoreCallback.InvitationCallback callback);
      The parameters are described below:
      Parameter
      Type
      Description
      callback
      TUIRoomCoreCallback.InvitationCallback
      The result.

      cancelSpeechApplication

      This API is used by a participant to cancel the request to speak.
      void cancelSpeechApplication(TUIRoomCoreCallback.ActionCallback callback);
      The parameters are described below:
      Parameter
      Type
      Description
      callback
      TUIRoomCoreCallback.ActionCallback
      The result.

      replySpeechApplication

      This API is used by the host to approve/reject a participant’s speech request.
      void replySpeechApplication(boolean agree, String userId, TUIRoomCoreCallback.ActionCallback callback);
      The parameters are described below:
      Parameter
      Type
      Description
      agree
      boolean
      Whether to approve.
      userId
      String
      The user ID.
      callback
      TUIRoomCoreCallback.ActionCallback
      Callback of the result.

      forbidSpeechApplication

      This API is used by the host to disable requests to speak.
       void forbidSpeechApplication(boolean forbid, TUIRoomCoreCallback.ActionCallback callback);
      The parameters are described below:
      Parameter
      Type
      Description
      forbid
      boolean
      Whether to disable.
      callback
      TUIRoomCoreCallback.ActionCallback
      The result.

      sendOffSpeaker

      This API is used by the host to stop the speech of a participant.
      void sendOffSpeaker(String userId, TUIRoomCoreCallback.ActionCallback callback);
      The parameters are described below:
      Parameter
      Type
      Description
      userId
      String
      The user ID.
      callback
      TUIRoomCoreCallback.ActionCallback
      The result.

      sendOffAllSpeakers

      This API is used by the host to stop the speech of all members.
      void sendOffAllSpeakers(TUIRoomCoreCallback.ActionCallback callback);
      The parameters are described below:
      Parameter
      Type
      Description
      callback
      TUIRoomCoreCallback.ActionCallback
      The result.

      exitSpeechState

      This API is used by a participant to exit the speaker mode.
      void exitSpeechState(TUIRoomCoreCallback.ActionCallback callback);
      The parameters are described below:
      Parameter
      Type
      Description
      callback
      TUIRoomCoreCallback.ActionCallback
      The result.

      Screen Sharing APIs

      startScreenCapture

      This API is used to start screen sharing.
      void startScreenCapture(TRTCCloudDef.TRTCVideoEncParam encParams, TRTCCloudDef.TRTCScreenShareParams screenShareParams);
      The parameters are described below:
      Parameter
      Type
      Description
      encParams
      TRTCCloudDef.TRTCVideoEncParam
      Screen sharing encoding parameters. We recommend you use the above configuration. If you set encParams to null, the encoding parameter settings before startScreenCapture is called will be used.
      screenShareParams
      TRTCCloudDef.TRTCScreenShareParams
      Special screen sharing configuration. We recommend you set this to floatingView, which can prevent the application from being closed by the system and help protect user privacy.
      Note:
      For more information, see TRTC SDK.

      stopScreenCapture

      This API is used to stop screen capturing.
      void stopScreenCapture();

      Beauty Filter APIs

      getBeautyManager

      This API is used to get the beauty filter management object TXBeautyManager.
      TXBeautyManager getBeautyManager();
      You can do the following using the beauty filter manger:
      Set the beauty filter style and apply effects including skin brightening, rosy skin, eye enlarging, face slimming, chin slimming, chin lengthening/shortening, face shortening, nose narrowing, eye brightening, teeth whitening, eye bag removal, wrinkle removal, and smile line removal.
      Adjust the hairline, eye spacing, eye corners, lip shape, nose wings, nose position, lip thickness, and face shape.
      Apply animated effects such as face widgets (materials).
      Add makeup effects.
      Recognize gestures.

      Settings APIs

      setVideoQosPreference

      This API is used to set network QoS control parameters.
       void setVideoQosPreference(TRTCCloudDef.TRTCNetworkQosParam preference);
      The parameters are described below:
      Parameter
      Type
      Description
      preference
      TRTCNetworkQosParam
      The network QoS policy.

      setAudioQuality

      This API is used to set audio quality.
      void setAudioQuality(int quality);
      The parameters are described below:
      Parameter
      Type
      Description
      quality
      int
      The audio quality. For more information, see TRTC SDK.

      setVideoResolution

      This API is used to set the resolution.
      void setVideoResolution(int resolution);
      The parameters are described below:
      Parameter
      Type
      Description
      resolution
      int
      The video resolution. For more information, see TRTC SDK.

      setVideoFps

      This API is used to set the frame rate.
      void setVideoFps(int fps);
      The parameters are described below:
      Parameter
      Type
      Description
      fps
      int
      The video capturing frame rate.
      Note:
      Recommended value: 15 or 20 fps. Video will stutter severely if the frame rate is lower than 5 fps and slightly if it is lower than 10 fps. Setting the frame rate to higher than 20 fps would be a waste of resources (the frame rate of films is 24 fps).

      setVideoBitrate

      This API is used to set the bitrate.
      void setVideoBitrate(int bitrate);
      The parameters are described below:
      Parameter
      Type
      Description
      bitrate
      int
      The bitrate. The SDK encodes streams at the target video bitrate. However, it may reduce the bitrate if network conditions are poor. For more information, see TRTC SDK.
      Note:
      Recommended value: See the recommended bitrate for each TRTCVideoResolution value. For a better viewing experience, you can slightly increase the bitrate. For example, the recommended bitrate for TRTC_VIDEO_RESOLUTION_1280_720 is 1,200 Kbps. You can set the bitrate to 1,500 Kbps.

      enableAudioEvaluation

      This API is used to enable the volume reminder.
      void enableAudioEvaluation(boolean enable);
      The parameters are described below:
      Parameter
      Type
      Description
      enable
      boolean
      true: Enable; false: Disable.
      Note:
      After the volume reminder is enabled, the volumes measured by the SDK will be returned via the onUserVolumeUpdate callback.

      setAudioPlayVolume

      This API is used to set the playback volume.
      void setAudioPlayVolume(int volume);
      The parameters are described below:
      Parameter
      Type
      Description
      volume
      int
      The payback volume. Value range: 0-100. Default value: 100.

      setAudioCaptureVolume

      This API is used to set the mic capturing volume.
      void setAudioCaptureVolume(int volume);
      The parameters are described below:
      Parameter
      Type
      Description
      volume
      int
      The capturing volume. Value range: 0-100. Default value: 100.

      startFileDumping

      This API is used to start audio recording.
      void startFileDumping(TRTCCloudDef.TRTCAudioRecordingParams trtcAudioRecordingParams);
      The parameters are described below:
      Parameter
      Type
      Description
      trtcAudioRecordingParams
      TRTCCloudDef.TRTCAudioRecordingParams
      The audio recording parameters. For more information, see TRTC SDK.
      Note:
      After this API is called, the SDK will record all audios of a call, including the local audio, remote audios, and background music, into a single file. This API works regardless of whether you are in the room or not. When leaveRoom is called, audio recording will stop automatically.

      stopFileDumping

      This API is used to stop audio recording.
      void stopFileDumping();

      SDK Version APIs

      getSdkVersion

      This API is used to get the SDK version.
      int getSdkVersion();

      Error Event Callbacks

      onError

      void onError(int code, String message);
      The parameters are described below:
      Parameter
      Type
      Description
      code
      int
      The error code
      message
      String
      The error message.

      Basic Event Callbacks

      onDestroyRoom

      The room was closed.
      void onDestroyRoom();

      onUserVoiceVolume

      The audio volume of a user.
      void onUserVoiceVolume(String userId, int volume);
      The parameters are described below:
      Parameter
      Type
      Description
      userId
      String
      The user ID.
      volume
      int
      The volume. Value range: 0-100.

      onRoomMasterChanged

      The host changed.
      void onRoomMasterChanged(String previousUserId, String currentUserId);
      The parameters are described below:
      Parameter
      Type
      Description
      previousUserId
      String
      The host’s user ID before the change.
      currentUserId
      String
      The host’s user ID after the change.

      Remote User Callbacks

      onRemoteUserEnter

      A remote user entered the room.
      void onRemoteUserEnter(String userId);
      The parameters are described below:
      Parameter
      Type
      Description
      userId
      String
      The user ID.

      onRemoteUserLeave

      A remote user exited the room.
      void onRemoteUserLeave(String userId);
      The parameters are described below:
      Parameter
      Type
      Description
      userId
      String
      The user ID.

      onRemoteUserCameraAvailable

      A remote user enabled/disabled their camera.
      void onRemoteUserCameraAvailable(String userId, boolean available);
      The parameters are described below:
      Parameter
      Type
      Description
      userId
      String
      The user ID.
      available
      boolean
      true: Enabled; false: Disabled.

      onRemoteUserScreenVideoAvailable

      A member enabled/disabled video sharing.
      void onRemoteUserScreenVideoAvailable(String userId, boolean available);
      The parameters are described below:
      Parameter
      Type
      Description
      userId
      String
      The User ID.
      available
      boolean
      Whether the user enabled/disabled screen sharing.

      onRemoteUserAudioAvailable

      A remote user enabled/disabled their mic.
      void onRemoteUserAudioAvailable(String userId, boolean available);
      The parameters are described below:
      Parameter
      Type
      Description
      userId
      String
      The user ID.
      available
      boolean
      Whether the user enabled/disabled their mic.

      onRemoteUserEnterSpeechState

      A remote user started speaking.
      void onRemoteUserEnterSpeechState(String userId);
      The parameters are described below:
      Parameter
      Type
      Description
      userId
      String
      The user ID.

      onRemoteUserExitSpeechState

      A remote user stopped speaking.
      void onRemoteUserExitSpeechState(String userId);
      The parameters are described below:
      Parameter
      Type
      Description
      userId
      String
      The user ID.

      Chat Message Event Callbacks

      onReceiveChatMessage

      A text chat message was received.
      void onReceiveChatMessage(String userId, String message);
      The parameters are described below:
      Parameter
      Type
      Description
      userId
      String
      The user ID.
      message
      String
      The message content.

      onReceiveRoomCustomMsg

      A custom message was received.
      void onReceiveRoomCustomMsg(String userId, String data);
      The parameters are described below:
      Parameter
      Type
      Description
      userId
      String
      The user ID.
      message
      String
      The custom message content.

      Room Control Message Callbacks

      onReceiveSpeechInvitation

      The host sent a speech invitation (received by a participant).
      void onReceiveSpeechInvitation(String userId);
      The parameters are described below:
      Parameter
      Type
      Description
      userId
      String
      The host's user ID.

      onReceiveInvitationCancelled

      The host canceled the speech invitation (received by a participant).
      void onReceiveInvitationCancelled(String userId);
      The parameters are described below:
      Parameter
      Type
      Description
      userId
      String
      The host's user ID.

      onReceiveSpeechApplication

      A participant sent a request to speak (received by the host).
      void onReceiveSpeechApplication(String userId);
      The parameters are described below:
      Parameter
      Type
      Description
      userId
      String
      The user ID.

      onSpeechApplicationCancelled

      A participant canceled a speech request.
      void onSpeechApplicationCancelled(String userId);
      The parameters are described below:
      Parameter
      Type
      Description
      userId
      String
      The user ID.

      onSpeechApplicationForbidden

      The host disabled requests to speak.
      void onSpeechApplicationForbidden(boolean isForbidden);
      The parameters are described below:
      Parameter
      Type
      Description
      isForbidden
      boolean
      Whether to disable.

      onOrderedToExitSpeechState

      A participant was asked to stop speaking.
      void onOrderedToExitSpeechState(String userId);
      The parameters are described below:
      Parameter
      Type
      Description
      userId
      String
      The host's user ID.

      onCallingRollStarted

      The host started a roll call (received by participants).
      void onCallingRollStarted(String userId);

      onCallingRollStopped

      The host stopped a roll call (received by participants).
      void onCallingRollStopped(String userId);

      onMemberReplyCallingRoll

      A participant replied to the roll call (received by the host).
      void onMemberReplyCallingRoll(String userId);
      The parameters are described below:
      Parameter
      Type
      Description
      userId
      String
      The user ID.

      onChatRoomMuted

      The host disabled/enabled chat messages.
      void onChatRoomMuted(boolean muted);
      The parameters are described below:
      Parameter
      Type
      Description
      muted
      boolean
      Disabled or not.

      onMicrophoneMuted

      The host disabled mic use.
      void onMicrophoneMuted(boolean muted);
      The parameters are described below:
      Parameter
      Type
      Description
      muted
      boolean
      Disabled or not.

      onCameraMuted

      The host disabled camera use.
      void onCameraMuted(boolean muted);
      The parameters are described below:
      Parameter
      Type
      Description
      muted
      boolean
      Disabled or not.

      onReceiveKickedOff

      The host removed a member from the room.
      void onReceiveKickedOff(String userId);
      The parameters are described below:
      Parameter
      Type
      Description
      userId
      String
      The user ID of the host/admin.

      Callback of Statistics on Network Quality and Technical Metrics

      onStatistics

      Callback of technical metric statistics.
      void onStatistics(TRTCStatistics statistics);
      The parameters are described below:
      Parameter
      Type
      Description
      statis
      TRTCStatistics
      Statistics.

      onNetworkQuality

      Network quality.
      void onNetworkQuality(TRTCCloudDef.TRTCQuality localQuality, List<TRTCCloudDef.TRTCQuality> remoteQuality);
      
      The parameters are described below:
      Parameter
      Type
      Description
      localQuality
      TRTCCloudDef.TRTCQuality
      The upstream network quality.
      remoteQuality
      List&amp;lt;TRTCCloudDef.TRTCQuality&amp;gt;
      The downstream network quality.
      Note:
      For more information, see TRTC SDK.

      Screen Sharing Event Callbacks

      onScreenCaptureStarted

      Screen sharing started.
       void onScreenCaptureStarted();

      onScreenCaptureStopped

      Screen sharing stopped.
      void onScreenCaptureStopped(int reason);
      The parameters are described below:
      Parameter
      Type
      Description
      reason
      int
      The reason. 0: The user stopped screen sharing; 1: Screen sharing was interrupted by another application.
      
      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