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

IRtcEngine 接口类包含应用程序调用的主要方法。
IRtcChannel 类在指定房间中实现实时音视频功能。通过创建多个 IRtcChannel 对象，用户可以同时加入多个房间。

房间管理

方法	功能	起始版本
Initialize	初始化 NERtc SDK 服务。	V4.5.907
Release	销毁 IRtcEngine 对象。	V4.5.907
CreateChannel	创建 RTC channel 对象。	V4.5.907
Destroy	销毁 RTC channel对象。	V4.5.907
SetChannelProfile	设置房间场景。	V4.5.907
SetClientRole	设置用户角色。	V4.5.907
JoinChannel	加入房间。	V4.5.907
SwitchChannel	切换房间。	V4.5.907
LeaveChannel	离开房间。	V4.5.907
GetConnectionState	获取房间连接状态。	V4.5.907
SetParameters	设置音视频通话的相关参数。	V4.5.907
UpdatePermissionKey	更新权限密钥。	V5.4.5
ReportCustomEvent	上报自定义事件。	V5.4.5

房间事件

事件	描述	起始版本
OnClientRoleChanged	用户角色已切换回调。	V4.5.907
OnJoinChannel	加入房间回调。	V4.5.907
OnRejoinChannel	重新加入房间回调。	V4.5.907
OnLeaveChannel	离开房间回调。	V4.5.907
OnUserJoined	远端用户加入当前房间回调。	V4.5.907
OnUserLeft	远端用户离开当前房间回调。	V4.5.907
OnDisconnect	服务器连接断开回调。	V4.5.907
OnReconnectingStart	开始重连回调。	V4.5.907
OnConnectionStateChanged	房间连接状态已改变回调。	V4.5.907
OnPermissionKeyWillExpire	权限密钥即将过期事件回调。	V5.4.5
OnUpdatePermissionKey	更新权限密钥事件回调。	V5.4.5

音频管理

方法	功能	起始版本
SetAudioProfile	设置音频编码配置	V4.5.907
AdjustRecordingSignalVolume	调节采集信号音量。	V4.5.907
AdjustPlaybackSignalVolume	调节本地播放音量。	V4.5.907
AdjustUserPlaybackSignalVolume	调节本地播放的指定远端用户的信号音量。	V4.5.907
EnableLocalAudio	开关本地音频采集	V4.5.907
MuteLocalAudioStream	开关本地音频发送	V4.5.907
SubscribeRemoteAudioStream	订阅／取消订阅指定音频流。	V4.5.907
SubscribeAllRemoteAudioStream	订阅或取消订阅所有音频流。	V4.5.907
EnableLoopbackRecording	开启声卡采集。	V4.5.907
AdjustLoopbackRecordingSignalVolume	调节声卡采集信号音量。	V4.5.907
SetRemoteHighPriorityAudioStream	设置远端用户音频流为高优先级。	V5.4.5
SetAudioSubscribeOnlyBy	设置本地用户音频只能被房间内其他指定用户订阅	V5.4.5
EnableMediaPublish	发布或停止发布本地音频	V5.4.5
AdjustChannelPlaybackSignalVolume	调节本地播放的指定房间的所有远端用户的信号音量	V5.4.5
SetAudioSessionOperationRestriction	设置 SDK 对 Audio Session 的控制权限	V5.4.5

视频管理

方法	功能	起始版本
EnableLocalVideo	开关本地视频	V4.5.907
SetCameraCaptureConfig	设置摄像头采集配置	V4.5.907
SetVideoConfig	设置视频发送配置	V4.5.907
SetupLocalVideoCanvas	设置本地用户视图	V4.5.907
SetupRemoteVideoCanvas	设置远端用户视图	V4.5.907
SetLocalRenderMode	设置本地视图显示模式	V4.5.907
SetRemoteRenderMode	设置远端视图显示模式	V4.5.907
StartVideoPreview	开启视频预览	V4.5.907
StopVideoPreview	停止视频预览	V4.5.907
MuteLocalVideoStream	停止或恢复发送本地视频流	V4.5.907
SubscribeRemoteVideoStream	订阅 / 取消订阅指定远端用户的视频流	V4.5.907
SetLocalVideoMirrorMode	设置本地视频镜像模式	V4.5.907
EnableSuperResolution	启用或停止 AI 超分。	V4.5.907

本地媒体事件

方法	功能	起始版本
OnFirstVideoDataReceived	已显示首帧远端视频回调	V4.5.907
OnFirstAudioDataReceived	已接收到远端音频首帧回调	V4.5.907
OnFirstAudioFrameDecoded	已解码远端音频首帧的回调	V4.5.907
OnFirstVideoFrameDecoded	已接收到远端视频并完成解码回调	V4.5.907
OnMediaRightChanged	服务端禁言音视频权限变化回调	V5.4.5
OnSubstreamAudioFrameDidRecord	辅流采集音频数据回调	V5.4.5

远端媒体事件

方法	功能	起始版本
OnUserAudioStart	远端用户开启音频回调	V4.5.907
OnUserAudioStop	远端用户停用音频回调	V4.5.907
OnUserVideoStart	远端用户开启视频回调	V4.5.907
OnUserVideoStop	远端用户停用视频回调	V4.5.907
OnUserVideoProfileUpdate	远端用户视频配置更新回调	V4.5.907
OnUserAudioMute	远端用户是否静音回调	V4.5.907
OnUserVideoMute	远端用户是否禁视频流回调	V4.5.907
OnSubstreamPlaybackAudioFrameBeforeMixing	获取指定远端用户混音前的辅流音频数据	V5.4.5

屏幕共享

方法	功能	起始版本
StartScreenCaptureByDisplayId	开启屏幕共享，共享范围为指定屏幕的指定区域。该方法仅适用于 macOS 平台。	V4.5.907
StartScreenCaptureByScreenRect	开启屏幕共享，共享范围为指定屏幕的指定区域。该方法仅适用于 Windows 平台。	V4.5.907
StartScreenCaptureByWindowId	开启屏幕共享，共享范围为指定窗口的指定区域。	V4.5.907
SetExcludeWindowList	设置共享指定屏幕或屏幕区域时，需要屏蔽的窗口列表。	V4.5.907
UpdateScreenCaptureRegion	更新屏幕共享区域。	V4.5.907
PauseScreenCapture	暂停屏幕共享。	V4.5.907
ResumeScreenCapture	恢复屏幕共享。	V4.5.907
StopScreenCapture	停止屏幕共享。	V4.5.907
SetScreenCaptureMouseCursor	设置共享屏幕时是否显示鼠标	V5.4.5
UpdateScreenCaptureParameters	更新屏幕共享参数	V5.4.5

事件	描述	起始版本
OnScreenCaptureStatusChanged	屏幕共享状态变化回调。该方法仅适用于 Windows 平台。	V4.5.907

多房间管理

方法	功能	起始版本
CreateChannel	创建并获取一个 NERtcChannel 对象。通过创建多个对象，用户可以同时加入多个频道。	V4.5.907
IRtcChannel	该类提供在指定频道内实现实时音视频功能的方法。	V4.5.907

事件	描述	起始版本
ChannelOnClientRoleChanged	用户角色已切换回调。	V4.5.907
ChannelOnJoinChannel	加入房间回调。	V4.5.907
ChannelOnRejoinChannel	重新加入房间回调。	V4.5.907
ChannelOnLeaveChannel	离开房间回调。	V4.5.907
ChannelOnUserJoined	远端用户加入当前房间回调。	V4.5.907
ChannelOnUserLeft	远端用户离开当前房间回调。	V4.5.907
ChannelOnDisconnect	服务器连接断开回调。	V4.5.907
ChannelOnReconnectingStart	开始重连回调。	V4.5.907
ChannelOnConnectionStateChanged	房间连接状态已改变回调。	V4.5.907
ChannelOnFirstVideoDataReceived	已显示首帧远端视频回调	V4.5.907
ChannelOnFirstAudioDataReceived	已接收到远端音频首帧回调	V4.5.907
ChannelOnFirstAudioFrameDecoded	已解码远端音频首帧的回调	V4.5.907
ChannelOnFirstVideoFrameDecoded	已接收到远端视频并完成解码回调	V4.5.907
OnUserAudioStart	远端用户开启音频回调	V4.5.907
OnUserAudioStop	远端用户停用音频回调	V4.5.907
OnUserVideoStart	远端用户开启视频回调	V4.5.907
OnUserVideoStop	远端用户停用视频回调	V4.5.907
OnUserVideoProfileUpdate	远端用户视频配置更新回调	V4.5.907
OnUserAudioMute	远端用户是否静音回调	V4.5.907
OnUserVideoMute	远端用户是否禁视频流回调	V4.5.907

音乐文件播放及混音(伴音)

方法	功能	起始版本
StartAudioMixing	开始播放音乐文件	V4.5.907
StopAudioMixing	停止播放音乐文件	V4.5.907
PauseAudioMixing	暂停播放音乐文件	V4.5.907
ResumeAudioMixing	恢复播放音乐文件	V4.5.907
SetAudioMixingPlaybackVolume	设置音乐文件播放音量	V4.5.907
SetAudioMixingSendVolume	设置音乐文件的发送音量	V4.5.907
GetAudioMixingPlaybackVolume	获取音乐文件的播放音量	V4.5.907
GetAudioMixingSendVolume	获取音乐文件的发送音量	V4.5.907
GetAudioMixingDuration	获取音乐文件的总长度	V4.5.907
GetAudioMixingCurrentPosition	获取音乐文件的播放进度	V4.5.907
SetAudioMixingPosition	设置音乐文件的播放进度	V4.5.907
SetAudioMixingPitch	设置伴音的音调	V5.4.5
GetAudioMixingPitch	获取伴音的音调	V5.4.5

事件	描述	起始版本
OnAudioMixingStateChanged	本地用户的音乐文件播放状态改变回调	V4.5.907
OnAudioMixingTimestampUpdate	本地用户的音乐文件播放进度回调	V4.5.907

音效文件播放管理

方法	功能	起始版本
GetEffectPlaybackVolume	获取音效文件播放音量。	V4.5.907
SetEffectPlaybackVolume	设置音效文件播放音量	V4.5.907
PlayEffect	播放指定音效文件	V4.5.907
StopEffect	停止播放指定音效文件	V4.5.907
StopAllEffects	停止播放所有音效文件	V4.5.907
PauseEffect	暂停音效文件播放	V4.5.907
PauseAllEffects	暂停所有音效文件播放	V4.5.907
ResumeEffect	恢复播放指定音效文件	V4.5.907
ResumeAllEffects	恢复播放所有音效文件	V4.5.907
SetEffectSendVolume	调节音效文件发送音量	V4.5.907
GetEffectSendVolume	获取音效文件发送音量	V4.5.907
SetEffectPitch	设置音效文件音调	V5.4.5
GetEffectPitch	获取音效文件音调	V5.4.5
GetEffectDuration	获取音效文件的总长度	V5.4.5
GetEffectCurrentPosition	获取音效文件的播放进度	V5.4.5
SetEffectPosition	设置音效文件的播放进度	V5.4.5

事件	描述	起始版本
OnAudioEffectFinished	本地音效文件播放已结束回调	V4.5.907
OnAudioEffectTimestampUpdate	本地音效文件播放进度回调	V4.6.29

变声与混响

方法	功能	起始版本
SetAudioEffectPreset	设置 SDK 预设的人声的变声音效。	V4.5.907
SetVoiceBeautifierPreset	设置 SDK 预设的美声效果。	V4.5.907
SetLocalVoiceEqualization	设置本地语音音效均衡，即自定义设置本地人声均衡波段的中心频率。	V4.5.907
SetLocalVoicePitch	设置本地语音音调。	V4.5.907
SetLocalVoiceReverbParam	开启本地语音混响效果。	V5.4.5

旁路推流

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

方法	功能	起始版本
AddLiveStreamTask	添加房间推流任务	V4.5.907
UpdateLiveStreamTask	更新修改房间推流任务	V4.5.907
RemoveLiveStreamTask	删除房间推流任务	V4.5.907

事件	描述	起始版本
OnAddLiveStreamTask	通知添加直播任务结果	V4.5.907
OnUpdateLiveStreamTask	通知更新直播任务结果	V4.5.907
OnRemoveLiveStreamTask	通知删除直播任务结果	V4.5.907
OnLiveStreamStateChanged	通知直播推流状态	V4.5.907

跨房间流媒体转发

方法	功能	起始版本
StartChannelMediaRelay	开始跨房间媒体流转发。	V4.5.907
UpdateChannelMediaRelay	更新媒体流转发的目标房间。	V4.5.907
StopChannelMediaRelay	停止跨房间媒体流转发。	V4.5.907

事件	描述	起始版本
OnMediaRelayStateChanged	跨房间媒体流转发状态发生改变回调。	V4.5.907
OnMediaRelayEvent	媒体流相关转发事件回调。	V4.5.907

媒体补充增强信息

方法	功能	起始版本
SendSEIMsg	通过主流通道发送媒体补充增强信息。	V4.5.907

音量提示

方法	功能	起始版本
EnableAudioVolumeIndication	启用说话者音量提示	V4.5.907

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

耳返

方法	功能	起始版本
EnableEarback	开启耳返功能	V4.5.907
SetEarbackVolume	设置耳返音量	V4.5.907

视频大小流

方法	功能	起始版本
EnableDualStreamMode	设置是否开启视频大小流模式。	V4.5.907

音视频流回退

方法	功能	起始版本
SetLocalPublishFallbackOption	设置弱网条件下发布的音视频流回退选项。	V4.5.907
SetRemoteSubscribeFallbackOption	设置弱网条件下订阅的音视频流回退选项。	V4.5.907
SetLocalMediaPriority	设置本地用户的媒体流优先级。	V4.5.907

通话前网络测试

方法	功能	起始版本
StartLastmileProbeTest	开始通话前网络质量探测。	V4.5.907
StopLastmileProbeTest	停止通话前网络质量探测。	V4.5.907

事件	描述	起始版本
OnLastmileQuality	报告本地用户的网络质量。	V4.5.907
OnLastmileProbeResult	报告通话前网络上下行 last mile 质量。	V4.5.907

自定义音频采集与渲染

方法	功能	起始版本
SetExternalAudioSource	启用外部自定义音频数据输入功能，并设置采集参数。	V4.5.907
PushExternalAudioFrame	将外部音频数据帧推送给内部引擎	V4.5.907
SetExternalAudioRender	设置外部音频渲染	V4.5.907
PullExternalAudioFrame	拉取外部音频数据	V4.5.907
SetStreamAlignmentProperty	对齐本地系统时间与服务端时间。	V5.4.5
GetNtpTimeOffset	获取本地系统时间与服务端时间的差值。	V5.4.5

自定义视频采集

方法	功能	起始版本
SetExternalVideoSource	配置外部视频源	V4.5.907
PushExternalVideoFrame	推送外部视频帧	V4.5.907

音视频裸流传输

方法	功能	起始版本
SetPreDecodeObserver	注册解码前媒体数据观测器。	V5.4.5
PushExternalAudioEncodedFrame	推送外部音频主流编码帧。	V5.4.5
PushExternalVideoEncodedFrame	推送外部视频编码帧。	V5.4.5
SetVideoEncoderQosObserver	注册视频编码 QoS 信息监听器。	V5.4.5

事件	描述	起始版本
OnFrame	解码前媒体数据回调。	V5.4.5
OnRequestSendKeyFrame	I 帧请求事件回调。	V5.4.5
OnVideoCodecUpdated	视频编码器类型信息回调。	V5.4.5
OnBitrateUpdated	码率信息回调。	V5.4.5

原始音频数据

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

原始视频数据

事件	描述	起始版本
OnCaptureVideoFrame	采集视频数据回调。	V4.5.907

水印

方法	功能	起始版本
SetLocalVideoWatermarkConfigs	添加本地视频水印。	V5.4.5

事件	描述	起始版本
OnLocalVideoWatermarkState	水印结果回调。	V5.4.5

加密

方法	功能	起始版本
EnableEncryption	开启或关闭媒体流加密。	V4.5.907

客户端音频录制

方法	功能	起始版本
StartAudioRecording	开始客户端录音。	V4.5.907
StartAudioRecordingWithConfig	开始客户端录音。	V5.4.5
StopAudioRecording	停止客户端录音。	V4.5.907

事件	描述	起始版本
OnAudioRecording	音频录制状态回调。	V4.5.907

音频设备管理

方法	功能	起始版本
SetPlayoutDeviceMute	设置当前播放设备静音状态	V4.5.907
GetPlayoutDeviceMute	获取当前播放设备静音状态	V4.5.907
SetRecordDeviceMute	设置当前采集设备静音状态	V4.5.907
GetRecordDeviceMute	获取当前采集设备静音状态	V4.5.907

事件	描述	起始版本
OnAudioHowling	检测到啸叫回调。	V4.5.907

设备管理事件

方法	功能	起始版本
OnAudioDeviceStateChanged	音频设备状态更改回调	V4.5.907
OnAudioDefaultDeviceChanged	音频默认设备更改回调	V4.5.907
OnVideoDeviceStateChanged	视频设备状态更改回调	V4.5.907
OnCheckNECastAudioDriverResult	安装虚拟声卡的结果回调（仅适用于 Mac 系统）	V5.4.5

美颜

方法	功能	起始版本
StartBeauty	开启美颜功能模块	V5.4.5
StopBeauty	结束美颜功能模块	V5.4.5
EnableBeauty	暂停或恢复美颜效果	V5.4.5
SetBeautyEffect	设置美颜效果	V5.4.5
GetBeautyEffect	获取指定美颜类型的强度设置	V5.4.5
AddBeautyFilter	添加滤镜效果	V5.4.5
RemoveBeautyFilter	移除滤镜	V5.4.5
SetBeautyFilterLevel	设置滤镜强度	V5.4.5

虚拟背景

方法	功能	起始版本
EnableVirtualBackground	开启或关闭虚拟背景。	V5.4.5

事件	描述	起始版本
OnVirtualBackgroundSourceEnabled	通知虚拟背景功能是否成功启用的回调。	V5.4.5

云代理

方法	功能	起始版本
SetCloudProxy	开启并设置云代理服务。	V5.4.5

故障排查

方法	功能	起始版本
StartAudioDump	开始记录音频 dump 音频 dump 可用于分析音频问题	V4.5.907
StopAudioDump	结束记录音频 dump	V4.5.907
UploadSdkInfo	上传SDK日志信息	V4.5.907

事件	描述	起始版本
OnError	发生错误回调	V4.5.907
ChannelOnError	发生错误回调	V4.5.907
OnWarning	发生警告回调	V4.5.907