Namespace NERTC

此接口用于加载滤镜资源，并添加对应的滤镜效果。需要更换滤镜时，重复调用此接口使用新的滤镜资源即可

调用时机：请先调用 NERTC.startBeauty 方法开启美颜

since

5.6.33 及以上。

note

• 仅APP端支持

example

//设置滤镜参数并传递
this.engine.addBeautyFilter('2D/bunny', 'aa.json');

since

5.3.7 及以上。

example

this.engine.addEventListener("onJoinChannel", (result, channelId, elapsed, userID) => {
this.engine.nertcPrint('加入房间成功 onJoinChannel:' + result)
});

详情描述：通过此接口可以实现在通话过程中随时调节本地播放的某个房间的所有用户的混音音量。

调用时机：请在初始化后调用该方法，且该方法仅可在加入房间后调用。

since

5.3.7 及以上。

note

• 该方法设置内部引擎为启用状态，在 NERTC.leaveChannel 后失效，但在本次通话过程中有效。

example

//调整本地播放的某个房间内所有用户的音量为50
this.engine.adjustChannelPlaybackSignalVolume(50);

调用时机：请在初始化后调用该方法，且该方法仅可在加入房间后调用。

since

5.5.21 及以上。

example

 this.engine.adjustLoopBackRecordingSignalVolume(100)

详情描述：通过本接口可以实现设置录制声音的信号幅度，从而达到调节采集音量的目的。

调用时机：请在初始化后调用该方法，且该方法仅可在加入房间后调用。

相关回调：

1. 成功调用该方法切换本地用户的发流状态后，房间内其他用户会收到 [[NERTC.onUserAudioStart]]（开启发送音频）或 [[NERTC.onUserAudioStop]]（停止发送音频）的回调。

相关接口：

1. muteLocalAudio()：

• 在需要开启本地音频采集（监测本地用户音量）但不发送音频流的情况下，您也可以调用 NERTC.muteLocalAudio 方法。
• 两者的差异在于, NERTC.muteLocalAudio 仍然保持与服务器的音频通道连接，而 NERTC.enableMediaPub 表示断开此通道，因此若您的实际业务场景为多人并发的大房间，建议您调用 NERTC.enableMediaPub 方法。

since

5.3.7 及以上。

note

• 该方法设置内部引擎为启用状态，在 NERTC.leaveChannel 后设置失效，将恢复至默认。
• 建议设置本地采集音量为默认值（100）或小于该值，否则可能会导致音质问题。

example

//将采集音量设置为100
this.engine.adjustRecordingSignalVolume(100);

详情描述：通过此接口可以实现在通话过程中随时调节本地播放的指定远端用户的混音音量。

调用时机：请在初始化后调用该方法，且该方法仅可在加入房间后调用。

since

5.3.7 及以上。

note

• 该方法设置内部引擎为启用状态，在 NERTC.leaveChannel 后设置失效，将恢复至默认。但在本次通话过程中有效，比如指定远端用户中途退出房间，则再次加入此房间时仍旧维持该设置。
• 该方法每次只能调整一位远端用户的播放音量，若需调整多位远端用户在本地播放的音量，则需多次调用该方法。

example

//调整uid为12345的用户在本地的播放音量为50
this.engine.adjustUserPlaybackSignalVolume({
userID: 12345,
volume: 50
});
//调整uid为12345的用户在本地的播放音量为0，静音该用户。
this.engine.adjustUserPlaybackSignalVolume({
userID: 12345,
volume: 0
});

详情描述：1V1场景下，一般是大小屏渲染（远端大屏，本端小屏展示在右上角），本接口允许用户动态切换两者的视图窗口。

调用时机：请在双方视图都已经渲染的情况下，调用该接口。

since

5.6.0 及以上。

example

 this.engine.changeVideoCanvas({
localVideoCanvasConfig: {
renderMode: 2, // 0表示使用视频，视频等比缩放，1表示适应区域，会裁剪，2：折中方案 //当前demo先使用数字，正式版本会是枚举
mirrorMode: 2, //1表示启用镜像，2表示不启用
},
remoteVideoCanvasConfig: {
renderMode: 1, // 0表示使用视频，视频等比缩放，1表示适应区域，会裁剪，2：折中方案 //当前demo先使用数字，用户可以使用枚举
mirrorMode: 1, //1表示启用镜像，2表示不启用
userID: this.remoteUserID,
userStringID: this.remoteUserID + ''
}
})

详情描述：该方法释放 NERTC SDK 使用的所有资源。有些 App 只在用户需要时才进行实时音视频通信，完成音视频通话后，则将资源释放出来用于其他操作，该方法适用于此类情况。。

调用时机：该接口需要在调用 NERTC.leaveChannel、并收到 NERtcCallback.onUserLeave 回调后调用。或收到 NERtcCallback.onDisconnect 回调、重连失败时调用此接口销毁实例，并释放资源。

since

5.3.7 及以上。

note

• 请避免 NERTC.destroyEngine 和 NERTC.leaveChannel 同时调用

example

this.engine.destroyEngine();

详情描述：通过本接口可以实现解绑本地视频辅流用户和显示视图。

since

5.3.7 及以上。

example

 this.engine.destroyLocalSubStreamVideoCanvas();

详情描述：通过本接口可以实现解绑本地用户和显示视图。

since

5.3.7 及以上。

example

 this.engine.destroyLocalVideoCanvas();

详情描述：通过本接口可以实现解绑远端用户和显示视图。

since

5.3.7 及以上。

example

 this.engine.destroyRemoteSubStreamVideoCanvas({userID: 111})

详情描述：通过本接口可以实现解绑远端用户和显示视图。

since

5.3.7 及以上。

example

 this.engine.destroyRemoteVideoCanvas({userID: 111})

详情描述：通过此接口可以实现允许 SDK 定期向 App 反馈房间内发音频流的用户和瞬时音量最高的远端用户（最多 3 位，包括本端）的音量相关信息，即当前谁在说话以及说话者的音量。

调用时机：请在初始化后调用该方法，且该方法仅可在加入房间后调用。

业务场景: 适用于通过发言者的人声相关信息做出 UI 上的音量展示的场景，或根据发言者的音量大小进行视图布局的动态调整。

相关回调:

1. 启用该方法后，只要房间内有发流用户，无论是否有人说话，SDK 都会在加入房间后根据预设的时间间隔触发 onLocalAudioVolumeIndication()、onRemoteAudioVolumeIndication() 回调。

since

5.3.7 及以上。

note

• 该方法设置内部引擎为启用状态，在 NERTC.leaveChannel 后设置失效，将恢复至默认。

example

//设置间隔为500ms的人声音量提示
this.engine.enableAudioVolumeIndication({
enable: true,
interval: 500,
enableVad: false
});

暂停美颜效果后，包括全局美颜、滤镜、贴纸和美妆在内的所有美颜效果都会暂时关闭，直至重新恢复美颜效果。

since

5.6.33 及以上。

note

• 该方法仅适用APP平台

example

this.engine.enableBeauty(true)

调用时机：请在初始化后调用该方法，且该方法仅可在加入房间后调用。

since

5.3.7 及以上。

note

• 加入房间后，耳返功能可以随时开启，但只有当插入耳机或耳麦时，耳返功能才会生效；当拔出耳机或耳麦时会自动暂停，再次插入耳机或耳麦自动恢复，且耳返功能可以实时关闭。

example

//将采集音量设置为100
this.engine.enableEarback({
enabled: true,
volume: 100
});

详情描述：通过本接口可以实现开启或关闭本地语音功能，进行本地音频采集及处理。

调用时机：请在初始化后调用该方法，且该方法仅可在加入房间后调用。

业务场景: 适用于通过发言者的人声相关信息做出 UI 上的音量展示的场景，或根据发言者的音量大小进行视图布局的动态调整。

相关回调:

1. 开启本地视频采集后，远端会收到 NERtcCallback.onUserAudioStart 回调。
2. 关闭本地视频采集后，远端会收到 NERtcCallback.onUserAudioStop 回调。

since

5.3.7 及以上。

note

• 该方法设置内部引擎为开启或关闭状态, 在 NERTC.leaveChannel 后仍然有效。
• 该方法会操作音频硬件设备，建议避免频繁开关，否则可能导致设备异常。

example

// 打开音频采集
this.engine.enableLocalAudio(true)

详情描述：通过本接口可以实现开启或关闭本地视频，不影响接收远端视频。

调用时机：请在初始化后调用该方法，且该方法仅可在加入房间后调用。

业务场景: 适用于通过发言者的人声相关信息做出 UI 上的音量展示的场景，或根据发言者的音量大小进行视图布局的动态调整。

相关回调:

1. 开启本地视频采集后，远端会收到 NERtcCallback.onUserVideoStart 回调。
2. 关闭本地视频采集后，远端会收到 NERtcCallback.onUserVideoStop 回调。

since

5.3.7 及以上。

note

• 该方法设置内部引擎为开启或关闭状态, 在 NERTC.leaveChannel 后仍然有效。
• 在您的应用切到后台或者其他应用占用摄像头时，可能会导致摄像头打开失败，需要注册 camera 动态权限。

example

// MAIN: 主流, SUB: 辅流
this.engine.enableLocalVideo({
videoStreamType: NERtcVideoStreamType.MAIN,
enable: true
})

调用时机：请在初始化后调用该方法，且该方法仅可在加入房间后调用。

since

5.5.21 及以上。

example

 this.engine.enableLoopbackRecording(true)

详情描述：该方法用于开始或停止向网络发送本地音频或视频数据。 该方法不影响接收或播放远端媒体流，也不会影响本地音频或视频的采集状态。

调用时机：请在初始化后调用该方法，且该方法仅可在加入房间后调用。

since

5.3.7 及以上。

note

• 该方法暂时仅支持控制音频流的发送。
• 停止发送媒体流的状态会在通话结束后被重置为允许发送。

example

 this.engine.enableMediaPub(true);

详情描述：该方法获取当前伴奏播放进度，单位为毫秒。

返回：音乐文件的播放位置，单位为毫秒。

since

5.6.0 及以上。

example

const position = this.engine.getAudioMixingCurrentPosition();

详情描述：该方法获取伴奏时长，单位为毫秒。

调用时机：请在初始化后调用该方法，且该方法仅可在加入房间后调用。

since

5.6.0 及以上。

note

• 请在加入房间后调用该方法。
• 伴音相关方法为异步加载，刚开始伴音时，如果立即调用此方法，获取到的伴奏时长可能为错误码30001。如果遇到此类问题，等待伴音状态是开始之后再调用。 返回：伴奏时长，单位为毫秒。

example

const duration = this.engine.getAudioMixingDuration();

返回：音乐文件的音调。

since

5.6.0 及以上。

example

const pitch = this.engine.getAudioMixingPitch();

详情描述：该方法获取混音里伴奏的本地播放音量大小。

调用时机：请在初始化后调用该方法，且该方法仅可在加入房间后调用。

since

5.6.0 及以上。

example

const volume = this.engine.getAudioMixingPlaybackVolume();

详情描述：该方法获取混音里伴奏的发送音量大小。

调用时机：请在初始化后调用该方法，且该方法仅可在加入房间后调用。

since

5.6.0 及以上。

example

const volume = this.engine.getAudioMixingSendVolume();

调用时机：请在初始化后调用该方法。

since

5.3.7 及以上。

example

 const connectState = this.engine.getConnectionState();

详情描述：安卓端专用，用于检查当前APP是否配置启动了某些服务（比如前台服务）。

调用时机：请在初始化后调用该方法。

since

5.5.21 及以上。

example

 //检查是否开启了前台服务
this.engine.isServiceEnable('FOREGROUND_SERVICE')

详情描述：通过本接口可以实现加入音视频房间，加入房间后可以与房间内的其他用户进行音视频通话。

调用时机：请在初始化引擎后调用该方法。

使用限制：无。

相关接口:

1. 您可以调用 NERTC.leaveChannel 方法离开房间。

相关回调:

1. 成功调用该方法加入房间后，本地会触发 NERtcCallback.onJoinChannel 回调通知，远端会触发 NERtcCallback.onUserJoined 回调通知。

since

5.3.7 及以上。

note

• 调用 NERTC.joinChannel 方法之后，NERTC SDK 会通过按照默认配置调整音频模式（audio mode），此后请勿修改 SDK 调整过的音频模式，否则可能会导致音频路由错误等问题。
• 加入音视频房间时，如果指定房间尚未创建，云信服务器内部会自动创建一个同名房间。
• 传参中 uid 可选，若不指定则默认为 0，SDK 会自动分配一个随机 uid，并在 NERTC.joinChannel 回调方法中返回；App 层必须记住该返回值并维护，SDK 不对该返回值进行维护。
• 同一个房间内的用户可以互相通话，多个用户加入同一个房间，可以群聊。使用不同 App Key 的 App 之间不能互通。

example

    this.engine.joinChannel({
token: '',
channelName: 'xxx',
myUid: 100
});

详情描述：通过本接口可以实现挂断或退出通话，并释放本房间内的相关资源。

调用时机：请在初始化并成功加入房间后调用该方法。

相关回调:

1. 成功调用该方法离开房间后，本地会触发 NERtcCallback.onLeaveChannel 回调通知，远端会触发 NERtcCallback.onUserLeave 回调通知。

since

5.3.7 及以上。

note

- 结束通话时必须调用此方法离开房间，否则无法开始下一次通话。

example

 this.engine.leaveChannel();

详情描述：该方法用于向网络发送或取消发送本地音频数据，不影响本地音频的采集状态，也不影响接收或播放远端音频流。

调用时机：请在初始化后调用该方法，且该方法仅可在加入房间后调用。

相关回调:

1. 若本地用户在说话，成功调用该方法后，房间内其他用户会收到 NERtcCallback.onUserAudioMute 回调

since

5.3.7 及以上。

note

• 该方法设置内部引擎为开启或关闭状态, 在 NERTC.leaveChannel 后仍然有效。

example

// 打开音频采集
this.engine.muteLocalAudio(true)

详情描述：调用该方法取消发布本地视频主流或辅流后，SDK 不再发送本地视频流。

调用时机：一般在通过 NERTC.enableLocalVideo 接口开启本地视频采集并发送后调用该方法。

业务场景: 适用于通过发言者的人声相关信息做出 UI 上的音量展示的场景，或根据发言者的音量大小进行视图布局的动态调整。

相关回调:

1. 开启本地视频采集后，远端会收到 NERtcCallback.onUserVideoStart 回调。
2. 关闭本地视频采集后，远端会收到 NERtcCallback.onUserVideoStop 回调。

since

5.3.7 及以上。

note

• 该方法设置内部引擎为开启或关闭状态, 在 NERTC.leaveChannel 后仍然有效。
• 调用该方法取消发布本地视频流时，设备仍然处于工作状态。
• 该方法仅适用于视频主流，若您希望取消或恢复发布视频辅流，请调用 NERTC.muteLocalVideo方法

example

this.engine.muteLocalVideo(true)

详情描述：原生java暴露的日志输出接口，可以输入到android Studio/xcode的控制台，以及写入手机日志文件中。

调用时机：开发者js开发语言的业务console日志需要存入系统日志文件时。

since

5.3.7 及以上。

note

-该接口默认写入sdk的系统日志文件中，日志等级为INFO。

example

 const message = "这是一个调试日志"
this.engine.nertcPrint(message);

详情描述：通过此接口可以实现暂停播放伴音文件。

调用时机：请在初始化后调用该方法，且该方法仅可在加入房间后调用。

since

5.6.0 及以上。

note

• 请先调用 NERTC.startAudioMixing 开启伴音

example

this.engine.pauseAudioMixing()

since

5.6.33 及以上。

note

• userID可选，如果不填写，表示房间中其他所有人，都会执行resume。
• 该方法仅适用H5平台

example

this.engine.rePlayAudio()

since

5.3.7 及以上。

调用时机：请先调用 NERTC.addBeautyFilter 方法开启美颜

since

5.6.33 及以上。

note

• 仅APP端支持

example

this.engine.removeBeautyFilter();

since

5.3.7 及以上。

since

5.5.11 及以上。

note

• userID可选，如果不填写，表示房间中其他所有人，都会执行resume。
• 该方法仅适用H5平台

example

this.engine.resume()

详情描述：通过此接口可以实现恢复播放伴音文件。

调用时机：请在初始化后调用该方法，且该方法仅可在加入房间后调用。

since

5.6.0 及以上。

example

this.engine.resumeAudioMixing()

详情描述：通过此接口可以实现当本地人声和播放的音乐文件混音时，仅调节音乐文件的音调。

调用时机：请先调用 NERTC.startAudioMixing 方法开启伴音。

业务场景：适用于 K 歌中为了匹配人声，调节背景音乐音高的场景。

since

5.6.0 及以上。

note

• 当前伴音任务结束后，此接口的设置会恢复至默认。

example

const pitch = this.engine.setAudioMixingPitch();

详情描述：该方法调节混音里伴奏的播放音量大小。请在房间内调用该方法。

调用时机：请在初始化后调用该方法，且该方法仅可在加入房间后调用。

since

5.6.0 及以上。

example

this.engine.setAudioMixingPlaybackVolume(100)

详情描述：该方法可以设置音频文件的播放位置。这样你可以根据实际情况播放文件，而非从头到尾播放整个文件。

调用时机：请在初始化后调用该方法，且该方法仅可在加入房间后调用。

since

5.6.0 及以上。

详情描述：该方法调节混音里伴奏的发送音量大小。请在房间内调用该方法。

调用时机：请在初始化后调用该方法，且该方法仅可在加入房间后调用。

since

5.6.0 及以上。

example

this.engine.setAudioMixingSendVolume(100)

详情描述：通过此接口可以实现设置音频编码的采样率、码率、编码模式、声道数等，也可以设置音频属性的应用场景，包括聊天室场景、语音场景、音乐场景等。

调用时机：请在初始化后调用该方法，且该方法仅可在加入房间后调用。

since

5.3.7 及以上。

note

• 音乐场景下，建议将 profile 设置为 HIGH_QUALITY。 若您通过 NERTC.setChannelProfile 接口设置房间场景为直播模式，即 LIVE_BROADCASTING，但未调用此方法设置音频编码属性，或仅设置 profile 为 DEFAULT，则 SDK 会自动设置 profile 为 HIGH_QUALITY，且设置 scenario 为 MUSIC。

example

 this.engine.setAudioProfile({
profile: NERTCAudioProfile.STANDARD, //设置profile为标准模式
scenario: NERTCAudioScenario.SPEECH //scenario为语音场景
})

通过此接口可以实现设置磨皮、美白等多种美颜类型和对应的美颜强度。

调用时机：请在引擎初始化之后调用此接口，且该方法在加入房间前后均可调用。

since

5.6.33 及以上。

note

• H5端type仅支持：kNERtcBeautyWhiten（美白）、kNERtcBeautySmooth（磨皮）、kNERtcBeautyFaceRuddy（红润）

example

//设置美白（推荐 0.6）
this.engine.setBeautyEffect(NERtcBeautyEffectType["kNERtcBeautyWhiten"], 0.6)
//设置磨皮（推荐 0.7）
this.engine.setBeautyEffect(NERtcBeautyEffectType["kNERtcBeautySmooth"], 0.7)
//设置红润（推荐 0.5）
this.engine.setBeautyEffect(NERtcBeautyEffectType["kNERtcBeautyFaceRuddy"], 0.5)

调用时机：请先调用 NERTC.addBeautyFilter 方法开启美颜

since

5.6.33 及以上。

note

• 仅APP端支持
• 滤镜强度设置实时生效，更换滤镜后滤镜强度不变，如需调整，可以再次调用此接口重新设置滤镜强度。

example

//设置滤镜参数并传递
this.engine.setBeautyFilterLevel(1);

详情描述：通过此接口可以实现设置房间场景为通话（默认）或直播场景。针对不同场景采取的优化策略不同，如通话场景侧重语音流畅度，直播场景侧重视频清晰度。

调用时机：请在初始化后调用该方法，且该方法仅可在加入房间前调用。

since

5.3.7 及以上。

example

 //设置房间场景为直播场景
this.engine.setChannelProfile(NERTCChannelProfile.LIVE_BROADCASTING);

详情描述：通过此接口可以实现设置房间场景为通话（默认）或直播场景。针对不同场景采取的优化策略不同，如通话场景侧重语音流畅度，直播场景侧重视频清晰度。

调用时机：请在初始化后调用该方法，且该方法仅可在加入房间前调用。

使用限制：该方法仅在通过 setChannelProfile() 方法设置房间场景为直播场景（LIVE_BROADCASTING）时调用有效。

业务场景：适用于观众上下麦与主播互动的互动直播场景。

注意事项：用户切换为观众角色时，SDK 会自动关闭音视频设备。

相关回调：

1. 加入房间前调用该方法设置用户角色，不会触发任何回调，在加入房间成功后角色自动生效：
   • 设置用户角色为主播：加入房间后，远端用户触发 onUserJoined() 回调。
   • 设置用户角色为观众：加入房间后，远端用户不触发任何回调。
2. 加入房间后调用该方法切换用户角色
   • 从观众角色切为主播：本端用户触发 onClientRoleChange() 回调，远端用户触发 onUserJoined() 回调。
   • 从主播角色切为观众：本端用户触发 onClientRoleChange() 回调，远端用户触发 onUserLeave() 回调。

since

5.3.7 及以上。

example

 //切换用户角色为主播
 this.engine.setClientRole(NERTCUserRole.CLIENT_ROLE_BROADCASTER);

调用时机：调用 NERTC.enableEarback 方法开启耳返功能之后，您可以调用 NERTC.setEarbackVolume 方法设置耳返音量。

since

5.3.7 及以上。

example

this.engine.setEarbackVolume(100);

此接口用于H5端的设置滤镜效果

调用时机：请先调用 NERTC.startBeauty 方法开启美颜

since

5.6.33 及以上。

note

• 仅H5端支持

example

//设置滤镜效果为白皙,强度 0.3
this.engine.setFilter('baixi', 0.3)

详情描述：通过此接口可以设置视频主流或辅流的编码分辨率、裁剪模式、码率、帧率、带宽受限时的视频编码降级偏好、编码的镜像模式、编码的方向模式参数。

调用时机：请在初始化后调用该方法，且该方法仅可在加入房间后调用。

since

5.3.7 及以上。

note

• 每个属性对应一套视频参数，例如分辨率、帧率、码率等。所有设置的参数均为理想情况下的最大值。当视频引擎因网络环境等原因无法达到设置的分辨率、帧率或码率的最大值时，会取最接近最大值的那个值。
• 此接口为全量参数配置接口，重复调用此接口时，SDK 会刷新此前的所有参数配置，以最新的传参为准。所以每次修改配置时都需要设置所有参数，未设置的参数将取默认值

example

let localVideoConfig = {
videoStreamType: NERtcVideoStreamType.MAIN, // 表示是对视频主流的配置
maxProfile: NERtcVideoProfileType.Standard, //不推荐使用了
frameRate: NERtcVideoFrameRate.FRAME_RATE_FPS_24, //设置帧率24
minFrameRate: NERtcVideoFrameRate.FRAME_RATE_FPS_15, //设置最小帧率15
bitrate: 1500, //设置视频码率1500kbps
minBitrate: 1000, //设置视频码率最小为1000kbps
width: 1280, //设置视频宽为1280
height: 720, //设置视频高为720
cropMode: NERtcVideoCropMode.CROP_16x9, //视频采集宽高比为16:9
degradationPreference: NERtcDegradationPreference.DEGRADATION_DEFAULT, //带宽受限时的视频编码降级偏好为默认
mirrorMode: mirrorMode: NERTCMirrorMode.AUTO, //AUTO表示使用默认值,由sdk控制
orientationMode: NERtcVideoOutputOrientationMode.VIDEO_OUTPUT_ORIENTATION_MODE_ADAPTATIVE //（默认）该模式下 SDK 输出的视频方向与采集到的视频方向一致。接收端会根据收到的视频旋转信息对视频进行旋转
};
this.engine.setLocalVideoConfig(localVideoConfig)

详情描述：此接口提供技术预览或特别定制功能（比如AI降噪功能），详情请咨询技术支持或者开发者文档。

调用时机：请在初始化后调用该方法，且该方法在加入房间前后均可调用。

使用限制：无

业务场景：适用于需要开启SDK特殊功能。

since

5.5.21 及以上。

example

 //开启AI降噪功能
this.engine.setParameters({
keyAudioAINSEnable: true //开启AI降噪
})
//设置屏幕共享在前置摄像头下支持设置取消镜像
this.engine.setParameters({
keyVideoLocalPreviewMirror: true //设置屏幕共享在前置摄像头下支持设置取消镜像（安卓端）
})

详情描述：通过本接口可以实现设置是否将语音路由到扬声器，即设备外放。

调用时机：请在初始化后调用该方法，且该方法仅可在加入房间后调用。

since

5.3.7 及以上。

note

• 若设备连接了耳机或蓝牙，则无法开启外放。

example

 this.engine.setSpeakerphoneOn(true)

详情描述：注册统计信息观测器，设置统计信息回调。

调用时机：请在初始化后调用该方法。

相关回调:

1. 启用该方法后，只要房间内有媒体，SDK 都会在加入房间后根间隔触发 NERtcCallback.onNetworkQuality、NERtcCallback.onRtcStats、NERtcCallback.onLocalAudioStats、NERtcCallback.onRemoteAudioStats、NERtcCallback.onLocalVideoStats、 NERtcCallback.onRemoteVideoStats回调。

since

5.3.7 及以上。

note

• 该方法设置内部引擎为开启或关闭状态, 在 NERTC.leaveChannel 后仍然有效。

example

this.engine.setStatsObserver(true);

详情描述：创建 NERtc 实例。 通过本接口可以实现创建 NERtc 实例并初始化 NERTC SDK 服务。

业务场景：是使用NERtc服务的前提。

调用时机：请确保在调用其他 API 前先调用该方法创建并初始化 NERtc 实例。

since

5.3.7 及以上。

note

• 使用同一个 App Key 的 App 才能进入同一个房间进行通话或直播。
• 一个 App Key 只能用于创建一个 NERtc 实例；若您需要更换 App Key，必须先调用 NERTC.destroyEngine 方法销毁当前实例，再调用本方法重新创建实例。
• 创建实例时，如果参数设置错误，可能会出现 Exception、Error 异常回调通知。

example

    import NERTC from "@/NERtcUniappSDK-JS/lib/index";
    import NERTCLogLevel from "@/NERtcUniappSDK-JS/lib/NERtcDefines"
this.engine = NERTC.setupEngineWithContext({
appKey: 'xxxxxxxxxx', // your appkey
logDir: '', // expected log directory
logLevel: NERTCLogLevel.INFO,
});

详情描述：通过此接口可以实现设置本端用户的辅流显示视图。

调用时机：请在初始化后调用该方法，且该方法在加入房间前后均可调用。

使用限制：无。

since

5.3.7 及以上。

note

• 在实际业务中，通常建议在初始化后即调用该方法进行本地视图设置，然后再加入房间或开启预览。
• 在无需使用画布时，建议及时释放之前的画布，否则可能会引起系统 EGL 资源耗尽而导致程序崩溃。

example

    this.engine.setupLocalSubStreamVideoCanvas({
renderMode: NERTCRenderMode.Fit, // Fit表示应区域。视频尺寸等比缩放,保证所有区域被填满,视频超出部分会被裁剪
mirrorMode: NERTCMirrorMode.AUTO, //AUTO表示使用默认值,由sdk控制
isMediaOverlay: false //表示小画布置于大画布上面
})

详情描述：通过本接口可以实现绑定本地用户和显示视图，并设置本地用户视图在本地显示时的镜像模式和裁减比例，只影响本地用户看到的视频画面。

调用时机：请在初始化后调用该方法，且该方法在加入房间前后均可调用。

使用限制：无。

since

5.3.7 及以上。

note

• 在实际业务中，通常建议在初始化后即调用该方法进行本地视图设置，然后再加入房间或开启预览。
• 在无需使用画布时，建议及时释放之前的画布，否则可能会引起系统 EGL 资源耗尽而导致程序崩溃。

example

    this.engine.setupLocalVideoCanvas({
renderMode: NERTCRenderMode.Fit, // Fit表示应区域。视频尺寸等比缩放,保证所有区域被填满,视频超出部分会被裁剪
mirrorMode: NERTCMirrorMode.AUTO, //AUTO表示使用默认值,由sdk控制
isMediaOverlay: false //表示小画布置于大画布上面
})

详情描述：通过本接口可以实现绑定远端用户和显示视图，并设置远端用户视图在本地显示时的镜像模式和裁减比例，只影响本地用户看到的视频画面。

调用时机：请在初始化后调用该方法，且该方法在加入房间前后均可调用。

since

5.3.7 及以上。

note

• 退出房间后，SDK 也会主动清除远端用户和视图的绑定关系。

example

    this.engine.addEventListener("onUserSubStreamVideoStart", (userID, maxProfile, userStringID) => {
const message = `onUserSubStreamVideoStart通知：对方开启屏幕共享，userID = ${userID}, maxProfile = ${maxProfile}`
//设置对端的视频辅流画布
this.engine.setupRemoteSubStreamVideoCanvas({
renderMode: NERTCRenderMode.Fit, // Fit表示应区域。视频尺寸等比缩放,保证所有区域被填满,视频超出部分会被裁剪
mirrorMode: NERTCMirrorMode.AUTO, //AUTO表示使用默认值,由sdk控制
isMediaOverlay: false, //表示小画布置于大画布上面
userID, //对方userID,可能会超过number范围,造成精度缺失
userStringID //对方String格式的userID
})
//主动去订阅对端视频辅流
this.engine.subscribeRemoteSubStreamVideo({
userID,
userStringID,
streamType:NERtcRemoteVideoStreamType.HIGH, //HIGH: 大流, LOW: 小流 
subscribe: true //true表示订阅，false表示取消订阅
})
});

详情描述：通过本接口可以实现绑定远端用户和显示视图，并设置远端用户视图在本地显示时的镜像模式和裁减比例，只影响本地用户看到的视频画面。

调用时机：请在初始化后调用该方法，且该方法在加入房间前后均可调用。

since

5.3.7 及以上。

note

• 退出房间后，SDK 也会主动清除远端用户和视图的绑定关系。

example

    this.engine.addEventListener("onUserVideoStart", (userID, maxProfile, userStringID) => {
const message = `onUserVideoStart通知：对方开启视频，userID = ${userID}, maxProfile = ${maxProfile}`
console.log(message)
//设置对端的视频画布
this.engine.setupRemoteVideoCanvas({
renderMode: NERTCRenderMode.Fit, // Fit表示应区域。视频尺寸等比缩放,保证所有区域被填满,视频超出部分会被裁剪
mirrorMode: NERTCMirrorMode.AUTO, //AUTO表示使用默认值,由sdk控制
isMediaOverlay: false, //表示小画布置于大画布上面
userID: userID, //对方userID,可能会超过number范围,造成精度缺失
userStringID //对方string格式的userID
})
//主动去订阅对端视频
this.engine.subscribeRemoteVideo({
userID,
userStringID,
streamType: NERtcRemoteVideoStreamType.HIGH, //HIGH: 大流, LOW: 小流 
SUBscribe: true //true表示订阅，false表示取消订阅
})
});

详情描述: 如果业务上在IOS系统上有开启屏幕共享的需求，需要先提前设置屏幕共享启动配置，，该API只有IOS端支持，需要做一下判断

调用时机：setupEngineWithContext初始化SDK引擎之后，就可以调用了。

since

5.6.35 及以上。

note

-该接口仅支持IOS端。

example

 if (uni.getSystemInfoSync().platform === "ios") {
//如果业务上在IOS系统上有开启屏幕共享的需求，需要先提前设置屏幕共享启动配置，，该API只有IOS端支持，需要做一下判断
this.engine.setupShareKit({
//为申请的app Group
appGroup: 'group.com.netease.xxx'
})
}

详情描述：通过本接口可以实现指定本地或在线音频文件和录音设备采集的音频流进行混音。

调用时机：

1. 请在初始化后调用该方法，且该方法仅可在加入房间后调用。
2. 发送伴音前必须前调用 NERTC.enableLocalAudio 方法开启本地音频采集。

since

5.6.0 及以上。

note

• 支持的音乐文件类型包括 MP3、M4A、AAC、3GP、WMA 、WAV 和 FLAC 格式，支持本地文件或在线 URL。
• 若您在通话中途调用此接口播放音乐文件时，手动设置了伴音播放音量或发送音量，则当前通话中再次调用时默认沿用此设置。

example

this.engine.startAudioMixing({
path: '', //伴音文件的绝对路径 or url
loopCount: 1, //循环一次
sendEnabled: true, //发送到远端
sendVolume: 100, //发送伴音文件的原始音量
playbackEnabled: true, //本端播放伴音文件
playbackVolume: 100, //本地播放使用伴音文件的原始音量
startTimeStamp: 0  //音乐文件开始播放的时间，UTC 时间戳
})

since

5.6.33 及以上。

使用前提：请先调用 NERTC.enableLocalVideo 方法开启本地视频采集。

调用时机：请在引擎初始化之后调用此接口，且该方法在加入房间前后均可调用。

note

• 开启美颜功能模块后，默认无美颜效果，您需要通过 NERTC.setBeautyEffect 或其他滤镜等相关接口设置美颜或滤镜效果。

example

this.engine.startBeauty()

详情描述：通过本接口可以实现在加入房间前启动本地视频预览，支持预览本地摄像头或外部输入视频。

调用时机：请在初始化后调用该方法，且该方法仅可当不在房间内时可调用。

业务场景：适用于加入房间前检查设备状态是否可用、预览视频效果等场景。

使用限制：

1. 请在通过 NERTC.setupLocalVideoCanvas 接口设置视频画布后调用该方法。

note

• 在加入房间前预览视频效果时设置的美颜、虚拟背景等视频效果在房间内仍然生效；在房间内设置的视频效果在退出房间后预览视频时也可生效。

since

5.3.7 及以上。

example

// MAIN: 主流, SUB: 辅流 
 this.engine.startPreview(NERtcVideoStreamType.MAIN)

详情描述：通过此接口开启屏幕共享后，屏幕共享内容以视频辅流的形式发送。

调用时机：请在引擎初始化之后调用此接口，且该方法仅可在加入房间后调用。

相关回调：

1. 成功开启屏幕共享辅流后，远端会触发 [[NERTC.onUserSubStreamVideoStart]] 回调。

since

- 安卓端：5.3.7 及以上。
- IOS端：5.6.35 及以上。

example

    let screenConfigParam = {
maxProfile: NERtcVideoProfileType.Standard, 
frameRate: NERtcVideoFrameRate.FRAME_RATE_FPS_24, //设置帧率24
minFrameRate: NERtcVideoFrameRate.FRAME_RATE_FPS_15, //设置最小帧率15
bitrate: 2500, //设置屏幕共享码率1500kbps
minBitrate: 1500, //设置屏幕共享码率最小为1000kbps
contentPrefer: NERtcSubStreamContentPrefer.CONTENT_PREFER_DETAILS, //屏幕共享功能的编码策略倾向
};
this.engine.startScreenCapture(screenConfigParam)

详情描述：通过本接口可以实现停止播放本地或在线音频文件，或者录音设备采集的混音音频流。

调用时机：请在初始化后调用该方法，且该方法仅可在加入房间后调用。

since

5.6.0 及以上。

example

this.engine.stopAudioMixing()

如果后续不再需要使用美颜功能，可以调用 NERTC.stopBeauty 结束美颜功能模块，SDK 会自动销毁美颜引擎并释放资源

since

5.6.33 及以上。

example

this.engine.stopBeauty()

详情描述：通过本接口可以实现在预览本地视频后关闭预览。

调用时机：建议在通过 NERTC.startPreview 接口开启视频预览后调用该方法。

since

5.3.7 及以上。

example

// MAIN: 主流, SUB: 辅流 
 this.engine.stopPreview(NERtcVideoStreamType.MAIN)

详情描述：通过此接口可以实现关闭屏幕共享辅流。

相关回调：

1. 成功调用此方法后，远端会触发 [[NERTC.onUserSubStreamVideoStop]]

since

5.3.7 及以上。

example

 this.engine.stopScreenCapture(screenConfigParam)

详情描述：加入房间后，默认不订阅所有远端用户的视频辅流；若您希望看到指定远端用户的视频辅流，可以在监听到对方加入房间或发布视频辅流之后，通过此方法订阅该用户的视频辅流。

调用时机：

1. 请在初始化后调用该方法，且该方法仅可在加入房间后调用。
2. 请先调用 [[NERTC.]setupRemoteSubStreamVideoCanvas] 设置远端用户的视频辅流画布
3. 建议在收到远端用户发布视频辅流的回调通知 NERtcCallback.onUserSubStreamVideoStart 事件后调用此接口

相关回调:

1. NERtcCallback.onUserSubStreamVideoStart：远端用户发布视频辅流的回调。
2. NERtcCallback.onUserSubStreamVideoStop：远端用户停止发布视频辅流的回调。

since

5.3.7 及以上。

example

this.engine.addEventListener("onUserSubStreamVideoStart", (userID, maxProfile, userStringID) => {
const message = `onUserVideoStart通知：对方开启视频辅流，userID = ${userID}, maxProfile = ${maxProfile}`
//设置对端的视频辅流画布
this.engine.setupRemoteSubStreamVideoCanvas({
renderMode: NERTCRenderMode.Fit, // Fit表示应区域。视频尺寸等比缩放,保证所有区域被填满,视频超出部分会被裁剪
mirrorMode: NERTCMirrorMode.AUTO, //AUTO表示使用默认值,由sdk控制
isMediaOverlay: false, //表示小画布置于大画布上面
userID, //对方userID,如果其范围超过了Number,精度可能会缺失
userStringID //对方String格式的userID,用于精度缺失的场景
})
//主动去订阅对端视频辅流
this.engine.subscribeRemoteSubStreamVideo({
userID,
userStringID,
streamType:NERtcRemoteVideoStreamType.HIGH, //HIGH: 大流, LOW: 小流 
subscribe: true //true表示订阅，false表示取消订阅
})
});

详情描述：加入房间后，默认不订阅所有远端用户的视频主流；若您希望看到指定远端用户的视频，可以在监听到对方加入房间或发布视频流之后，通过此方法订阅该用户的视频主流。

调用时机：请在初始化后调用该方法，且该方法仅可在加入房间后调用。

业务场景: 适用于通过发言者的人声相关信息做出 UI 上的音量展示的场景，或根据发言者的音量大小进行视图布局的动态调整。

相关回调:

1. 开启本地视频采集后，远端会收到 NERtcCallback.onUserVideoStart 回调。
2. 关闭本地视频采集后，远端会收到 NERtcCallback.onUserVideoStop 回调。

since

5.3.7 及以上。

note

• 该方法设置内部引擎为开启或关闭状态, 在 NERTC.leaveChannel 后仍然有效。
• 调用该方法取消发布本地视频流时，设备仍然处于工作状态。
• 该方法仅适用于视频主流

example

this.engine.addEventListener("onUserVideoStart", (userID, maxProfile, userStringID) => {
const message = `onUserVideoStart通知：对方开启视频，userID = ${userID}, maxProfile = ${maxProfile}`
//设置对端的视频画布
this.engine.setupRemoteVideoCanvas({
renderMode: NERTCRenderMode.Fit, // Fit表示应区域。视频尺寸等比缩放,保证所有区域被填满,视频超出部分会被裁剪
mirrorMode: NERTCMirrorMode.AUTO, //AUTO表示使用默认值,由sdk控制
isMediaOverlay: false, //表示小画布置于大画布上面
userID, //对方userID,如果其范围超过了Number,精度可能会缺失
userStringID //对方String格式的userID,用于精度缺失的场景
})
//主动去订阅对端视频
this.engine.subscribeRemoteVideo({
userID,
userStringID,
streamType: NERtcRemoteVideoStreamType.HIGH, //HIGH: 大流, LOW: 小流 
subscribe: true //true表示订阅，false表示取消订阅
})
});

详情描述：该方法用于向网络发送或取消发送本地音频数据，不影响本地音频的采集状态，也不影响接收或播放远端音频流。

调用时机：请在调用 NERTC.startPreview 或 NERTC.joinChannel 方法且开启摄像头之后调用此接口。

since

5.3.7 及以上。

note

• 该方法需要在相机启动后才可调用。

example

this.engine.switchCamera()

调用时机：

1. 本地主流截图，需要在 NERTC.startPreview 或者 NERTC.enableLocalVideo 并 NERTC.joinChannel 成功之后调用。
2. 本地辅流截图，需要在 NERTC.joinChannel 并 NERTC.startScreenCapture 之后调用。

since

5.6.34 及以上。

note

• 截图返回的是图片的base64数据（png格式）

example

//本地视频画面截图
this.engine.takeLocalSnapshot(NERtcVideoStreamType.MAIN).then(result=>{
if(result.img){
const imgBase64 = result.img
} else {
console.log('本地截图失败原因: ', result.errorCode)
}
})

调用时机： 1.需要在收到 NERtcCallback.onUserVideoStart 与 NERtcCallback.onUserSubStreamVideoStart 回调之后调用。。

since

5.6.34 及以上。

note

• 截图返回的是图片的base64数据（png格式）

example

//本地视频画面截图
this.engine.takeRemoteSnapshot({
userID: 100, //number格式的userID
userStringID: '100', //string格式的userID,针对userID超过number范围的场景
videoStreamType: NERtcVideoStreamType.MAIN
}).then(result=>{
if(result.img){
const imgBase64 = result.img
} else {
console.log('本地截图失败原因: ', result.errorCode)
}
})

详情描述：上传的信息包括 log 和 Audio dump 等文件。

调用时机：只能在加入房间后调用。

since

5.3.7 及以上。

example

 this.engine.uploadSdkInfo();