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

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

房间管理

方法	功能	起始版本
createNERtcEngine	创建 RTC 引擎对象。	V3.5.0
destroyNERtcEngine	销毁 RTC 引擎对象。	V3.5.0
initialize	初始化 NERTC SDK 服务。	V3.5.0
release	销毁 IRtcEngine 对象。	V3.5.0
getVersion	查询 SDK 版本号。	V3.5.0
setChannelProfile	设置房间场景。	V3.6.0
setClientRole	设置用户角色。	V3.9.0
joinChannel	加入房间。	V3.5.0
leaveChannel	离开房间。	V3.5.0
switchChannel	快速切换房间。	V3.5.0
getConnectionState	获取网络连接状态。	V3.5.0
queryInterface	获取设备管理员对象的指针。	V3.5.0
setParameters	设置音视频通话的相关参数。	V3.5.0

房间事件

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

音频管理

方法	功能	起始版本
setAudioProfile	设置音频编码配置	V3.5.0
adjustRecordingSignalVolume	调节录音音量	V3.5.0
adjustPlaybackSignalVolume	设置音频编码配置	V3.5.0
enableLocalAudio	开关本地音频采集	V3.5.0
muteLocalAudioStream	开关本地音频发送	V3.5.0
subscribeRemoteAudioStream	订阅／取消订阅指定音频流。	V3.5.0
startSystemAudioLoopbackCapture	开启本地声卡采集。仅支持 Windows 平台。	V4.0.0
stopSystemAudioLoopbackCapture	关闭本地声卡采集。仅支持 Windows 平台。	V4.0.0
setSystemAudioLoopbackCaptureVolume	设置本地声卡采集音量。仅支持 Windows 平台。	V4.0.0

视频管理

方法	功能	起始版本
enableLocalVideo	开关本地视频	V3.5.0
setVideoConfig	设置视频发送配置	V3.5.0
setupLocalVideoCanvas	设置本地用户视图	V3.5.0
setupRemoteVideoCanvas	设置远端用户视图	V3.5.0
setLocalRenderMode	设置本地视图显示模式	V3.5.0
setRemoteRenderMode	设置远端视图显示模式	V3.5.0
startVideoPreview	开启视频预览	V3.5.0
stopVideoPreview	停止视频预览	V3.5.0
muteLocalVideoStream	开关本地视频发送	V3.5.0
subscribeRemoteVideoStream	订阅 / 取消订阅指定远端用户的视频流	V3.5.0
setLocalVideoMirrorMode	设置本地视频镜像模式	V3.5.0

本地媒体事件

方法	功能	起始版本
onFirstVideoDataReceived	已显示首帧远端视频回调	V3.5.0
onFirstAudioDataReceived	已接收到远端音频首帧回调	V3.5.0
onFirstAudioFrameDecoded	已解码远端音频首帧的回调	V3.5.0
onFirstVideoFrameDecoded	已接收到远端视频并完成解码回调	V3.5.0

远端媒体事件

方法	功能	起始版本
onUserAudioStart	远端用户开启音频回调	V3.5.0
onUserAudioStop	远端用户停用音频回调	V3.5.0
onUserVideoStart	远端用户开启视频回调	V3.5.0
onUserVideoStop	远端用户停用视频回调	V3.5.0
onUserVideoProfileUpdate	远端用户视频配置更新回调	V3.5.0
onUserAudioMute	远端用户是否静音回调	V3.5.0
onUserVideoMute	远端用户是否禁视频流回调	V3.5.0

数据统计事件

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

屏幕共享

方法	功能	起始版本
startScreenCaptureByDisplayId	通过屏幕 ID 共享屏幕，该方法仅适用于 macOS	V3.5.0
startScreenCaptureByWindowId	通过窗口 ID 共享窗口	V3.5.0
updateScreenCaptureRegion	更新屏幕共享区域	V3.5.0
stopScreenCapture	停止屏幕共享	V3.5.0
startScreenCaptureByScreenRect	通过指定区域共享屏幕	V3.5.0
pauseScreenCapture	暂停屏幕共享。	V3.7.0
resumeScreenCapture	恢复屏幕共享。	V3.7.0
setupLocalSubStreamVideoCanvas	设置本端的辅流视频回放画布	V3.9.0
setupRemoteSubStreamVideoCanvas	设置远端的辅流视频回放画布	V3.9.0
setLocalSubStreamRenderMode	设置本端的辅流渲染缩放模式	V3.9.0
setRemoteSubSteamRenderMode	设置远端的屏幕共享辅流视频渲染缩放模式	V3.9.0
subscribeRemoteVideoSubStream	订阅或取消订阅远端的屏幕共享辅流视频，订阅之后才能接收远端的辅流视频数据	V3.9.0

事件	描述	起始版本
onUserSubStreamVideoStart	远端用户开启屏幕共享辅流通道的回调	V3.9.0
onUserSubStreamVideoStop	远端用户停止屏幕共享辅流通道的回调	V3.9.0

音乐文件播放及混音

方法	功能	起始版本
startAudioMixing	开始播放音乐文件	V3.5.0
stopAudioMixing	停止播放音乐文件	V3.5.0
pauseAudioMixing	暂停播放音乐文件	V3.5.0
resumeAudioMixing	恢复播放音乐文件	V3.5.0
setAudioMixingPlaybackVolume	设置音乐文件播放音量	V3.5.0
setAudioMixingSendVolume	设置音乐文件的发送音量	V3.5.0
getAudioMixingPlaybackVolume	获取音乐文件的播放音量	V3.5.0
getAudioMixingSendVolume	获取音乐文件的发送音量	V3.5.0
getAudioMixingDuration	获取音乐文件的总长度	V3.5.0
getAudioMixingCurrentPosition	获取音乐文件的播放进度	V3.5.0
setAudioMixingPosition	设置音乐文件的播放进度	V3.5.0

事件	描述	起始版本
onAudioMixingStateChanged	本地用户的音乐文件播放状态改变回调	V3.5.0
onAudioMixingTimestampUpdate	本地用户的音乐文件播放进度回调	V3.5.0

音效文件播放管理

方法	功能	起始版本
getEffectPlaybackVolume	获取音效文件播放音量。	V3.5.0
setEffectPlaybackVolume	设置音效文件播放音量	V3.5.0
playEffect	播放指定音效文件	V3.5.0
stopEffect	停止播放指定音效文件	V3.5.0
stopAllEffects	停止播放所有音效文件	V3.5.0
pauseEffect	暂停音效文件播放	V3.5.0
pauseAllEffects	暂停所有音效文件播放	V3.5.0
resumeEffect	恢复播放指定音效文件	V3.5.0
resumeAllEffects	恢复播放所有音效文件	V3.5.0
setEffectSendVolume	调节音效文件发送音量	V3.5.0
getEffectSendVolume	获取音效文件发送音量	V3.5.0

事件	描述	起始版本
onAudioEffectFinished	本地音效文件播放已结束回调	V3.5.0

变声与混响

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

旁路推流

注意：该组方法仅适用于互动直播 2.0。

方法	功能	起始版本
addLiveStreamTask	添加房间推流任务	V3.5.0
updateLiveStreamTask	更新修改房间推流任务	V3.5.0
removeLiveStreamTask	删除房间推流任务	V3.5.0

事件	描述	起始版本
onAddLiveStreamTask	通知添加直播任务结果	V3.5.0
onUpdateLiveStreamTask	通知更新直播任务结果	V3.5.0
onRemoveLiveStreamTask	通知删除直播任务结果	V3.5.0
onLiveStreamState	通知直播推流状态	V3.5.0

媒体补充增强信息

方法

功能

起始版本

sendSEIMsg

通过主流通道发送媒体补充增强信息。

V4.0.0

sendSEIMsg

发送媒体补充增强信息。

通过本接口可指定发送 SEI 时使用主流或辅流通道。

V4.0.0

onRecvSEIMsg

收到远端流的媒体补充增强信息回调。

V4.0.0

音量提示

方法	功能	起始版本
enableAudioVolumeIndication	启用说话者音量提示	V3.5.0

事件	描述	起始版本
onRemoteAudioVolumeIndication	提示房间内谁正在说话及说话者音量的回调	V3.5.0
onLocalAudioVolumeIndication	提示房间内本地用户瞬时音量的回调	V3.5.0

耳返

方法	功能	起始版本
enableEarback	开启耳返功能	V3.5.0
setEarbackVolume	设置耳返音量	V3.5.0

视频大小流

方法	功能	起始版本
enableDualStreamMode	设置是否开启视频大小流模式。	V3.5.0

自定义音频采集与渲染

方法	功能	起始版本
setExternalAudioSource	启用外部自定义音频数据输入功能，并设置采集参数。	V3.9.0
pushExternalAudioFrame	将外部音频数据帧推送给内部引擎	V3.9.0
setExternalAudioRender	设置外部音频渲染	V4.0.0
pullExternalAudioFrame	拉取外部音频数据	V4.0.0

自定义视频采集

方法	功能	起始版本
setExternalVideoSource	配置外部视频源	V3.5.0
pushExternalVideoFrame	推送外部视频帧	V3.5.0

原始音频数据

方法	功能	起始版本
setRecordingAudioFrameParameters	设置录制的声音格式	V3.5.0
setPlaybackAudioFrameParameters	设置播放的声音格式	V3.5.0
setAudioFrameObserver	注册语音观测器对象	V3.5.0
setMixedAudioFrameParameters	设置采集和播放后的混合后的采样率。需要在加入房间之前调用该接口	V3.5.0

事件	描述	起始版本
onAudioFrameDidRecord	采集音频数据回调。	V3.5.0
onAudioFrameWillPlayback	播放音频数据回调。	V3.5.0
onMixedAudioFrame	音频采集与播放混合后数据帧回调	V3.5.0
onPlaybackAudioFrameBeforeMixing	某一远端用户的原始音频帧回调	V3.5.0

原始视频数据

事件	描述	起始版本
onCaptureVideoFrame	采集视频数据回调。	V3.5.0

音频设备管理

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

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

视频设备管理

方法	功能	起始版本
enumerateCaptureDevices	枚举视频采集设备	V3.5.0
setDevice	设置视频采集设备	V3.5.0
getDevice	获取当前视频采集设备	V3.5.0

设备管理事件

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

故障排查

方法	功能	起始版本
startAudioDump	开始记录音频 dump 音频 dump 可用于分析音频问题	V3.5.0
stopAudioDump	结束记录音频 dump	V3.5.0
getErrorDescription	获取错误描述。	V3.5.0
uploadSdkInfo	上传SDK日志信息	V3.5.0

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