Introduction

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

• IRtcEngine 接口类包含应用程序调用的主要方法。
• IRtcEngineEx 接口类包含应用程序调用的扩展方法。
• IRtcEngineEventHandler 接口类用于向应用程序发送回调通知。
• IRtcMediaStatsObserver 接口类用于向应用程序发送扩展的媒体回调通知。
• INERtcAudioFrameObserver 接口类用于向应用程序发送音频数据帧回调通知。
• IAudioDeviceManager 接口类用于向应用程序使用音频设备相关功能方法。

错误码

在调用 SDK API 的过程中，SDK 可能会返回错误码或状态码，您可以根据错误码或状态码判断当前 SDK 或任务的状态。如果遇到未知的错误码，请联系技术支持排查。

当前 SDK API 的错误码如下：

• 通用错误码：nertc::NERtcErrorCode
• 混音相关错误码：nertc::NERtcAudioMixingErrorCode
• 视频水印状态码：nertc::NERtcLocalVideoWatermarkState
• 警告码：nertc::NERtcWarnCode

房间管理

方法	功能	起始版本
createNERtcEngine	创建 RTC 引擎对象。	V5.4.109
initialize	初始化 NERTC SDK 服务。	V5.4.109
release	销毁 IRtcEngine 对象。	V5.4.109
getVersion	查询 SDK 版本号。	V5.4.109
setChannelProfile	设置房间场景。	V5.4.109
setClientRole	设置用户角色。	V5.4.109
joinChannel	加入房间，可以携带鉴权密钥等特定参数。	V5.4.109
leaveChannel	离开房间。	V5.4.109
switchChannel	快速切换房间。	V5.4.109
getConnectionState	获取房间连接状态。	V5.4.109
queryInterface	获取设备管理员对象的指针。	V5.4.109
setParameters	设置音视频通话的相关参数。	V5.4.109

房间事件

事件	描述	起始版本
onClientRoleChanged	用户角色已切换回调。	V5.4.109
onJoinChannel	加入房间回调。	V5.4.109
onRejoinChannel	重新加入房间回调。	V5.4.109
onLeaveChannel	离开房间回调。	V5.4.109
onUserJoined	远端用户加入当前房间回调。	V5.4.109
onUserLeft	远端用户离开当前房间回调。	V5.4.109
onDisconnect	服务器连接断开回调。	V5.4.109
onReconnectingStart	开始重连回调。	V5.4.109
onConnectionStateChange	房间连接状态已改变回调。	V5.4.109
onReleasedHwResources	通话结束设备资源释放回调。	V5.4.109

音频管理

方法	功能	起始版本
setAudioProfile	设置音频编码配置	V5.4.109
adjustRecordingSignalVolume	调节采集信号音量。	V5.4.109
adjustPlaybackSignalVolume	调节本地播放音量。	V5.4.109
enableLocalAudio	开关本地音频采集	V5.4.109
muteLocalAudioStream	开关本地音频发送	V5.4.109
subscribeRemoteAudioStream	订阅／取消订阅指定音频流。	V5.4.109
subscribeAllRemoteAudioStream	订阅或取消订阅所有音频流。	V5.4.109
setPublishAudioAllowList	设置本地用户音频只能被房间内其他指定用户订阅	V5.4.109
enableMediaPublish	发布或停止发布本地音频	V5.4.109

本地媒体事件

方法	功能	起始版本
onFirstAudioDataReceived	已接收到远端音频首帧回调	V5.4.109
onFirstAudioFrameDecoded	已解码远端音频首帧的回调	V5.4.109
onMediaRightChange	服务端禁言音视频权限变化回调。	V5.4.109

远端媒体事件

方法	功能	起始版本
onUserAudioStart	远端用户开启音频主流回调	V5.4.109
onUserAudioStop	远端用户停用音频主流回调	V5.4.109
onUserAudioMute	远端用户是否静音主流回调	V5.4.109

数据统计事件

方法	功能	起始版本
onRemoteAudioStats	通话中远端音频流的统计信息回调	V5.4.109
onRtcStats	当前通话统计回调	V5.4.109
onNetworkQuality	通话中每个用户的网络上下行质量报告回调	V5.4.109
onLocalAudioStats	本地音频流统计信息回调	V5.4.109
setStatsObserver	注册统计信息观测器	V5.4.109

变声与混响

方法	功能	起始版本
setAudioEffectPreset	设置 SDK 预设的人声的变声音效。	V5.4.109
setVoiceBeautifierPreset	设置 SDK 预设的美声效果。	V5.4.109
setLocalVoiceEqualization	设置本地语音音效均衡，即自定义设置本地人声均衡波段的中心频率。	V5.4.109
setLocalVoicePitch	设置本地语音音调。	V5.4.109

音量提示

方法	功能	起始版本
enableAudioVolumeIndication	启用说话者音量提示	V5.4.109
enableAudioVolumeIndication	启用说话者音量及本地是否有人声提示	V5.4.109

事件	描述	起始版本
onRemoteAudioVolumeIndication	提示房间内谁正在说话及说话者音量的回调	V5.4.109
onLocalAudioVolumeIndication	提示房间内本地用户瞬时音量的回调	V5.4.109
onLocalAudioVolumeIndication	提示房间内本地用户瞬时音量及是否存在人声的回调	V5.4.109

音频设备管理

方法	功能	起始版本
enumerateRecordDevices	枚举音频采集设备	V5.4.109
setRecordDevice	设置音频采集设备	V5.4.109
getRecordDevice	获取当前音频采集设备	V5.4.109
enumeratePlayoutDevices	枚举音频播放设备	V5.4.109
setPlayoutDevice	设备音频播放设备	V5.4.109
getPlayoutDevice	获取当前音频播放设备	V5.4.109
setRecordDeviceVolume	设置当前音频采集设备音量	V5.4.109
getRecordDeviceVolume	获取当前音频采集设备音量	V5.4.109
setPlayoutDeviceVolume	设置当前音频播放设备音量	V5.4.109
getPlayoutDeviceVolume	获取当前音频播放设备音量	V5.4.109
setPlayoutDeviceMute	设置当前播放设备静音状态	V5.4.109
getPlayoutDeviceMute	获取当前播放设备静音状态	V5.4.109
setRecordDeviceMute	设置当前采集设备静音状态	V5.4.109
getRecordDeviceMute	获取当前采集设备静音状态	V5.4.109
startRecordDeviceTest	开始测试音频采集设备	V5.4.109
stopRecordDeviceTest	停止测试音频采集设备	V5.4.109
startPlayoutDeviceTest	开始测试音频播放设备	V5.4.109
stopPlayoutDeviceTest	停止测试音频播放设备	V5.4.109
startAudioDeviceLoopbackTest	开始音频采集播放设备回路测试	V5.4.109
stopAudioDeviceLoopbackTest	停止音频采集播放设备回路测试	V5.4.109

事件	描述	起始版本
onAudioHowling	检测到啸叫回调。	V5.4.109

设备管理事件

方法	功能	起始版本
onAudioDeviceStateChanged	音频设备状态更改回调	V5.4.109
onAudioDefaultDeviceChanged	音频默认设备更改回调	V5.4.109
onVideoDeviceStateChanged	视频设备状态更改回调	V5.4.109

空间音效（3D 音效）

方法	功能	起始版本
enableSpatializer	开启/关闭空间音效	V5.4.109
setAudioRecvRange	设置空间音效的距离衰减属性和语音范围	V5.4.109
updateSelfPosition	设置说话者和接收者的位置信息	V5.4.109
setRangeAudioMode	设置渲染模式	V5.4.109
setRangeAudioTeamID	设置范围语音小队ID	V5.4.109

故障排查

方法	功能	起始版本
startAudioDump	开始记录音频 dump。	V5.4.109
startAudioDump	开始记录音频 dump。	V5.4.109
stopAudioDump	结束记录音频 dump	V5.4.109
getErrorDescription	获取错误描述。	V5.4.109
uploadSdkInfo	上传SDK日志信息	V5.4.109

事件	描述	起始版本
onError	发生错误回调	V5.4.109
onWarning	发生警告回调	V5.4.109