TUIRoom
is based on Tencent Real-Time Communication (TRTC) and Instant Messaging (IM). TUIRoom
includes the following features:TUIRoom
is an open-source class depending on two closed-source Tencent Cloud SDKs. For the specific implementation process, please see Group Audio/Video Room (for Android).TUIRoom
API OverviewTUIRoomCore
API | Description |
---|---|
getInstance | Gets a singleton object. |
destroyInstance | Terminates a singleton object. |
setListener | Sets event callbacks. |
API | Description |
---|---|
createRoom | Creates a room (called by anchor). |
destroyRoom | Terminates a room (called by anchor). |
enterRoom | Enters a room (called by room member). |
leaveRoom | Exits a room (called by other room members). |
getRoomInfo | Gets the room information. |
getRoomUsers | Gets the information of all users in the room. |
getUserInfo | Gets the information of a user. |
transferRoomMaster | Transfers the anchor permission (called by anchor). |
API | Description |
---|---|
startCameraPreview | Enables the preview image of local video. |
stopCameraPreview | Stops local video capturing and preview. |
startLocalAudio | Enables mic capturing. |
stopLocalAudio | Stops mic capturing. |
setVideoMirror | Sets the mirroring preview mode of the local image. |
setSpeaker | Sets whether to use the speaker or receiver. |
API | Description |
---|---|
startRemoteView | Subscribes to and plays back the remote video image of a specified member. |
stopRemoteView | Unsubscribes from and stops the playback of a remote video image. |
API | Description |
---|---|
sendChatMessage | Sends a chat message. |
sendCustomMessage | Sends a custom message. |
API | Description |
---|---|
muteUserMicrophone | Enables/Disables the mic of a specified user. |
muteAllUsersMicrophone | Enables/Disables the mic of all users and syncs the status to room information. |
muteUserCamera | Enables/Disables the camera of a specified user. |
muteAllUsersCamera | Enables/Disables the camera of all users and syncs the status to room information. |
muteChatRoom | Mutes/Unmutes the chat room (called by anchor). |
kickOffUser | Removes a specified user in the room (called by anchor). |
startCallingRoll | Starts calling roll by the anchor. |
stopCallingRoll | Stops calling roll by the anchor. |
replyCallingRoll | Replies to roll call by a member. |
sendSpeechInvitation | Invites a member to speak by the anchor. |
cancelSpeechInvitation | Cancels invitation to a member for speech by the anchor. |
replySpeechInvitation | Accepts/Rejects the speech invitation from the anchor by a member. |
sendSpeechApplication | Applies for speech by a member. |
replySpeechApplication | Approves/Rejects the speech application of a member by the anchor. |
forbidSpeechApplication | Forbids speech application by the anchor. |
sendOffSpeaker | Stops the speech of a member by the anchor. |
sendOffAllSpeakers | Stops the speech of all members by the anchor. |
exitSpeechState | Stops speech by a member and changes their role to audience. |
API | Description |
---|---|
startScreenCapture | Starts screen sharing. |
stopScreenCapture | Stops screen sharing. |
API | Description |
---|---|
getBeautyManager | Gets the beauty filter management object TXBeautyManager. |
API | Description |
---|---|
setVideoQosPreference | Sets network bandwidth limit parameters. |
API | Description |
---|---|
getSDKVersion | Gets the SDK version. |
TUIRoomCoreListener
API OverviewAPI | Description |
---|---|
onError | Error |
API | Description |
---|---|
onDestroyRoom | Room dismissal. |
onUserVoiceVolume | Volume level. |
onRoomMasterChanged | Anchor change. |
API | Description |
---|---|
onRemoteUserEnter | A remote user entered the room. |
onRemoteUserLeave | A remote user exited the room. |
onRemoteUserCameraAvailable | Whether a remote user enabled the camera. |
onRemoteUserScreenVideoAvailable | Whether a remote user enabled screen sharing. |
onRemoteUserAudioAvailable | Whether a remote user enabled sending audio. |
onRemoteUserEnterSpeechState | A remote user started speaking. |
onRemoteUserExitSpeechState | A remote user stopped speaking. |
API | Description |
---|---|
onReceiveChatMessage | A text message was received. |
onReceiveRoomCustomMsg | A custom message was received. |
API | Description |
---|---|
onReceiveSpeechInvitation | A member received a speech invitation from the anchor. |
onReceiveInvitationCancelled | A member received a speech invitation cancellation from the anchor. |
onReceiveSpeechApplication | The anchor received a speech application from a member. |
onSpeechApplicationCancelled | A member canceled a speech application. |
onSpeechApplicationForbidden | The anchor rejected a speech application. |
onOrderedToExitSpeechState | A member was asked to stop speaking. |
onCallingRollStarted | The anchor started a roll call. |
onCallingRollStopped | The anchor stopped a roll call. |
onMemberReplyCallingRoll | A member replied to roll call. |
onChatRoomMuted | The anchor muted/unmuted the room. |
onMicrophoneMuted | The anchor disabled the mic. |
onCameraMuted | The anchor disabled the camera. |
onReceiveKickedOff | The anchor removed a member. |
API | Description |
---|---|
onStatistics | Statistics on technical metrics. |
onNetworkQuality | Network quality. |
API | Description |
---|---|
onScreenCaptureStarted | Screen sharing started. |
onScreenCaptureStopped | Screen sharing stopped. |
TUIRoomCore
This API is used to get a TUIRoomCore singleton object.
public static TUIRoomCore getInstance(Context context);
The parameters are as detailed below:
Parameter | Type | Description |
---|---|---|
context | Context | Android context, which will be converted to ApplicationContext for the system APIs to call. |
void destroyInstance();
This API is used to set the event callback of TUIRoomCore. You can use TUIRoomCoreListener
to get different status notifications of TUIRoomCore.
void setListener(TUIRoomCoreListener listener);
The parameters are as detailed below:
Parameter | Type | Description |
---|---|---|
listener | TUIRoomCoreListener | Event callback class. |
This API is used to create a room (called by the anchor).
void createRoom(String roomId, TUIRoomCoreDef.SpeechMode speechMode, TUIRoomCoreCallback.ActionCallback callback);
The parameters are as detailed below:
Parameter | Type | Description |
---|---|---|
roomId | String | Room ID. You need to assign and manage the IDs in a centralized manner. |
speechMode | TUIRoomCoreDef.SpeechMode | Speech mode. |
callback | TUIRoomCoreCallback.ActionCallback | Room creation result. |
Generally, the anchor calls the APIs in the following steps:
createRoom()
to create a room, the result of which is returned via TUIRoomCoreCallback.ActionCallback
.startCameraPreview()
to enable camera capturing and preview.startLocalAudio()
to enable the local mic.This API is used to terminate a room (called by the anchor).
void destroyRoom(TUIRoomCoreCallback.ActionCallback callback);
The parameters are as detailed below:
Parameter | Type | Description |
---|---|---|
callback | UIRoomCoreCallback.ActionCallback | Room termination result. |
This API is used to enter a room (called by a member).
void enterRoom(String roomId, TUIRoomCoreCallback.ActionCallback callback);
The parameters are as detailed below:
Parameter | Type | Description |
---|---|---|
roomId | String | Room ID. |
callback | UIRoomCoreCallback.ActionCallback | Result. |
Generally, a member enters a room in the following steps:
enterRoom
and passes in roomId
to enter the room.startCameraPreview()
to enable camera preview and calls startLocalAudio()` to enable mic capturing.onRemoteUserCameraAvailable
event and calls startRemoteView()
to start playback.This API is used to exit a room (called by a member).
void leaveRoom(TUIRoomCoreCallback.ActionCallback callback);
The parameters are as detailed below:
Parameter | Type | Description |
---|---|---|
callback | UIRoomCoreCallback.ActionCallback | Result. |
This API is used to get the room information.
TUIRoomCoreDef.RoomInfo getRoomInfo();
This API is used to get the information of all users in the room.
List getRoomUsers();
This API is used to get the information of a user in the room.
void getUserInfo(String userId, TUIRoomCoreCallback.UserInfoCallback callback);
The parameters are as detailed below:
Parameter | Type | Description |
---|---|---|
userId | String | User ID |
callback | UIRoomCoreCallback.UserInfoCallback | Room member details. |
Set User Info
void setSelfProfile(String userName, String avatarURL, TUIRoomCoreCallback.ActionCallback callback);
The parameters are listed below:
Parameter | Type | Description |
---|---|---|
userName | String | User name. |
avatarURL | String | User profile photo URL. |
callback | TUIRoomCoreCallback.ActionCallback | Whether the setting succeeded. |
This API is used to transfer a group to another user.
void transferRoomMaster(String userId, TUIRoomCoreCallback.ActionCallback callback);
The parameters are as detailed below:
Parameter | Type | Description |
---|---|---|
userId | String | User ID |
callback | TUIRoomCoreCallback.ActionCallback | Callback of the result. |
This API is used to start the preview of the local camera.
void startCameraPreview(boolean isFront, TXCloudVideoView view);
The parameters are as detailed below:
Parameter | Type | Description |
---|---|---|
isFront | Boolean | true : front camera; false : rear camera |
view | TXCloudVideoView | The control that loads video images |
This API is used to stop the preview of the local camera.
void stopCameraPreview();
This API is used to start mic capturing.
void startLocalAudio(int quality);
The parameters are as detailed below:
Parameter | Type | Description |
---|---|---|
quality | int | Captured sound quality: |
This API is used to stop mic capturing.
void stopLocalAudio();
This API is used to set the mirroring preview mode of local video image.
void setVideoMirror(int type);
The parameters are as detailed below:
Parameter | Type | Description |
---|---|---|
type | int | Mirroring type. |
This API is used to set whether to use the speaker or receiver.
void setSpeaker(boolean isUseSpeaker);
The parameters are as detailed below:
Parameter | Type | Description |
---|---|---|
isUseSpeaker | boolean | true: device speaker; false: device receiver. |
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 as detailed below:
Parameter | Type | Description |
---|---|---|
userId | String | ID of the user whose video image is to be played back. |
view | TXCloudVideoView | The control that loads video images. |
streamType | TUIRoomCoreDef.SteamType | Stream type. |
callback | TUIRoomCoreCallback.ActionCallback | Result. |
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 as detailed below:
Parameter | Type | Description |
---|---|---|
userId | String | ID of the user whose video image is to be stopped. |
callback | TUIRoomCoreCallback.ActionCallback | Result. |
This API is used to switch between the front and rear cameras.
void switchCamera(boolean isFront);
The parameters are as detailed below:
Parameter | Type | Description |
---|---|---|
isFront | Boolean | true: front camera; false: rear camera. |
This API is used to broadcast a text message in a room, which is generally used for text chat.
void sendChatMessage(String message, TUIRoomCoreCallback.ActionCallback callback);
The parameters are as detailed below:
Parameter | Type | Description |
---|---|---|
message | String | Message content. |
callback | TUIRoomCoreCallback.ActionCallback | Callback of the operation. |
Sending Custom Messages
void sendCustomMessage(String data, TUIRoomCoreCallback.ActionCallback callback);
The parameters are as detailed below:
Parameter | Type | Description |
---|---|---|
data | String | Message content. |
callback | TUIRoomCoreCallback.ActionCallback | Callback of the operation. |
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 as detailed below:
Parameter | Type | Description |
---|---|---|
userId | String | User ID. |
mute | boolean | Whether to disable. |
callback | TUIRoomCoreCallback.ActionCallback | Callback of the result. |
This API is used to enable/disable the mic of all users.
void muteAllUsersMicrophone(boolean mute, TUIRoomCoreCallback.ActionCallback callback);
The parameters are as detailed below:
Parameter | Type | Description |
---|---|---|
mute | boolean | Whether to disable. |
callback | TUIRoomCoreCallback.ActionCallback | Callback of the result. |
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 detailed below:
Parameter | Type | Description |
---|---|---|
userId | String | User ID. |
mute | boolean | Whether to disable. |
callback | TUIRoomCoreCallback.ActionCallback | Callback of the result. |
This API is used to enable/disable the camera of all users.
void muteAllUsersCamera(boolean mute, TUIRoomCoreCallback.ActionCallback callback);
The parameters are as detailed below:
Parameter | Type | Description |
---|---|---|
mute | boolean | Whether to disable. |
callback | TUIRoomCoreCallback.ActionCallback | Callback of the result. |
This API is used to forbid/allow text chat.
void muteChatRoom(boolean mute, TUIRoomCoreCallback.ActionCallback callback);
The parameters are as detailed below:
Parameter | Type | Description |
---|---|---|
mute | boolean | Whether to disable. |
callback | TUIRoomCoreCallback.ActionCallback | Callback of the result. |
This API is used by the anchor to remove a member.
void kickOffUser(String userId, TUIRoomCoreCallback.ActionCallback callback);
The parameters are as detailed below:
Parameter | Type | Description |
---|---|---|
userId | String | User ID. |
callback | TUIRoomCoreCallback.ActionCallback | Callback of the result. |
This API is used by the anchor to start roll call.
void startCallingRoll(TUIRoomCoreCallback.ActionCallback callback);
The parameters are as detailed below:
Parameter | Type | Description |
---|---|---|
callback | TUIRoomCoreCallback.ActionCallback | Callback of the result. |
This API is used by the anchor to stop roll call.
void stopCallingRoll(TUIRoomCoreCallback.ActionCallback callback);
The parameters are as detailed below:
Parameter | Type | Description |
---|---|---|
callback | TUIRoomCoreCallback.ActionCallback | Callback of the result. |
This API is used by a member to reply to roll call.
void replyCallingRoll(TUIRoomCoreCallback.ActionCallback callback);
The parameters are as detailed below:
Parameter | Type | Description |
---|---|---|
callback | TUIRoomCoreCallback.ActionCallback | Callback of the result. |
This API is used by the anchor to invite a member to speak.
void sendSpeechInvitation(String userId, TUIRoomCoreCallback.InvitationCallback callback);
The parameters are as detailed below:
Parameter | Type | Description |
---|---|---|
userId | String | User ID. |
callback | TUIRoomCoreCallback.InvitationCallback | Result. |
This API is used by the anchor to cancel the speech invitation to a member.
void cancelSpeechInvitation(String userId, TUIRoomCoreCallback.ActionCallback callback);
The parameters are as detailed below:
Parameter | Type | Description |
---|---|---|
userId | String | User ID. |
callback | TUIRoomCoreCallback.ActionCallback | Callback of the result. |
This API is used by a member to accept/reject the speech invitation from the anchor.
void replySpeechInvitation(boolean agree, TUIRoomCoreCallback.ActionCallback callback);
The parameters are as detailed below:
Parameter | Type | Description |
---|---|---|
agree | boolean | Whether the invitation was accepted. |
callback | TUIRoomCoreCallback.ActionCallback | Callback of the result. |
This API is used by a member to apply to speak.
void sendSpeechApplication(TUIRoomCoreCallback.InvitationCallback callback);
The parameters are as detailed below:
Parameter | Type | Description |
---|---|---|
callback | TUIRoomCoreCallback.InvitationCallback | Result. |
This API is used by a member to cancel the speech application.
void cancelSpeechApplication(TUIRoomCoreCallback.ActionCallback callback);
The parameters are as detailed below:
Parameter | Type | Description |
---|---|---|
callback | TUIRoomCoreCallback.ActionCallback | Callback of the result. |
This API is used by the anchor to approve/reject the speech application of a member.
void replySpeechApplication(boolean agree, String userId, TUIRoomCoreCallback.ActionCallback callback);
The parameters are as detailed below:
Parameter | Type | Description |
---|---|---|
agree | Boolean | Whether the invitation was accepted. |
userId | String | User ID. |
callback | TUIRoomCoreCallback.ActionCallback | Callback of the result. |
This API is used by the anchor to forbid speech application.
void forbidSpeechApplication(boolean forbid, TUIRoomCoreCallback.ActionCallback callback);
The parameters are as detailed below:
Parameter | Type | Description |
---|---|---|
forbid | boolean | Whether speech application is forbidden. |
callback | TUIRoomCoreCallback.ActionCallback | Callback of the result. |
This API is used by the anchor to stop the speech of the specified member.
void sendOffSpeaker(String userId, TUIRoomCoreCallback.ActionCallback callback);
The parameters are as detailed below:
Parameter | Type | Description |
---|---|---|
userId | String | User ID. |
callback | TUIRoomCoreCallback.ActionCallback | Callback of the result. |
This API is used by the anchor to stop the speech of all members.
void sendOffAllSpeakers(TUIRoomCoreCallback.ActionCallback callback);
The parameters are as detailed below:
Parameter | Type | Description |
---|---|---|
callback | TUIRoomCoreCallback.ActionCallback | Callback of the result. |
This API is used for a member to stop speaking and change their role to audience.
void exitSpeechState(TUIRoomCoreCallback.ActionCallback callback);
The parameters are as detailed below:
Parameter | Type | Description |
---|---|---|
callback | TUIRoomCoreCallback.ActionCallback | Callback of the result. |
This API is used to start screen sharing.
void startScreenCapture(TRTCCloudDef.TRTCVideoEncParam encParams, TRTCCloudDef.TRTCScreenShareParams screenShareParams);
The parameters are as detailed 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 floatingView which can prevent the application from being killed by the system and help protect user privacy. |
Note:For more information, please see TRTC SDK.
This API is used to stop screen capturing.
void stopScreenCapture();
This API is used to get the beauty filter management object TXBeautyManager.
TXBeautyManager getBeautyManager();
You can do the following using TXBeautyManager
:
set QoS parameters
void setVideoQosPreference(TRTCCloudDef.TRTCNetworkQosParam preference);
The parameters are as detailed below:
Parameter | Type | Description |
---|---|---|
preference | TRTCCloudDef.TRTCNetworkQosParam | Network bandwidth limit policy. |
This API is used to set audio quality.
void setAudioQuality(int quality);
The parameters are as detailed below:
Parameter | Type | Description |
---|---|---|
quality | int | Audio quality. For more information, please see TRTC SDK. |
This API is used to set the resolution.
void setVideoResolution(int resolution);
The parameters are as detailed below:
Parameter | Type | Description |
---|---|---|
resolution | int | Video resolution. For more information, please see TRTC SDK. |
This API is used to set the frame rate.
void setVideoFps(int fps);
The parameters are as detailed below:
Parameter | Type | Description |
---|---|---|
fps | int | Video capturing frame rate. |
Note:Recommended value: 15 or 20 fps. If the frame rate is lower than 5 fps, there will be obvious lagging; if lower than 10 fps but higher than 5 fps, there will be slight lagging; if higher than 20 fps, too many resources will be wasted (the frame rate of movies is generally 24 fps).
This API is used to set the bitrate.
void setVideoBitrate(int bitrate);
The parameters are as detailed below:
Parameter | Type | Description |
---|---|---|
bitrate | int | Bitrate. The SDK encodes streams at the target video bitrate and will actively reduce the bitrate only if the network conditions are poor. For more information, please see TRTC SDK. |
Note:Recommended value: please see the optimal bitrate for each tier in
TRTCVideoResolution
. You can also slightly increase the optimal bitrate. For example,TRTC_VIDEO_RESOLUTION_1280_720
corresponds to the target bitrate of 1,200 Kbps, and you can also set the bitrate to 1,500 Kbps for higher definition.
This API is used to enable the volume reminder.
void enableAudioEvaluation(boolean enable);
The parameters are as detailed below:
Parameter | Type | Description |
---|---|---|
enable | boolean | true: enable; false: disable. |
Note:After this feature is enabled, the result of volume evaluation by the SDK will be obtained in
onUserVolumeUpdate
.
This API is used to set the playback volume.
void setAudioPlayVolume(int volume);
The parameters are as detailed below:
Parameter | Type | Description |
---|---|---|
volume | int | Playback volume. Value range: 0–100. Default value: 100. |
This API is used to set the mic capturing volume.
void setAudioCaptureVolume(int volume);
The parameters are as detailed below:
Parameter | Type | Description |
---|---|---|
volume | int | Capture volume. Value range: 0–100. Default value: 100. |
This API is used to start audio recording.
void startFileDumping(TRTCCloudDef.TRTCAudioRecordingParams trtcAudioRecordingParams);
The parameters are as detailed below:
Parameter | Type | Description |
---|---|---|
trtcAudioRecordingParams | TRTCCloudDef.TRTCAudioRecordingParams | Audio recording parameters. For more information, please see TRTC SDK. |
Note:After this API is called, the SDK will record all audio of a call, including local audio, remote audio, and background music, into a file. This API works regardless of whether a user is in the room. When
leaveRoom
is called, audio recording will stop automatically.
This API is used to stop audio recording.
void stopFileDumping();
This API is used to get SDK version information.
int getSdkVersion();
void onError(int code, String message);
The parameters are as detailed below:
Parameter | Type | Description |
---|---|---|
code | int | Error code |
message | String | Error message |
Room dismissal.
void onDestroyRoom();
User volume level.
void onUserVoiceVolume(String userId, int volume);
The parameters are as detailed below:
Parameter | Type | Description |
---|---|---|
userID | String | User ID |
volume | int | User volume level. Value range: 0–100. |
Anchor change.
void onRoomMasterChanged(String previousUserId, String currentUserId);
The parameters are as detailed below:
Parameter | Type | Description |
---|---|---|
previousUserId | String | Anchor's user ID before change. |
currentUserId | String | Anchor's user ID after change. |
A remote user entered the room.
void onRemoteUserEnter(String userId);
The parameters are as detailed below:
Parameter | Type | Description |
---|---|---|
userId | String | User ID |
A remote user exited the room.
void onRemoteUserLeave(String userId);
The parameters are as detailed below:
Parameter | Type | Description |
---|---|---|
userId | String | User ID |
Whether a remote user enabled the camera.
void onRemoteUserCameraAvailable(String userId, boolean available);
The parameters are as detailed below:
Parameter | Type | Description |
---|---|---|
userId | String | User ID. |
available | boolean | true: enabled; false: disabled. |
A member enabled/disabled video sharing.
void onRemoteUserScreenVideoAvailable(String userId, boolean available);
The parameters are as detailed below:
Parameter | Type | Description |
---|---|---|
userId | String | User ID. |
available | boolean | Whether screen sharing stream data is available. |
Whether a remote user is sending audio.
void onRemoteUserAudioAvailable(String userId, boolean available);
The parameters are as detailed below:
Parameter | Type | Description |
---|---|---|
userId | String | User ID. |
available | boolean | Whether audio data is available. |
A remote user started speaking.
void onRemoteUserEnterSpeechState(String userId);
The parameters are as detailed below:
Parameter | Type | Description |
---|---|---|
userId | String | User ID |
A remote user stopped speaking.
void onRemoteUserExitSpeechState(String userId);
The parameters are as detailed below:
Parameter | Type | Description |
---|---|---|
userId | String | User ID |
Callback for receiving a text message.
void onReceiveChatMessage(String userId, String message);
The parameters are as detailed below:
Parameter | Type | Description |
---|---|---|
userID | String | User ID |
message | String | Text message |
Callback for receiving a custom message.
void onReceiveRoomCustomMsg(String userId, String data);
The parameters are as detailed below:
Parameter | Type | Description |
---|---|---|
userId | String | User ID |
message | String | Custom message content. |
A user received a speech invitation from the anchor.
void onReceiveSpeechInvitation(String userId);
The parameters are as detailed below:
Parameter | Type | Description |
---|---|---|
userId | String | Anchor's user ID. |
A user received a speech invitation cancellation from the anchor.
void onReceiveInvitationCancelled(String userId);
The parameters are as detailed below:
Parameter | Type | Description |
---|---|---|
userId | String | Anchor's user ID. |
The anchor received a speech application from a member.
void onReceiveSpeechApplication(String userId);
The parameters are as detailed below:
Parameter | Type | Description |
---|---|---|
userId | String | User ID |
A user canceled a speech application.
void onSpeechApplicationCancelled(String userId);
The parameters are as detailed below:
Parameter | Type | Description |
---|---|---|
userId | String | User ID |
The anchor forbidden a speech application.
void onSpeechApplicationForbidden(boolean isForbidden);
The parameters are as detailed below:
Parameter | Type | Description |
---|---|---|
isForbidden | boolean | Whether to forbid. |
A member was asked to stop speaking.
void onOrderedToExitSpeechState(String userId);
The parameters are as detailed below:
Parameter | Type | Description |
---|---|---|
userId | String | Anchor's user ID. |
The anchor started a roll call.
void onCallingRollStarted(String userId);
The anchor stopped a roll call.
void onCallingRollStopped(String userId);
A member replied to roll call.
void onMemberReplyCallingRoll(String userId);
The parameters are as detailed below:
Parameter | Type | Description |
---|---|---|
userId | String | User ID |
The anchor muted/unmuted the room.
void onChatRoomMuted(boolean muted);
The parameters are as detailed below:
Parameter | Type | Description |
---|---|---|
muted | boolean | Whether to disable. |
The anchor disabled the mic.
void onMicrophoneMuted(boolean muted);
The parameters are as detailed below:
Parameter | Type | Description |
---|---|---|
muted | boolean | Whether to disable. |
The anchor disabled the camera.
void onCameraMuted(boolean muted);
The parameters are as detailed below:
Parameter | Type | Description |
---|---|---|
muted | boolean | Whether to disable. |
The anchor removed a member.
void onReceiveKickedOff(String userId);
The parameters are as detailed below:
Parameter | Type | Description |
---|---|---|
userId | String | Anchor/Admin's user ID. |
Callback of technical metric statistics.
void onStatistics(TRTCStatistics statistics);
The parameters are as detailed below:
Parameter | Type | Description |
---|---|---|
statis | TRTCStatistics | Statistics. |
Network quality.
void onNetworkQuality(TRTCCloudDef.TRTCQuality localQuality, List remoteQuality) ;
The parameters are as detailed below:
Parameter | Type | Description |
---|---|---|
localQuality | TRTCCloudDef.TRTCQuality | Upstream network quality. |
remoteQuality | List<TRTCCloudDef.TRTCQuality> | Downstream network quality. |
Note:For more information, please see TRTC SDK.
Screen sharing started.
void onScreenCaptureStarted();
Screen sharing stopped.
void onScreenCaptureStopped(int reason);
The parameters are as detailed below:
Parameter | Type | Description |
---|---|---|
reason | int | Reason for stop. 0: the user stopped proactively; 1: stopped due to preemption by another application. |
Was this page helpful?