API 详情

Client 接口提供音视频通话的核心功能，例如进入房间、发布和订阅音视频流等。

你可以通过以下方式来创建 client 对象：

const { Client } = require('./VolcEngineRTC_MiniApp');

成员函数

函数说明

init

init(
    appId: string,
    onSuccess: () => void,
    onFailure: (err: VolcEngineRTCError) => void,
  ) : void

初始化 client ，是进行所有后续操作的前提。

参数

VolcEngineRTCError 配置

注意

所有后续操作都需要以此函数的调用为前提。

destroy

destroy(
    onSuccess: () => void,
    onFailure: (err: VolcEngineRTCError) => void,
  ): void

销毁 client 实例。本地用户已经在房间内时，调用本接口将退出房间和销毁 client 实例。

参数

VolcEngineRTCError 配置

join

join(
    token: string,
    roomId: string,
    userId: string,
    onSuccess: (userId: string) => void,
    onFailure: (err: VolcEngineRTCError) => void,
  ): void

初始化 client 后可以调用此接口进入房间，建立微信小程序与信令服务器的 WebSocket 长连接。

参数

注意

• 同一个 client 实例只可以同时进入一个房间。
• 与 leave 为逆操作。
• 调用该接口将触发远端的 PEER_ONLINE 事件，不同平台的事件名称可能略有差异，此处以微信小程序端的事件名称为例。
• 一个 RTC 房间最多同时容纳 20 名可见用户，最多 8 人可同时上麦。更多信息参看用户和媒体流上限。

leave

leave(
    onSuccess: () => void,
    onFailure: (err: VolcEngineRTCError) => void,
  ): void

进入房间后可以调用此接口离开当前房间。

参数

注意

1. 与 join 为逆操作。
2. 调用该接口将触发远端的 PEER_LEAVE 事件，不同平台的事件名称可能略有差异，此处以微信小程序端的事件名称为例。

publish

publish(
    onSuccess: (url: string) => void,
    onFailure: (err: VolcEngineRTCError) => void,
  ): void

本地用户发布音视频流时，你需要先调用 publish，并将它返回的音视频流 url 地址作为参数传入 live-pusher。
参数

注意

1. 与 unpublish 为逆操作。
2. 用户已经在房间内才可以调用本接口。
3. SDK 会对发布音视频流的用户进行鉴权，只有当该用户的 Token 是具有发布权限的才能成功发流。
4. 建议提醒用户同时打开摄像机和麦克风权限，否则无法正常发布媒体流。
5. 调用该接口将触发已订阅了该用户的远端的 STREAM_ADDED 事件，不同平台的事件名称可能略有差异，此处以微信小程序端的事件名称为例。
6. 开始发布媒体流之后，建议通过监听 UPDATE_URL 和 STREAM_FAILED 关注媒体流的发布状态。

unpublish

unpublish(
    onSuccess: () => void,
    onFailure: (err: VolcEngineRTCError) => void,
  ): void

取消发布音视频流。

参数

注意

1. 与 publish 为逆操作。
2. 用户发布音视频流后可以调用本接口。
3. 调用该接口将在已订阅了该用户的远端触发 STREAM_REMOVED 事件，不同平台的事件名称可能略有差异，此处以微信小程序端的事件名称为例。

subscribe

subscribe(
    userId: string,
    options: SubOptions,
    onSuccess: (url: string) => void,
    onFailure: (err: VolcEngineRTCError) => void,
  ): void

订阅远端音视频流。

参数

SubOptions 配置

注意

1. 与 unsubscribe 为逆操作。

2. 建议配合 EVENT.STREAM_ADDED 事件使用。

3. 用户已经在房间内才可以调用本接口。

4. 订阅媒体流之后，建议通过监听 UPDATE_URL 和 STREAM_FAILED 关注媒体流的接收状态。

unsubscribe

unsubscribe(
    userId: string,
    options: { screen?: boolean },
    onSuccess: () => void,
    onFailure: (err: VolcEngineRTCError) => void,
  ): void

取消订阅远端音视频流。

参数

options 配置

注意

1. 与 subscribe 为逆操作。
2. 本地用户已经订阅了远端用户才可以调用本接口。

muteLocal

muteLocal(
    options: {
      audio: boolean;
      video: boolean;
    },
    onSuccess: () => void,
    onFailure: (err: VolcEngineRTCError) => void,
  ) : void

当你需要禁用本地音视频流采集时，请通过使用微信小程序标签 live-pusher 中的 enable-camera 和 enable-mic 实现，并调用本接口来通知服务端。

参数

muteRemote

muteRemote(
    userId: string,
    options: {
      audio: boolean;
      video: boolean;
      screen: boolean;
    },
    onSuccess: () => void,
    onFailure: (err: VolcEngineRTCError) => void,
  ):void

暂停接收指定的远端用户的音视频流。

参数

注意

• 指定的远端用户为已订阅的用户才可以调用本接口。
• 调用 muteRemote 接口后，服务器将暂停推送指定的流，而如果调用 unSubscribe 接口，服务端将停止对指定流进行转码。

setUserVisibility

setUserVisibility(enable, onSuccess, onFailure): Promise<void>;

设置用户身份。可见用户可以发布和订阅媒体流。不可见用户只能订阅媒体流。进房后默认为可见用户。
一个 RTC 房间最多同时容纳 20 名可见用户，最多 8 人可同时上麦。更多信息参看用户和媒体流上限。

参数

返回值

类型: Promise
注意

• 该方法在加入房间前后均可调用。
• 在房间内调用此方法，房间内其他用户会收到相应的回调通知：
  • 从 false 切换至 true 时，房间内其他用户会收到 PEER_ONLINE 回调通知；
  • 从 true 切换至 false 时，房间内其他用户会收到 PEER_LEAVE 回调通知。

on

on(event: string, callback: () => void): void

监听事件

参数

注意

与 off 为逆操作。

off

off(event: string, callback: () => void): void

取消监听事件

参数

注意

与 on 为逆操作。

reportPusherStateChange

reportPusherStateChange(code: number, message: string);

如果你需要 SDK 收集上行的媒体流状态，例如，打开摄像头失败等，可以调用本接口，将相应的数据传给 RTC SDK，由 RTC SDK 进行整理和上报。推荐和 reportPusherNetStatusChange 一起在组件中调用，方便复用。
参数

注意

状态码 code 详情请在微信小程序文档中查询。

reportPusherNetStatusChange

reportPusherStateChange(info: any);

如果你需要 SDK 收集上行的媒体流信息，例如，当前视频帧率等，可以调用本接口，将相应的数据传给 RTC SDK，由 RTC SDK 进行整理和上报。推荐配合 reportPusherStateChange 使用。
参数

注意

网络状态数据 info 详情请在微信小程序文档中查询。