API Reference for web - Interface: ClientConfig
更新时间: 2023-10-23 16:45:52
# Interface: ClientConfig
interface/ClientInterface.ClientConfig
定义 createClient 中的 config 参数的接口。
# Properties
# codec
codec: "h264"
浏览器使用的编码格式,目前仅支持 h264
# mode
mode: "rtc"
| "live"
频道场景
SDK 需知道应用程序的使用场景, 从而使用不同的优化手段。
支持以下场景:
"live"
: 直播场景,有主播和观众两种用户角色,可以通过 setClientRole 方法设置主播和观众的角色。主播可以收发语音/视频流,而观众只能接收语音/视频,无法发送。"rtc"
: 通信场景,用于常见的一对一通话或群聊,频道中的任何用户可以自由说话。
# role
role: ClientRole
直播场景中(mode 为 "live"
时)的用户角色。
用户角色确定用户在 SDK 层的权限,包含是否可以发布和订阅音视频轨道、是否可以推流到 CDN。用户角色有
"host"
(主播)和"audience"
(观众)。主播既可发布轨道,也可订阅轨道;观众不能进行 publish 操作。直播场景中的用户角色默认为观众。如需发布音视频,必须将角色角色为主播。 在创建客户端之后,你可以随时调用 setClientRole 来改变用户角色。