Optional Readonly channelThe current channel name.
The value is undefined if the local user has not joined a channel.
Readonly connectionConnection state between the SDK and the Agora server.
Readonly localSince
4.0.0
The list of the local tracks that the local user is publishing.
Readonly remoteA list of the remote users in the channel, each of which includes the user ID and the corresponding track information.
The list is empty if the local user has not joined a channel.
Optional Readonly uidThe ID of the local user.
The value is undefined if the local user has not joined a channel.
Allows a user to join a channel.
Users in the same channel can talk to each other.
When joining a channel, the [AgoraRTCClient.on("connection-state-change")]__type callback is triggered on the local client.
After joining a channel, if the user is in the communication profile, or is a host in the Live Broadcast profile, the [AgoraRTCClient.on("user-joined")]__type callback is triggered on the remote client.
The App ID of your Agora project.
A string that provides a unique channel name for the call. The length must be within 64 bytes. Supported character scopes:
The token generated at your server:
Optional uid: null | UIDThe user ID, an integer or a string, ASCII characters only. Ensure this ID is unique. If you set the uid to null, the Agora server assigns a number uid and returns it in the Promise object.
Note:
- All users in the same channel should have the same type (number or string) of
uid.- You can use string UIDs to interoperate with the Native SDK 2.8 or later. Ensure that the Native SDK uses the User Account to join the channel. See Use String User Accounts.
- To ensure the data accuracy in Agora Analytics, Agora recommends that you specify
uidfor each user and ensure it is unique.
A Promise object with the user ID.
uid.uid.uid parameter empty or set it as null, the Agora server assigns a number uid and returns it.Leaves a channel.
When leaving the channel, the [AgoraRTCClient.on("connection-state-change")]IAgoraRTCClient.event_connection_state_change callback is triggered on the local client.
When a user (in the communication profile) or a host (in the live-broadcast profile) leaves the channel, the [AgoraRTCClient.on("user-left")]IAgoraRTCClient.event_user_left callback is triggered on each remote client in the channel.
Publishes local audio and/or video tracks to a channel.
After publishing the local tracks, the [AgoraRTCClient.on("user-published")]__type callback is triggered on the remote client.
Note:
- In an interactive live streaming, call setClientRole to set the user role as the host before calling this method.
- You can call this method multiple times to add tracks for publishing.
- An
AgoraRTCClientobject can publish multiple audio tracks. The SDK automatically mixes the audio tracks into one audio track. Exception: Safari does not support publishing multiple audio tracks on versions earlier than Safari 12.- An
AgoraRTCClientobject can publish only one video track. If you want to switch the published video track, for example, from a camera video track to a scree-sharing video track, you must unpublish the published video track.
Local tracks created by [AgoraRTC.createMicrophoneAudioTrack]createMicrophoneAudioTrack / [AgoraRTC.createCameraVideoTrack]createCameraVideoTrack or other methods.
Subscribes to the audio and/or video tracks of a remote user.
await client.subscribe(user，"audio");
user.audioTrack.play();
The remote user.
The media type of the tracks to subscribe to.
"video": Subscribe to the video track only."audio": Subscribe to the audio track only.When the subscription succeeds, the SDK adds the subscribed tracks to [user.audioTrack]audioTrack and [user.videoTrack]videoTrack. You can go on to call [audioTrack.play]play or [videoTrack.play]play to play the tracks.
The
Promiseobject throws theTRACK_IS_NOT_PUBLISHEDerror if the specified tracks do not exist.
Subscribes to the audio and/or video tracks of a remote user.
await client.subscribe(user，"audio");
user.audioTrack.play();
The remote user.
The media type of the tracks to subscribe to.
"video": Subscribe to the video track only."audio": Subscribe to the audio track only.When the subscription succeeds, the SDK adds the subscribed tracks to [user.audioTrack]audioTrack and [user.videoTrack]videoTrack. You can go on to call [audioTrack.play]play or [videoTrack.play]play to play the tracks.
The
Promiseobject throws theTRACK_IS_NOT_PUBLISHEDerror if the specified tracks do not exist.
Subscribes to the audio and/or video tracks of a remote user.
await client.subscribe(user，"audio");
user.audioTrack.play();
The remote user.
The media type of the tracks to subscribe to.
"video": Subscribe to the video track only."audio": Subscribe to the audio track only."datachannel": Reserved for future use.Optional channelId: numberWhen the subscription succeeds, the SDK adds the subscribed tracks to [user.audioTrack]audioTrack and [user.videoTrack]videoTrack. You can go on to call [audioTrack.play]play or [videoTrack.play]play to play the tracks.
The
Promiseobject throws theTRACK_IS_NOT_PUBLISHEDerror if the specified tracks do not exist.
Unpublishes the local audio and/or video tracks.
After the local client unpublishes, the [AgoraRTCClient.on("user-unpublished")]__type callback is triggered on each remote client in the channel.
Note: In an interactive live streaming, after a host unpublishes the local tracks, the SDK does not automatically change the role of this host to the audience. To change the user role, you must call setClientRole.
Optional tracks: ILocalTrack | ILocalTrack[]The tracks to unpublish. If left empty, all the published tracks are unpublished.
Unsubscribes from the audio and/or video tracks of a remote user.
The remote user.
Optional mediaType: "audio" | "video" | "datachannel"The media type of the tracks to unsubscribe from:
"video": Unsubscribe from the video track only.“audio”: Unsubscribe from the audio track only."datachannel": Reserved for future use.Optional channelId: numberReserved for future use.
The Promise object throws the TRACK_IS_NOT_SUBSCRIBED error if the specified tracks do not exist.
Starts relaying media streams across channels.
After this method call, the SDK triggers the following callbacks:
state 3. Refer to code for the error code and call this method again.code 4, reporting that the SDK starts relaying the media stream to the destination channel.Note:
- Contact sales-us@agora.io to enable this function.
- We do not support string user IDs in this API.
- Call this method only after joining a channel.
- In a live-broadcast channel, only a host can call this method.
- To call this method again after it succeeds, you must call stopChannelMediaRelay to quit the current relay.
client.startChannelMediaRelay(config).then(() => {
console.log("startChannelMediaRelay success");
}).catch(e => {
console.log("startChannelMediaRelay failed", e);
})
Configurations of the media stream relay.
A Promise object, which is resolved if the media relay starts successfully.
Updates the destination channels for media stream relay.
After the channel media relay starts, if you want to relay the media stream to more channels, or leave the current relay channel, you can call this method.
Note:
- Call this method after startChannelMediaRelay.
- You can add a maximum of four destination channels to a relay.
Configurations of the media stream relay.
A Promise object, which is resolved if the update succeeds. If the update fails, the media relay state is reset, and you need to call startChannelMediaRelay again to restart the relay.
Enables dual-stream mode.
Enables dual-stream mode for the local stream. Dual streams are a hybrid of a high-quality video stream and a low-quality video stream:
Note:
enableDualStreamdoes not apply to the audio-only mode.- On Android Chrome, the Web SDK cannot send high-quality and low-quality streams in H.264.
client.enableDualStream().then(() => {
console.log("Enable Dual stream success!");
}).catch(err => {
console.log(err);
})
Sets the video profile of the low-quality video stream.
If you have enabled the dual-stream mode by calling enableDualStream, use this method to set the low-quality video stream profile.
If you do not set the low-quality video stream profile, the SDK assigns the default values based on your stream video profile.
Note:
- Firefox: Frame rate settings do not take effect. The browser sets the frame rate as 30 fps.
- iOS Safari: The browser does not support setting
LowStreamParameter.bitrate. The resolution of the low-quality stream must be proportional to the resolution of the high-quality stream.- Due to limitations of some devices and browsers, the resolution you set may get adjusted by the browser. In this case, billings are calculated based on the actual resolution.
The video profile of the low-quality video stream.
Sets the video type of all of the remote stream.
If a remote user enables dual-stream mode, after using this method, local client will subscribe the specified streamType by default. The local client subscribes to the high-quality video stream by default.
- Agora suggests calling
setRemoteDefaultVideoStreamTypebefore joining the channel.- The method call of setRemoteVideoStreamType to set the video stream type of a specified remote user overrides this method.
The remote video stream type:
Sets which video stream of a remote user to subscribe to.
If a remote user enables dual-stream mode, the user sends a hybrid of a high-quality video stream and a low-quality video stream. Use this method to set which video stream to subscribe to. The local client subscribes to the high-quality video stream by default.
This method works only if the remote user has enabled dual-stream mode (enableDualStream). If both this method and setStreamFallbackOption are called, the actual video stream that the user subscribes to depends on the fallback option set in setStreamFallbackOption.
The ID of the remote user.
The remote video stream type:
Sets the stream fallback option.
Use this method to set the fallback option for the subscribed video stream. Under poor network conditions, the SDK can subscribe to the low-quality video stream or only to the audio stream.
If the auto-fallback option is enabled, the SDK triggers the [AgoraRTCClient.on("stream-type-changed")]__type callback when the remote stream changes from a high-quality video stream to a low-quality video stream or vice versa, and triggers the [AgoraRTCClient.on("stream-fallback")]__type callback when the remote stream changes from a video stream to an audio stream or vice versa.
This method works only if the remote user has enabled the dual-stream mode by enableDualStream.
The ID of the remote user.
The fallback option. See RemoteStreamFallbackType for details.
Sets the video layout and audio for CDN live streaming.
Ensure that you enable the RTMP Converter service before using this function.
Configurations for live transcoding. See LiveStreamingTranscodingConfig for details.
Publishes the local stream to the CDN.
See Push Streams to the CDN for details.
Note:
- This method adds only one stream HTTP/HTTPS URL address each time it is called.
- Pushing streams to the CDN is not supported on mobile devices.
The CDN streaming URL in the RTMP format. ASCII characters only.
Optional transcodingEnabled: booleanWhether to enable live transcoding. Transcoding sets the audio and video profiles and the picture-in-picture layout for the stream to be pushed to the CDN. It is often used to combine the audio and video streams of multiple hosts in a CDN live stream.
If set as
true, setLiveTranscoding must be called before this method.
true: Enable transcoding.false: (Default) Disable transcoding.Enables the volume indicator.
This method enables the SDK to regularly report the local and remote users who are speaking and their volumes.
After the volume indicator is enabled, the SDK triggers the [AgoraRTCClient.on("volume-indicator")]__type callback to report the volumes every two seconds, regardless of whether there are active speakers in the channel.
If the local user leaves the channel and rejoins the channel, you need to call
enableAudioVolumeIndicatoragain.
client.enableAudioVolumeIndicator();
client.on("volume-indicator", volumes => {
volumes.forEach((volume, index) => {
console.log(`${index} UID ${volume.uid} Level ${volume.level}`);
});
})
Since
4.1.0
Gets the statistics of a local audio track.
Since
4.1.0
Gets the statistics of a local video track.
Note: You cannot get the
encodeDelayproperty on iOS.
Gets the statistics of the call.
The statistics of the call.
Since
4.1.0
Gets the statistics of remote audio tracks.
Note: The statistics are calculated after subscribing the remote stream, which may take at most 3 seconds. You can call this method periodically.
Since
4.2.0
Gets the network quality of all the remote users to whom the local user subscribes.
Since
4.1.0
Gets the statistics of remote video tracks.
Note: The statistics are calculated after subscribing the remote stream, which may take at most 3 seconds. You can call this method periodically.
Since
4.11.0
Subscribes to the audio and/or video tracks of multiple remote users at one time.
const result = await client.massSubscribe([{user:userA, mediaType:'audio'}, {user: userB, mediaType:'audio'}]);
for(const {track, mediaType, error} of result) {
if(error) {
console.error(error);
continue;
}
if(track) {
if(mediaType === 'audio') {
track.play();
}else{
track.play(document.querySelector('.video-container'));
}
}
}
The list of remote users to subscribe to. Each list entry contains the following information:
user: The remote user. See [AgoraRTCRemoteUser]IAgoraRTCRemoteUser.mediaType: The media type of the tracks to subscribe to."video": Subscribe to this user's video track."audio": Subscribe to this user's audio track.Normally, the returned list has the same length and order as subscribeList, and each list entry contains the following information:
user: The remote user. See [AgoraRTCRemoteUser]IAgoraRTCRemoteUser.mediaType: The media type of the tracks subscribed to:"video": The video track is subscribed to."audio": The audio track is subscribed to.track: The remote track. See [RemoteTrack]IRemoteTrack.error: The error message. If subscription of a user's audio and/or video tracks fails, the error message is returned through this parameter.Since
4.11.0
Unsubscribes from the audio and/or video tracks of multiple remote users at one time.
client.massUnsubscribe([{user:userA}, {user: userB}]);
The list of remote users to unsubscribe from. Each list entry contains the following information:
user: The remote user. See [AgoraRTCRemoteUser]IAgoraRTCRemoteUser.mediaType: The media type of the tracks to unsubscribe from."video": Unsubscribe from this user's video track."audio": Unsubscribe from this user's audio track.The event name.
See [connection-state-change]__type.
Occurs when the state of the connection between the SDK and the server changes.
The current connection state.
The previous connection state.
Optional reason: ConnectionDisconnectedReasonThe reason of disconnection if curState is "DISCONNECTED".
IAgoraRTCClient
Events
The event name.
See [user-joined]__type.
Occurs when a remote user or host joins the channel.
The SDK triggers this callback when one of the following situations occurs:
Information of the remote user.
IAgoraRTCClient
Events
The event name.
See [user-left]__type.
Occurs when a remote user becomes offline.
The SDK triggers this callback when one of the following situations occurs:
In live-broadcast channels, the SDK triggers this callback only when a host goes offline.
Information of the user who is offline.
Reason why the user has gone offline.
"Quit": The user calls leave and leaves the channel."ServerTimeOut": The user has dropped offline."BecomeAudience": The client role is switched from host to audience.IAgoraRTCClient
Events
The event name.
See [user-published]__type.
Occurs when a remote user publishes an audio or video track.
You can subscribe to and play the audio or video track in this callback. See subscribe and [RemoteTrack.play]play.
The SDK also triggers this callback to report the existing tracks in the channel when a user joins the channel.
client.on("user-published", async (user, mediaType) => {
await client.subscribe(user, mediaType);
if (mediaType === "video") {
console.log("subscribe video success");
user.videoTrack.play("xxx");
}
if (mediaType === "audio") {
console.log("subscribe audio success");
user.audioTrack.play();
}
})
Information of the remote user.
Type of the track.
"audio": The remote user publishes an audio track."video": The remote user publishes a video track."datachannel": Reserved for future use.Optional config: IDataChannelConfigReserved for future use.
IAgoraRTCClient
Events
The event name.
See [user-unpublished]__type.
Occurs when a remote user unpublishes an audio or video track.
Information of the remote user.
Type of the track.
"audio": The remote user unpublishes an audio track."video": The remote user unpublishes a video track.Optional config: IDataChannelConfigIAgoraRTCClient
Events
The event name.
See [user-info-updated]__type.
Reports the state change of users.
In most cases, you only need to listen for [user-published]IAgoraRTCClient.event_user_published and [user-unpublished]IAgoraRTCClient.event_user_unpublished events for operations including subscribing, unsubscribing, and displaying whether the remote user turns on the camera and microphone. You do not need to pay special attention to user states since the SDK automatically handles user states.
This event indicating the media stream of a remote user is active does not necessarily mean that the local user can subscribe to this remote user. The local user can subscribe to a remote user only when receiving the [user-published]IAgoraRTCClient.event_user_published event.
The ID of the remote user.
The current user state. Note that the "enable-local-video" and "disable-local-video" states are only for synchronizing states with the clients that integrate the RTC Native SDK.
IAgoraRTCClient
Events
The event name.
See [media-reconnect-start]__type.
Occurs when the SDK starts to reestablish the media connection for publishing and subscribing.
The ID of the user who reestablishes the connection. If it is the local uid, the connection is for publishing; if it is a remote uid, the connection is for subscribing.
IAgoraRTCClient
Events
The event name.
See [media-reconnect-end]__type.
Occurs when the SDK ends reestablishing the media connection for publishing and subscribing.
The ID of the user who reestablishes the connection. If it is the local uid, the connection is for publishing; if it is a remote uid, the connection is for subscribing.
IAgoraRTCClient
Events
The event name.
See [stream-type-changed]__type.
Occurs when the type of a remote video stream changes.
The SDK triggers this callback when a high-quality video stream changes to a low-quality video stream, or vice versa.
The ID of the remote user.
The new stream type:
IAgoraRTCClient
Events
The event name.
See [stream-fallback]__type.
Occurs when a remote video stream falls back to an audio stream due to unreliable network conditions or switches back to video after the network conditions improve.
The ID of the remote user.
Whether the remote media stream falls back or recovers:
"fallback": The remote media stream falls back to audio-only due to unreliable network conditions."recover": The remote media stream switches back to the video stream after the network conditions improve.IAgoraRTCClient
Events
The event name.
See [channel-media-relay-state]__type.
Occurs when the state of the media stream relay changes.
The SDK reports the state and error code of the current media relay with this callback.
If the media relay is in an abnormal state, you can find the error code in ChannelMediaRelayError (for example if the token has expired, or repeated reconnection attempts fail.)
The state of the media relay.
The error code.
IAgoraRTCClient
Events
The event name.
See [channel-media-relay-event]__type.
Reports events during a media stream relay.
The event code for a media stream relay.
IAgoraRTCClient
Events
The event name.
See [volume-indicator]__type.
Reports all the speaking local and remote users and their volumes.
It is disabled by default. You can enable this callback by calling enableAudioVolumeIndicator. If enabled, it reports the users' volumes every two seconds regardless of whether there are users speaking.
The volume is an integer ranging from 0 to 100. Usually a user with volume above 60 is a speaking user.
client.on("volume-indicator", function(result){
result.forEach(function(volume, index){
console.log(`${index} UID ${volume.uid} Level ${volume.level}`);
});
});
An object consisting of the following properties:
IAgoraRTCClient
Events
The event name.
See [crypt-error]__type.
Occurs when decryption fails.
The SDK triggers this callback when the decryption fails during the process of subscribing to a stream. The failure is usually caused by incorrect encryption settings. See setEncryptionConfig for details.
IAgoraRTCClient
Events
The event name.
See [token-privilege-will-expire]__type.
Occurs 30 seconds before a token expires.
You must request a new token from your server and call renewToken to pass a new token as soon as possible.
client.on("token-privilege-will-expire", async function(){
// After requesting a new token
await client.renewToken(token);
});
IAgoraRTCClient
Events
The event name.
See [token-privilege-did-expire]__type.
Occurs when the token expires.
You must request a new token from your server and call join to use the new token to join the channel.
client.on("token-privilege-did-expire", async () => {
// After requesting a new token
await client.join(<APPID>, <CHANNEL NAME>, <NEW TOKEN>);
});
IAgoraRTCClient
Events
The event name.
See [network-quality]__type.
Reports the network quality of the local user.
After the local user joins the channel, the SDK triggers this callback to report the uplink and downlink network conditions of the local user once every two second.
Agora recommends listening for this event and displaying the network quality.
The network quality of the local user.
IAgoraRTCClient
Events
The event name.
See [live-streaming-error]__type.
Occurs when an error occurs in CDN live streaming.
After the method call of startLiveStreaming succeeds, the SDK triggers this callback when errors occur during CDN live streaming.
You can visit err.code to get the error code. The errors that you may encounter include:
LIVE_STREAMING_INVALID_ARGUMENT: Invalid argument.LIVE_STREAMING_INTERNAL_SERVER_ERROR: An error occurs in Agora's streaming server.LIVE_STREAMING_PUBLISH_STREAM_NOT_AUTHORIZED: The URL is occupied.LIVE_STREAMING_TRANSCODING_NOT_SUPPORTED: Sets the transcoding parameters when the transcoding is not enabled.LIVE_STREAMING_CDN_ERROR: An error occurs in the CDN.LIVE_STREAMING_INVALID_RAW_STREAM: Timeout for the CDN live streaming. Please check your media stream.The URL of the CDN live streaming that has errors.
The error details.
IAgoraRTCClient
Events
The event name.
See [live-streaming-warning]__type.
Occurs when a warning occurs in CDN live streaming.
After the method call of startLiveStreaming succeeds, the SDK triggers this callback when warnings occur during CDN live streaming.
You can visit err.code to get the warning code. The warnings that you may encounter include:
LIVE_STREAMING_WARN_STREAM_NUM_REACH_LIMIT: Pushes stremas to more than 10 URLs.LIVE_STREAMING_WARN_FAILED_LOAD_IMAGE: Fails to load the background image or watermark image.LIVE_STREAMING_WARN_FREQUENT_REQUEST: Pushes stremas to the CDN too frequently.The URL of the CDN live streaming that has warnings.
The warning details.
IAgoraRTCClient
Events
The event name.
See [exception]__type.
Reports exceptions in the channel.
Exceptions are not errors, but usually reflect quality issues.
This callback also reports recovery from an exception.
Each exception corresponds to a recovery event.
Exception
| Code | Message | Exception |
|---|---|---|
| 1001 | FRAMERATE_INPUT_TOO_LOW | Captured video frame rate is too low |
| 1002 | FRAMERATE_SENT_TOO_LOW | Sent video frame rate is too low |
| 1003 | SEND_VIDEO_BITRATE_TOO_LOW | Sent video bitrate is too low |
| 1005 | RECV_VIDEO_DECODE_FAILED | Decoding received video fails |
| 2001 | AUDIO_INPUT_LEVEL_TOO_LOW | Sent audio volume is too low |
| 2002 | AUDIO_OUTPUT_LEVEL_TOO_LOW | Received audio volume is too low |
| 2003 | SEND_AUDIO_BITRATE_TOO_LOW | Sent audio bitrate is too low |
| 2005 | RECV_AUDIO_DECODE_FAILED | Decoding received audio fails |
Recoveries
| Code | Message | Recovery |
|---|---|---|
| 3001 | FRAMERATE_INPUT_TOO_LOW_RECOVER | Captured video frame rate recovers |
| 3002 | FRAMERATE_SENT_TOO_LOW_RECOVER | Sent video frame rate recovers |
| 3003 | SEND_VIDEO_BITRATE_TOO_LOW_RECOVER | Sent video bitrate recovers |
| 3005 | RECV_VIDEO_DECODE_FAILED_RECOVER | Decoding received video recovers |
| 4001 | AUDIO_INPUT_LEVEL_TOO_LOW_RECOVER | Sent audio volume recovers |
| 4002 | AUDIO_OUTPUT_LEVEL_TOO_LOW_RECOVER | Received audio volume recovers |
| 4003 | SEND_AUDIO_BITRATE_TOO_LOW_RECOVER | Sent audio bitrate recovers |
| 4005 | RECV_AUDIO_DECODE_FAILED_RECOVER | Decoding received audio recovers |
IAgoraRTCClient
Events
The event name.
See [is-using-cloud-proxy]__type.
Since
4.4.0
The SDK triggers this callback to indicate whether the media stream is forwarded by the Agora cloud proxy service.
Whether the media stream is forwarded by the Agora cloud proxy service.
true: Forwarded by the Agora cloud proxy service.false: Not forwarded by the Agora cloud proxy service.IAgoraRTCClient
Events
DEPRECATED from 4.19.0.
The event name.
See [join-fallback-to-proxy]__type.
DEPRECATED from v4.19.0. This callback will not be triggered because the SDK stops using proxy to ensure connectivity.
Occurs when the SDK automatically switches to TCP/TLS 443.
As of v4.11.0, if the SDK fails in the attempt to directly connect to Agora SD-RTN™ after you call [[join]], the SDK automatically switches to TCP/TLS 443 in order to ensure connectivity.
The server address used after the switch.
IAgoraRTCClient
Events
The event name.
See [published-user-list]__type.
Since
4.11.0
If you enable support for 128 hosts in a channel, this callback is triggered when [[join]] is called. The callback reports remote users who publish audio and/or video tracks in the channel.
Note:
- For the
published-user-listto be triggered, every user in the channel must use a number as their user ID (uid).published-user-listhas the following impacts on [AgoraRTCClient.on("user-joined")]__type and [AgoraRTCClient.on("user-published")]__type:
- If you listen for the
published-user-listevent, users reported by thepublished-user-listcallback are not reported byuser-joinedanduser-published.- If you do not listen for the
published-user-listevent, theuser-joinedanduser-publishedcallbacks are not affected.
The remote user.
IAgoraRTCClient
Events
The event name.
See [content-inspect-connection-state-change]__type.
The event name.
See [content-inspect-error]__type.
Optional error: AgoraRTCErrorWhen the specified event happens, the SDK triggers the callback that you pass.
The event name.
See [image-moderation-connection-state-change]__type.
When the specified event happens, the SDK triggers the callback that you pass.
The event name.
The callback function.
Renews the token.
The token expires after a set time once token is enabled. When the SDK triggers the [AgoraRTCClient.on("token-privilege-will-expire")]__type callback, call this method to pass a new token. Otherwise the SDK disconnects from the server.
The new token.
Reports customized messages to Agora's data center.
Temporarily, Agora supports reporting a maximum of 20 message pieces within 5 seconds.
Messages. You can report multiple messages one time.
client.sendCustomReportMessage({
reportId: "id1", category: "category1", event: "custom", label: "label1", value: 0,
}).then(() => {
console.log("send custom report success");
}).catch(e => {
console.error("send custom report error");
});
Sets the user role and level in a live streaming (when [mode]mode is "live").
"host" or "audience". A host can publish and subscribe to streams, while an audience member can only subscribe to streams. The default role in a live streaming is "audience". Before publishing tracks, you must call this method to set the user role as "host".Note:
- When [mode]mode is
"rtc", this method does not take effect and all users are"host"by default.- If the local client switches the user role after joining a channel, the SDK triggers the [AgoraRTCClient.on("user-joined")]__type or [AgoraRTCClient.on("user-left")]__type callback on the remote client.
- To switch the user role to
"audience"after calling publish, call unpublish first. Otherwise the method call fails and throws an exception.
The role of the user.
Optional options: ClientRoleOptionsThe detailed options of a user, including user level.
Sets the encryption configurations.
Use this method to enable the built-in encryption before joining a channel.
If the encryption configurations are incorrect, the SDK triggers the [AgoraRTCClient.on("crypt-error")]__type callback when publishing tracks or subscribing to tracks.
Notes:
- All users in a channel must use the same encryption mode, secret, and salt.
- You must call this method before joining a channel, otherwise the method call does not take effect and encryption is not enabled.
- As of v4.7.0, after a user leaves the channel, the SDK automatically disables the built-in encryption. To re-enable the built-in encryption, call this method before the user joins the channel again.
- Do not use this method for CDN live streaming.
The encryption mode.
The encryption secret. ASCII characters only. When a user uses a weak secret, the SDK outputs a warning message to the Web Console and prompts the users to set a strong secret. A strong secret must contain at least eight characters and be a combination of uppercase and lowercase letters, numbers, and special characters. Due to browser encryption algorithm limitations, the secret length cannot exceed 62 characters. Agora recommends you use OpenSSL to generate the secret on your server. For details, see Media Stream Encryption.
Optional salt: Uint8ArrayThe salt. Only valid when you set the encryption mode as "aes-128-gcm2" or "aes-256-gcm2". Agora recommends you use OpenSSL to generate the salt on your server. For details, see Media Stream Encryption.
Disables the third-party video moderation service.
Default is false and can only be set to false.
Enables and configures the third-party video moderation service.
After calling this method, the SDK triggers the [image-moderation-connection-state-change]__type callback, and captures the snapshots of the locally sent video to send to the third-party service provider for moderation.
- Before calling this method, make sure the following requirements are met:
- You have activated the third-party video moderation service.
- The local user has joined the channel, and the local video track has been published and enabled.
Default is true and can only be set to true.
Configuration for the video moderation service. See ImageModerationConfiguration.
Deploys your proxy server.
Do not use this method and startProxyServer together. They have the following differences:
setProxyServer: This method allows you to use a custom proxy server
for purposes including signaling transmission, log uploading, and event reporting. But it cannot be used for media transmission.startProxyServer: This method provides Agora's cloud proxy service,
which handles media and signaling transmission with simple setup. For more
information, refer to [Using Cloud Proxy Service](https://docs.agora.io/en/
video-call-4.x/cloud_proxy_web_ng?platform=Web).Note:
- Call this method before join.
- Proxy services by different service providers may result in slow performance if you are using the Firefox browser. Therefore, Agora recommends using the same service provider for the proxy services. If you use different service providers, Agora recommends not using the Firefox browser.
Your proxy server domain name. ASCII characters only.
Enables cloud proxy.
You must call this method before joining the channel or after leaving the channel.
For the extra settings required for using the cloud proxy service, see Use Cloud Proxy.
Optional mode: numberCloud proxy mode:
3: The cloud proxy for the UDP protocol, that is, the Force UDP cloud proxy mode. In this mode, the SDK always transmits data over UDP.5: The cloud proxy for the TCP (encryption) protocol, that is, the Force TCP cloud proxy mode. In this mode, the SDK always transmits data over TLS 443.Note: As of v4.15.0, the default value of
modeis3.
An interface providing the local client with basic functions for a voice or video call, such as joining a channel, publishing tracks, or subscribing to tracks.
An
AgoraRTCClientobject is created by the [[createClient]] method.