Interface ClientConfig

用于控制客户端行为的接口。

在调用 createClient 创建客户端对象时,你需要配置该接口。

modecodec 属性必须设置。

Hierarchy

  • ClientConfig

Index

Properties

Properties

codec

codec: SDK_CODEC

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

  • "vp8": 浏览器使用 VP8 编码。
  • "h264": 浏览器使用 H.264 编码。

Safari 12.1 及之前版本不支持 VP8 编码。

mode

mode: SDK_MODE

频道场景。

Agora Web SDK NG 需知道 app 的使用场景(例如通信场景或直播场景),从而使用不同的优化手段。

Agora 频道支持以下场景:

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

Optional role

直播场景中的用户角色。

如果 mode 设置为 live, 可以通过本参数设置用户角色,默认角色为观众(audience);

角色为 host 的用户没有限制,角色为 audience 的用户不能进行 publish 操作。

在创建客户端之后,你可以随时调用 setClientRole 来改变用户角色。