Overview

TRTCCloud
Basic Method
API
Description
﻿sharedInstance﻿
Create a `TRTCCloud` singleton.
﻿destroySharedInstance﻿
Destroy the `TRTCCloud` singleton.
﻿registerListener﻿
Set event listening
﻿unRegisterListener﻿
Remove event listening
Room APIs
API
Description
﻿enterRoom﻿
Enters a room. If the room does not exist, the system will create one automatically.
﻿exitRoom﻿
Leave the room.
﻿switchRole﻿
Switch roles, applicable only to live streaming scenarios (TRTC_APP_SCENE_LIVE and TRTC_APP_SCENE_VOICE_CHATROOM).
﻿switchRoom﻿
Switches rooms.
﻿connectOtherRoom﻿
Request cross-room call (host PK).
﻿disconnectOtherRoom﻿
Exit cross-room call.
﻿setDefaultStreamRecvMode﻿
Set the audio and video data reception mode, which must be configured before entering the room to take effect.
CDN Interface Functions
API
Description
﻿startPublishMediaStream﻿
Start publishing media stream.
﻿updatePublishMediaStream﻿
Update published media stream.
﻿stopPublishMediaStream﻿
Stop publishing media stream.
Video Interface Functions
API
Description
﻿startLocalPreview﻿
Enable the preview of local video.
﻿updateLocalView﻿
Update local video preview screen.
﻿stopLocalPreview﻿
Stop local video capture and preview.
﻿muteLocalVideo﻿
Pauses/resumes publishing local video data.
﻿startRemoteView﻿
Starts playing the video of a remote user.
﻿updateRemoteView﻿
Update the video rendering view of the remote user.
﻿stopRemoteView﻿
Stops playing and pulling the video of a remote user.
﻿stopAllRemoteView﻿
Stops playing and pulling the videos of all remote users.
﻿muteRemoteVideoStream﻿
Pauses/Resumes receiving the video of a specified remote user.
﻿muteAllRemoteVideoStreams﻿
Pauses/Resumes receiving the videos of all remote users.
﻿setVideoEncoderParam﻿
Sets video encoder parameters.
﻿setNetworkQosParam﻿
Sets the parameters for network flow control.
﻿setLocalRenderParams﻿
Sets the rendering mode of the local image.
﻿setRemoteRenderParams﻿
Sets the parameters related to remote images.
﻿enableSmallVideoStream﻿
Enables dual-stream encoding mode for large and small screens.
﻿setRemoteVideoStreamType﻿
Selects the big or small screen for a specified UID.
﻿snapshotVideo﻿
Takes a video screenshot.
﻿setGravitySensorAdaptiveMode﻿
Sets the adaptive mode for gravity sensing.
Audio related interface functions
API
Description
﻿startLocalAudio﻿
Enables local audio capturing and publishing.
﻿stopLocalAudio﻿
Disables local audio capturing and publishing.
﻿muteLocalAudio﻿
Mute/unmute local audio.
﻿muteRemoteAudio﻿
Mute/unmute the sound of a specified remote user.
﻿muteAllRemoteAudio﻿
Mute/Unmute all user's voices.
﻿setRemoteAudioVolume﻿
Set the volume of a specific remote user's audio playback.
﻿setAudioCaptureVolume﻿
Sets the SDK capturing volume.
﻿getAudioCaptureVolume﻿
Obtains the SDK capture volume.
﻿setAudioPlayoutVolume﻿
Sets the SDK playback volume.
﻿getAudioPlayoutVolume﻿
Gets the SDK playback volume.
﻿enableAudioVolumeEvaluation﻿
Enables volume level prompt.
﻿startLocalRecording﻿
Start local media recording, which includes both audio and video data.
﻿stopLocalRecording﻿
Stop local media recording.
Device management interface
API
Description
﻿getDeviceManager﻿
Obtain device management module. For interface details, see Device Management Interface Documentation﻿
Music and Vocal Special Effects
API
Description
﻿getAudioEffectManager﻿
Obtain TXAudioEffectManager for managing BGM, short sound effects, and vocal special effects. For interface details, see Sound Effect Management Documentation﻿
﻿startSystemAudioLoopback﻿
Enable system audio capture.
﻿stopSystemAudioLoopback﻿
Stop system audio capture.
﻿setSystemAudioLoopbackVolume﻿
Set system audio capturing volume.
Auxiliary stream related interface functions
API
Description
﻿startScreenCapture﻿
Start screen sharing
﻿stopScreenCapture﻿
Stop screen capturing
﻿pauseScreenCapture﻿
Pause screen sharing
﻿resumeScreenCapture﻿
Resumes screen sharing
﻿getScreenCaptureSources﻿
Enumerate shareable screens and windows (this API is only supported on Windows)
﻿selectScreenCaptureTarget﻿
Select the screen or window to be shared (this API is only supported on Windows)
﻿setSubStreamEncoderParam﻿
Set the screen sharing (i.e., substream) video encoding parameters (supported on both desktop and mobile systems)
Custom capturing and custom rendering
API
Description
﻿enableCustomVideoCapture﻿
Enable/Disable Custom Video Capture Mode.
﻿sendCustomVideoData﻿
Submit your captured video frames to the SDK.
﻿enableCustomAudioCapture﻿
Enable/Disable Custom Audio Capture Mode.
﻿sendCustomVideoData﻿
Submit your captured audio data to the SDK.
﻿enableMixExternalAudioFrame﻿
Enable/Disable Custom Audio Track.
Custom message sending APIs
API
Description
﻿sendCustomCmdMsg﻿
Sends a custom message to all users in a room.
﻿sendSEIMsg﻿
Embeds small-volume custom data into video frames.
Network Testing
API
Description
﻿startSpeedTest﻿
Starts network speed testing. This may compromise the quality of video calls and should be avoided during a video call.
﻿stopSpeedTest﻿
Stops server speed measurement.
Log Interface Functions
API
Description
﻿getSDKVersion﻿
Gets the SDK version.
﻿setLogLevel﻿
Sets the log output level.
﻿setConsoleEnabled﻿
Enables/Disables console log printing.
﻿setLogCompressEnabled﻿
Enables/Disables local log compression.
﻿setLogDirPath﻿
Modifies the log save path.
﻿setLogCallback﻿
Sets the log callback.
﻿showDebugView﻿
Display Debug Information Floating Layer (can show audio and video information and event information).
﻿callExperimentalAPI﻿
Calls the experimental API.
TRTCCloudListener
Event callback interface for Tencent Cloud video call feature.
Error and warning event callback APIs
API
Description
﻿onError﻿
Error callback, indicating an irrecoverable error in the SDK. It is essential to listen and provide users with appropriate interface prompts accordingly.
﻿onWarning﻿
Warning callback, designed to inform you of non-critical issues, such as lag or recoverable decoding failure.
Room event callback APIs
API
Description
﻿onEnterRoom﻿
Callback for having joined the room.
﻿onExitRoom﻿
Event callback for leaving the room.
﻿onSwitchRole﻿
Event callback for switching roles.
﻿onSwitchRoom﻿
Result callback for switching rooms (switchRoom).
﻿onConnectOtherRoom﻿
Result callback for requesting cross-room call (Host PK).
﻿onDisConnectOtherRoom﻿
Result callback for ending cross-room call (Host PK).
Member Event Callback
API
Description
﻿onRemoteUserEnterRoom﻿
A user has joined the current room.
﻿onRemoteUserLeaveRoom﻿
A user has left the current room.
﻿onUserVideoAvailable﻿
Whether the remote user has a main route view that can be played (generally used for cameras).
﻿onUserSubStreamAvailable﻿
Whether the remote user has an auxiliary route view that can be played (generally used for screen sharing).
﻿onUserAudioAvailable﻿
Whether the remote user has playable audio data.
﻿onFirstVideoFrame﻿
Start rendering the first frame image of a local or remote user.
﻿onFirstAudioFrame﻿
Start playing the first frame audio of a remote user (local sound is not notified for the time being).
﻿onSendFirstLocalVideoFrame﻿
The first frame of local video data has been sent out.
﻿onSendFirstLocalAudioFrame﻿
The first frame of local audio data has been sent out.
﻿onRemoteVideoStatusUpdated﻿
Callback for changes in remote video status.
﻿onRemoteAudioStatusUpdated﻿
Callback for changes in remote audio status.
﻿onUserVideoSizeChanged﻿
Callback for changes in user's video size.
Callback for local recording and local screenshot events
API
Description
﻿onLocalRecordBegin﻿
When the local recording task has started, the SDK will notify through this callback.
﻿onLocalRecording﻿
While the local recording task is in progress, the SDK will periodically notify users through this callback.
﻿onLocalRecordFragment﻿
When you enable segmented recording, the SDK will notify you through this callback each time a segment is completed.
﻿onLocalRecordComplete﻿
When the local recording task has ended, the SDK will notify you through this callback.
﻿onSnapshotComplete﻿
Callback for local screenshot completion.
Statistics and quality callback
API
Description
﻿onNetworkQuality﻿
Network quality, this callback is triggered every 2 seconds, providing statistics for the current network's upload and download quality.
﻿onStatistics﻿
Technical indicators statistics callback.
﻿onSpeedTestResult﻿
Callback for the result of the network speed test.
Server event callback
API
Description
﻿onConnectionLost﻿
The SDK's connection to the server has disconnected.
﻿onTryToReconnect﻿
The SDK attempts to reconnect to the server.
﻿onConnectionRecovery﻿
The SDK's connection to the server has been restored.
Hardware Device Event Callback
API
Description
﻿onCameraDidReady﻿
Camera Ready.
﻿onMicDidReady﻿
Microphone Ready.
﻿onUserVoiceVolume﻿
Callback for indicating volume level, including the volume of each userId and the remote master volume.
﻿onAudioDeviceCaptureVolumeChanged﻿
The system capture volume of the current microphone has changed.
﻿onAudioDevicePlayoutVolumeChanged﻿
The playback volume of the current system has changed.
﻿onSystemAudioLoopbackError﻿
Event callback for successful system sound capture (only applicable to desktop systems).
﻿onTestMicVolume﻿
Microphone test volume callback
﻿onTestSpeakerVolume﻿
Speaker test volume callback
Custom message receipt callback
API
Description
﻿onRecvCustomCmdMsg﻿
Receipt of a custom message callback.
﻿onMissCustomCmdMsg﻿
Custom message loss callback.
﻿onRecvSEIMsg﻿
Received SEI message callback.
CDN Bypass Forward Callback
API
Description
﻿onStartPublishMediaStream﻿
Callback for setting On-Cloud MixTranscoding parameters, corresponding to the startPublishMediaStream() interface in TRTCCloud.
﻿onUpdatePublishMediaStream﻿
Callback for setting On-Cloud MixTranscoding parameters, corresponding to the updatePublishMediaStream() interface in TRTCCloud.
﻿onStopPublishMediaStream﻿
Callback for setting On-Cloud MixTranscoding parameters, corresponding to the stopPublishMediaStream() interface in TRTCCloud.
﻿onCdnStreamStateChanged﻿
Callback for changes in RTMP/RTMPS stream pushing status.
Screen sharing callback
API
Description
﻿onScreenCaptureStarted﻿
When screen sharing starts, the SDK will notify through this callback.
﻿onScreenCapturePaused﻿
When the pauseScreenCapture() is called to pause screen sharing, the SDK will notify through this callback.
﻿onScreenCaptureResumed﻿
When the resumeScreenCapture() is called to resume screen sharing, the SDK will notify through this callback.
﻿onScreenCaptureStopped﻿
When screen sharing stops, the SDK will notify via this callback.
﻿onScreenCaptureCovered﻿
Event callback for when the target window of screen sharing is obscured (applicable only to Windows operating systems)
More event callbacks
TRTC Log Callback
API
Description
﻿onLog﻿
Local LOG print callback
Callback interface for playing background music
API
Description
﻿onStart﻿
Callback notification for music playback start.
﻿onPlayProgress﻿
Callback notification for music playback progress.
﻿onComplete﻿
Callback notification for music playback end.
Background Music Preload Event Callback
API
Description
﻿onLoadProgress﻿
Background Music Preload Progress.
﻿onLoadError﻿
Background Music Preload Error.
Device Connectivity Status Change Callback
API
Description
﻿onDeviceChanged﻿
The connectivity status of the local device has changed (Desktop systems only)
TXAudioEffectManager
API
Description
﻿enableVoiceEarMonitor﻿
Enable ear monitoring, allowing local users to hear their own voice.
﻿setVoiceEarMonitorVolume﻿
Set ear monitoring volume
﻿setVoiceReverbType﻿
Set voice reverb effects (KTV, small room, auditorium, deep, bright, etc.)
﻿setVoiceChangerType﻿
Set voice changing effects (loli, uncle, heavy metal, punk, etc.)
﻿setVoiceCaptureVolume﻿
Set microphone voice volume
﻿setVoicePitch﻿
Set voice pitch.
﻿setMusicObserver﻿
Set event callback interface for background music.
﻿startPlayMusic﻿
Start playing background music
﻿stopPlayMusic﻿
Stop playing background music
﻿pausePlayMusic﻿
Pause playing background music
﻿resumePlayMusic﻿
Resumes background music
﻿setAllMusicVolume﻿
Sets global background music volume for local and remote users
﻿setMusicPublishVolume﻿
Sets the remote volume of background music. The host can use this API to set the volume of background music heard by remote audiences.
﻿setMusicPlayoutVolume﻿
Sets the local volume of background music. The host can use this API to set the volume of local background music.
﻿setMusicPitch﻿
Adjusts the pitch of background music
﻿setMusicSpeedRate﻿
Adjusts the speed of background music
﻿getMusicCurrentPosInMS﻿
Gets the current playback progress of the background music (milliseconds)
﻿getMusicDurationInMS﻿
Gets the total duration of the background music file (milliseconds)
﻿seekMusicToPosInMS﻿
Sets the playback progress of the background music (milliseconds)
﻿setMusicScratchSpeedRate﻿
Adjusts the speed effect of the scratch disk
﻿setPreloadObserver﻿
Set preload event callback
﻿preloadMusic﻿
Preload background music
﻿getMusicTrackCount﻿
Get the number of tracks in background music
﻿setMusicTrack﻿
Specify the track to play background music
TXDeviceManager
API
Description
﻿isFrontCamera﻿
Set whether to use the front camera
﻿switchCamera﻿
Switch camera (front/rear)
﻿getCameraZoomMaxRatio﻿
Get the maximum zoom level of the camera
﻿setCameraZoomRatio﻿
Set the camera zoom factor (focal length)
﻿isAutoFocusEnabled﻿
Check if the device supports automatic face position recognition
﻿enableCameraAutoFocus﻿
Set whether to enable automatic face position recognition
﻿setCameraFocusPosition﻿
Set the camera focus position
﻿enableCameraTorch﻿
Enable/disable flashlight, also known as torch mode
﻿setAudioRoute﻿
Set audio routing, i.e., use receiver or speaker
﻿getDevicesList﻿
Get the device list of specified type
﻿setCurrentDevice﻿
Set the device currently in use
﻿getCurrentDevice﻿
Get the device currently in use
﻿setCurrentDeviceVolume﻿
Set the volume of the current device
﻿getCurrentDeviceVolume﻿
Get the volume of the current device
﻿setCurrentDeviceMute﻿
Set the mute state of the current device
﻿getCurrentDeviceMute﻿
Query the mute state of the current device
﻿enableFollowingDefaultAudioDevice﻿
Set the audio device used by the SDK to follow the system default device (desktop only)
﻿startCameraDeviceTest﻿
Start camera testing (desktop only)
﻿stopCameraDeviceTest﻿
Stop camera testing (desktop only)
﻿startMicDeviceTest﻿
Start mic testing (desktop only)
﻿startMicDeviceTestAndPlayback﻿
Start mic testing (desktop only)
﻿stopMicDeviceTest﻿
Stop mic testing (desktop only)
﻿startSpeakerDeviceTest﻿
Start speaker testing (desktop only)
﻿stopSpeakerDeviceTest﻿
Stop speaker testing (desktop only)
﻿setApplicationPlayVolume﻿
Set the volume of the current process in the Windows system volume mixer
﻿getApplicationPlayVolume﻿
Get the volume of the current process in the Windows system volume mixer
﻿setApplicationMuteState﻿
Set the mute state of the current process in the Windows system volume mixer
﻿getApplicationMuteState﻿
Get the mute state of the current process in the Windows system volume mixer
﻿setCameraCaptureParam﻿
Set camera capture preferences
﻿setDeviceObserver﻿
Set onDeviceChanged event callback
Enumeration definitions
Enum Type
Description
﻿TRTCAppScene﻿
Application scenario
﻿TRTCAudioFrameFormat﻿
Audio Frame Content Format
﻿TRTCAudioFrameOperationMode﻿
Audio Callback Data Operation Mode
﻿TRTCAudioQuality﻿
Sound Quality
﻿TRTCAudioRecordingContent﻿
Audio Recording Content Type
﻿TRTCAVStatusChangeReason﻿
Playback State Change Reason
﻿TRTCAVStatusType﻿
Audio and video playback status
﻿TRTCBeautyStyle﻿
Media recording type
﻿TRTCGSensorMode﻿
Sets the adaptive mode for gravity sensing (only applicable to mobile devices)
﻿TRTCLocalRecordType﻿
Media recording type.
﻿TRTCLogLevel﻿
Log level
﻿TRTCPublishMode﻿
Publishing mode
﻿TRTCQuality﻿
Network quality
﻿TRTCRoleType﻿
Roles
﻿TRTCScreenCaptureSourceType﻿
Screen sharing target type (desktop only)
﻿TRTCSnapshotSourceType﻿
Local video screenshot data source
﻿TRTCSpeedTestScene﻿
Speed test scenario
﻿TRTCVideoBufferType﻿
Video data shipping method
﻿TRTCVideoFillMode﻿
Video image fill mode
﻿TRTCVideoMirrorType﻿
Video mirroring type
﻿TRTCVideoPixelFormat﻿
Video pixel format
﻿TRTCVideoQosPreference﻿
Image quality preference
﻿TRTCVideoResolution﻿
Video resolution
﻿TRTCVideoResolutionMode﻿
Video aspect ratio mode
﻿TRTCVideoRotation﻿
Video image rotation direction
﻿TRTCVideoStreamType﻿
Video stream type
﻿TRTCWaterMarkSrcType﻿
Watermark image source type
﻿TXVoiceReverbType﻿
Reverb special effect
﻿TXVoiceChangerType﻿
Voice change special effect
﻿TXAudioRoute﻿
Audio routing (i.e., sound playback mode)
﻿TXMediaDeviceType﻿
Device type (desktop platform only)
﻿TXMediaDeviceState﻿
Device operation
﻿TXCameraCaptureMode﻿
Camera capture preferences
Type Definition
Struct type
Description
﻿TRTCAudioFrame﻿
Audio frame data
﻿TRTCAudioFrameCallbackFormat﻿
Format parameters for custom audio callbacks
﻿TRTCAudioVolumeEvaluateParams﻿
Volume evaluation and other related parameter settings
﻿TRTCImageBuffer﻿
Structure for storing window thumbnails and icons
﻿TRTCLocalRecordingParams﻿
Local media file recording parameters
﻿TRTCLocalStatistics﻿
Local audio and video metrics
﻿TRTCNetworkQosParam﻿
Network bandwidth limit parameters
﻿TRTCParams﻿
Room entry parameters
﻿TRTCPublishCdnUrl﻿
Target URL for publishing to Tencent Cloud or a third-party CDN
﻿TRTCPublishTarget﻿
Publishing target
﻿TRTCQualityInfo﻿
Network quality
﻿TRTCRemoteStatistics﻿
Remote audio and video metrics
﻿TRTCRenderParams﻿
Rendering parameters of the video image
﻿TRTCScreenCaptureProperty﻿
Advanced control parameters for screen sharing
﻿TRTCScreenCaptureSourceInfo﻿
Target information for screen sharing (desktop only)
﻿TRTCScreenCaptureSourceList﻿
List of screen windows
﻿TRTCSpeedTestParams﻿
Network speed test parameters
﻿TRTCSpeedTestResult﻿
Network speed test results
﻿TRTCStatistics﻿
Network and performance metrics
﻿TRTCStreamEncoderParam﻿
Encoding parameters
﻿TRTCStreamMixingConfig﻿
Transcoding parameters
﻿TRTCSwitchRoomConfig﻿
Room switch parameters
﻿TRTCTexture﻿
Video texture data
﻿TRTCUser﻿
User to publish stream
﻿TRTCVideoEncParam﻿
Video codec parameters
﻿TRTCVideoFrame﻿
Video frame information
﻿TRTCVideoLayout﻿
Video layout for transcoded stream
﻿TRTCVolumeInfo﻿
Volume
﻿TRTCWatermark﻿
Watermark layout
﻿AudioMusicParam﻿
Background music playback control information
﻿TXCameraCaptureParam﻿
Camera capture parameters
﻿TXDeviceInfo﻿
Information about audio and video devices (desktop platform only)
Video rendering component
API
Description
﻿TRTCCloudVideoView﻿
Video view window for displaying local video, remote video, or auxiliary stream.

TRTCCloud
TRTCCloudListener
More event callbacks
TXAudioEffectManager
TXDeviceManager
Enumeration definitions
Type Definition
Video rendering component

API	Description
sharedInstance	Create a `TRTCCloud` singleton.
destroySharedInstance	Destroy the `TRTCCloud` singleton.
registerListener	Set event listening
unRegisterListener	Remove event listening

API	Description
enterRoom	Enters a room. If the room does not exist, the system will create one automatically.
exitRoom	Leave the room.
switchRole	Switch roles, applicable only to live streaming scenarios (TRTC_APP_SCENE_LIVE and TRTC_APP_SCENE_VOICE_CHATROOM).
switchRoom	Switches rooms.
connectOtherRoom	Request cross-room call (host PK).
disconnectOtherRoom	Exit cross-room call.
setDefaultStreamRecvMode	Set the audio and video data reception mode, which must be configured before entering the room to take effect.

API	Description
startPublishMediaStream	Start publishing media stream.
updatePublishMediaStream	Update published media stream.
stopPublishMediaStream	Stop publishing media stream.

API	Description
startLocalPreview	Enable the preview of local video.
updateLocalView	Update local video preview screen.
stopLocalPreview	Stop local video capture and preview.
muteLocalVideo	Pauses/resumes publishing local video data.
startRemoteView	Starts playing the video of a remote user.
updateRemoteView	Update the video rendering view of the remote user.
stopRemoteView	Stops playing and pulling the video of a remote user.
stopAllRemoteView	Stops playing and pulling the videos of all remote users.
muteRemoteVideoStream	Pauses/Resumes receiving the video of a specified remote user.
muteAllRemoteVideoStreams	Pauses/Resumes receiving the videos of all remote users.
setVideoEncoderParam	Sets video encoder parameters.
setNetworkQosParam	Sets the parameters for network flow control.
setLocalRenderParams	Sets the rendering mode of the local image.
setRemoteRenderParams	Sets the parameters related to remote images.
enableSmallVideoStream	Enables dual-stream encoding mode for large and small screens.
setRemoteVideoStreamType	Selects the big or small screen for a specified UID.
snapshotVideo	Takes a video screenshot.
setGravitySensorAdaptiveMode	Sets the adaptive mode for gravity sensing.

API	Description
startLocalAudio	Enables local audio capturing and publishing.
stopLocalAudio	Disables local audio capturing and publishing.
muteLocalAudio	Mute/unmute local audio.
muteRemoteAudio	Mute/unmute the sound of a specified remote user.
muteAllRemoteAudio	Mute/Unmute all user's voices.
setRemoteAudioVolume	Set the volume of a specific remote user's audio playback.
setAudioCaptureVolume	Sets the SDK capturing volume.
getAudioCaptureVolume	Obtains the SDK capture volume.
setAudioPlayoutVolume	Sets the SDK playback volume.
getAudioPlayoutVolume	Gets the SDK playback volume.
enableAudioVolumeEvaluation	Enables volume level prompt.
startLocalRecording	Start local media recording, which includes both audio and video data.
stopLocalRecording	Stop local media recording.

API	Description
getDeviceManager	Obtain device management module. For interface details, see Device Management Interface Documentation

API	Description
getAudioEffectManager	Obtain TXAudioEffectManager for managing BGM, short sound effects, and vocal special effects. For interface details, see Sound Effect Management Documentation
startSystemAudioLoopback	Enable system audio capture.
stopSystemAudioLoopback	Stop system audio capture.
setSystemAudioLoopbackVolume	Set system audio capturing volume.

API	Description
startScreenCapture	Start screen sharing
stopScreenCapture	Stop screen capturing
pauseScreenCapture	Pause screen sharing
resumeScreenCapture	Resumes screen sharing
getScreenCaptureSources	Enumerate shareable screens and windows (this API is only supported on Windows)
selectScreenCaptureTarget	Select the screen or window to be shared (this API is only supported on Windows)
setSubStreamEncoderParam	Set the screen sharing (i.e., substream) video encoding parameters (supported on both desktop and mobile systems)

API	Description
enableCustomVideoCapture	Enable/Disable Custom Video Capture Mode.
sendCustomVideoData	Submit your captured video frames to the SDK.
enableCustomAudioCapture	Enable/Disable Custom Audio Capture Mode.
sendCustomVideoData	Submit your captured audio data to the SDK.
enableMixExternalAudioFrame	Enable/Disable Custom Audio Track.

API	Description
sendCustomCmdMsg	Sends a custom message to all users in a room.
sendSEIMsg	Embeds small-volume custom data into video frames.

API	Description
startSpeedTest	Starts network speed testing. This may compromise the quality of video calls and should be avoided during a video call.
stopSpeedTest	Stops server speed measurement.

API	Description
getSDKVersion	Gets the SDK version.
setLogLevel	Sets the log output level.
setConsoleEnabled	Enables/Disables console log printing.
setLogCompressEnabled	Enables/Disables local log compression.
setLogDirPath	Modifies the log save path.
setLogCallback	Sets the log callback.
showDebugView	Display Debug Information Floating Layer (can show audio and video information and event information).
callExperimentalAPI	Calls the experimental API.

API	Description
onError	Error callback, indicating an irrecoverable error in the SDK. It is essential to listen and provide users with appropriate interface prompts accordingly.
onWarning	Warning callback, designed to inform you of non-critical issues, such as lag or recoverable decoding failure.

API	Description
onEnterRoom	Callback for having joined the room.
onExitRoom	Event callback for leaving the room.
onSwitchRole	Event callback for switching roles.
onSwitchRoom	Result callback for switching rooms (switchRoom).
onConnectOtherRoom	Result callback for requesting cross-room call (Host PK).
onDisConnectOtherRoom	Result callback for ending cross-room call (Host PK).

API	Description
onRemoteUserEnterRoom	A user has joined the current room.
onRemoteUserLeaveRoom	A user has left the current room.
onUserVideoAvailable	Whether the remote user has a main route view that can be played (generally used for cameras).
onUserSubStreamAvailable	Whether the remote user has an auxiliary route view that can be played (generally used for screen sharing).
onUserAudioAvailable	Whether the remote user has playable audio data.
onFirstVideoFrame	Start rendering the first frame image of a local or remote user.
onFirstAudioFrame	Start playing the first frame audio of a remote user (local sound is not notified for the time being).
onSendFirstLocalVideoFrame	The first frame of local video data has been sent out.
onSendFirstLocalAudioFrame	The first frame of local audio data has been sent out.
onRemoteVideoStatusUpdated	Callback for changes in remote video status.
onRemoteAudioStatusUpdated	Callback for changes in remote audio status.
onUserVideoSizeChanged	Callback for changes in user's video size.

API	Description
onLocalRecordBegin	When the local recording task has started, the SDK will notify through this callback.
onLocalRecording	While the local recording task is in progress, the SDK will periodically notify users through this callback.
onLocalRecordFragment	When you enable segmented recording, the SDK will notify you through this callback each time a segment is completed.
onLocalRecordComplete	When the local recording task has ended, the SDK will notify you through this callback.
onSnapshotComplete	Callback for local screenshot completion.

API	Description
onNetworkQuality	Network quality, this callback is triggered every 2 seconds, providing statistics for the current network's upload and download quality.
onStatistics	Technical indicators statistics callback.
onSpeedTestResult	Callback for the result of the network speed test.

API	Description
onConnectionLost	The SDK's connection to the server has disconnected.
onTryToReconnect	The SDK attempts to reconnect to the server.
onConnectionRecovery	The SDK's connection to the server has been restored.

API	Description
onCameraDidReady	Camera Ready.
onMicDidReady	Microphone Ready.
onUserVoiceVolume	Callback for indicating volume level, including the volume of each userId and the remote master volume.
onAudioDeviceCaptureVolumeChanged	The system capture volume of the current microphone has changed.
onAudioDevicePlayoutVolumeChanged	The playback volume of the current system has changed.
onSystemAudioLoopbackError	Event callback for successful system sound capture (only applicable to desktop systems).
onTestMicVolume	Microphone test volume callback
onTestSpeakerVolume	Speaker test volume callback

API	Description
onRecvCustomCmdMsg	Receipt of a custom message callback.
onMissCustomCmdMsg	Custom message loss callback.
onRecvSEIMsg	Received SEI message callback.

API	Description
onStartPublishMediaStream	Callback for setting On-Cloud MixTranscoding parameters, corresponding to the startPublishMediaStream() interface in TRTCCloud.
onUpdatePublishMediaStream	Callback for setting On-Cloud MixTranscoding parameters, corresponding to the updatePublishMediaStream() interface in TRTCCloud.
onStopPublishMediaStream	Callback for setting On-Cloud MixTranscoding parameters, corresponding to the stopPublishMediaStream() interface in TRTCCloud.
onCdnStreamStateChanged	Callback for changes in RTMP/RTMPS stream pushing status.

API	Description
onScreenCaptureStarted	When screen sharing starts, the SDK will notify through this callback.
onScreenCapturePaused	When the pauseScreenCapture() is called to pause screen sharing, the SDK will notify through this callback.
onScreenCaptureResumed	When the resumeScreenCapture() is called to resume screen sharing, the SDK will notify through this callback.
onScreenCaptureStopped	When screen sharing stops, the SDK will notify via this callback.
onScreenCaptureCovered	Event callback for when the target window of screen sharing is obscured (applicable only to Windows operating systems)

API	Description
onStart	Callback notification for music playback start.
onPlayProgress	Callback notification for music playback progress.
onComplete	Callback notification for music playback end.

API	Description
onLoadProgress	Background Music Preload Progress.
onLoadError	Background Music Preload Error.

API	Description
onDeviceChanged	The connectivity status of the local device has changed (Desktop systems only)

API	Description
enableVoiceEarMonitor	Enable ear monitoring, allowing local users to hear their own voice.
setVoiceEarMonitorVolume	Set ear monitoring volume
setVoiceReverbType	Set voice reverb effects (KTV, small room, auditorium, deep, bright, etc.)
setVoiceChangerType	Set voice changing effects (loli, uncle, heavy metal, punk, etc.)
setVoiceCaptureVolume	Set microphone voice volume
setVoicePitch	Set voice pitch.
setMusicObserver	Set event callback interface for background music.
startPlayMusic	Start playing background music
stopPlayMusic	Stop playing background music
pausePlayMusic	Pause playing background music
resumePlayMusic	Resumes background music
setAllMusicVolume	Sets global background music volume for local and remote users
setMusicPublishVolume	Sets the remote volume of background music. The host can use this API to set the volume of background music heard by remote audiences.
setMusicPlayoutVolume	Sets the local volume of background music. The host can use this API to set the volume of local background music.
setMusicPitch	Adjusts the pitch of background music
setMusicSpeedRate	Adjusts the speed of background music
getMusicCurrentPosInMS	Gets the current playback progress of the background music (milliseconds)
getMusicDurationInMS	Gets the total duration of the background music file (milliseconds)
seekMusicToPosInMS	Sets the playback progress of the background music (milliseconds)
setMusicScratchSpeedRate	Adjusts the speed effect of the scratch disk
setPreloadObserver	Set preload event callback
preloadMusic	Preload background music
getMusicTrackCount	Get the number of tracks in background music
setMusicTrack	Specify the track to play background music

API	Description
isFrontCamera	Set whether to use the front camera
switchCamera	Switch camera (front/rear)
getCameraZoomMaxRatio	Get the maximum zoom level of the camera
setCameraZoomRatio	Set the camera zoom factor (focal length)
isAutoFocusEnabled	Check if the device supports automatic face position recognition
enableCameraAutoFocus	Set whether to enable automatic face position recognition
setCameraFocusPosition	Set the camera focus position
enableCameraTorch	Enable/disable flashlight, also known as torch mode
setAudioRoute	Set audio routing, i.e., use receiver or speaker
getDevicesList	Get the device list of specified type
setCurrentDevice	Set the device currently in use
getCurrentDevice	Get the device currently in use
setCurrentDeviceVolume	Set the volume of the current device
getCurrentDeviceVolume	Get the volume of the current device
setCurrentDeviceMute	Set the mute state of the current device
getCurrentDeviceMute	Query the mute state of the current device
enableFollowingDefaultAudioDevice	Set the audio device used by the SDK to follow the system default device (desktop only)
startCameraDeviceTest	Start camera testing (desktop only)
stopCameraDeviceTest	Stop camera testing (desktop only)
startMicDeviceTest	Start mic testing (desktop only)
startMicDeviceTestAndPlayback	Start mic testing (desktop only)
stopMicDeviceTest	Stop mic testing (desktop only)
startSpeakerDeviceTest	Start speaker testing (desktop only)
stopSpeakerDeviceTest	Stop speaker testing (desktop only)
setApplicationPlayVolume	Set the volume of the current process in the Windows system volume mixer
getApplicationPlayVolume	Get the volume of the current process in the Windows system volume mixer
setApplicationMuteState	Set the mute state of the current process in the Windows system volume mixer
getApplicationMuteState	Get the mute state of the current process in the Windows system volume mixer
setCameraCaptureParam	Set camera capture preferences
setDeviceObserver	Set onDeviceChanged event callback

Enum Type	Description
TRTCAppScene	Application scenario
TRTCAudioFrameFormat	Audio Frame Content Format
TRTCAudioFrameOperationMode	Audio Callback Data Operation Mode
TRTCAudioQuality	Sound Quality
TRTCAudioRecordingContent	Audio Recording Content Type
TRTCAVStatusChangeReason	Playback State Change Reason
TRTCAVStatusType	Audio and video playback status
TRTCBeautyStyle	Media recording type
TRTCGSensorMode	Sets the adaptive mode for gravity sensing (only applicable to mobile devices)
TRTCLocalRecordType	Media recording type.
TRTCLogLevel	Log level
TRTCPublishMode	Publishing mode
TRTCQuality	Network quality
TRTCRoleType	Roles
TRTCScreenCaptureSourceType	Screen sharing target type (desktop only)
TRTCSnapshotSourceType	Local video screenshot data source
TRTCSpeedTestScene	Speed test scenario
TRTCVideoBufferType	Video data shipping method
TRTCVideoFillMode	Video image fill mode
TRTCVideoMirrorType	Video mirroring type
TRTCVideoPixelFormat	Video pixel format
TRTCVideoQosPreference	Image quality preference
TRTCVideoResolution	Video resolution
TRTCVideoResolutionMode	Video aspect ratio mode
TRTCVideoRotation	Video image rotation direction
TRTCVideoStreamType	Video stream type
TRTCWaterMarkSrcType	Watermark image source type
TXVoiceReverbType	Reverb special effect
TXVoiceChangerType	Voice change special effect
TXAudioRoute	Audio routing (i.e., sound playback mode)
TXMediaDeviceType	Device type (desktop platform only)
TXMediaDeviceState	Device operation
TXCameraCaptureMode	Camera capture preferences

Struct type	Description
TRTCAudioFrame	Audio frame data
TRTCAudioFrameCallbackFormat	Format parameters for custom audio callbacks
TRTCAudioVolumeEvaluateParams	Volume evaluation and other related parameter settings
TRTCImageBuffer	Structure for storing window thumbnails and icons
TRTCLocalRecordingParams	Local media file recording parameters
TRTCLocalStatistics	Local audio and video metrics
TRTCNetworkQosParam	Network bandwidth limit parameters
TRTCParams	Room entry parameters
TRTCPublishCdnUrl	Target URL for publishing to Tencent Cloud or a third-party CDN
TRTCPublishTarget	Publishing target
TRTCQualityInfo	Network quality
TRTCRemoteStatistics	Remote audio and video metrics
TRTCRenderParams	Rendering parameters of the video image
TRTCScreenCaptureProperty	Advanced control parameters for screen sharing
TRTCScreenCaptureSourceInfo	Target information for screen sharing (desktop only)
TRTCScreenCaptureSourceList	List of screen windows
TRTCSpeedTestParams	Network speed test parameters
TRTCSpeedTestResult	Network speed test results
TRTCStatistics	Network and performance metrics
TRTCStreamEncoderParam	Encoding parameters
TRTCStreamMixingConfig	Transcoding parameters
TRTCSwitchRoomConfig	Room switch parameters
TRTCTexture	Video texture data
TRTCUser	User to publish stream
TRTCVideoEncParam	Video codec parameters
TRTCVideoFrame	Video frame information
TRTCVideoLayout	Video layout for transcoded stream
TRTCVolumeInfo	Volume
TRTCWatermark	Watermark layout
AudioMusicParam	Background music playback control information
TXCameraCaptureParam	Camera capture parameters
TXDeviceInfo	Information about audio and video devices (desktop platform only)

API	Description
TRTCCloudVideoView	Video view window for displaying local video, remote video, or auxiliary stream.