Agora Web API Reference

概览 AgoraRTC Client Stream Error Codes Warning Codes

定义 createClient 中的 config 参数的接口。

Note

mode 和 codec 属性必须设置。

example

示例代码

var config = {
     mode: "live",
     codec: "vp8",
     proxyServer: "YOUR HTTP PROXY SERVER IP",
     turnServer: [{
         turnServerURL: "YOUR TURNSERVER URL",
         username: "YOUR USERNAME",
         password: "YOUR PASSWORD",
         udpport: "THE UDP PORT YOU WANT TO ADD",
         tcpport: "THE TCP PORT YOU WANT TO ADD",
         forceturn: false
     }]
}
var client = AgoraRTC.createClient(config);

Hierarchy

ClientConfig

Index

Properties

Optional areaCode

areaCode: AREAS[]

服务器的访问区域。

自从
3.1.2

该功能为高级设置，适用于有访问安全限制的场景。

默认情况下，SDK 会就近选择 Agora 服务器进行连接。设置访问区域之后，SDK 只会连接到指定区域内的 Agora 服务器，详见 AREAS。

Note:

访问区域限制为全局设置，对整个浏览器页签生效，即只要一个 Client 设置了访问区域，同页面创建的其他 Client 均会遵守访问区域限制。
仅支持指定单个访问区域。

示例代码

var config = {
    mode: "live",
    codec: "vp8",
    // 指定仅访问北美的服务器。
    areaCode: [AgoraRTC.AREAS.NORTH_AMERICA]
};
var client = AgoraRTC.createClient(config);

codec

codec: "vp8" | "vp9" | "h264"

浏览器使用的编码格式，有以下两种选择：

"vp8": 浏览器使用 VP8 编码
"h264": 浏览器使用 H.264 编码
"vp9": 预留参数，暂不支持

Note

Safari 12.1 及之前版本不支持 VP8 编解码。
移动端对编解码格式的支持情况比较复杂，详见移动端使用 Agora Web SDK。

mode

mode: "live" | "rtc"

频道场景

Agora Web SDK 需知道应用程序的使用场景, 从而使用不同的优化手段。

Agora 频道支持以下场景:

"live": 直播场景，有主播和观众两种用户角色，可以通过 Client.setClientRole 方法设置主播和观众的角色。主播可以收发语音/视频流，而观众只能接收语音/视频，无法发送。
"rtc": 通信场景，用于常见的一对一通话或群聊，频道中的任何用户可以自由说话。

Optional proxyServer

proxyServer: string

HTTP 代理服务器域名

Agora Web SDK 还提供 startProxyServer 方法支持云代理服务，详见使用云代理。

ASCII 字符，字符串长度大于 0 小于 256 字节。

Note

仅支持 443 端口 https/SSL 代理服务器。
请确保该服务器同时支持 wss (WebSocket Secure)。
需打开的防火墙端口详见应用企业防火墙限制。

Optional turnServer

turnServer: TurnServer[]

TURN 服务器设置

由 TurnServer 对象组成的数组，支持传入多组 TURN 服务器设置。

Agora Web SDK 还提供 startProxyServer 方法支持云代理服务，详见使用云代理。