本文档包含NemoSDK中所有AI人脸识别、虚拟背景、美颜和滤镜相关的函数接口。
版本支持: 3.11.0
函数概述: 加载电子铭牌模块
函数定义:
virtual void enableEletronicNameplate(bool enable) = 0;
函数参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
enable | bool | 是 | 无 | 是否加载 |
版本支持: 3.11.0
函数概述: 请求本地人脸识别
函数定义:
virtual void startAIFace(bool enable, XYFaceType type) = 0;
函数参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
enable | bool | 是 | 无 | 是否开启本地人脸识别 |
type | 是 | 无 | 人脸识别类型 |
版本支持: 3.3.0
函数概述: 请求人脸信息
函数定义:
virtual void getFaceInfo(const XYArray<int32_t>& faceIDs) = 0;
函数参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
faceIDs | const XYArray& | 是 | 无 | 需要请求的人脸信息的ID数组（通过reqFace回调拿到） |
版本支持: 3.11.0
函数概述: 设置Wayland模式
函数定义:
virtual void setWaylandMode(bool isWayland) = 0;
函数参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
isWayland | bool | 是 | 无 | 是否是Wayland模式 |
版本支持: 3.11.0
函数概述: 设置虚拟背景模式
函数定义:
virtual void setVirtualBgMode(XYVirtualBgMode mode) = 0;
函数参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
mode | 是 | 无 | 虚拟背景模式 |
版本支持: 3.11.0
函数概述: 设置用户自定义虚拟背景图片路径
函数定义:
virtual void setVirtualBgImg(const char* imgPath) = 0;
函数参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
imgPath | const char* | 是 | 无 | 自定义虚拟背景图片路径 |
版本支持: 3.11.0
函数概述: 设置滤镜的风格和滤镜效果等级
函数定义:
virtual void setVideoFilterEffect(XYFilterStyle style, int effectLevel) = 0;
函数参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
style | 是 | 无 | 滤镜风格 | |
effectLevel | int | 是 | 无 | 滤镜效果等级（范围为0-100） |
版本支持: 3.11.0
函数概述: 设置美颜的风格和效果等级
函数定义:
virtual void setVideoBeautyEffect(XYBeautyStyle style, int effectLevel) = 0;
函数参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
style | 是 | 无 | 美颜风格 | |
effectLevel | int | 是 | 无 | 美颜效果等级（范围为0-100） |
版本支持: 3.11.0
函数概述: 启用/禁用虚拟数字人
函数定义:
virtual void setDigitalHumanOptions(bool enabled, const char* pmPath, const char* ptPath, const char* bgPath) = 0;
函数参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
enabled | bool | 是 | 无 | 启用/禁用 |
pmPath | const char* | 是 | 无 | 人物模型路径 |
ptPath | const char* | 是 | 无 | 模型贴图路径 |
bgPath | const char* | 是 | 无 | 背景图路径 |
版本支持: 3.11.0
函数概述: 设置本地视频降噪选项
函数定义:
virtual void setVideoDenoiserOptions(bool enabled, XYVideoDenoiserOptions options) = 0;
函数参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
enabled | bool | 是 | 无 | 是否开启此功能 |
options | 是 | 无 | 详见 @{XYVideoDenoiserOptions@} |
版本支持: 3.11.0
函数概述: 设置本地视频暗光增强选项
函数定义:
virtual void setVideoLowLightEnhanceOptions(bool enabled, XYVideoLowLightEnhanceOptions options) = 0;
函数参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
enabled | bool | 是 | 无 | 是否开启此功能 |
options | 是 | 无 | 详见 @{XYVideoDenoiserOptions@} |
版本支持: 3.11.0
函数概述: 设置远端内容流锐化是否开启
函数定义:
virtual void setRemoteContentSharpenEnabled(bool enabled) = 0;
函数参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
enabled | bool | 是 | 无 | 是否开启此功能 |
版本支持: 3.3.0
函数概述: 获取gpu信息
函数定义:
virtual void getGPUInfo() = 0;
版本支持: 3.3.0
函数概述: 开启gpu加速, 如果启用虚拟背景跟美颜, 在初始化之后可以开启gpu加速
函数定义:
virtual void setEnableGPUs(const XYArray<XYString>& enableGPUs) = 0;
函数参数:
版本支持: 3.3.0
函数状态: 已废弃, 请使用 enableEletronicNameplate(bool enable)
函数概述: 广播本地电子铭牌到远端: 开启后接收端可以收到广播出去的人脸信息
函数定义:
virtual void broadcastEletronicBadge(bool enable) = 0;
函数参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
enable | bool | 是 | 无 | 是否开启 |
版本支持: 3.3.0
函数状态: 已废弃, 请使用 startAIFace(bool enable, XYFaceType type)
函数概述: 人脸识别模式
函数定义:
virtual void enableFaceDetectMode(SDKFaceType faceType, bool enable) = 0;
函数参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
faceType | SDKFaceType | 是 | 无 | 人脸识别类型 |
enable | bool | 是 | 无 | 是否可用 |
版本支持: 3.3.0
函数状态: 已废弃, 请使用 setVirtualBgMode(XYVirtualBgMode mode)
函数概述: 虚拟背景模式
函数定义:
virtual void setVirtualBgMode(SDKVirtualBgMode mode) = 0;
函数参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
mode | SDKVirtualBgMode | 是 | 无 | 背景模式 |
版本支持: 3.3.0
函数状态: 已废弃, 请使用 setVirtualBgImg(const char* imgPath)
函数概述: 虚拟背景图片, 仅支持jpg格式 (其他格式得话应用层自己处理格式转换跟存储逻辑, 可参考demo)
函数定义:
virtual void setVirtualBgImage(const char* imgPath) = 0;
函数参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
imgPath | const char* | 是 | 无 | 图片路径 |
版本支持: 3.3.0
函数状态: 已废弃, 请使用 setVideoBeautyEffect(XYBeautyStyle style, int effectLevel)
函数概述: 设置美颜效果
函数定义:
virtual void setVideoBeautyEffect(SDKBeautyStyle style, int effectLevel) = 0;
函数参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
style | SDKBeautyStyle | 是 | 无 | 美颜样式 |
effectLevel | int | 是 | 无 | 效果等级 |
版本支持: 3.3.0
函数状态: 已废弃, 请使用 setVideoFilterEffect(XYFilterStyle style, int effectLevel)
函数概述: 设置滤镜效果
函数定义:
virtual void setVideoFilterEffect(SDKFilterStyle style, int effectLevel) = 0;
函数参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
style | SDKFilterStyle | 是 | 无 | 滤镜样式 |
effectLevel | int | 是 | 无 | 效果等级 |