Options
All
  • Public
  • Public/Protected
  • All
Menu

NERTC V5.6.35

NERTC Uniapp SDK

网易云信 NERTC SDK 提供完善的音视频通话开发框架,提供基于网络的点对点视频通话和语音通话功能,还提供多人视频和音频会议功能,支持通话中音视频设备控制和实时音视频模式切换,美颜等功能。

  • NERTC 是基础对象,包含应用程序调用的所有方法。

注意:错误码与安卓端相同。

房间管理

方法 功能描述 版本
NERTC.setupEngineWithContext 创建 RTC 引擎对象。 v5.3.7
NERTC.destroyEngine 销毁NERtc实例,释放资源。 v5.3.7
NERTC.setChannelProfile 获取可用的媒体输入/输出设备。 v5.3.7
NERTC.setClientRole 设置用户角色。 v5.3.7
NERTC.setParameters 此接口提供技术预览或特别定制功能(如AI降噪)。 v5.5.21
NERTC.joinChannel 加入房间。 v5.3.7
NERTC.leaveChannel 离开房间。 v5.3.7
NERTC.getConnectionState 获取房间连接状态。 v5.3.7
NERTC.nertcPrint 原生日志输出接口,可以输入到android Studio/xcode的控制台,以及写入手机日志文件中。 v5.3.7
NERTC.uploadSdkInfo 上传sdk日志到云信服务器。 v5.3.7

房间事件

方法 功能描述 版本
NERtcCallback.onClientRoleChange 用户角色已切换回调。 v5.3.7
NERtcCallback.onJoinChannel 自己加入房间回调。 v5.3.7
NERtcCallback.onReJoinChannel 自己重新加入房间回调。 v5.3.7
NERtcCallback.onLeaveChannel 自己离开房间回调。 v5.3.7
NERtcCallback.onUserJoined 远端用户加入当前房间回调。 v5.3.7
NERtcCallback.onUserLeave 远端用户离开当前房间回调。 v5.3.7
NERtcCallback.onDisconnect sdk服务器连接断开回调。 v5.3.7
NERtcCallback.onConnectionTypeChanged 本地网络类型已改变回调。 v5.3.7
NERtcCallback.onConnectionStateChanged sdk房间连接状态已改变回调。 v5.3.7

音频管理

方法 功能描述 版本
NERTC.setAudioProfile 设置音频编码配置。 v5.3.7
NERTC.adjustRecordingSignalVolume 调节录音音量。 v5.3.7
NERTC.adjustUserPlaybackSignalVolume 调节播放音量。 v5.3.7
NERTC.adjustChannelPlaybackSignalVolume 调节本地播放的指定远端用户的信号音量。 v5.3.7
NERTC.enableLocalAudio 开关本地音频采集。 v5.3.7
NERTC.muteLocalAudio 开关本地音频发送。 v5.3.7
NERTC.enableAudioVolumeIndication 注册音频处理观测器,设置音频处理回调。 v5.3.7
NERTC.enableMediaPub 发布或停止发布本地音频。 v5.3.7

视频管理

方法 功能描述 版本
NERTC.setLocalVideoConfig 设置视频编码配置。 v5.3.7
NERTC.enableLocalVideo 开启/关闭本地视频的采集与发送。 v5.3.7
NERTC.setupLocalVideoCanvas 设置本地用户视图。 v5.3.7
NERTC.setupRemoteVideoCanvas 设置远端用户视图。 v5.3.7
NERTC.startPreview 开启视频预览。 v5.3.7
NERTC.stopPreview 停止视频预览。 v5.3.7
NERTC.muteLocalVideo 取消/恢复发布本地视频。 v5.3.7
NERTC.subscribeRemoteVideo 订阅/取消订阅指定远端用户的视频流 。 v5.3.7
NERTC.changeVideoCanvas 交换本端和远端视频的视图 。 v5.6.0

云信美颜

方法 功能描述 版本
NERTC.startBeauty 开启美颜。 v5.6.33
NERTC.stopBeauty 关闭美颜。 v5.6.33
NERTC.setBeautyEffect 设置美颜效果。 v5.6.33
NERTC.setFilter 添加滤镜效果(H5专用)。 v5.6.33
NERTC.addBeautyFilter 添加滤镜效果(APP专用)。 v5.6.33
NERTC.setBeautyFilterLevel 设置滤镜强度(APP专用)。 v5.6.33
NERTC.removeBeautyFilter 取消滤镜效果(APP专用)。 v5.6.33
NERTC.enableBeauty 暂停或恢复美颜效果(APP专用)。 v5.6.33

截图

方法 功能描述 版本
NERTC.takeLocalSnapshot 本地视频画面截图。 v5.6.34
NERTC.takeRemoteSnapshot 远端视频画面截图。 v5.6.34

本地媒体事件

方法 功能描述 版本
NERtcCallback.onFirstAudioFrameDecoded 已解码远端音频首帧的回调 。 v5.3.7
NERtcCallback.onFirstVideoFrameDecoded 已接收到远端视频首帧并完成解码的回调。 v5.3.7
NERtcCallback.onFirstVideoDataReceived 已显示远端视频首帧的回调 。 v5.3.7
NERtcCallback.onFirstAudioDataReceived 远端音频首帧回调。 v5.3.7

远端媒体事件

方法 功能描述 版本
NERtcCallback.onUserVideoMute 远端用户暂停或恢复发送视频主流的回调。 v5.3.7
NERtcCallback.onUserAudioMute 远端用户暂停或恢复音频主流发送的回调。 v5.3.7
NERtcCallback.onUserAudioStart 远端用户开启音频主流的回调。 v5.3.7
NERtcCallback.onUserAudioStop 远端用户关闭音频主流的回调。 v5.3.7
NERtcCallback.onUserVideoStart 远端用户开启视频的回调。 v5.3.7
NERtcCallback.onUserVideoStop 远端用户关闭视频的回调。 v5.3.7

数据统计事件

方法 功能描述 版本
NERtcCallback.onRtcStats 当前通话统计回调,每2秒触发一次。 v5.3.7
NERtcCallback.onNetworkQuality 通话中每个用户的网络上下行质量报告回调。 v5.3.7
NERtcCallback.onLocalAudioStats 本地音频流统计信息回调。 v5.3.7
NERtcCallback.onLocalVideoStats 本地视频流统计信息回调。 v5.3.7
NERtcCallback.onRemoteAudioStats 通话中远端音频流的统计信息回调。 v5.3.7
NERtcCallback.onRemoteVideoStats 通话中远端视频流的统计信息回调。 v5.3.7
NERTC.setStatsObserver 设置统计信息回调。 v5.3.7

屏幕共享

方法 功能描述 版本
NERTC.setupShareKit IOS屏幕共享配置。 v5.6.35
NERTC.setupLocalSubStreamVideoCanvas 设置本端的辅流视频回放画布。 v5.3.7
NERTC.setupRemoteSubStreamVideoCanvas 设置远端的辅流视频回放画布。 v5.3.7
NERTC.startScreenCapture 开启屏幕共享。 v5.3.7
NERTC.stopScreenCapture 停止屏幕共享。 v5.3.7
NERTC.subscribeRemoteSubStreamVideo 订阅或取消订阅远端的屏幕共享辅流视频,订阅之后才能接收远端的辅流视频数据 。 v5.3.7

屏幕共享事件

方法 功能描述 版本
NERtcCallback.onUserSubStreamVideoStart 远端用户开启屏幕共享辅流通道的回调。 v5.3.7
NERtcCallback.onUserSubStreamVideoStop 远端用户停止屏幕共享辅流通道的回调。 v5.3.7

音频共享

方法 功能描述 版本
NERTC.enableLoopbackRecording 是否开启音频共享(即系统声音)。 v5.5.21
NERTC.adjustLoopBackRecordingSignalVolume 设置音频共享的音量。 v5.5.21

音量提示

方法 功能描述 版本
NERTC.enableAudioVolumeIndication 启用说话者音量提示 。 v5.3.7

音量提示事件

方法 功能描述 版本
NERtcCallback.onRemoteAudioVolumeIndication 提示房间内谁正在说话及说话者音量的回调。 v5.3.7
NERtcCallback.onLocalAudioVolumeIndication 提示房间内本地用户瞬时音量及是否存在人声的回调。 v5.3.7

耳返

方法 功能描述 版本
NERTC.enableEarback 开启耳返功能。 v5.3.7
NERTC.setEarbackVolume 设置耳返音量。 v5.3.7

H5平台自动播放受限

方法 功能描述 版本
NERTC.resume 监测到自动播放受限后,重新恢复音视频流。 v5.5.11
NERTC.rePlayAudio 监测到自动播放受限后,重新播放音视流。 v5.5.11

伴音

方法 功能描述 版本
NERTC.startAudioMixing 开启伴音。 v5.6.0
NERTC.stopAudioMixing 停止伴音。 v5.6.0
NERTC.pauseAudioMixing 暂停伴音。 v5.6.0
NERTC.resumeAudioMixing 恢复伴音。 v5.6.0
NERTC.setAudioMixingPlaybackVolume 设置节伴奏播放音量。 v5.6.0
NERTC.setAudioMixingSendVolume 调节伴奏发送音量。 v5.6.0
NERTC.getAudioMixingPlaybackVolume 获取伴奏本地播放音量。 v5.6.0
NERTC.getAudioMixingSendVolume 获取伴奏发送音量。 v5.6.0
NERTC.getAudioMixingDuration 获取伴奏时长。 v5.6.0
NERTC.setAudioMixingPosition 设置音乐文件的播放位置。 v5.6.0
NERTC.getAudioMixingCurrentPosition 获取音乐文件的播放进度。 v5.6.0
NERTC.getAudioMixingPitch 获取当前伴音文件的音调。 v5.6.0
NERTC.setAudioMixingPitch 设置当前伴音文件的音调。 v5.6.0
NERtcCallback.onAudioMixingStateChanged 远端用户加入当前房间回调。 v5.6.0
NERtcCallback.onAudioMixingTimestampUpdate 远端用户离开当前房间回调。 v5.6.0