方法调用成功时执行的回调函数。
方法调用失败时执行的回调函数。返回值为错误码和错误信息。
初始化客户端对象。
你的小程序项目的 App ID。
方法调用成功时执行的回调函数。无返回值。
方法调用失败时执行的回调函数。返回值为错误码和错误信息。
加入频道。
在 app 服务器端生成的用于鉴权的 Token:
频道名,能标识直播频道的字符串。
指定用户的 ID。
是否为纯音频场景:
true
:纯音频场景。false
:非纯音频场景。用户 ID 类型, 可选字段, 默认值为 INT 值 0。详见 UidType。
方法调用成功时执行的回调函数。返回值为用户 ID。
方法调用失败时执行的回调函数。返回值为错误码和错误信息。
退出频道。
方法调用成功时执行的回调函数。无返回值。
方法调用失败时执行的回调函数。返回值为错误码和错误信息。
停止接收远端用户的音视频流。
远端用户的 ID。
选择停止接收哪一种流,有三种选择:
audio
:远端用户发送的音频流,即声音。video
:远端用户发送的视频流,即视频画面。all
:远端用户发送的音视频流,即声音和视频画面。方法调用成功时执行的回调函数。无返回值。
方法调用失败时执行的回调函数。返回值为错误码和错误信息。
停止发送本地用户的音视频流。
选择停止发送哪一种流,有三种选择:
audio
:本地用户发送的音频流,即声音。video
:本地用户发送的视频流,即视频画面。all
:本地用户发送的音视频流,即声音和视频画面。方法调用成功时执行的回调函数。无返回值。
方法调用失败时执行的回调函数。返回值为错误码和错误信息。
取消监听流事件。
想要取消监听的流事件。
用户被服务器禁止。
通知应用程序发生错误。 该回调中会包含详细的错误码和错误信息。
通知应用程序已添加远端音视频流。 该回调中会包含已添加的远端用户 ID。
通知应用程序已删除远端音视频流。 该回调中会包含已删除的远端用户 ID。
通知应用程序已更新 Url 地址。 该回调中会包含远端用户的 ID 和更新后的拉流地址。
通知应用程序远端视频已旋转。 该回调中会包含视频的旋转信息以及远端用户的 ID。
Token 已过期回调。
Token 服务即将过期回调。
通知应用程序远端用户已停止发送音频流。 该回调中会包含停止发送音频流的用户 ID。
通知应用程序远端用户已停止发送视频流。 该回调中会包含停止发送视频流的用户 ID。
通知应用程序远端用户已恢复发送音频流。 该回调中会包含恢复发送音频流的用户 ID。
通知应用程序远端用户已恢复发送视频流。 该回调中会包含恢复发送视频流的用户 ID。
跨频道媒体流转发事件回调。
该回调报告跨频道媒体流转发过程中发生的事件。
事件码
跨频道媒体流转发状态回调。
当跨频道媒体流转发状态发生改变时,SDK 会触发该回调,并报告当前的转发状态以及相关的错误信息。
跨频道媒体流转发出错的错误码:
状态码
code
中提示的错误信息。发生异常后,SDK 会重置跨频道媒体流转发的相关状态,你需要调用 startChannelMediaRelay 重新开始跨频道媒体流转发。发布本地音视频流。
该方法将本地音视频流发布到 SD-RTN。互动直播中,调用该 API 的用户即默认为主播。
方法调用成功时执行的回调函数。返回值为音视频流的推流地址。
方法调用失败时执行的回调函数。返回值为错误码和错误信息。
string 型,音视频流的推流地址。
重新加入频道。
该方法让用户重新加入声网 RTC 频道。如果你的小程序中有切后台的场景需求,请确保使用该方法做好重连机制。
在 app 服务器端生成的用于鉴权的 Token:
频道名,能标识直播频道的字符串。
指定用户的 ID。
频道内已有用户的用户 ID 列表。
是否为纯音频场景:
true
:纯音频场景。false
:非纯音频场景。用户 ID 类型, 可选字段, 默认值为 INT 值 0。详见 UidType。
方法调用成功时执行的回调函数。返回值为用户 ID。
方法调用失败时执行的回调函数。返回值为错误码和错误信息。
更新 Token。
新的 Token。
方法调用成功时执行的回调函数。
方法调用失败时执行的回调函数。返回值为错误码和错误信息。
设置 IoT 设备使用的音频编码格式。
IoT 设备使用的音频编码格式,详见AudioCodec。
设置订阅的视频流类型。
用户 ID。
方法调用成功时执行的回调函数。
方法调用失败时执行的回调函数。返回值为错误码和错误信息。
设置用户角色。
注:如果在主播已 publish
的状态下调用该方法将用户角色设置为 audience
,会导致之前的推流地址无效。
方法调用成功时执行的回调函数。无返回值。
方法调用失败时执行的回调函数。返回值为错误码和错误信息。
开始跨频道媒体流转发。
该方法可用于实现跨频道媒体流转发。
调用该方法后,SDK 会触发以下回调:
Client.on("channel-media-relay-state")
,报告当前的跨频道媒体流转发状态和错误码。state
为 2,code
为 0。state
为 3,code
为错误码。你可以尝试再次调用本方法。Client.on("channel-media-relay-event")
,报告跨频道媒体流转发相关的事件。code
为 4,表示 SDK 开始向目标频道发送数据包。Note
跨频道媒体流转发参数配置,详见 ChannelMediaRelayConfiguration。
媒体流转发是否成功的回调。
null
:媒体流转发成功。停止跨频道媒体流转发。
一旦停止转发,用户会退出所有的目标频道。
调用该方法会触发 Client.on("channel-media-relay-state")
回调。
state
为 0。state
为 3,code
错误码可能为 2 或 8,一般是在网络较差的情况下,退出的消息发送不成功导致的。你可以调用 Client.leave 离开频道来停止跨频道媒体流转发。停止跨频道媒体流转发是否成功的回调。
null
:停止跨频道媒体流转发成功。订阅远端音视频流。
该方法从 SD-RTN 订阅并接收远端音视频流。
要订阅的远端用户 ID。
设置是否订阅视频或音频。
是否订阅音频流:
true
:(默认)订阅。false
:不订阅。是否订阅视频流:
true
:(默认)订阅。false
:不订阅。方法调用成功时执行的回调函数。返回值为音视频的拉流地址。
方法调用失败时执行的回调函数。返回值为错误码和错误信息。
一个对象,包含以下数据:
url
:string 型,音视频流的拉流地址rotation
:number 型,视频帧顺时针旋转角度。恢复接收远端用户的音视频流。
远端用户的 ID。
选择停止接收哪一种流,有三种选择:
audio
:远端用户发送的音频流,即声音。video
:远端用户发送的视频流,即视频画面。all
:远端用户发送的音视频流,即声音和视频画面。方法调用成功时执行的回调函数。无返回值。
方法调用失败时执行的回调函数。返回值为错误码和错误信息。
恢复发送本地用户的音视频流。
选择恢复发送哪一种流,有三种选择:
audio
:本地用户发送的音频流,即声音。video
:本地用户发送的视频流,即视频画面。all
:本地用户发送的音视频流,即声音和视频画面。方法调用成功时执行的回调函数。无返回值。
方法调用失败时执行的回调函数。返回值为错误码和错误信息。
停止发布本地音视频流。
方法调用成功时执行的回调函数。无返回值。
方法调用失败时执行的回调函数。返回值为错误码和错误信息。
停止订阅远端音视频流。
该方法停止从 SD-RTN 订阅并接收远端音视频流。
要停止订阅的远端用户 ID。
方法调用成功时执行的回调函数。无返回值。
方法调用成功时执行的回调函数。返回值为错误码和错误信息。
更新媒体流转发的目标频道。
成功开始跨频道转发媒体流后,如果你希望添加或删除媒体流转发的目标频道,可以调用该方法。
调用该方法后,SDK 会触发 Client.on("channel-media-relay-event")
回调。
code
为 7。code
为 8,同时还会触发 Client.on("channel-media-relay-state")
回调,其中 state
为 3。出错后跨频道媒体流转发状态会被重置,你需要调用 startChannelMediaRelay 重新开始跨频道媒体流转发。Note
跨频道媒体流转发参数配置,详见 ChannelMediaRelayConfiguration。
更新目标频道是否成功的回调。
null
:更新目标频道成功。上报拉流过程中的网络状态。
远端用户的用户 ID。
live-player 组件报告的网络状态数据。
Note:要收到 live-player 组件报告的网络状态数据,你需要在创建 live-player 组件时注册监听 bindnetstatus
。详见微信小程序 live-player 文档。
上报拉流状态。
远端用户的用户 ID。
live-player 组件报告的拉流状态码。
Note:要收到 live-player 组件报告的拉流状态码,你需要在创建 live-player 组件时注册监听 bindstatechange
。详见微信小程序 live-player 文档。
上报推流过程中的网络状态。
live-pusher 组件报告的网络状态数据。
Note:要收到 live-pusher 组件报告的网络状态通知,你需要在创建 live-pusher 组件时注册监听 bindnetstatus
。详见微信小程序 live-pusher 文档。
上报推流状态。
live-pusher 组件报告的推流状态码。
Note:要收到 live-pusher 组件报告的推流状态码,你需要在创建 live-pusher 组件时注册监听 bindstatechange
。详见微信小程序 live-pusher 文档。
销毁客户端对象。