You need to enable JavaScript to run this app.
导航
概览
最近更新时间:2024.05.27 11:57:44首次发布时间:2022.01.21 10:38:44
我的收藏
有用
有用
无用
无用
Client

Client 对象提供音视频通话的核心功能,例如加入房间、发布和订阅音视频流等。

你可以通过 new Client 来创建 client 对象。

方法列表

基础功能

API描述
init初始化 client
destroy销毁 clinet 实例并释放相关资源
join加入房间
leave离开当前房间
publish发布音视频流
unpublish停止发布音视频流
subscribe订阅指定远端用户音视频流
unsubscribe取消订阅指定远端用户音视频流
muteLocal暂停发送本地音视频流给远端订阅用户
muteRemote暂停接收指定远端用户的音视频流
setUserVisibility设置用户可见性
setBusinessId设置业务标识参数

媒体流数据统计和上报

媒体流的发布和接收通过微信小程序标签 live-pusherlive-player 实现。如果你需要收集上下行的媒体流数据,可以调用以下接口,将相应的数据传给 RTC SDK, 由 RTC SDK 进行整理和上报。

API描述
reportPusherStateChange收集和上报 live-pusherbindstatechange 发布者状态改变数据
reportPusherNetStatusChange收集和上报 live-pusherbindnetstatus 发布者网络状态数据
reportPlayerStateChange收集和上报 live-playerbindstatechange 订阅者状态改变数据
reportPlayerNetStatusChange收集和上报 live-playerbindnetstatus 订阅者网络状态数据

回调

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 事件
DISCONNECTWebSocket 异常中断

错误码

关于 client 的错误码,参看错误码