Client 对象提供音视频通话的核心功能,例如加入房间、发布和订阅音视频流等。
你可以通过 new Client
来创建 client 对象。
API | 描述 |
---|---|
init | 初始化 client |
destroy | 销毁 clinet 实例并释放相关资源 |
join | 加入房间 |
leave | 离开当前房间 |
publish | 发布音视频流 |
unpublish | 停止发布音视频流 |
subscribe | 订阅指定远端用户音视频流 |
unsubscribe | 取消订阅指定远端用户音视频流 |
muteLocal | 暂停发送本地音视频流给远端订阅用户 |
muteRemote | 暂停接收指定远端用户的音视频流 |
setUserVisibility | 设置用户可见性 |
setBusinessId | 设置业务标识参数 |
媒体流的发布和接收通过微信小程序标签 live-pusher 和 live-player 实现。如果你需要收集上下行的媒体流数据,可以调用以下接口,将相应的数据传给 RTC SDK, 由 RTC SDK 进行整理和上报。
API | 描述 |
---|---|
reportPusherStateChange | 收集和上报 live-pusher 的 bindstatechange 发布者状态改变数据 |
reportPusherNetStatusChange | 收集和上报 live-pusher 的 bindnetstatus 发布者网络状态数据 |
reportPlayerStateChange | 收集和上报 live-player 的 bindstatechange 订阅者状态改变数据 |
reportPlayerNetStatusChange | 收集和上报 live-player 的 bindnetstatus 订阅者网络状态数据 |
API | 描述 |
---|---|
on | 监听 SDK.EVENTS 对象中包含的事件 |
off | 取消监听事件 |
SDK.EVENTS
对象中包含的事件列举如下。
事件名 | 说明 |
---|---|
STREAM_ADDED | 房间内有远端流加入 |
STREAM_REMOVED | 房间内远端流退出 |
UPDATE_URL | 推流或拉流地址更新 |
STREAM_FAILED | 推流或拉流异常 |
MUTE_AUDIO | 远端流关闭音频 |
UNMUTE_AUDIO | 远端流打开音频 |
MUTE_VIDEO | 远端流关闭视频 |
UNMUTE_VIDEO | 远端流打开视频 |
CLIENT_BANNED | 服务端踢出用户 |
PEER_ONLINE | 房间内有其他用户加入 |
PEER_LEAVE | 房间内有其他用户退出 |
ERROR | 收到微信小程序的 SocketTask.onError 事件 |
DISCONNECT | WebSocket 异常中断 |
关于 client 的错误码,参看错误码。