NERoomRtcController

interface NERoomRtcController : NERoomRtcBaseController

音视频控制器

Functions

addBeautyFilter

abstract fun addBeautyFilter(path: String): Int

调用 addBeautyFilter 添加滤镜效果，并通过 setBeautyFilterLevel 设置滤镜强度。滤镜效果可以和全局美颜效果互相叠加，但是不支持叠加多个滤镜。需要更换滤镜时，重复调用此接口使用新的滤镜资源即可。添加滤镜时，需要通过 path 指定滤镜模型所在路径，支持 SD 卡上的绝对路径，或 asset 目录下的相对路径。参数 level 用于指定滤镜强度，取值范围为 0,1，默认为 0.

addBeautySticker

abstract fun addBeautySticker(path: String): Int

添加贴纸效果。此接口用于加载贴纸资源，添加对应的贴纸效果。需要更换贴纸时，重复调用此接口使用新的贴纸资源即可。使用滤镜、贴纸和美妆等自定义美颜效果之前，需要先准备好对应的美颜资源或模型。贴纸效果可以和全局美颜、滤镜、美妆等效果互相叠加，但是不支持叠加多个贴纸。

adjustUserPlaybackSignalVolume

abstract fun adjustUserPlaybackSignalVolume(userUuid: String, volume: Int): Int

调节本地播放的指定远端用户的信号音量加入房间后，您可以多次调用该方法设置本地播放的不同远端用户的音量；也可以反复调节本地播放的某个远端用户的音量。

disableEarBack

abstract fun disableEarBack(): Int

关闭耳返功能。

enableAudioVolumeIndication

abstract fun enableAudioVolumeIndication(enable: Boolean, interval: Int): Int

启用说话者音量提示。该方法允许 SDK 定期向 App 反馈本地发流用户和瞬时音量最高的远端用户（最多 3 位）的音量相关信息，即当前谁在说话以及说话者的音量。启用该方法后，只要房间内有发流用户，无论是否有人说话， SDK 都会在加入房间后根据预设的时间间隔触发 NERoomListener.onRtcAudioVolumeIndication 回调

enableBeauty

abstract fun enableBeauty(isOpenBeauty: Boolean): Int

打开美颜功能，leave channel不会重置接口目前主要用在需要临时关闭美颜，比如对比美颜前后的效果时才需要用到

enableEarBack

abstract fun enableEarBack(volume: Int): Int

开启耳返功能。开启耳返功能后，必须连接上耳机或耳麦，才能正常使用耳返功能。

enableVirtualBackground

abstract fun enableVirtualBackground(enabled: Boolean, backgroundSource: NERoomVirtualBackgroundSource?): Int

开启/关闭虚拟背景。启用虚拟背景功能后，您可以使用自定义背景图片替换本地用户的原始背景图片。替换后，频道内所有用户都可以看到自定义背景图片。注解您可以通过 NERtcCallbackEx#onVirtualBackgroundSourceEnabled() 回调查看虚拟背景是否开启成功或出错原因。建议您在满足以下条件的场景中使用该功能：采用高清摄像设备，环境光线均匀。捕获的视频图像整洁，用户肖像半长且基本无遮挡，并且背景是与用户衣服颜色不同的单一颜色。虚拟背景功能不支持在 Texture 格式的视频或通过 Push 方法从自定义视频源获取的视频中设置虚拟背景。若您设置背景图片为自定义本地图片，SDK 会在保证背景图片内容不变形的前提下，对图片进行一定程度上的缩放和裁剪，以适配视频采集分辨率。 enabled 设置是否开启虚拟背景。true：开启。false: 关闭。

getEglContext

abstract fun getEglContext(): EGLContext

获取外部纹理的context

getScreenSharingUserUuid

abstract fun getScreenSharingUserUuid(): String?

查询屏幕共享者的userUuid

isSpeakerphoneOn

abstract fun isSpeakerphoneOn(): Boolean

查询扬声器是否开启

joinRtcChannel

abstract fun joinRtcChannel(callback: NECallback<Unit>? = null)

加入音视频房间

leaveRtcChannel

abstract fun leaveRtcChannel(callback: NECallback<Unit>? = null)

离开音视频房间

muteMemberAudio

abstract fun muteMemberAudio(userUuid: String, callback: NECallback<Unit>? = null)

尝试关闭成员音频，会进行权限校验

muteMemberVideo

abstract fun muteMemberVideo(userUuid: String, callback: NECallback<Unit>? = null)

尝试关闭成员视频，会进行权限校验

muteMyAudio

abstract fun muteMyAudio(callback: NECallback<Unit>? = null)

关闭本端音频发送该方法用于禁止上行本地音频流

muteMyVideo

abstract fun muteMyVideo(callback: NECallback<Unit>? = null)

关闭本端视频

playEffect

abstract fun playEffect(effectId: Int, option: NERoomCreateAudioEffectOption): Int

播放指定音效文件。该方法播放指定的本地或在线音效文件。支持的音效文件类型包括 MP3、M4A、AAC、3GP、WMA 和 WAV 格式，支持本地 SD 卡中的文件和在线 URL

pushExternalVideoFrame

abstract fun pushExternalVideoFrame(frame: NERoomVideoFrame): Int

推送外部视频帧该方法主动将视频帧数据用 NERtcVideoFrame 类封装后传递给 SDK （该方法设置内部引擎为启用状态，在 leaveChannel 后不再有效。请确保在你调用本方法前已调用 setExternalVideoSource，并将参数设为 true，否则调用本方法后会一直报错。）

removeBeautyFilter

abstract fun removeBeautyFilter(): Int

不需要使用滤镜效果时，调用 removeBeautyFilter 移除滤镜。

removeBeautySticker

abstract fun removeBeautySticker(): Int

取消贴纸效果。

setAudioMixingPlaybackVolume

abstract fun setAudioMixingPlaybackVolume(volume: Int): Int

调节伴奏播放音量。该方法调节混音里伴奏的播放音量大小。

setAudioMixingSendVolume

abstract fun setAudioMixingSendVolume(volume: Int): Int

调节伴奏发送音量。该方法调节混音里伴奏的发送音量大小。

setBeautyEffect

abstract fun setBeautyEffect(beautyType: NERoomBeautyEffectType, level: Float): Int

https://doc.yunxin.163.com/docs/jcyOTA0ODM/DQ1OTY0NjI?

setBeautyFilterLevel

abstract fun setBeautyFilterLevel(level: Float): Int

设置滤镜强度。取值越大，滤镜强度越大，开发者可以根据业务需求自定义设置滤镜强度。滤镜强度设置实时生效，更换滤镜后滤镜强度不变，如需调整，可以再次调用此接口重新设置滤镜强度。

setEffectPlaybackVolume

abstract fun setEffectPlaybackVolume(effectId: Int, volume: Int): Int

设置音效文件播放音量。

setEffectSendVolume

abstract fun setEffectSendVolume(effectId: Int, volume: Int): Int

设置音效文件发送音量。

setExternalVideoSource

abstract fun setExternalVideoSource(enable: Boolean): Int

开启或关闭外部视频源数据输入该方法启用外部视频数据输入功能（该方法设置内部引擎为启用状态，在 leaveChannel 后仍然有效。如果需要关闭该功能，需要在下次通话前调用接口关闭该功能。如果使用了外部视频源，请在调用 startScreenCapture、enableLocalVideo 或 startVideoPreview 之前调用此 API。屏幕共享时，外部输入视频源默认使用辅流通道；非屏幕共享时，外部输入视频源使用主流通道，此时与 Camera 互斥。之前使用主流通道或者当前使用主流通道，且主流已经开启时，请勿更改设置。之前使用辅流通道或者当前使用辅流通道，且辅流已经开启时，请勿更改设置。）

setSpeakerphoneOn

abstract fun setSpeakerphoneOn(on: Boolean): Int

打开或关闭扬声器

setupLocalVideoCanvas

abstract fun setupLocalVideoCanvas(videoView: NERoomVideoView?): Int

设置本地视图

setupLocalVideoRender

abstract fun setupLocalVideoRender(videoRender: IVideoRender?): Int

设置本地视图

setupRemoteVideoCanvas

abstract fun setupRemoteVideoCanvas(videoView: NERoomVideoView?, userUuid: String): Int

设置远端用户视图