AgoraRTC 是 Agora Web SDK 中所有可调用方法的入口。

AgoraRTC 方法可用于创建客户端 (Client) 和音视频流 (Stream) 对象。

AgoraRTC 方法还可以检查浏览器兼容性和设置日志上传。

Index

Variables

Const BUILD

BUILD: string

Agora Web SDK 的编译信息

example

AgoraRTC.BUILD

Const VERSION

VERSION: string

Agora Web SDK 的版本号

example

AgoraRTC.VERSION

Functions

checkSystemRequirements

  • checkSystemRequirements(): boolean
  • 该方法检查 Web SDK 对正在使用的浏览器的适配情况。

    你需要在创建音视频对象 (createClient)之前调用该方法,用以检查 Web SDK 对正在使用的浏览器的适配情况。

    Note:

    对于一些 Chrome 内核的浏览器(如:QQ 浏览器等),我们暂时未做全量测试,如需使用,可以进行尝试。在接下来的数个版本中,我们会逐渐完成大部分主流浏览器的适配与测试。

    Returns boolean

    • true: Web SDK 与当前使用的浏览器适配。
    • false: Web SDK 与当前使用的浏览器不适配。

createClient

  • 该方法用于创建客户端,在每次会话里仅调用一次。

    example

    AgoraRTC.createClient(config)

    Parameters

    Returns Client

createStream

  • 该方法创建并返回音视频流对象。

    example

    AgoraRTC.createStream(spec)

    Parameters

    Returns Stream

getDevices

  • getDevices(callback: function): void
  • 该方法枚举可用的媒体输入/输出设备,比如麦克风、摄像头、耳机等。

    调用成功后 SDK 会通过 MediaDeviceInfo 对象返回可用的媒体设备。

    example

    示例代码

    AgoraRTC.getDevices (function(devices) {
    var devCount = devices.length;
    
    var id = devices[0].deviceId;
    });

    Parameters

    Returns void

getScreenSources

  • getScreenSources(callback: function): void
  • 该方法用于获取屏幕共享源

    在 Electron 环境进行屏幕共享时,需要调用该方法获取屏幕共享源,详见进行屏幕共享

    调用成功后 SDK 会返回一组 DesktopCapturerSource 对象。

    example

    示例代码

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

    Parameters

    Returns void