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

IRtcEngine 接口类包含应用程序调用的主要方法。
IRtcCallback 接口类用于向应用程序发送回调通知。
IVoiceEngine 接口类包含语音消息调用的主要方法。
IAudioDeviceManager 接口类提供用于管理音频设备的相关接口。
IDeviceCollection 接口类获取设备相关的信息。

错误码

在调用 SDK API 的过程中，SDK 可能会返回错误码或状态码。根据打印的日志，您可以判断当前 SDK 或任务的状态。如果遇到未知的错误码，请提交工单联系网易云信技术支持工程师排查。

当前 SDK API 的错误码如下：

日志等级：nertc::wwiseplugin::RtcLogLevel
错误码：nertc::wwiseplugin::RtcErrorCode

房间管理

方法	功能	起始版本
Release	销毁 IRtcEngine 对象。	V5.4.109
GetVersion	查询 SDK 版本号。	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
OnConnectionStateChanged	房间连接状态已改变回调。	V5.4.109

音频管理

方法	功能	起始版本
SetPublishAudioAllowList	设置音频流只能被指定的用户订阅。	V5.4.109
SetSubscribeAudioAllowList	设置指定订阅的音频流。	V5.4.109

语音消息

方法	功能	起始版本
setEvents	为 nertc_voice_engine 对象指定一个或多个事件处理函数。	V5.4.127
setAuth	语音模块鉴权。	V5.4.127
setMaxMessageLength	设置语音消息最大长度。	V5.4.127
startRecording	开始录制语音消息。	V5.4.127
stopRecording	停止录制语音消息。	V5.4.127
pauseRecording	暂停录制语音消息。	V5.4.127
resumeRecording	恢复录制语音消息。	V5.4.127
cancelRecording	取消制语音消息。	V5.4.127
uploadRecordedFile	上传录制的语音消息。	V5.4.127
downloadRecordedFile	下载录制的语音消息。	V5.4.127
stopPlayFile	停止播放录制的语音消息。	V5.4.127
speechToText	语音转文字。	V5.4.127
getFileSize	获取文件大小。	V5.4.127
getVoiceFileDuration	获取语音消息时长。	V5.4.127
setMicVolume	设置麦克风录制音量。	V5.4.127
getMicVolume	获取麦克风录制音量。	V5.4.127
setSpeakerVolume	设置语音播放音量。	V5.4.127
getSpeakerVolume	获取语音播放音量。	V5.4.127

方法	功能	起始版本
OnAuth	语音消息鉴权回调。	V5.4.127
OnRecordCompleted	语音消息录制完毕回调。	V5.4.127
OnPlayCompleted	语音消息播放完毕回调。	V5.4.127
OnUploadCompleted	语音消息上传完毕回调。	V5.4.127
OnDownloadCompleted	语音消息下载完毕回调。	V5.4.127
OnSpeechToTextCompleted	语音消息转文字完毕回调。	V5.4.127
OnRecordingVolume	设置录制音量回调。	V5.4.127
OnPlayingVolume	设置播放音量回调。	V5.4.127

本地媒体事件

方法	功能	起始版本
OnFirstAudioDataReceived	已接收到远端音频首帧回调。	V5.4.109
OnFirstAudioFrameDecoded	已解码远端音频首帧的回调。	V5.4.109

远端媒体事件

方法	功能	起始版本
OnUserAudioStart	远端用户开启音频主流回调。	V5.4.109
OnUserAudioStop	远端用户停用音频主流回调。	V5.4.109
OnUserAudioMute	远端用户是否静音主流回调。	V5.4.109

音量提示

方法	功能	起始版本
EnableAudioVolumeIndication	启用说话者音量提示。	V5.4.109

事件	描述	起始版本
OnRemoteAudioVolumeIndication	提示房间内谁正在说话及说话者音量的回调。	V5.4.109
OnLocalAudioVolumeIndication	提示房间内本地用户瞬时音量的回调。	V5.4.109

音频设备管理

方法	功能	起始版本
enumerateRecordDevices	枚举音频采集设备。	V5.4.109
setRecordDevice	设置当前音频采集设备。	V5.4.109
getRecordDevice	获取当前音频采集设备。	V5.4.109
setRecordDeviceVolume	设置当前音频采集设备音量。	V5.4.109
getRecordDeviceVolume	获取当前音频采集设备音量。	V5.4.109
setRecordDeviceMute	设置当前采集设备静音状态。	V5.4.109
getRecordDeviceMute	获取当前采集设备静音状态。	V5.4.109
startRecordDeviceTest	开始测试音频采集设备。	V5.4.109
stopRecordDeviceTest	停止测试音频采集设备。	V5.4.109
GetEnableLoopbackWithGameObjectID	开启或关闭 loopback。	V5.4.109
GetEnableLoopbackWithGameObjectID	查询是否开启或关闭 loopback。	V5.4.109
startAudioDeviceLoopbackTest	开始音频采集播放设备回路测试。	V5.4.109
stopAudioDeviceLoopbackTest	停止音频采集播放设备回路测试。	V5.4.109

设备管理事件

方法	功能	起始版本
OnAudioDeviceStateChanged	音频设备状态更改回调。	V5.4.109
OnAudioDefaultDeviceChanged	音频默认设备更改回调。	V5.4.109

空间音效（3D 音效）

方法	功能	起始版本
SetAudioRecvRange	设置空间音效的距离衰减属性和语音范围。	V5.4.109
UpdateSelfPosition	设置说话者和接收者的位置信息。	V5.4.109
SetRangeAudioMode	设置渲染模式。	V5.4.109
SetRangeAudioTeamID	设置范围语音小队 ID。	V5.4.109

故障排查

方法	功能	起始版本
StartAudioDump	开始记录音频 dump。	V5.4.109
StopAudioDump	结束记录音频 dump	V5.4.109

事件	描述	起始版本
OnError	发生错误回调。	V5.4.109
OnWarning	发生警告回调。	V5.4.109