NERTC Electron SDK API 概览

说明

NERtcEngine 包含了 Electron NeRTC 接口。 NERtcChannel 包含了 Electron NeRTC Channel 接口。

房间管理

|方法|功能描述|起始版本| |---|---|---| initialize|初始化 NERTC SDK 服务|V3.9.0 release|销毁 IRtcEngine 对象|V3.9.0 getVersion|查询 SDK 版本号|V3.9.0 setChannelProfile|设置房间场景|V3.9.0 setClientRole|设置用户角色|V3.9.0 joinChannel|加入房间|V3.9.0 leaveChannel|离开房间|V3.9.0 getConnectionState|获取网络连接状态|V3.9.0 createChannel|创建一个 NERtcChannel 对象|V5.5.21 joinChannelWithOptions|加入房间附带可选信息|V5.5.21 switchChannel|快速切换音视频房间|V4.4.8 switchChannelWithOptions|快速切换音视频房间，可带自定义信息|V4.4.8 switchChannelWithOptionsEx|快速切换音视频房间扩展接口|V5.4.0

房间事件

|事件|功能描述|起始版本| |---|---|---| onClientRoleChanged|用户角色已切换回调|V3.9.0 onJoinChannel|加入房间回调|V3.9.0 onRejoinChannel|重新加入房间回调|V3.9.0 onLeaveChannel|离开房间回调|V3.9.0 onUserJoined|远端用户加入当前房间回调|V3.9.0 onUserLeft|远端用户离开当前房间回调|V3.9.0 onDisconnect|服务器连接断开回调|V3.9.0 onReconnectingStart|开始重连回调|V3.9.0 onConnectionStateChange|网络连接状态已改变回调|V3.9.0 onReleasedHwResources|通话结束设备资源释放回调|V3.9.0 onRecvSEIMsg|监听 SEI 数据回调|V4.1.110 onUserJoinedWithExtraInfo|远端用户加入当前频道回调扩展接口|V5.4.0 onUserLeftWithExtraInfo|远端用户离开当前频道回调扩展接口|V5.4.0

音频管理

|方法|功能描述|起始版本| |---|---|---| setAudioProfile|设置音频编码配置|V3.9.0 adjustRecordingSignalVolume|调节录音音量|V3.9.0 adjustPlaybackSignalVolume|设置音频编码配置|V3.9.0 enableLocalAudio|开关本地音频采集|V3.9.0 muteLocalAudioStream|开关本地音频发送|V3.9.0 subscribeRemoteAudioStream|订阅／取消订阅指定音频流|V3.9.0 subscribeRemoteSubStreamAudio|订阅／取消订阅指定音频辅流|V5.4.0 setRemoteHighPriorityAudioStream|设置远端用户音频流高优先级|V4.1.110 setAudioEffectPreset|设置 SDK 预设的人声的变声音效|V4.1.110 setVoiceBeautifierPreset|设置 SDK 预设的美声效果。调用该方法可以为本地发流用户设置 SDK 预设的人声美声效果|V4.1.110 setLocalVoicePitch|设置本地语音音调。该方法改变本地说话人声音的音调|V4.1.110 setLocalVoiceEqualization|设置本地语音音效均衡，即自定义设置本地人声均衡波段的中心频率|V4.1.110 enableLocalSubStreamAudio|开关本地音频辅流|V5.5.21 muteLocalSubStreamAudio|开关本地音频辅流发送|V5.5.21 subscribeRemoteSubStreamAudio|订阅／取消订阅指定音频辅流|V5.5.21 subscribeAllRemoteAudioStream|订阅／取消订阅所有远端用户的音频主流|V5.5.21 setAudioSubscribeOnlyBy|设置自己的音频只能被房间内指定的人订阅|V5.5.21 setSubscribeAudioAllowlist|指定只订阅的音频流|V5.5.21 setSubscribeAudioBlocklist|指定不订阅的音频流|V5.5.21 setStreamAlignmentProperty|开启精准对齐，对齐本地系统与服务端的时间|V5.5.21 getNtpTimeOffset|获取本地系统时间与服务端时间差值|V5.5.21 startAudioRecording|开始客户端录音|V4.4.8 startAudioRecordingWithConfig|开始客户端录音扩展接口|V5.4.0 stopAudioRecording|停止客户端录音|V5.4.0 setLocalVoiceReverbParam|设置本地语音混响效果|V5.4.0 enableMediaPub|开启或关闭本地媒体流（主流）的发送|V5.4.0

视频管理

|方法|功能描述|起始版本| |---|---|---| enableLocalVideo|开关本地视频|V3.9.0 setVideoConfig|设置视频发送配置|V3.9.0 setupLocalVideoCanvas|设置本地用户视图|V3.9.0 setupRemoteVideoCanvas|设置远端用户视图|V3.9.0 setRenderMode|设置本地/远端视图显示模式|V3.9.0 startVideoPreview|开启视频预览|V3.9.0 stopVideoPreview|停止视频预览|V3.9.0 muteLocalVideoStream|开关本地视频发送|V3.9.0 subscribeRemoteVideoStream|订阅 / 取消订阅指定远端用户的视频流|V3.9.0 setLocalVideoMirrorMode|设置本地视频镜像模式|V3.9.0 setParameters|复杂参数设置|V3.9.0 getParameters|获取内部参数|V5.5.21 sendSEIMsg| 发送媒体补充增强信息（SEI）|V4.1.110 sendSEIMsgWithType| 发送媒体补充增强信息（SEI）可选主辅流|V4.1.110 captureImageByUid| 在指定用户的画布上截图|V4.1.112 enableLocalVideoWithType|开关本地主辅流视频|V5.5.21 setCameraCaptureConfig|设置本地摄像头的视频主流采集配置|V5.5.21 setCameraCaptureConfigWithType|设置本地摄像头的视频主流或辅流采集配置|V5.5.21 setVideoConfigWithType|设置主辅流视频发送配置|V5.5.21 enableDualStreamMode|设置视频双流发送|V3.9.0 setLocalVideoMirrorModeWithType|设置主辅流本地视频镜像模式|V5.5.21 startVideoPreviewWithType|开启主辅流视频预览|V5.5.21 stopVideoPreviewWithType|停止主辅流视频预览|V5.5.21 muteLocalVideoStreamWithType|开关本地主辅流视频发送|V5.5.21 startChannelMediaRelay|开始跨房间媒体流转发|V5.5.21 updateChannelMediaRelay|更新媒体流转发的目标房间|V5.5.21 stopChannelMediaRelay|停止跨房间媒体流转发|V5.5.21 setLocalPublishFallbackOption|设置弱网条件下发布的音视频流回退选项|V5.5.21 setRemoteSubscribeFallbackOption|设置弱网条件下订阅的音视频流回退选项|V5.5.21 enableSuperResolution|启用或停止 AI 超分|V4.4.0 enableEncryption|开启或关闭媒体流加密|V4.4.0 enableVirtualBackground|启用/禁用虚拟背景|V5.4.0 isFeatureSupported|获取当前设备是否支持虚拟背景功能|V5.4.0 setLocalMediaPriority|设置本地用户的媒体流优先级|V4.4.8 enableLocalData|开启/关闭本地数据通道|V5.4.0 subscribeRemoteData|取消或恢复订阅指定远端用户数据通道流|V5.4.0 sendData|通过数据通道发送数据|V5.4.0 setLocalVideoWatermarkConfigs|设置视频水印，水印在本地预览及发送过程中均生效|V5.5.20

本地媒体事件

|事件|功能描述|起始版本| |---|---|---| onFirstVideoDataReceived|已显示首帧远端视频回调|V3.9.0 onFirstAudioDataReceived|已接收到远端音频首帧回调|V3.9.0 onFirstAudioFrameDecoded|已解码远端音频首帧的回调|V3.9.0 onFirstVideoFrameDecoded|已接收到远端视频并完成解码回调|V3.9.0 onFirstVideoDataReceivedWithType|已显示首帧远端视频回调扩展接口|V3.9.0 onFirstVideoFrameDecodedWithType|已显示首帧远端视频回调扩展接口|V3.9.0

远端媒体事件

|事件|功能描述|起始版本| |---|---|---| onUserAudioStart|远端用户开启音频回调|V3.9.0 onUserAudioStop|远端用户停用音频回调|V3.9.0 onUserVideoStart|远端用户开启视频回调|V3.9.0 onUserVideoStop|远端用户停用视频回调|V3.9.0 onUserVideoProfileUpdate|远端用户视频配置更新回调|V3.9.0 onUserAudioMute|远端用户是否静音回调|V3.9.0 onUserVideoMute|远端用户是否禁视频流回调|V3.9.0 onUserVideoMuteWithType|远端用户是否禁视频流回调扩展接口|V5.4.0 onUserSubStreamAudioStart|远端用户开启音频辅流回调|V5.4.0 onUserSubStreamAudioStop|远端用户停用音频辅流回调|V5.4.0 onUserSubStreamAudioMute|远端用户是否静音的回调|V5.4.0

数据统计事件

|事件|功能描述|起始版本| |---|---|---| onRemoteAudioStats|通话中远端音频流的统计信息回调|V3.9.0 onRtcStats|当前通话统计回调|V3.9.0 onNetworkQuality|通话中每个用户的网络上下行质量报告回调|V3.9.0 onLocalAudioStats|本地音频流统计信息回调|V3.9.0 onLocalVideoStats|本地视频流统计信息回调|V3.9.0 onRemoteVideoStats|通话中远端视频流的统计信息回调|V3.9.0

屏幕共享

|方法|功能描述|起始版本| |---|---|---| startScreenCaptureByDisplayId|通过屏幕 ID 共享屏幕，该方法仅适用于 macOS|V3.9.0 startScreenCaptureByWindowId|通过窗口 ID 共享窗口|V3.9.0 updateScreenCaptureRegion|更新屏幕共享区域|V3.9.0 stopScreenCapture|停止屏幕共享|V3.9.0 startScreenCaptureByScreenRect|通过指定区域共享屏幕|V3.9.0 pauseScreenCapture|暂停屏幕共享|V3.9.0 resumeScreenCapture|恢复屏幕共享|V3.9.0 setupLocalSubStreamVideoCanvas|设置本端的辅流视频画布|V3.9.0 setupRemoteSubStreamVideoCanvas|设置远端的辅流视频回放画布|V3.9.0 subscribeRemoteVideoSubStream|订阅或取消订阅远端的屏幕共享辅流视频，订阅之后才能接收远端的辅流视频数据|V3.9.0 setSubStreamRenderMode|设置屏幕共享辅流视频渲染缩放模式|V3.9.0 enumerateScreenCaptureSourceInfo|枚举屏幕分享源信息|V4.1.110 setScreenCaptureMouseCursor|在共享屏幕或窗口时，更新是否显示鼠标|V5.4.0 setExcludeWindowList|设置屏幕捕捉时需屏蔽的窗口列表, 该方法在捕捉过程中可动态调用|V4.4.8 updateScreenCaptureParameters|更新屏幕共享参数|V4.4.8

屏幕共享事件

|事件|功能描述|起始版本| |---|---|---| onScreenCaptureStatus|屏幕共享暂停/恢复/开始/结束等回调|V5.5.21 onUserSubStreamVideoStart|远端用户开启屏幕共享辅流通道的回调|V3.9.0 onUserSubStreamVideoStop|远端用户停止屏幕共享辅流通道的回调|V3.9.0

音乐文件播放及混音

|方法|功能描述|起始版本| |---|---|---| startAudioMixing|开始播放音乐文件|V3.9.0 stopAudioMixing|停止播放音乐文件|V3.9.0 pauseAudioMixing|暂停播放音乐文件|V3.9.0 resumeAudioMixing|恢复播放音乐文件|V3.9.0 setAudioMixingPlaybackVolume|设置音乐文件播放音量|V3.9.0 setAudioMixingSendVolume|设置音乐文件的发送音量|V3.9.0 getAudioMixingPlaybackVolume|获取音乐文件的播放音量|V3.9.0 getAudioMixingSendVolume|获取音乐文件的发送音量|V3.9.0 getAudioMixingDuration|获取音乐文件的总长度|V3.9.0 getAudioMixingCurrentPosition|获取音乐文件的播放进度|V3.9.0 setAudioMixingPosition|设置音乐文件的播放进度|V3.9.0 setAudioMixingPitch|设置当前伴音文件的音调|V5.5.21 getAudioMixingPitch|获取当前伴音文件的音调|V5.5.21

音乐文件播放及混音事件

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

音效文件播放管理

|方法|功能描述|起始版本| |---|---|---| getEffectPlaybackVolume|获取音效文件播放音量|V3.9.0 setEffectPlaybackVolume|设置音效文件播放音量|V3.9.0 playEffect|播放指定音效文件|V3.9.0 stopEffect|停止播放指定音效文件|V3.9.0 stopAllEffects|停止播放所有音效文件|V3.9.0 pauseEffect|暂停音效文件播放|V3.9.0 pauseAllEffects|暂停所有音效文件播放|V3.9.0 resumeEffect|恢复播放指定音效文件|V3.9.0 resumeAllEffects|恢复播放所有音效文件|V3.9.0 setEffectSendVolume|调节音效文件发送音量|V3.9.0 getEffectSendVolume|获取音效文件发送音量|V3.9.0 setEffectPitch|设置指定音效文件的音调|V5.4.0 getEffectPitch|获取指定音效文件的音调|V5.4.0 setEffectPosition|设置指定音效文件的播放位置|V5.4.0 getEffectCurrentPosition|获取指定音效文件的播放进度|V5.4.0 getEffectDuration|获取指定音效文件的时长|V5.4.0

音效文件播放管理事件

|事件|描述|起始版本| |---|---|---| onAudioEffectFinished|本地音效文件播放已结束回调|V3.9.0 onAudioEffectTimestampUpdate|本地用户的指定音效文件播放进度回调|V4.6.29

本地声卡采集

|方法|功能描述|起始版本| |---|---|---| enableLoopbackRecording|开启声卡采集|V4.1.110 adjustLoopbackRecordingSignalVolume|调节声卡采集信号音量|V4.1.110 adjustUserPlaybackSignalVolume|调节本地播放的指定远端用户的指定流类型的信号音量|V4.1.110 adjustChannelPlaybackSignalVolume|调节本地播放的指定房间的所有远端用户的信号音量|V5.4.0 checkNECastAudioDriver|检测虚拟声卡是否安装（仅适用于 Mac 系统）|V5.4.0

音量提示

|方法|功能描述|起始版本| |---|---|---| enableAudioVolumeIndication|启用说话者音量提示|V3.9.0 enableAudioVolumeIndicationEx|启用说话者音量提示|V5.5.21

音量提示事件

|事件|描述|起始版本| |---|---|---| onRemoteAudioVolumeIndication|提示频道内谁正在说话及说话者音量的回调|V3.9.0 onLocalAudioVolumeIndication|提示频道内本地用户瞬时音量的回调|V3.9.0 onLocalAudioVolumeIndicationEx|提示频道内本地用户瞬时音量的回调扩展接口|V3.9.0

耳返

|方法|功能描述|起始版本| |---|---|---| enableEarback|开启耳返功能|V3.9.0 setEarbackVolume|设置耳返音量|V3.9.0

旁路推流（互动直播）

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

旁路推流（互动直播）事件

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

音频设备管理

|方法|功能描述|起始版本| |---|---|---| setRecordDevice|设置音频采集设备|V3.9.0 getRecordDevice|获取当前音频采集设备|V3.9.0 enumeratePlayoutDevices|枚举音频播放设备|V3.9.0 enumerateRecordDevices|获取系统中所有的音频采集设备列表|V5.5.21 setPlayoutDevice|设备音频播放设备|V3.9.0 getPlayoutDevice|获取当前音频播放设备|V3.9.0 setRecordDeviceVolume|设置当前音频采集设备音量|V3.9.0 getRecordDeviceVolume|获取当前音频采集设备音量|V3.9.0 setPlayoutDeviceVolume|设置当前音频播放设备音量|V3.9.0 getPlayoutDeviceVolume|获取当前音频播放设别音量|V3.9.0 setPlayoutDeviceMute|设置当前播放设备静音状态|V3.9.0 getPlayoutDeviceMute|获取当前播放设备静音状态|V3.9.0 setRecordDeviceMute|设置当前采集设备静音状态|V3.9.0 getRecordDeviceMute|获取当前采集设备静音状态|V3.9.0 startRecordDeviceTest|开始测试音频采集设备|V3.9.0 stopRecordDeviceTest|停止测试音频采集设备|V3.9.0 startPlayoutDeviceTest|开始测试音频播放设备|V3.9.0 stopPlayoutDeviceTest|停止测试音频播放设备|V3.9.0 startAudioDeviceLoopbackTest|开始音频采集播放设备回路测试|V3.9.0 stopAudioDeviceLoopbackTest|停止音频采集播放设备回路测试|V3.9.0

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

视频设备管理

|方法|功能描述|起始版本| |---|---|---| setVideoDevice|设置视频采集设备|V3.9.0 getVideoDevice|获取当前视频采集设备|V3.9.0 enumerateVideoCaptureDevices|获取系统中所有的视频采集设备列表|V5.5.21 setVideoDeviceWithType|指定视频采集设备，可选主辅流|V5.5.21 getVideoDeviceWithType|获取当前使用的视频采集设备信息|V5.5.21

设备管理事件

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

故障排查

|方法|功能描述|起始版本| |---|---|---| startAudioDump|开始记录音频 dump 音频 dump 可用于分析音频问题|V3.9.0 stopAudioDump|结束记录音频 dump|V3.9.0 getErrorDescription|获取错误描述|V3.9.0 uploadSdkInfo|上传SDK日志信息|V3.9.0 startAudioDumpWithType|开始记录指定通道音频 dump 音频 dump 可用于分析音频问题|V5.5.21

网络探测

|方法|功能描述|起始版本| |---|---|---| startLastmileProbeTest|开始通话前网络质量探测|V4.5.0 stopLastmileProbeTest|停止通话前网络质量探测|V4.5.0 setCloudProxy|开启并设置云代理服务|V5.4.0

美颜

|方法|功能描述|起始版本| |---|---|---| startBeauty|开启美颜功能模块|V5.4.0 stopBeauty|结束美颜功能模块|V4.5.0 enableBeauty|暂停或恢复美颜效果|V5.4.0 getBeautyEffect|获取指定美颜类型的强度设置|V5.4.0 setBeautyEffect|设置美颜效果|V5.4.0 addBeautyFilter|添加滤镜效果|V5.4.0 removeBeautyFilter|取消滤镜效果|V5.4.0 setBeautyFilterLevel|设置滤镜强度|V5.4.0 addBeautySticker|添加贴纸效果|V5.4.0 removeBeautySticker|取消贴纸效果|V5.4.0 addBeautyMakeup|添加美妆效果|V5.4.0 removeBeautyMakeup|取消美妆效果|V5.4.0

空间音效

|方法|功能描述|起始版本| |---|---|---| setRangeAudioMode|设置玩家本人在房间中的范围语音模式，该设置不影响其他人|V5.4.0 setRangeAudioTeamID|设置范围语音的小队 ID|V5.4.0 setAudioRecvRange|设置空间音效的距离衰减属性和语音范围|V5.4.0 updateSelfPosition|更新本地用户的空间位置|V5.4.0 enableSpatializerRoomEffects|开启或关闭空间音效的房间混响效果|V5.4.0 setSpatializerRoomProperty|设置空间音效的房间混响属性|V5.4.0 setSpatializerRenderMode|设置空间音效的渲染模式|V5.4.0 initSpatializer|初始化引擎 3D 音效算法|V5.4.0 enableSpatializer|开启或关闭空间音效|V5.4.0

权限秘钥

|方法|功能描述|起始版本| |---|---|---| updatePermissionKey|更新权限密钥|V5.4.0

QS事件

|事件|功能描述|起始版本| |---|---|---| onRequestSendKeyFrame|I 帧请求事件回调|V5.4.0 onBitrateUpdated|视频码率信息回调|V5.4.0 onVideoCodecUpdated|视频编码器信息回调|V5.4.0

其他事件

|事件|功能描述|起始版本| |---|---|---| onError|发生错误回调|V3.9.0 onWarning|发生警告回调|V3.9.0 onApiCallExecuted|API 调用结束回调|V5.4.0 onRemoteVideoReceiveSizeChanged|接收的远端视频分辨率变化回调|V5.4.1 onLocalVideoRenderSizeChanged|本地视频预览的分辨率变化回调|V5.4.1 onFirstVideoFrameRender|已接收到远端视频首帧并完成渲染的回调|V3.9.0 onRecvSEIMsg|监听 SEI 数据回调|V4.1.110 onAudioRecording|音频录制状态回调|V3.9.0 onMediaRelayStateChanged|跨房间媒体流转发状态发生改变回调|V3.9.0 onMediaRelayEvent|媒体流相关转发事件回调|V3.9.0 onLocalPublishFallbackToAudioOnly|本地发布流已回退为音频流、或已恢复为音视频流回调|V3.9.0 onRemoteSubscribeFallbackToAudioOnly|订阅的远端流已回退为音频流、或已恢复为音视频流回调|V3.9.0 onLastmileQuality|通话前网络上下行 last mile 质量状态回调|V4.5.0 onLastmileProbeResult|通话前网络上下行 Last mile 质量探测报告回调|V4.5.0 onMediaRightChange|服务端禁言音视频权限变化回调|V5.4.0 onCheckNECastAudioDriverResult|收到检测安装声卡的内容回调|V5.4.0 onVirtualBackgroundSourceEnabled|通知虚拟背景功能是否成功启用的回调|V5.4.0 onLocalVideoWatermarkState|本地视频水印生效结果回调|V5.4.0 onPermissionKeyWillExpire|权限密钥即将过期事件回调|V5.4.0 onUpdatePermissionKey|更新权限密钥事件回调|V5.4.0 onUserDataReceiveMessage|远端用户通过数据通道发送数据的回调|V5.4.0 onUserDataStart|远端用户开启数据通道的回调|V5.4.0 onUserDataStop|远端用户停用数据通道的回调|V5.4.0 onUserDataStateChanged|远端用户数据通道状态变更回调|V5.4.0 onUserDataBufferedAmountChanged|远端用户数据通道 buffer 变更回调|V5.4.0