- 最新动态
- 服务公告
- 产品介绍
- 快速入门
- 用户指南
- 最佳实践
- API参考
-
客户端SDK参考
- 使用前必读
- SDK概述
- 隐私声明
- 合规使用指南
- Android SDK
- iOS/macOS SDK
- All Platform C++ SDK
- Web SDK
- 接入鉴权
- 附录
- 修订记录
-
常见问题
-
产品咨询
- SparkRTC支持哪些平台?
- SparkRTC Demo怎么体验?
- 在进行Windows的Demo使用或集成SDK时,提示微软C++标准库缺失,该如何获取?
- SparkRTC支持接入微信小程序吗?
- 实时音视频是什么?
- 实时音视频和直播有什么区别?
- SparkRTC是否支持在国外使用?
- SparkRTC RoomID是什么?取值区间值是多少?
- SparkRTC最多可以同时创建多少个房间?
- SparkRTC UserID是什么?取值范围是多少?
- 怎么理解SparkRTC的角色Role?
- SparkRTC最多可以支持多少个人同时视频通话?
- 实时音视频的时延是多少?
- SparkRTC是否支持连麦互动?
- SparkRTC是否支持双向的桌面推送?
- 实时音视频支持私有化部署吗?
- PC端实时音视频支持USB摄像头吗?
- 计费购买
- Signature相关
- 录制相关
-
SDK使用
- 移动端(Android/iOS)创建一个房间,是否支持PC端(MAC/Windows)接入?
- iOS平台如何缩减安装包体积?
- Android平台如何缩减安装包体积?
- iOS端是否可以监听远端离开房间?
- 背景音乐是否支持循环播放?
- SparkRTC是否支持调整背景音乐的播放进度?
- 支持监听房间成员进出房间吗?
- 如何监测断网和重连?
- 支持首帧渲染回调吗?能否监听画面开始渲染?
- 如何设置上行视频码率、分辨率和帧率?
- 有没有推荐的画面质量(码率、分辨率、帧率)相关参数配置?
- 如何实现横屏视频通话?
- 是否支持网络测速?如何操作?
- 是否支持音量大小提示?
- 自定义渲染支持哪些格式?
- SparkRTC支持iOS后台运行吗?
- 移动端如何实现录屏(屏幕分享)?
- 多人视频会议中,移动端和Web端可以进入同一房间吗?
- SparkRTC的Web端、移动端、PC端是不是同步的?
- Android SDK是否支持自定义采集数据?
- SparkRTC支持旁路推流吗?
- Windows端如何才能采集到被分享应用播放的声音?
- SDK是否支持断线重连机制?
- 如何创建房间?
- 两台手机同时运行SparkRTC APP,为什么无法互通?
- 鉴权是如何生成的?在什么时候生成?
- onVideoStats、onAudioStatus、onSubStreamStats回调触发时为什么程序会崩溃?
- 为什么本端听筒能听到自己的声音?
- setExternalAudioCapture(音频自采集)、setExternalVideoCapture(视频自采集)、setExternalMediaFrameOutput(视频自渲染)能在进入房间后开启吗?
- SparkRTC是否支持设置镜像画面?
- SparkRTC音视频过程中的上下行码率、分辨率、丢包率、音频采样率等信息怎么获取?
- SparkRTC是否支持设置本地采集音量?是否支持设置每个远端用户的播放音量?
- enableLocalVideo和muteLocalVideo有什么区别?
- enableLocalAudioStream和muteLocalAudio有什么区别?
- SparkRTC是否支持对房间进行权限校验?
- 接入PC端是否支持屏幕分享功能?
- SparkRTC是否支持将本地视频文件分享到实时音视频中?
- SparkRTC是否支持单纯的实时音频?
- 一个房间里可以同时有多路屏幕分享吗?
- SparkRTC是否支持1080P?
- 是否支持视频画面截图功能?
- 播放背景音乐是否支持在线音乐?
- 同一个页面中,可以创建N个RTC对象,通过N个UserID,分别登录到N个房间吗?
- Web端用宽高设置的推流分辨率适用于所有浏览器吗?
- Web端SDK在使用过程中拔掉摄像头,摄像头列表里面的数据如何清除?
- Web端SDK可以获取当前音量大小吗?
- Web端支持监听远端离开房间吗?
- Web端通话过程中为什么会出现回声、杂音、噪声、声音小?
- Web端如何切换摄像头和麦克风?
- SparkRTC支持白板功能吗?
- 相同UserID支持同时进入多个房间吗?
- SparkRTC房间的生命周期是多久?
- SparkRTC多人视频通话支持蓝牙耳机吗?
- SparkRTC多人视频通话支持仅订阅2/3/4人音频吗?
- 指定窗口分享,当窗口大小变化时,视频流的分辨率会跟着变化吗?
- 视频通话支持悬浮窗、大小画面切换功能吗?
- 发送自定义消息接口能实现聊天室、弹幕等功能吗?
- 支持查询所有的UserID吗?
- Web SDK中的checkSystemRequirements接口为什么会调用异常?
- 问题排查
-
产品咨询
- 文档下载
- 通用参考
链接复制成功!
流对象(Stream)
本章节介绍了Web SDK的Stream接口详情。
接口 |
描述 |
---|---|
播放该音视频流。 |
|
停止播放视频流。 |
|
恢复播放音视频。 |
|
关闭音视频。 |
|
禁用音频轨道。 |
|
禁用视频轨道。 |
|
启用音频轨道。 |
|
启用视频轨道。 |
|
获取Stream唯一标识ID。 |
|
获取Stream所属的用户ID。 |
|
设置音频输出设备。 |
|
设置音频音量大小。 |
|
获取实时音频音量级别。 |
|
流是否包含音频轨道。 |
|
流是否包含视频轨道。 |
|
获取流的音频轨道。 |
|
获取流的视频轨道。 |
|
获取流类型。 |
|
注册流对象事件回调接口。 |
|
取消注册流对象事件回调接口。 |
|
获取流信息。 |
|
获取视频截图 |
play
async play(elementId: string, options?: Options): Promise<void>
【功能说明】
播放音视频流。该方法会自动创建<audio>、<video>标签,并在指定的标签上播放音频和视频,同时该标签会被添加到页面中名为 “elementId ”的div容器下。
【请求参数】
- elementId:必选,string类型,HTML <div>标签ID。
- options:可选,Options类型,播放选项。
- objectFit:可选,string类型,远端共享流的默认值为contain,其他流默认值为cover。支持的枚举值如下:
- contain:优先保证视频内容全部显示。视频尺寸等比缩放,直至视频窗口的一边与视窗边框对齐。如果视频尺寸与显示视窗尺寸不一致,在保持长宽比的前提下,将视频进行缩放后填满视窗,缩放后的视频四周会有一圈黑边。
- cover:优先保证视窗被填满。视频尺寸等比缩放,直至整个视窗被视频填满。如果视频长宽与显示窗口不同,则视频流会按照显示视窗的比例进行周边裁剪或图像拉伸后填满视窗。
- fill:视频内容完全填充视窗。如果视频的宽高比与视窗不相匹配,那么视频将被拉伸以适应视窗。
- muted:可选,boolean类型,true表示静音,false表示不静音。默认值为false。
- resolutionId:可选,string类型。双流场景,指定播放的分辨率Id的视频,如果不指定,默认选择分辨率最高的视频。该参数为1.8.0版本新增。
- objectFit:可选,string类型,远端共享流的默认值为contain,其他流默认值为cover。支持的枚举值如下:
【返回参数】
Promise<void>:返回一个Promise对象。
- 由于浏览器自动播放策略的限制,在play()返回错误后需要引导用户通过手动触发页面控件后,调用resume接口恢复播放。
- 本地流播放通常需要设置muted参数为true(静音),以防播放出来的声音也被麦克风采集到,造成回音的效果。
- 在App上,一个resolution对应于一个音视频播放窗口,Stream中的音频对所有的resolution是公共的。
stop
stop(option?: StopOption): void
【功能说明】
停止播放音视频流。
【请求参数】
option:可选,StopOption类型,表示停止播放的选项。如果不传,则停止该流的音频和所有分辨率的视频。
StopOption类型定义如下:{
- audio:可选,boolean类型。表示是否停止音频。默认为false。
- video:可选,boolean类型。表示是否停止视频。默认为false。
- resolutionIds:可选,string[] 型。在video为true的时候有效。指定停止播放的分辨率Id 的视频,如果不传resolutionIds,则默认停止所有分辨率的视频。
}
【返回参数】
无
resume
async resume(option?: ResumeOption): Promise<void>
【功能说明】
- 在某些版本浏览器上,移动传入play()的div容器可能会导致音视频播放器进入PAUSED状态,此时需要调用该接口恢复播放。
- 由于浏览器自动播放策略的限制,在play()返回错误后需要引导用户通过手动方式调用该接口恢复播放。
【请求参数】
option:可选,表示恢复播放的选项,ResumeOption类型,如果不传则恢复播放该流的音频和所有分辨率的视频。
ResumeOption类型定义为:{
- audio:可选,boolean类型。是否resume音频。默认为false。
- video:可选,boolean类型。是否resume视频。默认为false。
- resolutionIds:可选,string[]类型,在video为true的时候有效。指定恢复播放的分辨率Id的视频,如果不传resolutionIds,默认恢复所有分辨率的视频。
}
【返回参数】
Promise<void>:返回一个Promise对象。
close
close(option?: CloseOption): void
【功能说明】
关闭音视频的播放。对于本地流,该方法在关闭播放的同时会关闭音视频采集,释放设备资源占用。
【请求参数】
option:可选,CloseOption类型,表示关闭音视频的选项。如果option不填写,则关闭音频和所有分辨率的视频。
CloseOption类型定义如下:{
- audio:可选,boolean类型。表示是否关闭音频。默认为false。
- video:可选,boolean类型。表示是否关闭视频。默认为false。
- resolutionIds:可选,string[]类型。在video为true的时候有效。指定关闭播放的分辨率Id的视频,如果不传resolutionIds,默认关闭所有分辨率的视频。
}
【返回参数】
无
muteAudio
muteAudio(): boolean
【功能说明】
禁用音频轨道。
【请求参数】
无
【返回参数】
boolean类型,true表示禁用音频轨道成功,false表示禁用音频轨道失败。
muteVideo
muteVideo(): boolean
【功能说明】
禁用视频轨道。
【请求参数】
无
【返回参数】
boolean类型,true表示禁用视频轨道成功,false表示禁用视频轨道失败。
unmuteAudio
unmuteAudio(): boolean
【功能说明】
启用音频轨道。
【请求参数】
无
【返回参数】
boolean类型,true表示启用音频轨道成功,false表示启用音频轨道失败。
unmuteVideo
unmuteVideo(): boolean
【功能说明】
启用视频轨道。
【请求参数】
无
【返回参数】
boolean类型,true表示启用视频轨道成功,false表示启用视频轨道失败。
getId
getId(): string
【功能说明】
获取Stream唯一标识ID。发布流中需包含视频流,发布后才能获取到有效的ID。
【请求参数】
无
【返回参数】
string类型,Stream唯一标识ID。
getUserId
getUserId(): string
【功能说明】
获取Stream所属的用户ID。对于本地流,如果在createStream的时候入参StreamConfig中没有设置该参数,则返回undefined。
【请求参数】
无
【返回参数】
string类型,Stream所属的用户ID。
setAudioOutput
setAudioOutput(deviceId: string): Promise<void>
【功能说明】
设置音频输出设备。
【请求参数】
deviceId:必选,string类型,音频输出设备的设备ID。
【返回参数】
Promise<void>:返回一个Promise对象。
setAudioVolume
setAudioVolume(volume: number): void
【功能说明】
设置音频音量大小。
【请求参数】
volume:必选,number类型,音量大小,取值范围为[0,100]。
【返回参数】
无
getAudioLevel
getAudioLevel(): number
【功能说明】
获取实时音量级别。
【请求参数】
无
【返回参数】
number类型,返回值在(0, 1)之间,通常该值大于0.1认为用户正在说话。
hasAudio
hasAudio(): boolean
【功能说明】
该Stream是否包含音频轨道。
【请求参数】
无
【返回参数】
boolean类型,true表示包含音频轨道,false表示不包含音频轨道。
hasVideo
hasVideo(): boolean
【功能说明】
该Stream 是否包含视频轨道
【请求参数】
无
【返回参数】
boolean类型,true表示包含视频轨道,false表示不包含视频轨道。
getAudioTrack
getAudioTrack(): MediaStreamTrack
【功能说明】
获取音频轨道
【请求参数】
无
【返回参数】
MediaStreamTrack类型。MediaStreamTrack类型详情可参见MediaStreamTrack。
getVideoTrack
getVideoTrack(resolutionId?:string): MediaStreamTrack
【功能说明】
获取视频轨道。
【请求参数】
resolutionId:可选,string类型。指定分辨率Id,如果不指定,默认选择分辨率最高的视频。
【返回参数】
MediaStreamTrack 类型。MediaStreamTrack类型详情可参见MediaStreamTrack。
getType
getType(): string
【功能说明】
获取流类型。用于判断一个流是主流还是辅流,辅流通常是一个屏幕共享流。
【请求参数】
无
【返回参数】
string类型,本地流:local,远端主流:main,远端辅流:auxiliary。
on
on(event: string, handler: function): void
【功能说明】
注册流对象事件回调接口。
- event:必选,string类型,事件名称。详细事件列表请参见RTCStreamEvent。
- handler:必选,function类型,事件处理方法。
【返回参数】
无
off
off(event: string, handler: function): void
【功能说明】
取消注册流对象事件回调接口。
- event:必选,string类型,事件名称。详细事件列表请参见RTCStreamEvent。
- handler:必选,function类型,事件处理方法。
【返回参数】
无
getStreamInfo
getStreamInfo(): StreamInfo
【功能说明】
获取已经初始化的本地流,或者收到的远端流的的信息。
【请求参数】
无
【返回参数】
StreamInfo 类型定义如下:{
- videoProfiles:RTCVideoProfileInfo[]类型。
- audioProfile:RTCAudioProfile类型。
}
RTCVideoProfileInfo类型定义如下:{
- resolutionId:string类型,表示分辨率Id。
- hasTrack:boolean类型,表示该分辨率的视频是否具备可播放的track。
- width:number类型,分辨率的宽度,单位为像素。
- height:number类型,分辨率的高度,单位为像素。
- frameRate:number类型,视频帧率,单位为帧/秒。
- minBitrate:number类型,视频最小码率,单位为bps。
- maxBitrate:number类型,视频最大码率,单位为bps。
}
RTCAudioProfile类型定义如下:{
- sampleRate:number类型,表示音频采样率。
- channelCount:number类型,表示音频声道数。
- bitrate:number类型,表示音频码率,单位为bps。
}
getVideoSnapshot
getVideoSnapshot(resolutionId?: string,format?: string, encoderOptions?: number): string
【功能说明】
获取视频截图
【请求参数】
- resolutionId:可选,string类型。双流场景,指定需要截图的视频分辨率Id,resolutionId可通过接口getStreamInfo 获取。如果不传resolutionId,则默认对分辨率最高的视频流截图。
- format:可选,string类型。表示截图的格式,可填‘jpeg’、‘webp’、'png'。如果不传format,则默认使用png格式截图。
- encoderOptions:可选,number类型。format填‘jpeg’或者‘webp’时生效,表示图片质量,值范围【0,1】,默认值为1。
【返回参数】
string类型,表示视频截图对象的url,当视频未播放,或者resolutionId错误时,返回的string为空。