Agora Web SDK API Reference

This method checks the compatibility between the Web SDK and the current web browser.

Use this method before calling createClient to check the compatibility between the system and the web browser.

Note

• Both the type and version of the browser affect the return value.
• Agora has not conducted comprehensive tests on some Chromium kernel browsers, such as QQ and 360. You can call this method to check if the SDK supports the browser.

This method creates and returns a client object. You can only call this method once each call session.

example

AgoraRTC.createClient(config)

This method creates and returns a stream object.

example

AgoraRTC.createStream(spec)

This method enumerates the available media input and output devices, such as microphones, cameras, headsets, and so on.

If this method succeeds, the SDK returns a list of media devices in an array of MediaDeviceInfo objects.

Note

On Chrome 81 or later, Safari, and Firefox, device IDs are only available after the user has granted permissions to use the media device. See Why can't I get device ID on Chrome 81?

example

Sample code

AgoraRTC.getDevices (function(devices) {
var devCount = devices.length;

var id = devices[0].deviceId;
}, function(errStr){
     console.error("Failed to getDevice", errStr);
});

To share the screen in Electron, call this method to get the screen sources. See Share the Screen for details.

If this method succeeds, the SDK returns a list of screen sources in an array of DesktopCapturerSource objects.

example

Sample code

AgoraRTC.getScreenSources(function(err, sources) {
  console.log(sources)
}

This method returns the codecs supported by both the Agora Web SDK and the web browser. The Agora Web SDK supports VP8 and H.264 for video, and OPUS for audio.

Note

• This method supports all web browsers. For web browsers that do not support WebRTC or are not recognized, the returned codec list is empty.
• The returned codec list is based on the SDP used by the web browser and for reference only.
• Some Android phones might claim to support H.264 but have problems in communicating with other platforms using H.264. In this case, we recommend using the VP8 codec.

example

Sample code

// Gets the supported decoding formats as the receiver
AgoraRTC.getSupportedCodec()
  .then(function(result){
    console.log(`Supported video codec: ${result.video.join(",")}`);
    console.log(`Supported audio codec: ${result.audio.join(",")}`);
  });

// Gets the supported encoding formats as the sender
navigator.mediaDevices.getUserMedia({video: true, audio: true})
 .then(function(mediaStream){
    return AgoraRTC.getSupportedCodec({stream: mediaStream});
 })
 .then(function(result){
    console.log(`Supported video codec: ${result.video.join(",")}`);
    console.log(`Supported audio codec: ${result.audio.join(",")}`);
 });