NERTC Electron SDK V4.4.8 API 概览
说明
NERtcEngine 包含了 Electron NeRTC 接口。
房间管理
| 方法 | 功能描述 | 起始版本 |
|---|---|---|
| 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 |
| switchChannel | 切换房间 | V4.4.8 |
| leaveChannel | 离开房间 | V3.9.0 |
| getConnectionState | 获取网络连接状态 | V3.9.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 |
| onReceSEIMsg | 监听 SEI 数据回调 | V4.1.110 |
音频管理
| 方法 | 功能描述 | 起始版本 |
|---|---|---|
| setAudioProfile | 设置音频编码配置 | V3.9.0 |
| adjustRecordingSignalVolume | 调节录音音量 | V3.9.0 |
| adjustPlaybackSignalVolume | 设置音频编码配置 | V3.9.0 |
| enableLocalAudio | 开关本地音频采集 | V3.9.0 |
| muteLocalAudioStream | 开关本地音频发送 | V3.9.0 |
| subscribeRemoteAudioStream | 订阅／取消订阅指定音频流 | V3.9.0 |
| setAudioEffectPreset | 设置 SDK 预设的人声的变声音效 | V4.1.110 |
| setVoiceBeautifierPreset | 设置 SDK 预设的美声效果。调用该方法可以为本地发流用户设置 SDK 预设的人声美声效果 | V4.1.110 |
| setLocalVoicePitch | 设置本地语音音调。该方法改变本地说话人声音的音调 | V4.1.110 |
| setLocalVoiceEqualization | 设置本地语音音效均衡，即自定义设置本地人声均衡波段的中心频率 | V4.1.110 |
| startAudioRecording | 开始客户端录音 | V4.4.8 |
| stopAudioRecording | 停止客户端录音 | V4.4.8 |
| setLocalPublishFallbackOption | 设置弱网条件下发布的音视频流回退选项 | V4.4.8 |
| setRemoteSubscribeFallbackOption | 设置弱网条件下订阅的音视频流回退选项 | V4.4.8 |
视频管理
| 方法 | 功能描述 | 起始版本 |
|---|---|---|
| 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 |
| sendSEIMsg | 发送媒体补充增强信息（SEI） | V4.1.110 |
| sendSEIMsgEx | 发送媒体补充增强信息（SEI）可选主副流 | V4.1.110 |
| captureImageByUid | 在指定用户的画布上截图 | V4.4.8 |
| setLocalMediaPriority | 设置本地用户的媒体流优先级 | V4.4.8 |
| startChannelMediaRelay | 开始跨房间媒体流转发 | V4.4.8 |
| updateChannelMediaRelay | 更新媒体流转发的目标房间 | V4.4.8 |
| stopChannelMediaRelay | 停止跨房间媒体流转发 | V4.4.8 |
| enableSuperResolution | 启用或停止 AI 超分 | V4.4.8 |
本地媒体事件
| 方法 | 功能描述 | 起始版本 |
|---|---|---|
| onFirstVideoDataReceived | 已显示首帧远端视频回调 | V3.9.0 |
| onFirstAudioDataReceived | 已接收到远端音频首帧回调 | V3.9.0 |
| onFirstAudioFrameDecoded | 已解码远端音频首帧的回调 | V3.9.0 |
| onFirstVideoFrameDecoded | 已接收到远端视频并完成解码回调 | 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 |
| onUserVideoMute | 远端用户是否禁视频流回调 | V3.9.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 共享屏幕 | 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 |
| setExcludeWindowList | 设置屏幕捕捉时需屏蔽的窗口列表 | V4.4.8 |
| 事件 | 描述 | 起始版本 |
|---|---|---|
| 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 |
| 事件 | 描述 | 起始版本 |
|---|---|---|
| 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 |
| 事件 | 描述 | 起始版本 |
|---|---|---|
| onAudioEffectFinished | 本地音效文件播放已结束回调 | V3.9.0 |
本地声卡采集
| 方法 | 功能描述 | 起始版本 |
|---|---|---|
| enableLoopbackRecording | 开启声卡采集 | V4.1.110 |
| adjustLoopbackRecordingSignalVolume | 调节声卡采集信号音量 | V4.1.110 |
| adjustUserPlaybackSignalVolume | 调节本地播放的指定远端用户的指定流类型的信号音量 | V4.1.110 |
音量提示
| 方法 | 功能描述 | 起始版本 |
|---|---|---|
| enableAudioVolumeIndication | 启用说话者音量提示 | V3.9.0 |
| 事件 | 描述 | 起始版本 |
|---|---|---|
| onRemoteAudioVolumeIndication | 提示频道内谁正在说话及说话者音量的回调 | V3.9.0 |
| onLocalAudioVolumeIndication | 提示频道内本地用户瞬时音量的回调 | 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 |
| 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 |
设备管理事件
| 方法 | 功能描述 | 起始版本 |
|---|---|---|
| onAudioDeviceStateChanged | 音频设备状态更改回调 | V3.9.0 |
| onAudioDefaultDeviceChanged | 音频默认设备更改回调 | V3.9.0 |
| onVideoDeviceStateChanged | 视频设备状态更改回调 | V3.9.0 |
屏幕共享事件
| 事件 | 描述 | 起始版本 |
|---|---|---|
| onScreenCaptureStatus | 屏幕共享暂停/恢复/开始/结束等回调 | V4.4.8 |
本地音频事件
| 事件 | 描述 | 起始版本 |
|---|---|---|
| onAudioRecording | 音频录制状态回调 | V4.4.8 |
| onMediaRelayStateChanged | 跨房间媒体流转发状态发生改变回调 | V4.4.8 |
| onMediaRelayEvent | 媒体流相关转发事件回调 | V4.4.8 |
| onLocalPublishFallbackToAudioOnly | 本地发布流已回退为音频流、或已恢复为音视频流回调 | V4.4.8 |
| onRemoteSubscribeFallbackToAudioOnly | 订阅的远端流已回退为音频流、或已恢复为音视频流回调 | V4.4.8 |
故障排查
| 方法 | 功能描述 | 起始版本 |
|---|---|---|
| startAudioDump | 开始记录音频 dump 音频 dump 可用于分析音频问题 | V3.9.0 |
| stopAudioDump | 结束记录音频 dump | V3.9.0 |
| getErrorDescription | 获取错误描述 | V3.9.0 |
| uploadSdkInfo | 上传SDK日志信息 | V3.9.0 |