Last updated: 2023-10-09 11:54:15Download PDF
Enters a room. If the room does not exist, the system will create one automatically.
Exits a room.
Switches roles. This API works only in live streaming scenarios (
Sets the audio/video data receiving mode, which must be set before room entry to take effect.
Requests a cross-room call (anchor competition).
Exits a cross-room call.
Starts pushing to Tencent Cloud’s live streaming CDN.
Stops pushing to Tencent Cloud’s live streaming CDN.
Starts relaying to the live streaming CDN of a non-Tencent Cloud vendor.
Stops relaying to the live streaming CDN of a non-Tencent Cloud vendor.
Sets On-Cloud MixTranscoding parameters.
Enables preview of the local video.
Stops local video capturing and preview.
Pauses/Resumes pushing local video data.
Starts displaying the image of a remote user.
Stops displaying the video image of a remote user and pulling the user’s video stream.
Stops displaying the video images of all users and pulling their video streams.
Pauses/Resumes receiving a specified remote video stream.
Pauses/Resumes receiving all remote video streams.
Sets video encoder parameters.
Sets QoS control parameters.
Sets the rendering mode of the local image.
Sets remote image parameters.
Sets the rotation of encoded video images, i.e., images presented to remote users and recorded by the server.
Sets the mirror mode of encoded images.
Sets the adaptation mode of the G-sensor.
Enables the dual-channel (big and small images) encoding mode.
Switches between the small and big images of a specified user.
Takes a video screenshot.
Enables local audio capturing and upstream data transfer.
Disables local audio capturing and upstream data transfer.
Mutes/Unmutes the local audio.
Sets the image to be pushed when local video pushing is paused.
Sets the audio route.
Mutes/Unmutes the audio of a specified remote user.
Mutes/Unmutes all users.
Sets the SDK capturing volume.
Gets the SDK capturing volume.
Sets the SDK playback volume.
Gets the SDK playback volume.
Enables volume reminders.
Starts audio recording.
Stops audio recording.
Sets the system volume type used during calls.
Device management APIs
Beauty filter APIs
Music and voice effect APIs
Custom message sending APIs
Network testing APIs
Callback APIs for the TRTC video call feature
Error and warning event callback APIs
Error callback. This indicates that the SDK encountered an irrecoverable error. Such errors must be listened for, and UI messages should be displayed to users if necessary.
Warning callback. This alerts you to non-serious problems such as lag or recoverable decoding failure.
Room event callback APIs
Callback of room entry
Callback of room exit
Callback of role switching
Callback of the result of requesting a cross-room call (anchor competition)
Callback of the result of ending a cross-room call (anchor competition)
Callback of the result of room switching (
User event callback APIs
Callback of the entry of a user
Callback of the exit of a user
Callback of whether a remote user has a playable primary image (usually the image of the camera)
Callback of whether a remote user has a playable substream image (usually the screen sharing image)
Callback of whether a remote user has playable audio
Callback of rendering the first video frame of the local user or a remote user
Callback of playing the first audio frame of a remote user. No notifications are sent for local audio.
Callback of sending the first local video frame
Callback of sending the first local audio frame
Callback APIs for background music playback
Callback APIs for background music playback
Callback APIs for statistics on network quality and technical metrics
Server event callback APIs
Callback of the disconnection of the SDK from the server
Callback of the SDK trying to connect to the server again
Callback of the reconnection of the SDK to the server
Callback of server speed test results. The SDK tests the speed of multiple server addresses, and the result of each test is returned through this callback.
Hardware event callback APIs
Custom message receiving callback APIs
Callback APIs for CDN relayed push
Callback of starting to push to Tencent Cloud’s live streaming CDN, which corresponds to the
Callback of stopping pushing to Tencent Cloud’s live streaming CDN, which corresponds to the
Callback of the completion of starting relayed push to CDNs
Callback of the completion of stopping relayed push to CDNs
Callback of setting On-Cloud MixTranscoding parameters, which corresponds to the
Screen sharing callback APIs
Callback of starting screen sharing
Callback of pausing screen sharing via the calling of
Callback of resuming screen sharing via the calling of
Callback of stopping screen sharing
Screenshot callback API
Callback of the completion of a screenshot
Definitions of Key Classes
Variables for key class definitions
Room entry parameters
Room switching parameters
Video encoding parameters
QoS control parameters
Remote image parameters
Position of the image of each channel in On-Cloud MixTranscoding
On-Cloud MixTranscoding configuration
Definitions of voice changing types (little girl, middle-aged man, metal, foreign accent, etc.)
Definitions of reverb effect types (karaoke, room, hall, low and deep, resonant, etc.)
Parameters for music and voice effect setting APIs
Audio recording parameters
CDN relayed push parameters