流对象(Stream)
本章节介绍了Web SDK的Stream接口详情。
接口 |
描述 |
|---|---|
播放该音视频流。 |
|
停止播放视频流。 |
|
恢复播放音视频。 |
|
关闭音视频。 |
|
禁用音频轨道。 |
|
禁用视频轨道。 |
|
启用音频轨道。 |
|
启用视频轨道。 |
|
获取 Stream 唯一标识ID。 |
|
获取 Stream 所属的用户ID。 |
|
设置音频输出设备。 |
|
设置音频音量大小。 |
|
获取实时音频音量级别。 |
|
是否包含视频轨道。 |
|
是否包含视频轨道。 |
|
获取音频轨道。 |
|
获取视频轨道。 |
|
获取流类型。 |
|
注册流对象事件回调接口。 |
|
取消注册流对象事件回调接口。 |
play
async play(elementId: string, options:Options): Promise<void>
【功能说明】
播放音视频流。该方法会自动创建<video> 标签，并在指定的标签上播放音频和视频，同时该标签会被添加到页面中名为 “elementId ”的div容器下。
- elementId：必选，string类型，HTML <div> 标签ID。
- options：可选，Options类型，播放选项。
- Options：{objectFit：可选，string类型，取值如下：
- 'contain' ：优先保证视频内容全部显示。视频尺寸等比缩放，直至视频窗口的一边与视窗边框对齐。如果视频尺寸与显示视窗尺寸不一致，在保持长宽比的前提下，将视频进行缩放后填满视窗，缩放后的视频四周会有一圈黑边。
- 'cover' ：优先保证视窗被填满。视频尺寸等比缩放，直至整个视窗被视频填满。如果视频长宽与显示窗口不同，则视频流会按照显示视窗的比例进行周边裁剪或图像拉伸后填满视窗。
- 'fill' ：视频内容完全填充视窗。如果视频的宽高比与视窗不相匹配，那么视频将被拉伸以适应视窗。
muted：可选，boolean类型，true表示静音，false表示不静音。默认值为false，本地流通常需要mute声音以防播放从麦克风采集的声音。
}
【返回参数】
Promise<void>：返回一个Promise对象。
【注意事项】
由于浏览器自动播放策略的限制，在play() 返回错误后需要引导用户通过手动调用resume接口恢复播放。
resume
async resume(): Promise<void>
【功能说明】
- 在某些版本浏览器上，移动传入play() 的div容器可能会导致音视频播放器进入‘PAUSED’状态，此时需要调用该接口恢复播放。
- 由于浏览器自动播放策略的限制，在play() 返回错误后需要引导用户通过手势调用该接口恢复播放。
【请求参数】
无
【返回参数】
Promise<void>：返回一个Promise对象。
muteAudio
muteAudio(): boolean
【功能说明】
禁用音频轨道。
【请求参数】
无
【返回参数】
boolean类型，true表示禁用音频轨道成功，false表示禁用音频轨道失败。
muteVideo
muteVideo(): boolean
【功能说明】
禁用视频轨道。
【请求参数】
无
【返回参数】
boolean类型，true表示禁用视频轨道成功，false表示禁用视频轨道失败。
unmuteAudio
unmuteAudio(): boolean
【功能说明】
启用音频轨道。
【请求参数】
无
【返回参数】
boolean类型，true表示启用音频轨道成功，false表示启用音频轨道失败。
unmuteVideo
unmuteVideo(): boolean
【功能说明】
打开本地摄像头。
【请求参数】
无
【返回参数】
boolean类型，true表示启用视频轨道成功，false表示启用视频轨道失败。
setAudioOutput
setAudioOutput(deviceId: string): Promise<void>
【功能说明】
设置音频输出设备。
【请求参数】
deviceId：string类型，音频输出设备的设备ID。
【返回参数】
无
setAudioVolume
setAudioVolume(volume: number): void
【功能说明】
设置音频音量大小
【请求参数】
volume：number类型，音量大小，取值范围为[0,100]。
【返回参数】
无
getType
getType(): string
【功能说明】
获取流类型。用于判断一个流是主流还是辅流，辅流通常是一个屏幕共享流。
【请求参数】
无
【返回参数】
string类型， 本地流：'local'，远端主流：'main' ，远端辅流'auxiliary'。
on
on(event: string, handler: function): void
【功能说明】
注册客户端对象事件回调接口。
- event：必选，string类型，事件名称。详细事件列表请参见RTCStreamEvent。
- handler：必选，function类型，事件处理方法。
【返回参数】
无
off
on(event: string, handler: function): void
【功能说明】
取消注册客户端对象事件回调接口。
- event：必选，string类型，事件名称。详细事件列表请参见RTCStreamEvent。
- handler：必选，function类型，事件处理方法。
【返回参数】
无
