-
- All Implemented Interfaces:
-
com.netease.yunxin.kit.roomkit.api.NEBaseController
public interface NERoomRtcBaseController implements NEBaseController
-
-
Method Summary
Modifier and Type Method Description abstract EGLContext
getEglContext()
获取外部纹理的context abstract Integer
startPreview(NERoomVideoView videoView)
开启预览 abstract Integer
startPreview()
开启预览 abstract Integer
stopPreview()
关闭预览,如果当前处于房间前的预览,会同时销毁RTC实例。 如果希望控制是否销毁RTC,可调用 stopPreview(Boolean) 变体方法。 abstract Integer
stopPreview(Boolean releaseRtc)
关闭预览,同时根据参数 releaseRtc 决定是否销毁底层 RTC Engine 实例。 abstract Integer
switchCamera()
切换摄像头 abstract Integer
switchCameraWithPosition(NERoomCameraPositionType cameraPos)
指定摄像头切换摄像头 abstract Integer
setLocalVideoConfig(NERoomVideoConfig videoConfig)
设置本地视频配置 abstract Integer
setupLocalVideoRender(IVideoRender videoRender)
设置本地视图 abstract Integer
setupLocalVideoCanvas(NERoomVideoView videoView)
设置本地视图 abstract Unit
setVideoFrameCallback(Boolean textureWithI420, Function1<NERoomVideoFrame, NERoomVideoFrame> callback)
设置美颜回调处理 abstract Integer
startBeauty()
example: https://doc.yunxin.163.com/docs/jcyOTA0ODM/DQ1OTY0NjI? abstract Integer
stopBeauty()
结束美颜功能模块。 如果后续不再需要使用美颜功能,可以调用 stopBeauty 结束美颜功能模块,SDK 会自动销毁美颜引擎并释放资源。 abstract Integer
enableBeauty(Boolean isOpenBeauty)
打开美颜功能,leave channel不会重置 接口目前主要用在需要临时关闭美颜,比如对比美颜前后的效果时才需要用到 abstract Integer
setBeautyEffect(NERoomBeautyEffectType beautyType, Float level)
https://doc.yunxin.163.com/docs/jcyOTA0ODM/DQ1OTY0NjI? abstract Integer
addBeautyFilter(String path)
调用 addBeautyFilter 添加滤镜效果,并通过 setBeautyFilterLevel 设置滤镜强度。 滤镜效果可以和全局美颜效果互相叠加,但是不支持叠加多个滤镜。需要更换滤镜时,重复调用此接口使用新的滤镜资源即可。 添加滤镜时,需要通过 path 指定滤镜模型所在路径,支持 SD 卡上的绝对路径,或 asset 目录下的相对路径。 参数 level 用于指定滤镜强度,取值范围为 0,1,默认为 0. abstract Integer
removeBeautyFilter()
不需要使用滤镜效果时,调用 removeBeautyFilter 移除滤镜。 abstract Integer
setBeautyFilterLevel(Float level)
设置滤镜强度。 取值越大,滤镜强度越大,开发者可以根据业务需求自定义设置滤镜强度。 滤镜强度设置实时生效,更换滤镜后滤镜强度不变,如需调整,可以再次调用此接口重新设置滤镜强度。 abstract Integer
addBeautySticker(String path)
添加贴纸效果。 此接口用于加载贴纸资源,添加对应的贴纸效果。需要更换贴纸时,重复调用此接口使用新的贴纸资源即可。 使用滤镜、贴纸和美妆等自定义美颜效果之前,需要先准备好对应的美颜资源或模型。 贴纸效果可以和全局美颜、滤镜、美妆等效果互相叠加,但是不支持叠加多个贴纸。 abstract Integer
removeBeautySticker()
取消贴纸效果。 abstract Integer
enableVirtualBackground(Boolean enabled, NERoomVirtualBackgroundSource backgroundSource)
开启/关闭虚拟背景。 启用虚拟背景功能后,您可以使用自定义背景图片替换本地用户的原始背景图片。 替换后,频道内所有用户都可以看到自定义背景图片。 注解 您可以通过 NERtcCallbackEx#onVirtualBackgroundSourceEnabled() 回调查看虚拟背景是否开启成功或出错原因。 建议您在满足以下条件的场景中使用该功能: 采用高清摄像设备,环境光线均匀。 捕获的视频图像整洁,用户肖像半长且基本无遮挡,并且背景是与用户衣服颜色不同的单一颜色。 虚拟背景功能不支持在 Texture 格式的视频或通过 Push 方法从自定义视频源获取的视频中设置虚拟背景。 若您设置背景图片为自定义本地图片,SDK 会在保证背景图片内容不变形的前提下,对图片进行一定程度上的缩放和裁剪,以适配视频采集分辨率。 abstract Integer
enableVirtualBackground(Boolean enabled, NERoomVirtualBackgroundSource backgroundSource, Boolean force)
开启虚拟背景 abstract NERoomVirtualBackgroundSupportedType
getVirtualBackgroundSupportedType()
获取虚拟背景支持类型 abstract Boolean
getIsSupported()
功能是否支持 -
-
Method Detail
-
getEglContext
abstract EGLContext getEglContext()
获取外部纹理的context
-
startPreview
abstract Integer startPreview(NERoomVideoView videoView)
开启预览
- Parameters:
videoView
- 视频画布
-
startPreview
abstract Integer startPreview()
开启预览
-
stopPreview
abstract Integer stopPreview()
关闭预览,如果当前处于房间前的预览,会同时销毁RTC实例。 如果希望控制是否销毁RTC,可调用 stopPreview(Boolean) 变体方法。
-
stopPreview
abstract Integer stopPreview(Boolean releaseRtc)
关闭预览,同时根据参数 releaseRtc 决定是否销毁底层 RTC Engine 实例。
- Parameters:
releaseRtc
- true:销毁RTC实例;false:不销毁RTC实例
-
switchCamera
abstract Integer switchCamera()
切换摄像头
-
switchCameraWithPosition
abstract Integer switchCameraWithPosition(NERoomCameraPositionType cameraPos)
指定摄像头切换摄像头
- Parameters:
cameraPos
- 摄像头位置
-
setLocalVideoConfig
abstract Integer setLocalVideoConfig(NERoomVideoConfig videoConfig)
设置本地视频配置
- Parameters:
videoConfig
- 视频配置
-
setupLocalVideoRender
abstract Integer setupLocalVideoRender(IVideoRender videoRender)
设置本地视图
- Parameters:
videoRender
- 视频画布
-
setupLocalVideoCanvas
abstract Integer setupLocalVideoCanvas(NERoomVideoView videoView)
设置本地视图
- Parameters:
videoView
- 视频画布
-
setVideoFrameCallback
abstract Unit setVideoFrameCallback(Boolean textureWithI420, Function1<NERoomVideoFrame, NERoomVideoFrame> callback)
设置美颜回调处理
- Parameters:
textureWithI420
- 是否需要同时返回 YUV I420 和 Texture 格式的数据,仅在第三方滤镜率需要 YUV 数据时设置。默认情况下 SDK 仅返回 Texture 数据。callback
- 回调
-
startBeauty
abstract Integer startBeauty()
example: https://doc.yunxin.163.com/docs/jcyOTA0ODM/DQ1OTY0NjI?platformId=50002#示例代码 启用美颜模块。 在开启视频之前,调用 startBeauty 开启美颜功能模块。开启美颜功能之后才能使用全局美颜、滤镜等美颜效果。 调用此接口后,开启美颜引擎。如果后续不再需要使用美颜功能,可以调用 stopBeauty 结束美颜功能模块,销毁美颜引擎并释放资源。 开启美颜功能模块后,默认开启全局美颜效果,您也可以通过 setBeautyEffect 或其他滤镜、贴纸相关接口设置美颜、滤镜等效果。
-
stopBeauty
abstract Integer stopBeauty()
结束美颜功能模块。 如果后续不再需要使用美颜功能,可以调用 stopBeauty 结束美颜功能模块,SDK 会自动销毁美颜引擎并释放资源。
-
enableBeauty
abstract Integer enableBeauty(Boolean isOpenBeauty)
打开美颜功能,leave channel不会重置 接口目前主要用在需要临时关闭美颜,比如对比美颜前后的效果时才需要用到
- Parameters:
isOpenBeauty
- true为打开美颜功能,false为关闭
-
setBeautyEffect
abstract Integer setBeautyEffect(NERoomBeautyEffectType beautyType, Float level)
https://doc.yunxin.163.com/docs/jcyOTA0ODM/DQ1OTY0NjI?platformId=50002#全局美颜效果 调用 setBeautyEffect 开启指定美颜效果,并设置美颜强度。
- Parameters:
beautyType
- 参数用于指定美颜效果。目前支持美白、磨皮等美颜效果,具体枚举值请参考下表。level
- 参数用于指定美颜强度。取值范围为 0,1,各种美颜效果的默认值不同。取值越大,美颜强度越大,开发者可以根据业务需要自定义设置美颜强度。
-
addBeautyFilter
abstract Integer addBeautyFilter(String path)
调用 addBeautyFilter 添加滤镜效果,并通过 setBeautyFilterLevel 设置滤镜强度。 滤镜效果可以和全局美颜效果互相叠加,但是不支持叠加多个滤镜。需要更换滤镜时,重复调用此接口使用新的滤镜资源即可。 添加滤镜时,需要通过 path 指定滤镜模型所在路径,支持 SD 卡上的绝对路径,或 asset 目录下的相对路径。 参数 level 用于指定滤镜强度,取值范围为 0,1,默认为 0.5。取值越大,滤镜越明显,开发者可以根据业务需要自定义设置滤镜强度。
- Parameters:
path
- 滤镜资源或模型所在路径。支持 SD 卡上的绝对路径,或 asset 目录下的相对路径。 SD卡:"/storage/emulated/0/Android/data/com.
-
removeBeautyFilter
abstract Integer removeBeautyFilter()
不需要使用滤镜效果时,调用 removeBeautyFilter 移除滤镜。
-
setBeautyFilterLevel
abstract Integer setBeautyFilterLevel(Float level)
设置滤镜强度。 取值越大,滤镜强度越大,开发者可以根据业务需求自定义设置滤镜强度。 滤镜强度设置实时生效,更换滤镜后滤镜强度不变,如需调整,可以再次调用此接口重新设置滤镜强度。
- Parameters:
level
- 滤镜强度。取值范围为 0 - 1,默认值为 0.
-
addBeautySticker
abstract Integer addBeautySticker(String path)
添加贴纸效果。 此接口用于加载贴纸资源,添加对应的贴纸效果。需要更换贴纸时,重复调用此接口使用新的贴纸资源即可。 使用滤镜、贴纸和美妆等自定义美颜效果之前,需要先准备好对应的美颜资源或模型。 贴纸效果可以和全局美颜、滤镜、美妆等效果互相叠加,但是不支持叠加多个贴纸。
- Parameters:
path
- 贴纸资源所在路径。支持 SD 卡上的绝对路径,或 asset 目录下的相对路径。 SD卡:"/storage/emulated/0/Android/data/com.
-
removeBeautySticker
abstract Integer removeBeautySticker()
取消贴纸效果。
-
enableVirtualBackground
abstract Integer enableVirtualBackground(Boolean enabled, NERoomVirtualBackgroundSource backgroundSource)
开启/关闭虚拟背景。 启用虚拟背景功能后,您可以使用自定义背景图片替换本地用户的原始背景图片。 替换后,频道内所有用户都可以看到自定义背景图片。 注解 您可以通过 NERtcCallbackEx#onVirtualBackgroundSourceEnabled() 回调查看虚拟背景是否开启成功或出错原因。 建议您在满足以下条件的场景中使用该功能: 采用高清摄像设备,环境光线均匀。 捕获的视频图像整洁,用户肖像半长且基本无遮挡,并且背景是与用户衣服颜色不同的单一颜色。 虚拟背景功能不支持在 Texture 格式的视频或通过 Push 方法从自定义视频源获取的视频中设置虚拟背景。 若您设置背景图片为自定义本地图片,SDK 会在保证背景图片内容不变形的前提下,对图片进行一定程度上的缩放和裁剪,以适配视频采集分辨率。
- Parameters:
enabled
- 设置是否开启虚拟背景。true:开启。false: 关闭。backgroundSource
- 背景 NERoomVirtualBackgroundSource
-
enableVirtualBackground
abstract Integer enableVirtualBackground(Boolean enabled, NERoomVirtualBackgroundSource backgroundSource, Boolean force)
开启虚拟背景
- Parameters:
enabled
- 是否开启虚拟背景,true开启,false关闭backgroundSource
- 背景 NERoomVirtualBackgroundSourceforce
- 是否强制开启,true强制开启,false不强制开启。通过getVirtualBackgroundSupportedType来判断,由于设备性能不足,不支持该功能,但可以强制打开
-
getVirtualBackgroundSupportedType
abstract NERoomVirtualBackgroundSupportedType getVirtualBackgroundSupportedType()
获取虚拟背景支持类型
-
getIsSupported
abstract Boolean getIsSupported()
功能是否支持
-
-
-
-