Interface IAgoraRTCClient

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 AgoraRTCClient object is created by the createClient method.

Hierarchy

  • EventEmitter
    • IAgoraRTCClient

Index

Events

channel-media-relay-event

  • Reports events during a media stream relay.

    Parameters

    Returns void

channel-media-relay-state

  • 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.)

    Parameters

    Returns void

connection-state-change

  • Occurs when the state of the connection between the SDK and the server changes.

    Parameters

    Returns void

crypt-error

  • crypt-error(): void
  • 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.

    Returns void

exception

  • exception(event: object): void
  • 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

    Parameters

    • event: object
      • code: number

        The event code.

      • msg: string

        The event message.

      • uid: UID

        The ID of the user who has experienced the exception or recovery event.

    Returns void

is-using-cloud-proxy

  • is-using-cloud-proxy(isUsingProxy: boolean): void
  • Since
       4.4.0

    The SDK triggers this callback to indicate whether the media stream is forwarded by the Agora cloud proxy service.

    • Earlier than v4.10.0: The callback is triggered after the method call of publish succeeds.
    • v4.10.0 and later: The callback is triggered after the method call of join succeeds.

    Parameters

    • isUsingProxy: boolean

      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.

    Returns void

join-fallback-to-proxy

  • join-fallback-to-proxy(proxyServer: string): void
  • Since
       4.9.0

    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.

    Parameters

    • proxyServer: string

      The server address used after the switch.

    Returns void

live-streaming-error

  • live-streaming-error(url: string, err: AgoraRTCError): void
  • 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.

    Parameters

    • url: string

      The URL of the CDN live streaming that has errors.

    • err: AgoraRTCError

      The error details.

    Returns void

live-streaming-warning

  • live-streaming-warning(url: string, warning: AgoraRTCError): void
  • 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.

    Parameters

    • url: string

      The URL of the CDN live streaming that has warnings.

    • warning: AgoraRTCError

    Returns void

media-reconnect-end

  • media-reconnect-end(uid: UID): void
  • Occurs when the SDK ends reestablishing the media connection for publishing and subscribing.

    Parameters

    • uid: UID

      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.

    Returns void

media-reconnect-start

  • media-reconnect-start(uid: UID): void
  • Occurs when the SDK starts to reestablish the media connection for publishing and subscribing.

    Parameters

    • uid: UID

      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.

    Returns void

network-quality

  • 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.

    Parameters

    Returns void

published-user-list

  • 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-list to be triggered, every user in the channel must use a number as their user ID (uid).
    • published-user-list has the following impacts on AgoraRTCClient.on("user-joined") and AgoraRTCClient.on("user-published"):
      • If you listen for the published-user-list event, users reported by the published-user-list callback are not reported by user-joined and user-published.
      • If you do not listen for the published-user-list event, the user-joined and user-published callbacks are not affected.

    Parameters

    Returns void

stream-fallback

  • stream-fallback(uid: UID, isFallbackOrRecover: "fallback" | "recover"): void
  • 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.

    Parameters

    • uid: UID

      The ID of the remote user.

    • isFallbackOrRecover: "fallback" | "recover"

      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.

    Returns void

stream-type-changed

  • 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.

    Parameters

    • uid: UID

      The ID of the remote user.

    • streamType: RemoteStreamType

      The new stream type:

      • 0: High-bitrate, high-resolution video stream.
      • 1: Low-bitrate, low-resolution video stream.

    Returns void

token-privilege-did-expire

  • token-privilege-did-expire(): void
  • 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>);
    });
    

    Returns void

token-privilege-will-expire

  • token-privilege-will-expire(): void
  • 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);
    });
    

    Returns void

user-info-updated

  • user-info-updated(uid: UID, msg: "mute-audio" | "mute-video" | "enable-local-video" | "unmute-audio" | "unmute-video" | "disable-local-video"): void
  • Reports the state change of users.

    In most cases, you only need to listen for user-published and 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 event.

    Parameters

    • uid: UID

      The ID of the remote user.

    • msg: "mute-audio" | "mute-video" | "enable-local-video" | "unmute-audio" | "unmute-video" | "disable-local-video"

      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.

    Returns void

user-joined

  • Occurs when a remote user or host joins the channel.

    • In a communication channel, this callback indicates that another user joins the channel and reports the ID of that user. The SDK also triggers this callback to report the existing users in the channel when a user joins the channel.
    • In a live-broadcast channel, this callback indicates that a host joins the channel. The SDK also triggers this callback to report the existing hosts in the channel when a user joins the channel. Ensure that you have no more than 17 hosts in a channel.

    The SDK triggers this callback when one of the following situations occurs:

    • A remote user or host joins the channel by calling join.
    • A remote audience switches the user role to host by calling setClientRole after joining the channel.
    • A remote user or host rejoins the channel after a network interruption.

    Parameters

    Returns void

user-left

  • Occurs when a remote user becomes offline.

    The SDK triggers this callback when one of the following situations occurs:

    • A remote user calls leave and leaves the channel.
    • A remote user has dropped offline. If no data packet of the user or host is received for 20 seconds, the SDK assumes that the user has dropped offline. A poor network connection may cause a false positive.
    • A remote user switches the client role from host to audience.

    In live-broadcast channels, the SDK triggers this callback only when a host goes offline.

    Parameters

    • user: IAgoraRTCRemoteUser

      Information of the user who is offline.

    • reason: string

      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.

    Returns void

user-published

  • 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.

    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();
      }
    })
    

    Parameters

    • user: IAgoraRTCRemoteUser

      Information of the remote user.

    • mediaType: "audio" | "video"

      Type of the track.

      • "audio": The remote user publishes an audio track.
      • "video": The remote user publishes a video track.

    Returns void

user-unpublished

  • Occurs when a remote user unpublishes an audio or video track.

    Parameters

    • user: IAgoraRTCRemoteUser

      Information of the remote user.

    • mediaType: "audio" | "video"

      Type of the track.

      • "audio": The remote user unpublishes an audio track.
      • "video": The remote user unpublishes a video track.

    Returns void

volume-indicator

  • volume-indicator(result: object[]): void
  • Reports all the speaking 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}`);
      });
    });
    

    Parameters

    • result: object[]

      An object consisting of the following properties:

      • level: The volume of the speaking user, ranging from 0 to 100.
      • uid: The ID of the speaking user.

    Returns void

Properties

Optional Readonly channelName

channelName: undefined | string

The current channel name.

The value is undefined if the local user has not joined a channel.

Readonly connectionState

connectionState: ConnectionState

Connection state between the SDK and the Agora server.

Readonly localTracks

localTracks: ILocalTrack[]

Since
   4.0.0

The list of the local tracks that the local user is publishing.

  • After a success method call of publish, the published track object is added to this list automatically.
  • After a success method call of unpublish, the unpublished track object is removed from this list automatically.

Readonly remoteUsers

remoteUsers: IAgoraRTCRemoteUser[]

A 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 uid

uid: UID

The ID of the local user.

The value is undefined if the local user has not joined a channel.

Agora Core Methods

join

  • join(appid: string, channel: string, token: string | null, uid?: UID | null): Promise<UID>
  • 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") 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") callback is triggered on the remote client.

    Parameters

    • appid: string

      The App ID of your Agora project.

    • channel: string

      A string that provides a unique channel name for the call. The length must be within 64 bytes. Supported character scopes:

      • All lowercase English letters: a to z.
      • All uppercase English letters: A to Z.
      • All numeric characters: 0 to 9.
      • The space character.
      • Punctuation characters and other symbols, including: "!", "#", "$", "%", "&", "(", ")", "+", "-", ":", ";", "<", "=", ".", ">", "?", "@", "[", "]", "^", "_", " {", "}", "|", "~", ",".
    • token: string | null

      The token generated at your server:

    • Optional uid: UID | null

      The 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.

      • If you use a number as the user ID, it should be a 32-bit unsigned integer with a value ranging from 0 to (232-1).
      • If you use a string as the user ID, the maximum length is 255 characters.
      To ensure a better end-user experience, Agora recommends using a number as the user ID.

      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 uid for each user and ensure it is unique.

    Returns Promise<UID>

    A Promise object with the user ID.

    • If you pass a number as the user ID, the SDK returns a number uid.
    • If you pass a string as the user ID, the SDK returns a string uid.
    • If you leave the uid parameter empty or set it as null, the Agora server assigns a number uid and returns it.

leave

  • leave(): Promise<void>

publish

  • Publishes local audio and/or video tracks to a channel.

    After publishing the local tracks, the AgoraRTCClient.on("user-published") 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 AgoraRTCClient object 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 AgoraRTCClient object 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.

    Parameters

    Returns Promise<void>

subscribe

  • Subscribes to the audio and/or video tracks of a remote user.

    await client.subscribe(user,"audio");
    user.audioTrack.play();
    

    Parameters

    • user: IAgoraRTCRemoteUser

      The remote user.

    • mediaType: "video"

      The media type of the tracks to subscribe to.

      • "video": Subscribe to the video track only.
      • "audio": Subscribe to the audio track only.

    Returns Promise<IRemoteVideoTrack>

    When the subscription succeeds, the SDK adds the subscribed tracks to user.audioTrack and user.videoTrack. You can go on to call audioTrack.play or videoTrack.play to play the tracks.

    The Promise object throws the TRACK_IS_NOT_PUBLISHED error 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();
    
    category

    Agora Core

    Parameters

    • user: IAgoraRTCRemoteUser

      The remote user.

    • mediaType: "audio"

      The media type of the tracks to subscribe to.

      • "video": Subscribe to the video track only.
      • "audio": Subscribe to the audio track only.

    Returns Promise<IRemoteAudioTrack>

    When the subscription succeeds, the SDK adds the subscribed tracks to user.audioTrack and user.videoTrack. You can go on to call audioTrack.play or videoTrack.play to play the tracks.

    The Promise object throws the TRACK_IS_NOT_PUBLISHED error 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();
    
    category

    Agora Core

    Parameters

    • user: IAgoraRTCRemoteUser

      The remote user.

    • mediaType: "video" | "audio"

      The media type of the tracks to subscribe to.

      • "video": Subscribe to the video track only.
      • "audio": Subscribe to the audio track only.

    Returns Promise<IRemoteTrack>

    When the subscription succeeds, the SDK adds the subscribed tracks to user.audioTrack and user.videoTrack. You can go on to call audioTrack.play or videoTrack.play to play the tracks.

    The Promise object throws the TRACK_IS_NOT_PUBLISHED error if the specified tracks do not exist.

unpublish

  • Unpublishes the local audio and/or video tracks.

    After the local client unpublishes, the AgoraRTCClient.on("user-unpublished") 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.

    Parameters

    • Optional tracks: ILocalTrack | ILocalTrack[]

      The tracks to unpublish. If left empty, all the published tracks are unpublished.

    Returns Promise<void>

unsubscribe

  • Unsubscribes from the audio and/or video tracks of a remote user.

    Parameters

    • user: IAgoraRTCRemoteUser

      The remote user.

    • Optional mediaType: "video" | "audio"

      The media type of the tracks to unsubscribe from:

      • "video": Unsubscribe from the video track only.
      • “audio”: Unsubscribe from the audio track only.
      • empty: Unsubscribe from all the tracks published by the remote user.

    Returns Promise<void>

    The Promise object throws the TRACK_IS_NOT_SUBSCRIBED error if the specified tracks do not exist.

Channel Media Relay Methods

startChannelMediaRelay

  • Starts relaying media streams across channels.

    After this method call, the SDK triggers the following callbacks:

    • AgoraRTCClient.on("channel-media-relay-state"), which reports the state and error code of the media stream relay.
      • If the media stream relay fails, this callback returns state 3. Refer to code for the error code and call this method again.
    • AgoraRTCClient.on("channel-media-relay-event"), which reports the events of the media stream relay.
      • If the media stream relay starts successfully, this callback returns 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);
    })
    

    Parameters

    Returns Promise<void>

    A Promise object, which is resolved if the media relay starts successfully.

stopChannelMediaRelay

  • stopChannelMediaRelay(): Promise<void>
  • Stops the media stream relay.

    Once the relay stops, the user leaves all the destination channels.

    Returns Promise<void>

    A Promise object, which is resolved if the relay stops successfully.

updateChannelMediaRelay

  • 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.

    Parameters

    Returns Promise<void>

    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.

Dual Stream Methods

disableDualStream

  • disableDualStream(): Promise<void>
  • Disables dual-stream mode.

    Returns Promise<void>

enableDualStream

  • enableDualStream(): Promise<void>
  • 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:

    • High-quality video stream: High bitrate, high resolution.
    • Low-quality video stream: Low bitrate, low resolution. The default video profile of the low-quality stream is: A resolution (width × height) of 160 × 120 px, a bitrate of 50 Kbps, and a frame rate of 15 fps. Call setLowStreamParameter to customize the video profile of the low-quality stream.

    Note:

    • enableDualStream does 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);
    })
    

    Returns Promise<void>

setLowStreamParameter

  • 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.
    • Call this method before calling publish.

    Parameters

    Returns void

setRemoteDefaultVideoStreamType

  • 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 setRemoteDefaultVideoStreamType before joining the channel.
    • The method call of setRemoteVideoStreamType to set the video stream type of a specified remote user overrides this method.

    Parameters

    • streamType: RemoteStreamType

      The remote video stream type:

      • 0: High-bitrate, high-resolution video stream.
      • 1: Low-bitrate, low-resolution video stream.

    Returns Promise<void>

setRemoteVideoStreamType

  • 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.

    Parameters

    • uid: UID

      The ID of the remote user.

    • streamType: RemoteStreamType

      The remote video stream type:

      • 0: High-bitrate, high-resolution video stream.
      • 1: Low-bitrate, low-resolution video stream.

    Returns Promise<void>

setStreamFallbackOption

  • 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") 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") 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.

    Parameters

    Returns Promise<void>

Live Streaming Methods

setLiveTranscoding

startLiveStreaming

  • startLiveStreaming(url: string, transcodingEnabled?: undefined | false | true): Promise<void>
  • 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.

    Parameters

    • url: string

      The CDN streaming URL in the RTMP format. ASCII characters only.

    • Optional transcodingEnabled: undefined | false | true

      Whether 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.

    Returns Promise<void>

stopLiveStreaming

  • stopLiveStreaming(url: string): Promise<void>
  • Removes a URL from CDN live streaming.

    This method removes only one URL address each time it is called. To remove multiple URLs, call this method multiple times.

    Parameters

    • url: string

      The URL to be removed.

    Returns Promise<void>

Other Methods

enableAudioVolumeIndicator

  • enableAudioVolumeIndicator(): void
  • Enables the volume indicator.

    This method enables the SDK to regularly report the remote users who are speaking and their volumes.

    After the volume indicator is enabled, the SDK triggers the AgoraRTCClient.on("volume-indicator") 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 enableAudioVolumeIndicator again.

    client.enableAudioVolumeIndicator();
    client.on("volume-indicator", volumes => {
      volumes.forEach((volume, index) => {
        console.log(`${index} UID ${volume.uid} Level ${volume.level}`);
      });
    })
    

    Returns void

getListeners

  • getListeners(event: string): Function[]
  • Gets all the listeners for a specified event.

    Parameters

    • event: string

      The event name.

    Returns Function[]

getLocalAudioStats

getLocalVideoStats

  • Since
       4.1.0

    Gets the statistics of a local video track.

    Note: You cannot get the encodeDelay property on iOS.

    Returns LocalVideoTrackStats

getRTCStats

  • Gets the statistics of the call.

    Returns AgoraRTCStats

    The statistics of the call.

getRemoteAudioStats

  • getRemoteAudioStats(): object
  • 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.

    Returns object

getRemoteNetworkQuality

  • getRemoteNetworkQuality(): object
  • Since
       4.2.0

    Gets the network quality of all the remote users to whom the local user subscribes.

    Returns object

getRemoteVideoStats

  • getRemoteVideoStats(): object
  • 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.

    Returns object

massSubscribe

  • massSubscribe(subscribeList: object[]): Promise<object[]>
  • 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'));
        }
      }
    }
    

    Parameters

    • subscribeList: object[]

      The list of remote users to subscribe to. Each list entry contains the following information:

      • user: The remote user. See AgoraRTCRemoteUser.
      • 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.

    Returns Promise<object[]>

    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.
    • 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.
    • error: The error message. If subscription of a user's audio and/or video tracks fails, the error message is returned through this parameter.

massUnsubscribe

  • massUnsubscribe(unsubscribeList: object[]): Promise<void>
  • 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}]);
    

    Parameters

    • unsubscribeList: object[]

      The list of remote users to unsubscribe from. Each list entry contains the following information:

      • user: The remote user. See AgoraRTCRemoteUser.
      • 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.
        • empty: Unsubscribe from all the tracks published by this user.

    Returns Promise<void>

off

  • off(event: string, listener: Function): void
  • Removes the listener for a specified event.

    Parameters

    • event: string

      The event name.

    • listener: Function

      The callback that corresponds to the event listener.

    Returns void

on

  • on(event: "connection-state-change", listener: typeof event_connection_state_change): void
  • on(event: "user-joined", listener: typeof event_user_joined): void
  • on(event: "user-left", listener: typeof event_user_left): void
  • on(event: "user-published", listener: typeof event_user_published): void
  • on(event: "user-unpublished", listener: typeof event_user_unpublished): void
  • on(event: "user-info-updated", listener: typeof event_user_info_updated): void
  • on(event: "media-reconnect-start", listener: typeof event_media_reconnect_start): void
  • on(event: "media-reconnect-end", listener: typeof event_media_reconnect_end): void
  • on(event: "stream-type-changed", listener: typeof event_stream_type_changed): void
  • on(event: "stream-fallback", listener: typeof event_stream_fallback): void
  • on(event: "channel-media-relay-state", listener: typeof event_channel_media_relay_state): void
  • on(event: "channel-media-relay-event", listener: typeof event_channel_media_relay_event): void
  • on(event: "volume-indicator", listener: typeof event_volume_indicator): void
  • on(event: "crypt-error", listener: typeof event_crypt_error): void
  • on(event: "token-privilege-will-expire", listener: typeof event_token_privilege_will_expire): void
  • on(event: "token-privilege-did-expire", listener: typeof event_token_privilege_did_expire): void
  • on(event: "network-quality", listener: typeof event_network_quality): void
  • on(event: "live-streaming-error", listener: typeof event_live_streaming_error): void
  • on(event: "live-streaming-warning", listener: typeof event_live_streaming_warning): void
  • on(event: "exception", listener: typeof event_exception): void
  • on(event: "is-using-cloud-proxy", listener: typeof event_is_using_cloud_proxy): void
  • on(event: "join-fallback-to-proxy", listener: typeof event_join_fallback_to_proxy): void
  • on(event: "published-user-list", listener: typeof event_published_user_list): void
  • on(event: "content-inspect-connection-state-change", listener: typeof event_content_inspect_connection_state_change): void
  • on(event: "content-inspect-error", listener: typeof event_content_inspect_error): void
  • on(event: string, listener: Function): void
  • Parameters

    • event: "connection-state-change"
    • listener: typeof event_connection_state_change

    Returns void

  • Parameters

    • event: "user-joined"
    • listener: typeof event_user_joined

    Returns void

  • Parameters

    • event: "user-left"
    • listener: typeof event_user_left

    Returns void

  • Parameters

    • event: "user-published"
    • listener: typeof event_user_published

    Returns void

  • Parameters

    • event: "user-unpublished"
    • listener: typeof event_user_unpublished

    Returns void

  • Parameters

    • event: "user-info-updated"
    • listener: typeof event_user_info_updated

    Returns void

  • Parameters

    • event: "media-reconnect-start"
    • listener: typeof event_media_reconnect_start

    Returns void

  • Parameters

    • event: "media-reconnect-end"
    • listener: typeof event_media_reconnect_end

    Returns void

  • Parameters

    • event: "stream-type-changed"
    • listener: typeof event_stream_type_changed

    Returns void

  • Parameters

    • event: "stream-fallback"
    • listener: typeof event_stream_fallback

    Returns void

  • Parameters

    • event: "channel-media-relay-state"
    • listener: typeof event_channel_media_relay_state

    Returns void

  • Parameters

    • event: "channel-media-relay-event"
    • listener: typeof event_channel_media_relay_event

    Returns void

  • Parameters

    • event: "volume-indicator"
    • listener: typeof event_volume_indicator

    Returns void

  • Parameters

    • event: "crypt-error"
    • listener: typeof event_crypt_error

    Returns void

  • Parameters

    • event: "token-privilege-will-expire"
    • listener: typeof event_token_privilege_will_expire

    Returns void

  • Parameters

    • event: "token-privilege-did-expire"
    • listener: typeof event_token_privilege_did_expire

    Returns void

  • Parameters

    • event: "network-quality"
    • listener: typeof event_network_quality

    Returns void

  • Parameters

    • event: "live-streaming-error"
    • listener: typeof event_live_streaming_error

    Returns void

  • Parameters

    • event: "live-streaming-warning"
    • listener: typeof event_live_streaming_warning

    Returns void

  • Parameters

    • event: "exception"
    • listener: typeof event_exception

    Returns void

  • Parameters

    • event: "is-using-cloud-proxy"
    • listener: typeof event_is_using_cloud_proxy

    Returns void

  • Parameters

    • event: "join-fallback-to-proxy"
    • listener: typeof event_join_fallback_to_proxy

    Returns void

  • Parameters

    • event: "published-user-list"
    • listener: typeof event_published_user_list

    Returns void

  • Parameters

    • event: "content-inspect-connection-state-change"
    • listener: typeof event_content_inspect_connection_state_change

    Returns void

  • Parameters

    • event: "content-inspect-error"
    • listener: typeof event_content_inspect_error

    Returns void

  • Parameters

    • event: string
    • listener: Function

    Returns void

once

  • once(event: string, listener: Function): void
  • Listens for a specified event once.

    When the specified event happens, the SDK triggers the callback that you pass and then removes the listener.

    Parameters

    • event: string

      The event name.

    • listener: Function

      The callback to trigger.

    Returns void

removeAllListeners

  • removeAllListeners(event?: undefined | string): void
  • Removes all listeners for a specified event.

    Parameters

    • Optional event: undefined | string

      The event name. If left empty, all listeners for all events are removed.

    Returns void

renewToken

  • renewToken(token: string): Promise<void>
  • 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") callback, call this method to pass a new token. Otherwise the SDK disconnects from the server.

    Parameters

    • token: string

      The new token.

    Returns Promise<void>

sendCustomReportMessage

  • Reports customized messages to Agora's data center.

    Temporarily, Agora supports reporting a maximum of 20 message pieces within 5 seconds.

    Parameters

    Returns Promise<void>

setClientRole

  • Sets the user role and level in a live streaming (when mode is "live").

    • The user role determines the permissions that the SDK grants to a user, such as permission to publish local streams, subscribe to remote streams, and push streams to a CDN address. You can set the user role as "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".
    • The detailed options of a user, including the user level. The user level determines the level of services that a user can enjoy within the permissions of the user's role. For example, an audience can choose to receive remote streams with low latency or ultra low latency. Levels affect prices.

    Note:

    • When 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") or AgoraRTCClient.on("user-left") 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.

    Parameters

    Returns Promise<void>

setEncryptionConfig

  • setEncryptionConfig(encryptionMode: EncryptionMode, secret: string, salt?: Uint8Array): void
  • 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") 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.

    Parameters

    • encryptionMode: EncryptionMode

      The encryption mode.

    • secret: string

      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: Uint8Array

      The 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.

    Returns void

setLicense

  • setLicense(license: string): void
  • Parameters

    • license: string

    Returns void

Proxy Methods

startProxyServer

  • startProxyServer(mode?: undefined | number): void
  • 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.

    Parameters

    • Optional mode: undefined | number

      Cloud 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 mode is 3.

    Returns void

stopProxyServer

  • stopProxyServer(): void
  • Disables cloud proxy.

    You must call this method before joining the channel or after leaving the channel.

    Returns void