VRTC

VRTC 是 Byte Web SDK 中所有可调用方法的入口。

VRTC 可用于创建客户端和音视频流对象，以及一些相关操作。

成员属性

成员函数

成员组件

• Logger

变量说明

VERSION

VERSION: string

SDK 版本号，用于版本管理

函数说明

checkSystemRequirements

checkSystemRequirements(): boolean

检查 Web SDK 对正在使用的浏览器的适配情况

返回值

true: Web SDK 与当前使用的浏览器适配

false: Web SDK 与当前使用的浏览器不适配

checkVideoPermission

checkVideoPermission(onSuccess: () => void, onFailure: () => void): void

检测是否有摄像头权限

参数

checkAudioPermission

checkAudioPermission(onSuccess: () => void, onFailure: () => void): void

检测是否有麦克风权限

参数

getDevices

getDevices(onSuccess: (devices: [DeviceInstance]) => void, onFailure?: (err: Error) => void): void

获取可用的媒体输入/输出设备，比如麦克风、摄像头、耳机等

参数

DeviceInstance详情

createClient

createClient(mode: string, role: string, iceUrl: string): client

创建客户端

参数

返回值

client

createStream

createStream(options: StreamOption): stream

创建音视频流对象

参数

StreamOption设置

返回值

stream

注意

1.mediaStream 由浏览器原生 API 实现。 2.microphoneId 和 cameraId 可以从 getDevices 中获取。

Client

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

你可以通过 createClient 来创建 client 对象。一个 client 对象代表一个本地客户端。

成员函数

函数说明

init

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

client 初始化，核心功能是与信令服务器建立 websocket 长链接，是所有后续操作的前提

参数

注意

1.后续操作都需要以此函数调用为前提。

join

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

加入房间

参数

返回值

本地用户的userId

注意

1.同一个 client 只可以加入一个房间。

2.token 与 appid 息息相关，是每个项目各自有生成方式。

3.与 leave 为逆操作。

4.加入大班小课功能后，可以同时创建两个 client 分别进入不同房间，但是只可以在一个房间内推流。

leave

leave(onSuccess?: () => void, onFailure?: (err: Error) => void): promise

离开当前房间

参数

返回值

promise

注意

1.与join为逆操作。

publish

publish(byteStream: byteStream, onFailure?: (err: Error) => void): promise

在房间内推流

参数

返回值

promise

注意

1.byteStream 需要 VRTC.createStream 来创建。

2.与 unpublish 为逆操作。

回调

成功推流会触发stream-published事件

unpublish

unpublish(byteStream: byteStream, onFailure?: (err: Error) => void): promise

停止推流

参数

返回值

promise

注意

1.与 publish 为逆操作。

回调

成功之后远端会受到stream-removed事件

subscribe

subscribe(byteStream: byteStream, options?: SubscribeOption, onFailure?: (err: Error) => void): promise

订阅远端流

参数

SubscribeOption配置

返回值

promise

注意

1.与 unsubscribe 为逆操作。

2.建议配合stream-added事件使用。

3.SubscribeOption 中 audio 与 video 不可以同时设置为 false 。

回调

成功订阅会触发stream-subscribed事件

unsubscribe

unsubscribe(byteStream: byteStream, onFailure?: (err: Error) => void): promise

停止订阅

参数

返回值

promise

注意

1.与 subscribe 为逆操作。

on

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

监听事件

参数

OnerEvent参数

注意

1.与 off 为逆操作。

off

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

取消监听事件

参数

OnerEvent参数

注意

1.与 on 为逆操作。

getConnectionState

getConnectionState(): symbol

获取连接状态

返回值

1.调用join之后为CONNECTING。

2.进入房间成功后为CONNECTED。

3.调用leave之后为DISCONNECTING。

4.离开房间成功后为DISCONNECTED。

getLocalVideoStats

getLocalVideoStats(callback: ({ uid: LocalVideoStats }) => void): void

获取本地流视频统计

参数

LocalVideoStats统计详情

getLocalAudioStats

getLocalAudioStats(callback: ({ uid: LocalAudioStats }) => void): void

获取本地流音频统计

参数

LocalAudioStats统计详情

getRemoteAudioStats

getRemoteAudioStats(callback: ({ uid: RemoteAudioStats }) => void): void

获取远端流音频统计

参数

RemoteAudioStats统计详情

getRemoteVideoStats

getRemoteVideoStats(callback: ({ uid: RemoteVideoStats }) => void): void

获取远端流视频统计

参数

RemoteVideoStats统计详情

renewToken

renewToken(token: string, onSuccess?: () => void, onFailure?: (err: Error) => void): promise

更新校验 token

参数

返回值

promise

注意

1.进入房间时传入的校验 token 有过期时间，一旦触发 token 过期，会收到token-request事件，请在收到此事件后重新生成 token 然后调用此函数。

setLiveTranscoding

setLiveTranscoding(liveTranscoding: object): void

设置直播推流转码

参数

liveTranscoding属性设置

liveTranscoding设置示例

var LiveTranscoding = {
  width: 640,
  height: 360,
  videoBitrate: 400,
  videoFramerate: 15,
  audioSampleRate: 48000,
  audioBitrate: 48,
  audioChannels: 1,
  videoGop: 30,
  transcodingUsers,
  backgroundColor: 0x000000
};

transcodingUsers设置

注意

1.请在调用startLiveStreaming前调用此参数。

startLiveStreaming

startLiveStreaming(url: string, enableTranscoding: boolean, onSuccess: () => void, onFailure: (err: Error) => void): void

开启转推直播，推流到cdn

参数

stopLiveStreaming

stopLiveStreaming(onSuccess: () => void, onFailure: (err: Error) => void): void

停止合流转推

参数

sendCustomMessage

sendCustomMessage(message: string｜Object, onSuccess?: () => void, onFailure?: (err: Error) => void): promise

用户发送消息，并透传房间内各客户端

参数

返回值

promise

sendMessageToUser

sendMessageToUser(uid: string｜Object, message: object): promise

向指定用户发送消息

参数

返回值

promise

setBusinessId

setBusinessId(id: string, onFailure?: (err: Error) => void): void

设置业务id，一般用于区分相同项目中的不同业务线

参数

getBusinessId

getBusinessId(): string

获取业务id

返回值

业务id

Stream

Stream 接口提供的方法用于定义音视频流对象的行为，例如流的播放控制、音视频的编码配置等。

你可以通过 createStream创建 stream 对象。一个 stream 对象指通话中发布的本地音视频流或订阅的远端音视频流。

成员函数

函数说明

init

init(onSuccess?: () => void, onFailure?: (err: Error) => void): void

流初始化

参数

注意

1.后续操作都需要以此函数调用为前提。

play

play(domID: string, option?: object, onFailure?: (err: Error) => void): void

播放媒体流

参数

option详情

getMediaStream

getMediaStream(): mediaStream

获取媒体流

返回值

mediaStream

setVideoBitRate

setVideoBitRate(bitrate: array): void

设置视频码率

参数

注意

1.码率设置会有一个缓步上升的过程，慢慢达到目标值。

2.如果范围设置比较窄，实际效果并不很精确。

3.请在 publish 之前调用此方法。

setVideoProfile

setVideoProfile(profile: string): void

设置视频属性，设置本地流的视频编码属性。每个属性对应一套视频参数，如分辨率、帧率、码率等

参数

profile规格

注意

1.码率，帧率和分辨率设置会有一个缓步上升的过程，慢慢达到目标值。

2.请在 publish 之前调用此方法。

setVideoEncoderConfiguration

setVideoEncoderConfiguration(option: object): void

自定义视频编码配置，可以根据需要灵活设置本地流的视频分辨率、帧率和码率

参数

option详情

option示例

stream.setVideoEncoderConfiguration({
  // 视频分辨率
  resolution: {
    width: 640,
    height: 480
  },
  // 视频编码帧率。通常建议是 15 帧，不超过 30 帧
  frameRate: {
    min: 15,
    max: 30
  },
  // 码率。一般情况下推荐使用标准码率
  bitrate: {
    min: 1000,
    max: 5000
  }
});

注意

1.码率，帧率和分辨率设置会有一个缓步上升的过程，慢慢达到目标值。

2.请在 publish 之前调用此方法。

getStats

getStats(callback: (StreamStats: StreamStats) => void): void;

获取流统计

参数

StreamStats详情

stop

stop(): void

停止播放（仅停止播放，不断开rtc连接）

close

close(): void

关闭视频流或音频流，停止推拉流，断开rtc连接，取消摄像头和麦克风的访问权限并清除统计

enableAudio

此接口已经废弃

enableAudio(): boolean

启用音频

返回值

true代表成功，false代表失败

注意

1.请使用unmuteAudio。

enableVideo

此接口已经废弃

enableVideo(): boolean

启用视频

返回值

true代表成功，false代表失败

注意

1.请使用unmuteVideo。

disableAudio

此接口已经废弃

disableAudio(): boolean

关闭音频

返回值

true代表成功，false代表失败

注意

1.请使用muteAudio。

disableVideo

此接口已经废弃

disableVideo(): boolean

关闭视频

返回值

true代表成功，false代表失败

注意

1.请使用muteVideo。

muteAudio

muteAudio(): boolean

关闭音频

返回值

true代表成功，false代表失败

muteVideo

muteVideo(): boolean

关闭视频

返回值

true代表成功，false代表失败

unmuteAudio

unmuteAudio(): void

开启音频

返回值

true代表成功，false代表失败

unmuteVideo

unmuteVideo(): boolean

关闭视频

返回值

true代表成功，false代表失败

getId

getId(): string

获取流id

返回值

当前流的id

hasAudio

hasAudio(): boolean

获取音频 flag

返回值

true：当前流有音频数据

false：当前流没有音频数据

hasVideo

hasVideo(): boolean

获取视频 flag

返回值

true：当前流有视频数据

false：当前流没有视频数据

replaceTrack

replaceTrack(mediaStreamTrack: mediaStreamTrack, onSuccess?: () => void, onFailure?: (err: Error) => void): void

替换媒体流里面的音频或者视频轨

参数

注意

1.mediaStreamTrack 为浏览器原生api。

getAudioLevel

getAudioLevel(): number

获取当前音频能量（可以理解为音量）

返回值

number：取值范围 0-1

注意

1.该方法获取的是当前时刻的音量。如果想表示本地或远端音量的变化，建议使用 setTimeout 或者 setInterval 方法实时获取。

startAudioMixing

startAudioMixing(options: object, callback?: (err?: Error) => void): void

开始播放音乐文件，指定在线音频文件和麦克风采集的音频流进行混音或替换（用音频文件替换麦克风采集的音频流）。

参数

options详情

使用示例

stream.startAudioMixing({
    filePath: 'example.mp3',
    playTime: 0,
    loop: true
}, function(error) {
    if (error) {
        // 错误处理
        return;
    }
    // 播放成功后的流程
});

注意

1.支持浏览器：Safari 12 及以上版本，Chrome 65 及以上版本以及最新版 Firefox 。

stopAudioMixing

stopAudioMixing(callback?: (err?: Error) => void): void

停止播放音乐文件

参数

pauseAudioMixing

pauseAudioMixing(callback?: (err?: Error) => void): void

暂停播放音乐文件

参数

resumeAudioMixing

resumeAudioMixing(callback?: (err?: Error) => void): void

恢复播放音乐文件

参数

getAudioMixingDuration

getAudioMixingDuration(): number

获取音乐文件总时长

返回值

音乐文件总时长(ms)

getAudioMixingCurrentPosition

getAudioMixingCurrentPosition(): number

获取音乐文件播放进度

返回值

音乐文件播放进度(ms)

setAudioMixingPosition

setAudioMixingPosition(position: number, callback?: (err?: Error) => void): void

设置音乐文件音频文件的播放位置

参数

adjustAudioMixingVolume

adjustAudioMixingVolume(volume: number, callback?: (err?: Error) => void): void

设置音乐文件音量

参数

getVideoTrack

getVideoTrack(): mediaStreamTrack

获取当前流中的视频轨道

返回值

视频轨道

注意

1.mediaStreamTrack 为浏览器原生api。

getAudioTrack

getAudioTrack(): mediaStreamTrack

获取当前流中的音频轨道

返回值

音频轨道

注意

1.mediaStreamTrack 为浏览器原生api。

mirror

mirror(enabled: boolean): void

打开/关闭镜像（与原方向相反）

Logger

VRTC.Logger

提供设置 logger 的方法，包括设置日志输出等级、开启/关闭日志上传。

成员常量

成员函数

函数说明

setLogLevel

设置日志输出等级

setLogLevel(level: LogLevel): void

参数

注意

1.LogLevel 为 logger 成员常量：VERBOSE ，DEBUG ，TRACE ，INFO ，WARNING ，ERROR ，NONE

2.默认输出等级为 WARNING 。

3.LogLevel 中各个等级日志输出量递减。