最近更新时间：2023.07.25 11:34:15
首次发布时间：2022.08.29 18:29:27
设置推流视频质量。SDK 内置多种视频质量模板，您可以通过内置模板来设置推流视频质量。
(quality: string) => Promise<void>
传入参数
| 参数名 | 类型 | 说明 |
|---|---|---|
| quality | string | 预定义的视频质量模版名称 |
视频质量模板详细说明如下表所示。
| 模版名称 | 分辨率 | 帧率（fps） | 码率（kbps） |
|---|---|---|---|
| 120p | 160×120 | 15 | 200 |
| 180p | 320×180 | 15 | 350 |
| 240p | 320×240 | 15 | 400 |
| 360p | 640×360 | 15 | 800 |
| 480p | 640×480 | 15 | 900 |
| 720p-1 | 1280×720 | 15 | 1500 |
| 720p-2 | 1280×720 | 25 | 1500 |
| 720p-3 | 1280×720 | 30 | 1500 |
| 1080p-1 | 1920×1080 | 15 | 2000 |
| 1080p-2 | 1920×1080 | 25 | 2000 |
| 1080p-3 | 1920*1080 | 30 | 2000 |
注意
WebTransport 推流不支持 360p 以下分辨率。
设置推流音频质量。SDK 内置音频质量模板，您可以通过内置模板来设置推流音频质量。
(quality: string) => Promise<void>
传入参数
| 参数名 | 类型 | 说明 |
|---|---|---|
| quality | string | 预定义的音频质量模版名称 |
音频质量模板详细说明如下表所示。
| 模版名称 | 采样率 | 码率（kbps） |
|---|---|---|
| STANDARD | 48000 | 40 |
| HIGHT | 48000 | 128 |
设置视频采集约束配置信息。
(config: MediaTrackConstraintSet) => Promise<void>
传入参数
| 参数名 | 类型 | 说明 |
|---|---|---|
| config | MediaTrackConstraintSet | 视频采集约束配置，详情请参见 MediaTrackConstraintSet |
设置音频采集约束配置信息。
(config: MediaTrackConstraintSet) => Promise<void>
传入参数
| 参数名 | 类型 | 说明 |
|---|---|---|
| config | MediaTrackConstraintSet | 音频采集约束配置，详情请参见 MediaTrackConstraintSet |
设置推流视频最大码率。
(bitrate: number) => Promise<void>
传入参数
| 参数名 | 类型 | 说明 |
|---|---|---|
| bitrate | number | 最大视频码率，单位为 bps |
设置推流音频最大码率。
(bitrate: number) => Promise<void>
传入参数
| 参数名 | 类型 | 说明 |
|---|---|---|
| bitrate | number | 最大音频码率，单位为 bps |
开始采集视频。
(deviceId: string) => Promise<void>
传入参数
| 参数名 | 类型 | 说明 |
|---|---|---|
| deviceId | string | 可用的视频采集设备 ID |
停止采集视频。
() => Promise<void>
切换视频采集设备。
(deviceId: string) => Promise<void>
传入参数
| 参数名 | 类型 | 说明 |
|---|---|---|
| deviceId | string | 需要切换的摄像头设备 ID |
开始采集音频。
(deviceId: string) => Promise<void>
传入参数
| 参数名 | 类型 | 说明 |
|---|---|---|
| deviceId | string | 可用的音频采集设备 ID |
停止采集音频。
() => Promise<void>
切换音频采集设备。
(deviceId: string) => Promise<void>
传入参数
| 参数名 | 类型 | 说明 |
|---|---|---|
| deviceId | string | 可用的音频采集设备 ID |
开始采集屏幕。
() => Promise<void>
停止采集屏幕。
() => Promise<void>
音频设备输入音量检测。音量取值范围为 [1,10] 。
() => Promise<void>
注意
检测输入音量时，需要保证当前音频采集状态为采集中。
停止音频设备输入音量检测。
() => Promise<void>
开始本地视频采集。
(file: File | string) => Promise<void>
注意
webtransport 推流不支持本地视频采集。
传入参数
| 参数名 | 类型 | 说明 |
|---|---|---|
| file | string | File | 本地上传的视频或者在线视频地址，支持 mp4 格式 |
停止本地视频采集。
() => Promise<void>
开始混音。
(url: string, loop: boolean) => Promise<void>
注意
开始混音时，需要确保当前处于音频采集状态。
传入参数
| 参数名 | 类型 | 说明 |
|---|---|---|
| url | string | 混音文件本地 blob 地址或 CDN 地址 |
loop | boolean | 循环方式。
|
暂停混音。
() => Promise<void>
重启混音播放。
() => Promise<void>
停止混音。如果已经在推流中，会自动结束混音流发布，替换成音频设备采集流。
() => Promise<void>
设置本地预览画面的预览容器。
(containerId: string) => Promise<void>
传入参数
| 参数名 | 类型 | 说明 |
|---|---|---|
| containerId | string | div 容器的 id 属性 |
预览已经采集到的音视频。
(type: TRACK_TYPES) => Promise<void>
传入参数
| 参数名 | 类型 | 说明 |
|---|---|---|
| type | TRACK_TYPES | 预览的音视频流类型 |
音视频流类型的枚举值如下所示。
| 属性 | 值 |
|---|---|
| CAMERA | 1 |
| AUDIO | 2 |
| SCREEN | 3 |
| FILE_VIDEO | 4 |
| FILE_AUDIO | 5 |
停止音视频本地预览。
(type: TRACK_TYPES) => Promise<void>
传入参数
| 参数名 | 类型 | 说明 |
|---|---|---|
| type | TRACK_TYPES | 停止预览的音视频流类型 |
音视频流类型的枚举值如下所示。
| 属性 | 值 |
|---|---|
| CAMERA | 1 |
| AUDIO | 2 |
| SCREEN | 3 |
| FILE_VIDEO | 4 |
| FILE_AUDIO | 5 |