Agora Web SDK API Reference

You can pass the preset video encoder configurations when calling the following methods:

• AgoraRTC.createCustomAudioTrack
• AgoraRTC.createMicrophoneAudioTrack
• AgoraRTC.createBufferSourceAudioTrack

The following table lists all the preset audio profiles. The SDK uses "music_standard" by default.

You can get the state with BufferSourceAudioTrack.on("source-state-change").

Get the visibility of the <video> tag through the following methods and events:

• [localVideoTrack.on("video-element-visible-status")]{@link ILocalVideoTrack.event_video_element_visible_status}
• localVideoTrack.getVideoElementVisibleStatus
• remoteVideoTrack.on("video-element-visible-status")
• remoteVideoTrack.getVideoElementVisibleStatus

This object contains the following parameters:

• visible: Boolean, whether the <video> tag is visible or not.
• reason: This parameter is only valid when visible is false, which indicates the reason:
  • "SIZE": The size of <video> is too small to see.
  • "STYLE": The CSS styles of <video> or its ancestor element cause <video> to be invisible.
  • "POSITION": The <video> tag or its ancestor element are positioned outside the viewport.
  • "COVERED": The <video> tag is covered by other elements.

You can get the connection state through connectionState.

The connection between the SDK and the edge server has the following states:

• "DISCONNECTED": The SDK is disconnected from the server.
• This is the initial state until you call join.
• The SDK also enters this state after you call leave, when the user is banned, or when the connection fails.
• "CONNECTING": The SDK is connecting to the server. The SDK enters this state when you call join.
• "CONNECTED": The SDK is connected to the server and joins a channel. The user can now publish streams or subscribe to streams in the channel.
• "RECONNECTING": The SDK is reconnecting to the server. If the connection is lost because the network is down or switched, the SDK enters this state.
• "DISCONNECTING": The SDK is disconnecting from the server. The SDK enters this state when you call leave.

Safari 12.1 or earlier does not support the VP8 codec.

The SDK differentiates channel profiles and applies different optimization algorithms accordingly. For example, it prioritizes smoothness and low latency for a video call, and prioritizes video quality for a video broadcast.

The SDK supports the following channel profiles:

• "live": Sets the channel profile as live broadcast. You need to go on to call setClientRole to set the client as either a host or an audience. A host can send and receive audio or video, while an audience can only receive audio or video.
• "rtc": Sets the channel profile as communication. It is used for a one-on-one call or a group call where all users in the channel can converse freely.

You can pass the preset video encoder configurations when calling AgoraRTC.createScreenVideoTrack.

The following table lists all the preset video profiles for screen sharing.

Each user in the same channel should have a unique user ID with the same data type (number or string).

You can pass the preset video encoder configurations when calling AgoraRTC.createCameraVideoTrack or AgoraRTC.createScreenVideoTrack.

The following table lists all the preset video profiles. The SDK uses "480p_1" by default.