Overview

Focus Mode

Font Size

Last updated: 2024-05-29 15:21:54

API Details
TRTC
1. ﻿TRTC is the main entry for TRTC SDK, providing APIs such as create trtc instance(TRTC.create), TRTC.getCameraList, TRTC.getMicrophoneList,  TRTC.isSupported.
2. ﻿trtc instance, provides the core capability for real-time audio and video calls.
Enter room trtc.enterRoom﻿
Exit room trtc.exitRoom﻿
Turn on camera trtc.startLocalVideo﻿
Turn on microphone trtc.startLocalAudio﻿
Turn off camera trtc.stopLocalVideo﻿
Turn off microphone trtc.stopLocalAudio﻿
Play remote video trtc.startRemoteVideo﻿
Stop playing remote video trtc.stopRemoteVideo﻿
Mute/unmute remote audio trtc.muteRemoteAudio﻿
TRTC Static Methods
Name
Description
﻿create﻿
Create a TRTC object for implementing functions such as entering a room, previewing, pushing, and pulling streams.
﻿setLogLevel﻿
Set the log output level It is recommended to set the DEBUG level during development and testing, which includes detailed prompt information. The default output level is INFO, which includes the log information of the main functions of the SDK.
﻿isSupported﻿
Check if the TRTC Web SDK is supported by the current browser
﻿getCameraList﻿
Returns the list of camera devices Note
﻿getMicrophoneList﻿
Returns the list of microphone devices Note
﻿getSpeakerList﻿
Returns the list of speaker devices For security reasons, the label and deviceId fields may be empty before the user authorizes access to the camera or microphone. Therefore, it is recommended to call this interface to obtain device details after the user authorizes access.
﻿setCurrentSpeaker﻿
Set the current speaker for audio playback
TRTC Methods
Name
Description
﻿enterRoom﻿
Enter a video call room.
﻿exitRoom﻿
Exit the current audio and video call room.
﻿switchRole﻿
Switches the user role, only effective in TRTC.TYPE.SCENE_LIVE interactive live streaming mode.
﻿destroy﻿
Destroy the TRTC instance
﻿startLocalAudio﻿
Start collecting audio from the local microphone and publish it to the current room.
﻿updateLocalAudio﻿
Update the configuration of the local microphone.
﻿stopLocalAudio﻿
Stop collecting and publishing the local microphone.
﻿startLocalVideo﻿
Start collecting video from the local camera, play the camera's video on the specified HTMLElement tag, and publish the camera's video to the current room.
﻿updateLocalVideo﻿
Update the local camera configuration.
﻿stopLocalVideo﻿
Stop capturing, previewing, and publishing the local camera.
﻿startScreenShare﻿
Start screen sharing.
﻿updateScreenShare﻿
Update screen sharing configuration
﻿stopScreenShare﻿
Stop screen sharing.
﻿startRemoteVideo﻿
Play remote video
﻿updateRemoteVideo﻿
Update remote video playback configuration
﻿stopRemoteVideo﻿
Used to stop remote video playback.
﻿muteRemoteAudio﻿
Mute a remote user and stop pulling audio data from that user. Only effective for the current user, other users in the room can still hear the muted user's voice.
﻿setRemoteAudioVolume﻿
Used to control the playback volume of remote audio.
﻿enableAudioVolumeEvaluation﻿
Enables or disables the volume callback.
﻿on﻿
Listen to the TRTC events﻿
﻿off﻿
Remove event listener
﻿getVideoSnapshot﻿
Get video snapshot
﻿getVideoTrack﻿
Get video track
﻿getAudioTrack﻿
Get audio track
﻿sendSEIMessage﻿
Send SEI message
﻿sendCustomMessage﻿
Send custom message
﻿startPlugin﻿
Start plugin
﻿updatePlugin﻿
Update plugin
﻿stopPlugin﻿
Stop plugin
Note
For FAQs, see Web.
Error Code
TRTC SDK defines 8 types of error codes. TRTC will throws error in the APIs and TRTC.EVENT.ERROR event and you can get the RtcError object for handling error.
Key
Code
Description
﻿INVALID_PARAMETER﻿
5000
The parameters passed in when calling the interface do not meet the API requirements.

Handling suggestion: Please check whether the passed-in parameters comply with the API specifications, such as whether the parameter type is correct.
﻿INVALID_OPERATION﻿
5100
The prerequisite requirements of the API are not met when calling the interface.

Handling suggestion: Please check whether the calling logic complies with the API prerequisite requirements according to the corresponding API document. 
﻿
For example: 
1. Switching roles before entering the room successfully.
2. The remote user and stream being played do not exist.
﻿ENV_NOT_SUPPORTED﻿
5200
The current environment does not support this function, indicating that the current browser does not support calling the corresponding API.

Handling suggestion: Usually, TRTC.isSupported can be used to perceive which capabilities the current browser supports. If the browser does not support it, you need to guide the user to use a browser that supports this capability. Reference: Detect Capabilities﻿
﻿DEVICE_ERROR﻿
5300
Capturing media devices failed.

The following interfaces will throw this error code when an exception occurs: startLocalVideo, updateLocalVideo, startLocalAudio, updateLocalAudio, startScreenShare, updateScreenShare
﻿
Handling suggestion: Guide the user to check whether the device has a camera and microphone, whether the system has authorized the browser, and whether the browser has authorized the page. It is recommended to increase the device detection process before entering the room to confirm whether the microphone and camera exist and can be captured normally before proceeding to the next call operation. Usually, this exception can be avoided after the device check.

Implementation reference: Detect Capabilities

If you need to distinguish more detailed exception categories, you can process according to the extraCode﻿
﻿SERVER_ERROR﻿
5400
Got server error.
﻿
Reasons: expired userSig, Tencent Cloud account arrears, TRTC service not enabled, etc.

Handling suggestion: Refer to the extraCode.
﻿OPERATION_FAILED﻿
5500
The exception that the SDK cannot solve after multiple retries under the condition of meeting the API call requirements, usually caused by browser or network problems.

The following interfaces will throw this error code when an exception occurs: enterRoom, startLocalVideo, startLocalAudio, startScreenShare, startRemoteVideo, switchRole

Handling suggestions:
Confirm whether the domain name and port required for communication meet your network environment requirements, refer to Handle Firewall Restriction.
Other issues need to be handled by engineers. Submit an issue in github.
﻿OPERATION_ABORT﻿
5998
The error code thrown when the API execution is aborted. 
﻿
When the API is called or repeatedly called without meeting the API lifecycle, the API will abort execution to avoid meaningless operations.

For example: Call enterRoom, startLocalVideo continuously, and call exitRoom without entering the room.

The following interfaces will throw this error code when an exception occurs: enterRoom, startLocalVideo, startLocalAudio, startScreenShare, startRemoteVideo, switchRole

Handling suggestions: Capture and identify this error code, then avoid unnecessary calls in business logic, or you can do nothing, because the SDK has done side-effect-free processing, you only need to identify and ignore this error code when catching it.
﻿UNKNOWN_ERROR﻿
5999
Unknown error.

Handling suggestions: Submit an issue in github.
Contact Us
﻿Submit an issue in github.
Contact us on telegram.
﻿

Help and Support

Was this page helpful?

You can also Contact sales or Submit a Ticket for help.

Help us improve! Rate your documentation experience in 5 mins.

Feedback

tencent cloud

Tencent Real-Time Communication

Overview

API Details

TRTC

TRTC Static Methods

TRTC Methods

Error Code

Contact Us

Help and Support

Name	Description
create	Create a TRTC object for implementing functions such as entering a room, previewing, pushing, and pulling streams.
setLogLevel	Set the log output level It is recommended to set the DEBUG level during development and testing, which includes detailed prompt information. The default output level is INFO, which includes the log information of the main functions of the SDK.
isSupported	Check if the TRTC Web SDK is supported by the current browser
getCameraList	Returns the list of camera devices Note
getMicrophoneList	Returns the list of microphone devices Note
getSpeakerList	Returns the list of speaker devices For security reasons, the label and deviceId fields may be empty before the user authorizes access to the camera or microphone. Therefore, it is recommended to call this interface to obtain device details after the user authorizes access.
setCurrentSpeaker	Set the current speaker for audio playback

Name	Description
enterRoom	Enter a video call room.
exitRoom	Exit the current audio and video call room.
switchRole	Switches the user role, only effective in TRTC.TYPE.SCENE_LIVE interactive live streaming mode.
destroy	Destroy the TRTC instance
startLocalAudio	Start collecting audio from the local microphone and publish it to the current room.
updateLocalAudio	Update the configuration of the local microphone.
stopLocalAudio	Stop collecting and publishing the local microphone.
startLocalVideo	Start collecting video from the local camera, play the camera's video on the specified HTMLElement tag, and publish the camera's video to the current room.
updateLocalVideo	Update the local camera configuration.
stopLocalVideo	Stop capturing, previewing, and publishing the local camera.
startScreenShare	Start screen sharing.
updateScreenShare	Update screen sharing configuration
stopScreenShare	Stop screen sharing.
startRemoteVideo	Play remote video
updateRemoteVideo	Update remote video playback configuration
stopRemoteVideo	Used to stop remote video playback.
muteRemoteAudio	Mute a remote user and stop pulling audio data from that user. Only effective for the current user, other users in the room can still hear the muted user's voice.
setRemoteAudioVolume	Used to control the playback volume of remote audio.
enableAudioVolumeEvaluation	Enables or disables the volume callback.
on	Listen to the TRTC events
off	Remove event listener
getVideoSnapshot	Get video snapshot
getVideoTrack	Get video track
getAudioTrack	Get audio track
sendSEIMessage	Send SEI message
sendCustomMessage	Send custom message
startPlugin	Start plugin
updatePlugin	Update plugin
stopPlugin	Stop plugin

Key	Code	Description
INVALID_PARAMETER	5000	The parameters passed in when calling the interface do not meet the API requirements. Handling suggestion: Please check whether the passed-in parameters comply with the API specifications, such as whether the parameter type is correct.
INVALID_OPERATION	5100	The prerequisite requirements of the API are not met when calling the interface. Handling suggestion: Please check whether the calling logic complies with the API prerequisite requirements according to the corresponding API document. For example: 1. Switching roles before entering the room successfully. 2. The remote user and stream being played do not exist.
ENV_NOT_SUPPORTED	5200	The current environment does not support this function, indicating that the current browser does not support calling the corresponding API. Handling suggestion: Usually, TRTC.isSupported can be used to perceive which capabilities the current browser supports. If the browser does not support it, you need to guide the user to use a browser that supports this capability. Reference: Detect Capabilities
DEVICE_ERROR	5300	Capturing media devices failed. The following interfaces will throw this error code when an exception occurs: startLocalVideo, updateLocalVideo, startLocalAudio, updateLocalAudio, startScreenShare, updateScreenShare Handling suggestion: Guide the user to check whether the device has a camera and microphone, whether the system has authorized the browser, and whether the browser has authorized the page. It is recommended to increase the device detection process before entering the room to confirm whether the microphone and camera exist and can be captured normally before proceeding to the next call operation. Usually, this exception can be avoided after the device check. Implementation reference: Detect Capabilities If you need to distinguish more detailed exception categories, you can process according to the extraCode
SERVER_ERROR	5400	Got server error. Reasons: expired userSig, Tencent Cloud account arrears, TRTC service not enabled, etc. Handling suggestion: Refer to the extraCode.
OPERATION_FAILED	5500	The exception that the SDK cannot solve after multiple retries under the condition of meeting the API call requirements, usually caused by browser or network problems. The following interfaces will throw this error code when an exception occurs: enterRoom, startLocalVideo, startLocalAudio, startScreenShare, startRemoteVideo, switchRole Handling suggestions: Confirm whether the domain name and port required for communication meet your network environment requirements, refer to Handle Firewall Restriction. Other issues need to be handled by engineers. Submit an issue in github.
OPERATION_ABORT	5998	The error code thrown when the API execution is aborted. When the API is called or repeatedly called without meeting the API lifecycle, the API will abort execution to avoid meaningless operations. For example: Call enterRoom, startLocalVideo continuously, and call exitRoom without entering the room. The following interfaces will throw this error code when an exception occurs: enterRoom, startLocalVideo, startLocalAudio, startScreenShare, startRemoteVideo, switchRole Handling suggestions: Capture and identify this error code, then avoid unnecessary calls in business logic, or you can do nothing, because the SDK has done side-effect-free processing, you only need to identify and ignore this error code when catching it.
UNKNOWN_ERROR	5999	Unknown error. Handling suggestions: Submit an issue in github.