NERTC Windows&macOS SDK

NERTC SDK 提供完善的音视频通话开发框架,提供基于网络的视频通话和语音通话功能,还提供多人视频和音频会议功能,支持通话中音视频设备控制和实时音视频模式切换,支持视频采集数据回调以实现美颜等自定义功能。

频道管理

方法 功能描述
initialize 初始化 NERTC SDK 服务
release 销毁 IRtcEngine 对象
setChannelProfile 设置频道场景
joinChannel 加入频道
leaveChannel 离开频道
getConnectionState 获取网络连接状态
queryInterface Retrieves the pointer to the device manager object.

频道事件

事件 事件描述
onJoinChannel 加入频道回调
onRejoinChannel 重新加入频道回调
onLeaveChannel 离开频道回调
onUserJoined 远端用户加入当前频道回调
onUserLeft 远端用户离开当前频道回调
onDisconnect 服务器连接断开回调

音频管理

方法 功能描述
enableLocalAudio 开关本地音频采集
setAudioProfile 设置音频编码配置
muteLocalAudioStream 开关本地音频发送
subscribeRemoteAudioStream 订阅/取消订阅指定音频流。

视频管理

方法 功能描述
enableLocalVideo 开关本地视频
setVideoConfig 设置视频发送配置
setupLocalVideoCanvas 设置本地用户视图
setupRemoteVideoCanvas 设置远端用户视图
setLocalRenderMode 设置本地视图显示模式
setRemoteRenderMode 设置远端视图显示模式
startVideoPreview 开启视频预览
stopVideoPreview 停止视频预览
muteLocalVideoStream 开关本地视频发送
subscribeRemoteVideoStream 订阅 / 取消订阅指定远端用户的视频流
setLocalVideoMirrorMode 设置本地视频镜像模式
setParameters 复杂参数设置

本地媒体事件

事件 事件描述
onFirstVideoDataReceived 已显示首帧远端视频回调
onFirstAudioDataReceived 已接收到远端音频首帧回调
onFirstAudioFrameDecoded 已解码远端音频首帧的回调
onFirstVideoFrameDecoded 已接收到远端视频并完成解码回调

远端媒体事件

事件 事件描述
onUserAudioStart 远端用户开启音频回调
onUserAudioStop 远端用户停用音频回调
onUserVideoStart 远端用户开启视频回调
onUserVideoStop 远端用户停用视频回调
onUserVideoProfileUpdate 远端用户视频配置更新回调
onUserAudioMute 远端用户是否静音回调
onUserVideoMute 远端用户是否禁视频流回调

数据统计事件

事件 事件描述
onRemoteAudioStats 通话中远端音频流的统计信息回调
onRtcStats 当前通话统计回调
onNetworkQuality 通话中每个用户的网络上下行质量报告回调
onLocalAudioStats 本地音频流统计信息回调
onLocalVideoStats 本地视频流统计信息回调
onRemoteVideoStats 通话中远端视频流的统计信息回调
setStatsObserver 注册统计信息观测器
getVersion 查询 SDK 版本号

屏幕共享

方法 功能描述
startScreenCaptureByDisplayId 通过屏幕 ID 共享屏幕,该方法仅适用于 macOS
startScreenCaptureByWindowId 通过窗口 ID 共享窗口
updateScreenCaptureRegion 更新屏幕共享区域
stopScreenCapture 停止屏幕共享
startScreenCaptureByScreenRect 通过指定区域共享屏幕

音乐文件播放及混音

方法 功能描述
startAudioMixing 开始播放音乐文件
stopAudioMixing 停止播放音乐文件
pauseAudioMixing 暂停播放音乐文件
resumeAudioMixing 恢复播放音乐文件
setAudioMixingPlaybackVolume 设置音乐文件播放音量
setAudioMixingSendVolume 设置音乐文件的发送音量
getAudioMixingPlaybackVolume 获取音乐文件的播放音量
getAudioMixingSendVolume 获取音乐文件的发送音量
getAudioMixingDuration 获取音乐文件的总长度
getAudioMixingCurrentPosition 获取音乐文件的播放进度
setAudioMixingPosition 设置音乐文件的播放进度
事件 事件描述
onAudioMixingStateChanged 本地用户的音乐文件播放状态改变回调
onAudioMixingTimestampUpdate 本地用户的音乐文件播放进度回调

音效文件播放管理

方法 功能描述
getEffectPlaybackVolume 获取音效文件播放音量
setEffectPlaybackVolume 设置音效文件播放音量
playEffect 播放指定音效文件
stopEffect 停止播放指定音效文件
stopAllEffects 停止播放所有音效文件
pauseEffect 暂停音效文件播放
pauseAllEffects 暂停所有音效文件播放
resumeEffect 恢复播放指定音效文件
resumeAllEffects 恢复播放所有音效文件
setEffectSendVolume 调节音效文件发送音量
getEffectSendVolume 获取音效文件发送音量
事件 事件描述
onAudioEffectFinished 本地音效文件播放已结束回调

音量提示

方法 功能描述
enableAudioVolumeIndication 启用说话者音量提示
事件 事件描述
onRemoteAudioVolumeIndication 提示频道内谁正在说话及说话者音量的回调
onLocalAudioVolumeIndication 提示频道内本地用户瞬时音量的回调

耳返

方法 功能描述
enableEarback 开启耳返功能
setEarbackVolume 设置耳返音量

旁路推流

方法 功能描述
addLiveStreamTask 添加房间推流任务
updateLiveStreamTask 更新修改房间推流任务
removeLiveStreamTask 删除房间推流任务
事件 事件描述
onAddLiveStreamTask 通知添加直播任务结果
onUpdateLiveStreamTask 通知更新直播任务结果
onRemoveLiveStreamTask 通知删除直播任务结果
onLiveStreamState 通知直播推流状态

视频自采集

方法 功能描述
setExternalVideoSource 配置外部视频源
pushExternalVideoFrame 推送外部视频帧

原始音视频数据

方法 功能描述
setRecordingAudioFrameParameters 设置录制的声音格式
setPlaybackAudioFrameParameters 设置播放的声音格式
setAudioFrameObserver 注册语音观测器对象
事件 事件描述
onCaptureVideoFrame 采集视频数据回调。
onAudioFrameDidRecord 采集音频数据回调。
onAudioFrameWillPlayback 播放音频数据回调。

## 设备管理事件

事件 事件描述
onAudioDeviceStateChanged 音频设备状态更改回调
onAudioDefaultDeviceChanged 音频默认设备更改回调
onVideoDeviceStateChanged 视频设备状态更改回调

故障排查

方法 功能描述
startAudioDump 开始记录音频 dump 音频 dump 可用于分析音频问题
stopAudioDump 结束记录音频 dump
getErrorDescription 获取错误描述。
uploadSdkInfo 上传SDK日志信息
事件 事件描述
onError 发生错误回调
onWarning 发生警告回调