NERTC Web SDK
NERTC Web SDK提供完善的音视频通话JavaScript开发框架,提供基于网络的视频通话和语音通话功能,支持在网页中调用API快速建立音视频连接,进行音视频通话和推流的服务。
完整的NERTC Web SDK由WEBRTC2、Client和Stream三部分组成
WEBRTC2对象
方法 | 功能描述 |
---|---|
createClient | 创建客户端 |
createStream | 创建音视频流对象 |
getDevices | 获取可用的媒体输入/输出设备 |
getCameras | 获取可用的视频输入设备 |
getMicrophones | 获取可用的音频输入设备 |
getSpeakers | 获取可用的音频输出设备 |
destroy | 销毁客户端 |
Client客户端对象
客户端管理
方法 | 功能描述 |
---|---|
createClient | 创建客户端对象实例 |
destroy | 销毁客户端对象实例 |
频道管理
方法 | 功能描述 |
---|---|
join | 加入音视频频道 |
leave | 离开音视频频道 |
setChannelProfile | 设置频道场景 |
setClientRole | 设置用户角色 |
publish | 发布音视频流 |
unpublish | 取消发布音视频流 |
subscribe | 接收远端音视频流 |
unsubscribe | 取消接收远端音视频流 |
setRemoteVideoStreamType | 动态更新订阅视频的分辨率 |
getConnectionState | 主动获取网络连接状态。 |
旁路推流管理
方法 | 功能描述 |
---|---|
addTasks | 增加旁路推流任务 |
deleteTasks | 删除旁路推流任务 |
updateTasks | 更新旁路推流任务 |
设备数据
方法 | 功能描述 |
---|---|
getSystemStats | 获取系统电量 |
getTransportStats | 获取网络连接状况统计数据 |
音视频数据统计
方法 | 功能描述 |
---|---|
getLocalAudioStats | 获取本地发布流的音频统计数据 |
getLocalVideoStats | 获取本地发布流的视频统计数据 |
getRemoteAudioStats | 获取远端订阅流的音频统计数据 |
getRemoteVideoStats | 获取远端订阅流的视频统计数据 |
getSessionStats | 获取会话的连接状况统计数据 |
Stream音视频流对象
音视频流管理
方法 | 功能描述 |
---|---|
createStream | 创建音视频流对象 |
destroy | 销毁音视频流对象 |
init | 初始化音视频流对象 |
play | 播放音视频流 |
stop | 停止播放音视频流 |
open | 打开音视频流输入设备,如麦克风 |
close | 关闭音视频流输入设备,如麦克风 |
音频管理
方法 | 功能描述 |
---|---|
setAudioProfile | 设置音频属性 |
setAudioVolume | 设置音频播放的音量 |
setCaptureVolume | 设置麦克风采集的音量 |
muteAudio | 禁用音频轨道 |
unmuteAudio | 启用音频轨道 |
getAudioLevel | 获取当前麦克风采集音量 |
hasAudio | 当前Stream是否有音频 |
setAudioOutput | 设置音频输出设备 |
视频管理
方法 | 功能描述 |
---|---|
setVideoProfile | 设置视频属性 |
setSubscribeConfig | 设置视频订阅的参数 |
setScreenProfile | 设置屏幕共享属性 |
muteVideo | 禁用视频轨道 |
unmuteVideo | 启用视频轨道 |
setLocalRenderMode | 设置本端视频画面大小 |
setRemoteRenderMode | 设置对端视频画面大小 |
takeSnapshot | 截取指定用户的视频画面(文件保存在浏览器默认路径) |
音乐文件播放及混音
方法 | 功能描述 |
---|---|
startAudioMixing | 开始播放音乐文件和本地麦克风声音的混合 |
pauseAudioMixing | 暂停播放音乐文件 |
resumeAudioMixing | 恢复播放音乐文件 |
stopAudioMixing | 停止播放音乐文件 |
adjustAudioMixingVolume | 调节音乐文件播放音量 |
getAudioMixingDuration | 获取音乐文件的总长度 |
setAudioMixingPosition | 获取音乐文件当前播放进度 |
录制管理
方法 | 功能描述 |
---|---|
startMediaRecording | 开启单人视频录制 |
stopMediaRecording | 结束视频录制 |
playMediaRecording | 播放录制的音视频文件 |
listMediaRecording | 枚举已录制的音视频文件 |
cleanMediaRecording | 清除录制的音视频 |
downloadMediaRecording | 下载录制的音视频 |
本篇文档内容是否对您有帮助?


此文档对你是否有帮助
×


×