实时音视频 SPARKRTC-主入口（HRTC）:createStream

时间：2024-09-13 11:45:24

实时音视频 SPARKRTC

createStream

(static) createStream(config: StreamConfig): Stream

【功能说明】

创建本地流对象。

【请求参数】

config：必选，StreamConfig类型，指定创建流的参数。

StreamConfig 定义为：{

screen：可选，boolean类型，如果为true表示该流对象采集的是辅流音视频。辅流即共享屏幕的流。默认值为false，即该流对象采集的是主流音视频。
video：可选，boolean类型，指定是否采集主流的视频，主流即摄像头的流。默认值为false。
audio：可选，boolean类型，指定是否采集主流的音频。默认值为false。screen为false的时候该参数有效。
microphoneId：可选，string类型，在audio为true的时候有效，表示采集音频的源麦克风设备Id。如果不传，系统自动设置默认值。
cameraId：可选，string类型，在video为true的时候有效，表示采集视频的摄像头设备Id。如果不传，系统自动设置默认值。
facingMode：可选，string类型，在video为true的时候有效，user表示前置摄像头，environment表示后置摄像头。
screenAudio：可选，boolean类型，是否包含屏幕共享背景音。默认值为false。该功能仅支持Windows平台Chrome浏览器 74及以上版本。该字段为1.4.0版本新增。
audioSource：可选，MediaStreamTrack类型，表示输入音轨对象。通过指定Track设置音频。MediaStreamTrack为Web API基本接口。
videoSource：可选，MediaStreamTrack类型，表示输入视轨对象。通过指定Track设置主流视频。MediaStreamTrack为Web API基本接口。
mirror：可选，boolean类型，表示主流的本地视频是否镜像。默认值为false。
userId：可选，string类型，表示该流归属的userId。

}

【返回参数】

Stream：流对象。

在采集主流有两种方式：
- 通过“audioSource”和“videoSource”设置音频和视频主流。这种模式下不支持大小流。
- 通过“audio/microphoneId”和“video/cameraId/facingMode”设置音频和视频主流。
如果未指定任何的音频源和视频源，则创建的流对象不包含音频流和视频流，无法播放。
如果采集视频，同一个Stream对象不能同时采集主流和辅流。
如果需要包含屏幕共享背景音，需要设置screen和screenAudio均为true，该参数仅在1.4.0 及以上版本生效。