本章节为您介绍 Web 推流 SDK 的接口概览。
VePusher 中包含的子类如下表所示。
| 名称 | 类型 | 描述 |
|---|---|---|
| device | Device | 设备管理相关信息 |
| capture | Capture | 音视频采集相关信息 |
| pusher | Pusher | 推流器相关信息 |
| observer | Observer | 数据、设备监听相关信息 |
设备管理对象，主要用于获取设备列表等。功能介绍如下表所示。
| 名称 | 描述 |
|---|---|
| checkSupport | 是否支持 RTM 推流 |
| getMicrophones | 获取麦克风设备列表 |
| getCameras | 获取摄像头设备列表 |
通过管理本地摄像头、麦克风、屏幕共享以及视频媒体文件的状态，进行音视频数据的采集。功能介绍如下表所示。
| 名称 | 描述 |
|---|---|
| setVideoQuality | 设置推流视频质量 |
| setAudioQuality | 设置推流音频质量 |
| setVideoCaptureConfig | 设置视频流 MediaTrackConstraints 参数 |
| setAudioCaptureConfig | 设置音频流 MediaTrackConstraints 参数 |
| setVideoBitrate | 设置视频流码率 |
| setAudioBitrate | 设置音频流码率 |
| startCamera | 打开本地摄像头设备 |
| stopCamera | 关闭本地摄像头设备 |
| switchCamera | 切换当前摄像头设备 |
| startMicrophone | 打开本地麦克风设备 |
| stopMicrophone | 关闭麦克风设备 |
| switchMicrophone | 切换当前麦克风设备 |
| startScreenCapture | 开启屏幕采集 |
| stopScreenCapture | 关闭屏幕采集 |
| startVolumeDetect | 音频设备输入音量检测 |
| stopVolumeDetect | 停止音频设备输入音量检测 |
| startMediaFile | 开始采集本地媒体文件流 |
| stopMediaFile | 停止采集本地媒体流文件，结束本地文件播放 |
| startAudioMix | 开始混音 |
| pauseAudioMix | 暂停混音 |
| resumeAudioMix | 继续混音 |
| stopAudioMix | 停止混音 |
| setRenderView | 设置本地预览画面的预览容器 |
| startPreview | 开始音视频数据预览 |
| stopPreview | 停止音视频数据预览 |
将采集到的音视频流推送到远端。功能介绍如下表所示。
| 名称 | 描述 |
|---|---|
| isPushing | 获取当前推流器是否正在推流中 |
| startPush | 开始音视频数据推流，建立 WebRTC 连接 |
| updatePush | 更新音视频推流数据类型 |
| stopPush | 停止推送音视频数据，同时关闭 WebRTC 连接 |
| setVideoMute | 设置是否推送黑帧画面 |
| setAudioMute | 设置是否推送静音帧 |
音视频采集和推流的回调通知，回调主要包括推流器状态、设备切换、警告已经错误信息等。功能介绍如下表所示。
| 名称 | 描述 |
|---|---|
| onError | 错误时的回调通知 |
| onWarning | 警告回调通知 |
| onCaptureFirstAudioFrame | 首帧音频采集完成的回调通知 |
| onCaptureFirstVideoFrame | 首帧视频采集完成的回调通知 |
| onPushStatusUpdate | 连接状态回调通知 |
| onMicrophoneChanged | 麦克风设备切换回调通知 |
| onCameraChanged | 摄像头设备切换回调通知 |
| onTrackEnded | 采集过程中，非正常结束的回调通知 |