Class: Stream

Stream


new Stream()

Stream对象构造函数 (请使用 {WEBRTC2.createStream} 来初始化sdk Stream对象)

Methods


<static> constructor(options)

Stream对象构造函数 (请使用 {WEBRTC2.createStream} 来初始化sdk Stream对象)

Parameters:
Name Type Description
options Object

配置参数

Properties
Name Type Argument Description
audio String <optional>

是否从麦克风采集音频

microphoneId String <optional>

麦克风设备 deviceId,通过 getMicrophones() 获取

video Object <optional>

是否从摄像头采集视频

cameraId String <optional>

摄像头设备 deviceId,通过 getCameras() 获取

screen Object <optional>

是否采集屏幕分享流

audioSource MeidaTrack <optional>

自定义的音频的track

videoSource MeidaTrack <optional>

自定义的视频的track

Returns:
Type
Stream

<static> destroy()

获取音视频流 ID

Returns:

num


adjustAudioMixingVolume()

调节伴奏音量

Returns:
Type
Promise

cleanMediaRecording(options)

清除录制的音视频

Parameters:
Name Type Description
options Object

参数对象

Properties
Name Type Description
recordId String

录制id,可以通过listMediaRecording接口获取

Returns:
Type
Promise

close(options)

关闭音视频输入设备,如麦克风、摄像头、屏幕共享

Parameters:
Name Type Description
options Object

配置对象

Properties
Name Type Description
type String

媒体设备: audio/video/screen

Returns:
Type
Promise

destroy()

销毁实例

Parameters:
Type Description
Void

downloadMediaRecording(param, options)

下载录制的音视频

Parameters:
Name Type Description
param Object

参数对象

options Object

参数对象

Properties
Name Type Description
recordId String

录制id,可以通过listMediaRecording接口获取

Returns:
Type
Promise

getAudioLevel()

当前从麦克风中采集的音量

Returns:

getAudioMixingCurrentPosition()

获取伴奏播放进度

Returns:
Type
Object

getAudioMixingDuration()

获取伴奏时长

Returns:
Type
Object

hasAudio()

当前Stream是否有音频

Returns:
Type
Boolean

init()

初始化音视频流对象

Returns:
Type
Promise

listMediaRecording()

枚举录制的音视频

Returns:
Type
Array

muteAudio()

禁用音频轨道

Returns:
Type
Promise

muteVideo()

禁用视频轨道

Returns:
Type
Promise

open(options)

打开音视频输入设备,如麦克风、摄像头、屏幕共享

Parameters:
Name Type Description
options Object

配置对象

Properties
Name Type Description
type String

媒体设备: audio/video/screen

deviceId String

指定要开启的设备ID,通过getDevices接口获取到设备列表

Returns:
Type
Promise

pauseAudioMixing()

暂停播放伴奏

Returns:
Type
Promise

play(view)

播放音视频流

Parameters:
Name Type Description
view div

div标签,播放画面的dom容器节点

Returns:
Type
Promise

playMediaRecording(options)

播放视频录制

Parameters:
Name Type Description
options Object

参数对象

Properties
Name Type Description
recordId String

录制id,可以通过listMediaRecording接口获取

view Element

音频或者视频画面待渲染的DOM节点,如div、span等非流媒体节点

Returns:
Type
Promise

resumeAudioMixing()

恢复播放伴奏

Returns:
Type
Promise

setAudioMixingPosition(playStartTime)

设置伴奏音频文件的播放位置。可以根据实际情况播放文件,而不是非得从头到尾播放一个文件,单位为ms

Parameters:
Name Type Description
playStartTime Number

伴音播放的位置

Returns:
Type
Promise

setAudioProfile(profile)

设置音频属性

Parameters:
Name Type Description
profile String

要设置的音频的属性:speech_low_quality(表示16 kHz 采样率,单声道,编码码率约 24 Kbps)、speech_standard'(表示32 kHz 采样率,单声道,编码码率约 24 Kbps)、music_standard(表示48 kHz 采样率,单声道,编码码率约 40 Kbps)、standard_stereo(表达48 kHz 采样率,双声道,编码码率约 64 Kbps)、high_quality(表示48 kHz 采样率,单声道, 编码码率约 128 Kbps)、high_quality_stereo(表示48 kHz 采样率,双声道,编码码率约 192 Kbps)

Returns:
Type
Void

setAudioVolume(volume)

设置音频播放的音量。

Parameters:
Name Type Description
volume Number

要设置的远端音频的播放音量,范围为 0(静音)到 100(声音最大)

Returns:
Type
Promise

setCaptureVolume(volume)

设置麦克风采集的音量。

Parameters:
Name Type Description
volume Number

要设置的麦克风采集音量。,范围为 0(静音)到 100(声音最大)

Returns:
Type
Void

setLocalRenderMode(options)

设置本端视频画面大小

Parameters:
Name Type Description
options Object

配置对象

Properties
Name Type Description
width Number

宽度

height Number

高度

cut Boolean

是否裁剪

Returns:
Type
Void

setRemoteRenderMode(options)

设置对端视频画面大小

Parameters:
Name Type Description
options Object

配置对象

Properties
Name Type Description
width Number

宽度

height Number

高度

cut Boolean

是否裁剪

Returns:
Type
Void

setScreenProfile(resolution, frameRate)

设置屏幕共享属性。

Parameters:
Name Type Description
resolution Number

设置本端屏幕共享分辨率:WebRTC2.VIDEO_QUALITY_480p、WebRTC2.VIDEO_QUALITY_720p、WebRTC2.VIDEO_QUALITY_1080p

frameRate String

设置本端屏幕共享帧率:WebRTC2.CHAT_VIDEO_FRAME_RATE_5、WebRTC2.CHAT_VIDEO_FRAME_RATE_10、WebRTC2.CHAT_VIDEO_FRAME_RATE_15、WebRTC2.CHAT_VIDEO_FRAME_RATE_20、WebRTC2.CHAT_VIDEO_FRAME_RATE_25

Returns:
Type
Null

setSubscribeConfig(options)

设置视频订阅的参数。

Parameters:
Name Type Description
options Object

配置参数

Properties
Name Type Argument Description
audio Boolean <optional>

是否订阅音频

video Boolean <optional>

是否订阅视频

resolution Number <optional>

订阅的视频分辨率:WebRTC2.VIDEO_QUALITY_180p、WebRTC2.VIDEO_QUALITY_480p、WebRTC2.VIDEO_QUALITY_720p、WebRTC2.VIDEO_QUALITY_1080p

Returns:
Type
Null

setVideoProfile(options)

设置视频属性。

Parameters:
Name Type Description
options Object

配置参数

Properties
Name Type Argument Description
resolution Number <optional>

设置本端视频分辨率:WebRTC2.VIDEO_QUALITY_180p、WebRTC2.VIDEO_QUALITY_480p、WebRTC2.VIDEO_QUALITY_720p、WebRTC2.VIDEO_QUALITY_1080p

frameRate Number <optional>

设置本端视频帧率:WebRTC2.CHAT_VIDEO_FRAME_RATE_5、WebRTC2.CHAT_VIDEO_FRAME_RATE_10、WebRTC2.CHAT_VIDEO_FRAME_RATE_15、WebRTC2.CHAT_VIDEO_FRAME_RATE_20、WebRTC2.CHAT_VIDEO_FRAME_RATE_25

Returns:
Type
Null

startAudioMixing(options)

云端音乐文件和本地麦克风声音混合;需要在启动麦克风之后使用

Parameters:
Name Type Description
options Object

参数对象

Properties
Name Type Description
audioFilePath String

必须,云端音频文件路径

loopback String

可选,是否循环播放,缺省为false,表示播放一次就结束(这里如果是false,则cycle参数不生效)

replace String

可选,是否替换麦克风采集的音频数据,缺省为false

cycle Number

可选,循环的次数,需要loopback参数置为true(如果想无限循环,cycle设置为0,loopback设置为true),缺省为0,如果loopback为true,表示无限循环,如果loopback为false,该参数不生效

playStartTime Number

可选,设置音频文件开始播放的位置,单位为 s。缺省设为 0,即从头开始播放

volume function

可选,设置伴音文件的音量

auidoMixingEnd function

可选,伴音文件播放完成的通知反馈(正常停止伴音或关掉通话获取其他原因停止伴音不会触发)

Returns:
Type
Promise

startMediaRecording(param)

开启单人视频录制

Parameters:
Name Type Description
param Object

参数对象

Properties
Name Type Description
type String

如果是自己流录制,'audio','video'或'screen'

reset Boolean

如果之前的录制视频未下载,是否重置,默认false

Returns:

包含recordId值,用于下载等操作

Type
Promise

stop()

停止播放音视频流

Returns:
Type
Void

stopAudioMixing()

停止播放伴奏

Returns:
Type
Promise

stopMediaRecording(options)

结束视频录制

Parameters:
Name Type Description
options Object

参数对象

Properties
Name Type Description
recordId String

录制id,可以通过listMediaRecording接口获取

Returns:
Type
Promise

switchDevice()

切换媒体输入设备,比如麦克风、扬声器、摄像头

Parameters:
Name Type Description
options.type String

媒体设备: audio/video/screen

options.deviceId String

指定要开启的设备ID,通过getDevices接口获取到设备列表

Returns:
Type
Promise

takeSnapshot(options)

截取指定用户的视频画面(文件保存在浏览器默认路径)

Parameters:
Name Type Description
options Object

配置参数

Properties
Name Type Description
name String

截取的图片的保存名称(默认是uid-1的格式名称)

Returns:
Type
Promise

unmuteAudio()

启用音频轨道

Returns:
Type
Promise

unmuteVideo()

启用视频轨道

Returns:
Type
Promise