API 概览

最近更新时间:2019-01-12 15:45:26

查看pdf

实时音视频 Web API 中包括了主动调用类的功能接口和触发设置的事件通知类接口,其中功能接口有基础功能接口和高级功能接口,事件通知有基础事件通知和高级事件通知。初级开发人员可以通过基础功能接口和基础事件通知完成基础开发接入,即可体验实时音视频主要功能。高级开发人员可以通过高级功能接口和高级事件通知的开发,体验实时音视频更高级功能。

基础功能接口

API 描述
WebRTCAPI.fn.detectRTC 检测是否支持 WebRTC
WebRTCAPI 初始化
WebRTCAPI.getLocalStream 获取本地音频/视频流
WebRTCAPI.enterRoom 创建或进入音视频房间
WebRTCAPI.startRTC 主动推流才需要用到
WebRTCAPI.stopRtc 停止推流
WebRTCAPI.quit 退出音视频房间

基础事件通知

事件 描述
onLocalStreamAdd 本地视频流新增/更新
onRemoteStreamUpdate 远端视频流新增/更新
onRemoteStreamRemove 远端视频流断开
onWebSocketClose websocket 断开
onRelayTimeout 视频流 server 超时断开
onKickout 被踢下线(同一个用户重复登录)

高级功能接口

API 描述
WebRTCAPI.updateStream 更新视频流
WebRTCAPI.openVideo 推流期间重新打开视频采集
WebRTCAPI.closeVideo 推流期间暂时关闭视频采集
WebRTCAPI.openAudio 推流期间重新打开音频采集
WebRTCAPI.closeAudio 推流期间暂时关闭音频采集
WebRTCAPI.changeSpearRole 切换音视频参数设定
WebRTCAPI.getVideoDevices 枚举视频采集设备
WebRTCAPI.getAudioDevices 枚举音频采集设备
WebRTCAPI.chooseVideoDevice 选择视频采集设备
WebRTCAPI.chooseAudioDevice 选择音频采集设备
WebRTCAPI.SoundMeter 声音输入检测

高级事件通知

事件 描述
onPeerConnectionAdd PeerConnection 新增通知 ,请确保您已经了解了 peer connection 通知的作用和意义

更新日志

2.6.1

## WebRTCAPI.getSpeakerDevices
    枚举音频输出设备
## WebRTCAPI.chooseSpeakerDevice
    枚举音频输出设备

联系我们

关注公众号"腾讯云视频",给公众号发关键字"技术支持",会有专人联系。