视频增强

addOrUpdateVideoEffect

为指定的视频特效节点 ID 和模板添加或更新视频特效。

Java

int addOrUpdateVideoEffect(int nodeId, String templateName);

自从

自 v4.6.0 版本新增。

信息

优先级规则：

• 风格妆特效节点优先于 FILTER 参数。
• 若要应用 FILTER 参数，必须先移除风格妆特效节点：

removeVideoEffect(STYLE_MAKEUP);
addOrUpdateVideoEffect(FILTER, "template name");

参数

nodeId

视频特效节点的唯一标识符或标识符组合。详见 VIDEO_EFFECT_NODE_ID。

templateName

特效模板名称。如果设置为 null 或空字符串，SDK 会从资源包中加载默认参数配置。

返回值

• 0：方法调用成功。
• < 0：方法调用失败。详见错误码了解详情和解决建议。

所属接口类

• IVideoEffectObject

createVideoEffectObject

创建一个 IVideoEffectObject 视频特效对象。

Java

public abstract IVideoEffectObject createVideoEffectObject(String bundlePath, Constants.MediaSourceType sourceType);

自从

自 v4.6.0 版本新增。

信息

你必须先调用 enableVideo 方法再调用此方法。该方法适用于 Android 4.4 及以上版本。

参数

bundlePath

视频特效资源包的路径。

sourceType

媒体源类型，例如 PRIMARY_CAMERA_SOURCE。详见 MediaSourceType。

返回值

方法调用成功，返回 IVideoEffectObject 对象。 方法调用失败，返回 null。

所属接口类

• RtcEngine

destroyVideoEffectObject

销毁一个视频特效对象。

Java

public abstract int destroyVideoEffectObject(IVideoEffectObject videoEffectObject);

自从

自 v4.6.0 版本新增。

信息

在调用该方法前必须先调用 enableVideo 方法。该方法适用于 Android 4.4 及以上版本。

参数

videoEffectObject

要销毁的视频特效对象。详见 IVideoEffectObject。

返回值

• 0：方法调用成功。
• < 0：方法调用失败。详见错误码了解详情和解决建议。

所属接口类

• RtcEngine

getFaceShapeAreaOptions [1/2]

获取美颜区域的当前设置。

Java

public abstract FaceShapeAreaOptions getFaceShapeAreaOptions(int shapeArea, Constants.MediaSourceType sourceType);

适用场景

当用户在应用中打开美型区域和塑形强度菜单时，可以调用该方法获取当前的美颜特效选项，然后根据结果刷新用户界面中的菜单并更新 UI。

调用时机

在调用 enableVideo 之后调用此方法。

参数

shapeArea

美颜增强区域。

• FACE_SHAPE_AREA_NONE（-1）：（默认）无效区域，不应用美颜效果。
• FACE_SHAPE_AREA_HEADSCALE（100）：头部，用于实现小头效果。调整范围为 [0, 100]，值越大头部越小，默认值为 100。
• FACE_SHAPE_AREA_FOREHEAD（101）：额头，用于调整发际线高度。调整范围为 [-100, 100]，正值抬高发际线，负值降低发际线，绝对值越大效果越明显，默认值为 50。
• FACE_SHAPE_AREA_FACECONTOUR（102）：脸部轮廓，用于实现瘦脸效果。调整范围为 [0, 100]，值越大瘦脸效果越明显，默认值为 10。
• FACE_SHAPE_AREA_FACELENGTH（103）：脸长，用于拉长或缩短脸部。调整范围为 [-100, 100]，正值拉长脸部，负值缩短脸部，绝对值越大效果越明显，默认值为 0。
• FACE_SHAPE_AREA_FACEWIDTH（104）：脸宽，用于实现窄脸效果。调整范围为 [0, 100]，值越大脸部越窄，默认值为 10。
• FACE_SHAPE_AREA_CHEEKBONE（105）：颧骨，用于调整颧骨宽度。调整范围为 [0, 100]，值越大颧骨越窄，默认值为 43。
• FACE_SHAPE_AREA_CHEEK（106）：面颊，用于调整面颊宽度。调整范围为 [0, 100]，值越大面颊越窄，默认值为 50。
• FACE_SHAPE_AREA_CHIN（108）：下巴，用于调整下巴长度。调整范围为 [-100, 100]，正值拉长下巴，负值缩短下巴，绝对值越大效果越明显，默认值为 -20。
• FACE_SHAPE_AREA_EYESCALE（200）：眼睛，用于实现大眼效果。调整范围为 [0, 100]，值越大眼睛越大，默认值为 50。
• FACE_SHAPE_AREA_EYEDISTANCE（201）：眼距调整。范围为 [-100, 100]，默认值为 0。绝对值越大，调整越明显，负值表示相反方向。
• FACE_SHAPE_AREA_EYEPOSITION（202）：眼睛位置调整。范围为 [-100, 100]，默认值为 0。绝对值越大，调整越明显，负值表示相反方向。
• FACE_SHAPE_AREA_LOWEREYELID（203）：下眼睑调整。范围为 [0, 100]，默认值为 0。值越大，调整越明显。
• FACE_SHAPE_AREA_EYEPUPILS（204）：瞳孔大小调整。范围为 [0, 100]，默认值为 0。值越大，调整越明显。
• FACE_SHAPE_AREA_EYEINNERCORNER（205）：内眼角调整。范围为 [0, 100]，默认值为 0。值越大，调整越明显。
• FACE_SHAPE_AREA_EYEOUTERCORNER（206）：外眼角调整。范围为 [0, 100]，默认值为 0。值越大，调整越明显。
• FACE_SHAPE_AREA_NOSELENGTH（300）：鼻子长度，用于拉长或缩短鼻子。调整范围为 [-100, 100]，正值拉长鼻子，负值缩短鼻子，绝对值越大效果越明显，默认值为 -10。
• FACE_SHAPE_AREA_NOSEWIDTH（301）：鼻子宽度，用于实现瘦鼻效果。调整范围为 [-100, 100]，正值加宽鼻子，负值缩窄鼻子，绝对值越大效果越明显，默认值为 72。
• FACE_SHAPE_AREA_NOSEWING（302）：鼻翼调整。范围为 [0, 100]，默认值为 0。值越大，调整越明显。
• FACE_SHAPE_AREA_NOSEROOT（303）：鼻根调整。范围为 [0, 100]，默认值为 0。值越大，调整越明显。
• FACE_SHAPE_AREA_NOSEBRIDGE（304）：鼻梁调整。范围为 [0, 100]，默认值为 0。值越大，调整越明显。
• FACE_SHAPE_AREA_NOSETIP（305）：鼻尖调整。范围为 [0, 100]，默认值为 0。值越大，调整越明显。
• FACE_SHAPE_AREA_NOSEGENERAL（306）：整体鼻子调整。范围为 [0, 100]，默认值为 0。值越大，调整越明显。
• FACE_SHAPE_AREA_MOUTHSCALE（400）：嘴巴，用于实现大嘴效果。调整范围为 [0, 100]，值越大嘴巴越大，默认值为 50。
• FACE_SHAPE_AREA_MOUTHPOSITION（401）：嘴巴位置调整。范围为 [-100, 100]，默认值为 0。绝对值越大，调整越明显，负值表示相反方向。
• FACE_SHAPE_AREA_MOUTHSMILE（402）：嘴角微笑调整。范围为 [0, 100]，默认值为 0。值越大，调整越明显。
• FACE_SHAPE_AREA_MOUTHLIP（403）：唇形调整。范围为 [0, 100]，默认值为 0。值越大，调整越明显。
• FACE_SHAPE_AREA_EYEBROWPOSITION（500）：眉毛位置调整。范围为 [-100, 100]，默认值为 0。绝对值越大，调整越明显，负值表示相反方向。
• FACE_SHAPE_AREA_EYEBROWTHICKNESS（501）：眉毛粗细调整。范围为 [0, 100]，默认值为 0。值越大，调整越明显。

sourceType

应用滤镜效果的媒体源类型，详见 MediaSourceType。

信息

该参数仅支持以下两种设置：

• 使用摄像头采集本地视频时，使用默认值 PRIMARY_CAMERA_SOURCE。
• 使用自定义视频源时，设置为 CUSTOM_VIDEO_SOURCE。

返回值

• 方法调用成功，返回 FaceShapeAreaOptions 实例。
• 方法调用失败，返回 null。

所属接口类

• RtcEngine

getFaceShapeAreaOptions [2/2]

获取当前美颜效果区域的设置选项。

Java

public abstract FaceShapeAreaOptions getFaceShapeAreaOptions(int shapeArea);

你可以调用该方法获取当前美颜效果的设置选项，并根据返回结果刷新界面菜单，更新 UI。

适用场景

当你在 App 中打开美型区域和强度设置菜单时，可以调用此方法获取当前的美颜特效选项，然后根据结果刷新菜单并更新 UI。

调用时机

在调用 enableVideo 方法之后调用此方法。

参数

shapeArea

美颜增强区域。

• FACE_SHAPE_AREA_NONE（-1）：（默认）无效区域，不应用美颜效果。
• FACE_SHAPE_AREA_HEADSCALE（100）：头部，用于实现小头效果。调整范围为 [0, 100]，值越大头部越小，默认值为 100。
• FACE_SHAPE_AREA_FOREHEAD（101）：额头，用于调整发际线高度。调整范围为 [-100, 100]，正值抬高发际线，负值降低发际线，绝对值越大效果越明显，默认值为 50。
• FACE_SHAPE_AREA_FACECONTOUR（102）：脸型轮廓，用于实现瘦脸效果。调整范围为 [0, 100]，值越大瘦脸效果越明显，默认值为 10。
• FACE_SHAPE_AREA_FACELENGTH（103）：脸长，用于实现拉长脸部效果。调整范围为 [-100, 100]，正值拉长脸部，负值缩短脸部，绝对值越大效果越明显，默认值为 0。
• FACE_SHAPE_AREA_FACEWIDTH（104）：脸宽，用于实现窄脸效果。调整范围为 [0, 100]，值越大脸部越窄，默认值为 10。
• FACE_SHAPE_AREA_CHEEKBONE（105）：颧骨，用于调整颧骨宽度。调整范围为 [0, 100]，值越大颧骨越窄，默认值为 43。
• FACE_SHAPE_AREA_CHEEK（106）：面颊，用于调整面颊宽度。调整范围为 [0, 100]，值越大面颊越窄，默认值为 50。
• FACE_SHAPE_AREA_CHIN（108）：下巴，用于调整下巴长度。调整范围为 [-100, 100]，正值拉长下巴，负值缩短下巴，绝对值越大效果越明显，默认值为 -20。
• FACE_SHAPE_AREA_EYESCALE（200）：眼睛，用于实现大眼效果。调整范围为 [0, 100]，值越大眼睛越大，默认值为 50。
• FACE_SHAPE_AREA_EYEDISTANCE（201）：眼距调整。调整范围为 [-100, 100]，负值表示相反方向，绝对值越大调整越明显，默认值为 0。
• FACE_SHAPE_AREA_EYEPOSITION（202）：眼睛位置调整。调整范围为 [-100, 100]，负值表示相反方向，绝对值越大调整越明显，默认值为 0。
• FACE_SHAPE_AREA_LOWEREYELID（203）：下眼睑调整。调整范围为 [0, 100]，值越大调整越明显，默认值为 0。
• FACE_SHAPE_AREA_EYEPUPILS（204）：瞳孔大小调整。调整范围为 [0, 100]，值越大调整越明显，默认值为 0。
• FACE_SHAPE_AREA_EYEINNERCORNER（205）：内眼角调整。调整范围为 [0, 100]，值越大调整越明显，默认值为 0。
• FACE_SHAPE_AREA_EYEOUTERCORNER（206）：外眼角调整。调整范围为 [0, 100]，值越大调整越明显，默认值为 0。
• FACE_SHAPE_AREA_NOSELENGTH（300）：鼻子长度，用于实现拉长鼻子效果。调整范围为 [-100, 100]，正值拉长鼻子，负值缩短鼻子，绝对值越大效果越明显，默认值为 -10。
• FACE_SHAPE_AREA_NOSEWIDTH（301）：鼻子宽度，用于实现瘦鼻效果。调整范围为 [-100, 100]，正值加宽鼻子，负值缩窄鼻子，绝对值越大效果越明显，默认值为 72。
• FACE_SHAPE_AREA_NOSEWING（302）：鼻翼调整。调整范围为 [0, 100]，值越大调整越明显，默认值为 0。
• FACE_SHAPE_AREA_NOSEROOT（303）：鼻根调整。调整范围为 [0, 100]，值越大调整越明显，默认值为 0。
• FACE_SHAPE_AREA_NOSEBRIDGE（304）：鼻梁调整。调整范围为 [0, 100]，值越大调整越明显，默认值为 0。
• FACE_SHAPE_AREA_NOSETIP（305）：鼻尖调整。调整范围为 [0, 100]，值越大调整越明显，默认值为 0。
• FACE_SHAPE_AREA_NOSEGENERAL（306）：整体鼻子调整。调整范围为 [0, 100]，值越大调整越明显，默认值为 0。
• FACE_SHAPE_AREA_MOUTHSCALE（400）：嘴巴，用于实现大嘴效果。调整范围为 [0, 100]，值越大嘴巴越大，默认值为 50。
• FACE_SHAPE_AREA_MOUTHPOSITION（401）：嘴巴位置调整。调整范围为 [-100, 100]，负值表示相反方向，绝对值越大调整越明显，默认值为 0。
• FACE_SHAPE_AREA_MOUTHSMILE（402）：嘴角微笑调整。调整范围为 [0, 100]，值越大调整越明显，默认值为 0。
• FACE_SHAPE_AREA_MOUTHLIP（403）：唇形调整。调整范围为 [0, 100]，值越大调整越明显，默认值为 0。
• FACE_SHAPE_AREA_EYEBROWPOSITION（500）：眉毛位置调整。调整范围为 [-100, 100]，负值表示相反方向，绝对值越大调整越明显，默认值为 0。
• FACE_SHAPE_AREA_EYEBROWTHICKNESS（501）：眉毛粗细调整。调整范围为 [0, 100]，值越大调整越明显，默认值为 0。

返回值

• 方法调用成功，返回 FaceShapeAreaOptions 实例。
• 方法调用失败，返回 null。

所属接口类

• RtcEngine

getFaceShapeBeautyOptions [1/2]

获取当前的美颜特效设置。

Java

public abstract FaceShapeBeautyOptions getFaceShapeBeautyOptions(Constants.MediaSourceType sourceType);

当用户在应用中打开美颜风格和风格强度菜单时，可以调用此方法，并根据返回结果刷新菜单和更新 UI。

适用场景

当用户在应用中打开美型风格和风格强度菜单时，可以调用该方法获取当前的美型选项，然后根据结果刷新用户界面中的菜单，并更新 UI。

调用时机

在调用 enableVideo 之后调用此方法。

参数

sourceType

媒体源类型，详见 MediaSourceType。

信息

该参数仅支持以下两种设置：

• 如果使用摄像头采集本地视频，使用默认值 PRIMARY_CAMERA_SOURCE。
• 如果使用自定义视频源，设置为 CUSTOM_VIDEO_SOURCE。

返回值

方法调用成功，返回 FaceShapeBeautyOptions 实例。 方法调用失败，返回 null。

所属接口类

• RtcEngine

getFaceShapeBeautyOptions [2/2]

获取当前的美颜特效设置。

Java

public abstract FaceShapeBeautyOptions getFaceShapeBeautyOptions();

适用场景

当你在应用中打开风格妆容和风格强度菜单时，可以调用该方法获取当前的美颜特效设置，然后根据结果刷新菜单并更新 UI。

调用时机

在调用 enableVideo 之后调用此方法。

返回值

• 方法调用成功，返回 FaceShapeBeautyOptions 实例。
• 方法调用失败，返回 null。

所属接口类

• RtcEngine

getOptions

获取当前配置的水印显示选项。

Java

public WatermarkOptions getOptions()

自从

自 v4.6.0 版本新增。

返回值

方法调用成功，返回 WatermarkOptions 对象。

所属接口类

• WatermarkConfig

getVideoEffectBoolParam

获取视频特效中的布尔类型参数。

Java

boolean getVideoEffectBoolParam(String option, String key);

自从

自 v4.6.0 版本新增。

参数

option

参数类别的标识符。

key

参数的键名。

返回值

• true：参数已启用。
• false：参数未启用或不存在。

所属接口类

• IVideoEffectObject

getVideoEffectFloatParam

获取视频特效中指定参数的 float 类型值。

Java

float getVideoEffectFloatParam(String option, String key);

自从

自 v4.6.0 版本新增。

参数

option

参数类别的标识符。

key

参数的键名。

返回值

• 方法调用成功，返回当前的 float 值。
• 方法调用失败，返回 0.0f。

所属接口类

• IVideoEffectObject

getVideoEffectIntParam

获取视频特效中的整数类型参数。

Java

int getVideoEffectIntParam(String option, String key);

自从

自 v4.6.0 版本新增。

参数

option

参数类别的标识符。

key

参数的键名。

返回值

• 方法调用成功，返回当前参数值。
• 方法调用失败，返回 0。

所属接口类

• IVideoEffectObject

performVideoEffectAction

对指定的视频特效节点执行操作。

Java

int performVideoEffectAction(int nodeId, VIDEO_EFFECT_ACTION actionId);

自从

自 v4.6.0 版本新增。

参数

nodeId

视频特效节点的唯一标识符。

actionId

要在视频特效节点上执行的操作，详见 VIDEO_EFFECT_ACTION。

返回值

• 0：方法调用成功。
• < 0：方法调用失败。详见错误码了解详情和解决建议。

所属接口类

• IVideoEffectObject

removeVideoEffect

移除指定节点 ID 的视频特效节点。

Java

int removeVideoEffect(int nodeId);

自从

自 v4.6.0 版本新增。

参数

nodeId

要移除的视频特效节点的唯一标识符。

返回值

• 0：方法调用成功。
• < 0：方法调用失败。详见错误码了解详情和解决建议。

所属接口类

• IVideoEffectObject

setBeautyEffectOptions [1/2]

设置图像增强功能及其参数。

Java

public abstract int setBeautyEffectOptions(boolean enabled, BeautyOptions options);

自从

自 v2.4.0 版本新增。

信息

• 此方法仅适用于 Android 5.0 或更高版本。
• 此方法依赖图像增强动态库 libagora_clear_vision_extension.so。如果该动态库被删除，则无法正常启用该功能。
• 此功能对设备性能要求较高。调用此方法时，SDK 会自动检测当前设备的能力。

调用时机

在调用 enableVideo 或 startPreview 之后调用此方法。

参数

enabled

是否启用图像增强功能：

• true：启用图像增强功能。
• false：（默认）禁用图像增强功能。

options

图像增强参数。详见 BeautyOptions。

返回值

• 0：方法调用成功。
• < 0：方法调用失败。详见错误码了解详情和解决建议。
  • -4：当前设备不支持该功能。可能的原因包括：
    • 当前设备能力不满足图像增强的要求。声网建议更换为高性能设备。
    • 当前设备版本低于 Android 5.0，不支持该功能。声网建议更换设备或升级操作系统。

所属接口类

• RtcEngine

setBeautyEffectOptions [2/2]

设置美颜特效选项并指定媒体源。

Java

public abstract int setBeautyEffectOptions(boolean enabled, BeautyOptions options, Constants.MediaSourceType sourceType);

自从

自 v2.4.0 版本新增。

该方法用于启用或禁用图像增强功能，并设置相关选项。与 setBeautyEffectOptions [1/2] 方法类似，但该方法允许你指定应用图像增强的媒体源类型。

调用时机

在调用 enableVideo 或 startPreview 之后调用该方法。

参数

enabled

是否启用图像增强功能：

• true：启用图像增强功能。
• false：（默认）禁用图像增强功能。

options

图像增强选项。详见 BeautyOptions。

sourceType

应用图像增强效果的媒体源类型。详见 MediaSourceType。

信息

该参数仅支持以下两种设置：

• 默认值为 PRIMARY_CAMERA_SOURCE。
• 如果使用自定义视频源，请将该参数设置为 CUSTOM_VIDEO_SOURCE。

返回值

• 0：方法调用成功。
• < 0：方法调用失败。详见错误码了解详情和解决建议。
  • -4：当前设备不支持该功能。可能原因包括：
    • 当前设备的性能不满足图像增强的要求，建议更换为高性能设备。
    • 当前设备的系统版本低于 Android 5.0，不支持该功能，建议更换设备或升级操作系统。

所属接口类

• RtcEngine

setColorEnhanceOptions [1/2]

设置色彩增强功能。

Java

public abstract int setColorEnhanceOptions(boolean enabled, ColorEnhanceOptions options);

自从

自 v3.6.2 版本新增。

摄像头采集的视频图像可能存在色彩失真。该功能可智能调整视频的饱和度和对比度等参数，从而提升视频的色彩丰富度和还原度，使画面更加生动。

信息

• 请在调用 enableVideo 方法之后调用此方法。
• 色彩增强功能对设备性能有一定要求。开启该功能后，如果设备出现严重发热问题，声网建议你降低色彩增强等级以减少性能消耗，或关闭该功能。
• 此方法依赖图像增强动态库 libagora_clear_vision_extension.so。如果该动态库被删除，将无法正常启用该功能。

参数

enabled

是否启用色彩增强功能：

• true：启用色彩增强。
• false：（默认）关闭色彩增强。

options

色彩增强选项。详见 ColorEnhanceOptions。

返回值

• 0：方法调用成功。
• < 0：方法调用失败。详见错误码了解详情和解决建议。

所属接口类

• RtcEngine

setColorEnhanceOptions [2/2]

设置色彩增强选项并指定媒体源。

Java

public abstract int setColorEnhanceOptions(boolean enabled, ColorEnhanceOptions options, Constants.MediaSourceType sourceType);

自从

自 v3.6.2 版本新增。

摄像头采集的视频图像可能存在色彩失真。色彩增强功能可智能调整视频的饱和度和对比度等参数，从而提升视频的色彩丰富度和还原度，使画面更加生动。该方法与 setColorEnhanceOptions [1/2] 功能相同，但允许你指定应用色彩增强的媒体源类型。

信息

• 请在调用 enableVideo 后调用此方法。
• 色彩增强功能对设备性能有一定要求。开启该功能后，如设备出现严重发热，声网建议你降低色彩增强等级以减少性能消耗，或关闭该功能。
• 此方法依赖图像增强动态库 libagora_clear_vision_extension.so。若该动态库被删除，则无法正常启用该功能。

参数

enabled

是否启用色彩增强：

• true：启用色彩增强。
• false：（默认）关闭色彩增强。

options

色彩增强选项。详见 ColorEnhanceOptions。

sourceType

应用滤镜效果的媒体源类型。详见 MediaSourceType。

信息

该参数仅支持以下两种设置：

• 默认值为 PRIMARY_CAMERA_SOURCE。
• 如果使用自定义视频源，请将该参数设置为 CUSTOM_VIDEO_SOURCE。

返回值

• 0：方法调用成功。
• < 0：方法调用失败。详见错误码了解详情和解决建议。

所属接口类

• RtcEngine

setFaceShapeAreaOptions [1/2]

设置面部区域的图像增强选项并指定媒体源。

Java

public abstract int setFaceShapeAreaOptions(FaceShapeAreaOptions options, Constants.MediaSourceType sourceType);

如果通过 setFaceShapeBeautyOptions 方法实现的预设美颜特效无法满足预期，你可以使用此方法设置美颜区域选项，单独微调面部的每个部分，从而实现更精细的美颜效果。该方法与 setFaceShapeAreaOptions [2/2] 类似，区别在于该方法支持指定应用美颜特效的媒体源。

信息

• 此方法仅适用于 Android 4.4 或更高版本。
• 此方法依赖图像增强动态库 libagora_clear_vision_extension.so。如果该动态库被删除，则无法正常启用该功能。
• 此功能对设备性能要求较高。调用此方法时，SDK 会自动检测当前设备的能力。

调用时机

在调用 setFaceShapeBeautyOptions 后调用此方法。

参数

options

面部增强区域，详见 FaceShapeAreaOptions。

sourceType

应用滤镜特效的媒体源类型，详见 MediaSourceType。

信息

在此方法中，该参数仅支持以下两种设置：

• 如果使用摄像头采集本地视频，使用默认值 PRIMARY_CAMERA_SOURCE。
• 如果使用自定义视频源，将该参数设置为 CUSTOM_VIDEO_SOURCE。

返回值

• 0：方法调用成功。
• < 0：方法调用失败。详见错误码了解详情和解决建议。
  • -4：当前设备不支持此功能。可能原因包括：
    • 当前设备能力不满足图像增强的要求。建议更换为高性能设备。
    • 当前设备版本低于 Android 4.4，不支持此功能。建议更换设备或升级操作系统。

所属接口类

• RtcEngine

setFaceShapeAreaOptions [2/2]

设置美颜增强的面部区域选项。

Java

public abstract int setFaceShapeAreaOptions(FaceShapeAreaOptions options);

你可以调用该方法设置面部区域选项，单独微调面部的每个部分，从而实现更精细的美颜效果。

信息

• 此方法仅适用于 Android 4.4 或更高版本。
• 此方法依赖图像增强动态库 libagora_clear_vision_extension.so。如果该动态库被删除，则无法正常启用该功能。
• 此功能对设备性能要求较高。调用此方法时，SDK 会自动检测当前设备的能力。

调用时机

请在调用 setFaceShapeBeautyOptions 方法之后调用此方法。

参数

options

面部增强区域选项，详见 FaceShapeAreaOptions。

返回值

• 0：方法调用成功。
• < 0：方法调用失败。详见错误码了解详情和解决建议。
  • -4：当前设备不支持此功能。可能原因包括：
    • 当前设备的能力不满足图像增强的要求，建议你更换为高性能设备。
    • 当前设备版本低于 Android 4.4，不支持此功能，建议你更换设备或升级操作系统。

所属接口类

• RtcEngine

setFaceShapeBeautyOptions [1/2]

设置美型效果并指定应用的媒体源。

Java

public abstract int setFaceShapeBeautyOptions(boolean enabled, FaceShapeBeautyOptions options, Constants.MediaSourceType sourceType);

该方法可通过预设参数一次性调整面部多个部位，实现瘦脸、放大眼睛、瘦鼻等轻度美型效果，并支持整体调节美型强度。该方法与 setFaceShapeBeautyOptions [2/2] 功能类似，区别在于该方法支持指定应用美型特效的媒体源。

信息

• 此方法仅适用于 Android 4.4 或更高版本。
• 此方法依赖图像增强动态库 libagora_clear_vision_extension.so。若该动态库被删除，则无法正常启用该功能。
• 此功能对设备性能要求较高。调用此方法时，SDK 会自动检测当前设备的能力。

调用时机

在调用 enableVideo 后调用此方法。

参数

enabled

是否启用美型特效：

• true：启用美型特效。
• false：（默认）关闭美型特效。

options

美型风格选项，详见 FaceShapeBeautyOptions。

sourceType

应用美型特效的媒体源类型，详见 MediaSourceType。

信息

该参数仅支持以下两种设置：

• 使用摄像头采集本地视频时，使用默认值 PRIMARY_CAMERA_SOURCE。
• 使用自定义视频源时，设置为 CUSTOM_VIDEO_SOURCE。

返回值

• 0：方法调用成功。
• < 0：方法调用失败。详见错误码了解详情和解决建议。
  • -4：当前设备不支持该功能。可能原因包括：
    • 当前设备能力不满足图像增强要求，建议更换为高性能设备。
    • 当前设备系统版本低于 Android 4.4，建议更换设备或升级操作系统。

所属接口类

• RtcEngine

setFaceShapeBeautyOptions [2/2]

设置美型选项。

Java

public abstract int setFaceShapeBeautyOptions(boolean enabled, FaceShapeBeautyOptions options);

信息

• 此方法仅适用于 Android 4.4 或更高版本。
• 此方法依赖图像增强动态库 libagora_clear_vision_extension.so。如果该动态库被删除，则无法正常启用该功能。
• 此功能对设备性能要求较高。调用此方法时，SDK 会自动检测当前设备的能力。

调用时机

在调用 enableVideo 方法之后调用此方法。

参数

enabled

是否启用美型效果：

• true：启用美型效果。
• false：（默认）关闭美型效果。

options

美型风格选项，详见 FaceShapeBeautyOptions。

返回值

• 0：方法调用成功。
• < 0：方法调用失败。详见错误码了解详情和解决建议。
  • -4：当前设备不支持该功能。可能的原因包括：
    • 当前设备的能力不满足图像增强的要求。建议更换为高性能设备。
    • 当前设备版本低于 Android 4.4，不支持该功能。建议更换设备或升级操作系统。

所属接口类

• RtcEngine

setFilterEffectOptions [1/2]

设置滤镜特效参数并指定媒体源。

Java

public abstract int setFilterEffectOptions(boolean enabled, FilterEffectOptions options, Constants.MediaSourceType sourceType);

自从

自 v4.4.1 版本新增。

该方法允许你设置滤镜特效参数，并指定滤镜特效应用的媒体源。

信息

• 该方法仅适用于 Android 5.0 或更高版本。
• 该方法依赖图像增强动态库 libagora_clear_vision_extension.so。如果该动态库被删除，该功能将无法正常启用。
• 该功能对设备性能要求较高。调用该方法时，SDK 会自动检测当前设备的能力。

调用时机

在调用 enableVideo 之后调用该方法。

参数

enabled

是否启用滤镜特效：

• true：启用。
• false：（默认）不启用。

options

滤镜特效参数。详见 FilterEffectOptions。

sourceType

滤镜特效应用的媒体源类型。详见 MediaSourceType。

信息

该参数仅支持以下两种设置：

• 如果使用摄像头采集本地视频，使用默认值 PRIMARY_CAMERA_SOURCE。
• 如果使用自定义视频源，设置为 CUSTOM_VIDEO_SOURCE。

返回值

• 0：方法调用成功。
• < 0：方法调用失败。详见错误码了解详情和解决建议。

所属接口类

• RtcEngine

setFilterEffectOptions [2/2]

设置滤镜特效选项。

Java

public abstract int setFilterEffectOptions(boolean enabled, FilterEffectOptions options);

自从

自 v4.4.1 版本新增。

信息

该方法仅适用于 Android 5.0 或更高版本。该方法依赖图像增强动态库 libagora_clear_vision_extension.so。如果该动态库被删除，则无法正常启用该功能。该功能对设备性能要求较高。调用该方法时，SDK 会自动检测当前设备的能力。

调用时机

在调用 enableVideo 方法之后调用该方法。

参数

enabled

是否启用滤镜特效：

• true：启用。
• false：（默认）不启用。

options

滤镜特效选项。详见 FilterEffectOptions。

返回值

• 0：方法调用成功。
• < 0：方法调用失败。详见错误码了解详情和解决建议。

所属接口类

• RtcEngine

setLowlightEnhanceOptions [1/2]

设置暗光增强功能。

Java

public abstract int setLowlightEnhanceOptions(boolean enabled, LowLightEnhanceOptions options);

自从

自 v3.6.2 版本新增。

信息

• 该方法依赖图像增强动态库 libagora_clear_vision_extension.so。如果该动态库被删除，将无法正常启用该功能。
• 暗光增强功能对设备性能有一定要求。如果启用后设备出现过热，声网建议将暗光增强选项设置为较低的性能消耗等级，或关闭该功能。
• 如果你希望在使用暗光增强功能时优先保证画质（LOW_LIGHT_ENHANCE_LEVEL_HIGH_QUALITY），需要先调用 setVideoDenoiserOptions 实现视频降噪，具体对应关系如下：
  • 当暗光增强设置为自动模式（LOW_LIGHT_ENHANCE_AUTO）时，视频降噪需设置为优先保证画质（VIDEO_DENOISER_LEVEL_HIGH_QUALITY）和自动模式（VIDEO_DENOISER_AUTO）。
  • 当暗光增强设置为手动模式（LOW_LIGHT_ENHANCE_MANUAL）时，视频降噪需设置为优先保证画质（VIDEO_DENOISER_LEVEL_HIGH_QUALITY）和手动模式（VIDEO_DENOISER_MANUAL）。

适用场景

暗光增强功能可自适应调整在背光、多云或黑暗等低光或光线不均的场景中采集的视频亮度值，恢复或突出图像细节，提升视频整体视觉效果。

调用时机

请在调用 enableVideo 后调用此方法。

参数

enabled

是否启用暗光增强功能：

• true：启用暗光增强。
• false：（默认）关闭暗光增强。

options

暗光增强选项。详见 LowLightEnhanceOptions。

返回值

• 0：方法调用成功。
• < 0：方法调用失败。详见错误码了解详情和解决建议。

所属接口类

• RtcEngine

setLowlightEnhanceOptions [2/2]

设置低光增强选项并指定媒体源。

Java

public abstract int setLowlightEnhanceOptions(boolean enabled, LowLightEnhanceOptions options, Constants.MediaSourceType sourceType);

自从

自 v3.6.2 版本新增。

该方法用于设置低光增强选项，并允许你指定应用低光增强的媒体源类型。

信息

• 该方法依赖图像增强动态库 libagora_clear_vision_extension.so。如果该动态库被删除，则无法正常启用该功能。
• 视频降噪对设备性能有一定要求。如果你在启用视频降噪后设备出现过热，声网建议你将视频降噪选项设置为较低的性能消耗等级，或完全关闭视频降噪。

适用场景

在黑暗环境中或使用低端视频采集设备时，视频图像可能会出现明显噪点，影响视频质量。在实时互动场景中，视频噪点还会占用码流资源，降低编码效率。

调用时机

请在调用 enableVideo 方法之后调用该方法。

参数

enabled

是否启用低光增强：

• true：启用低光增强。
• false：（默认）关闭低光增强。

options

低光增强选项。详见 LowLightEnhanceOptions。

sourceType

应用滤镜效果的媒体源类型。详见 MediaSourceType。

信息

该参数仅支持以下两种设置：

• 默认值为 PRIMARY_CAMERA_SOURCE。
• 如果你使用自定义视频源，请将该参数设置为 CUSTOM_VIDEO_SOURCE。

返回值

• 0：方法调用成功。
• < 0：方法调用失败。详见错误码了解详情和解决建议。

所属接口类

• RtcEngine

setVideoDenoiserOptions [1/2]

设置视频降噪功能及其选项。

Java

public abstract int setVideoDenoiserOptions(boolean enabled, VideoDenoiserOptions options);

自从

自 v3.6.2 版本新增。

你可以调用该方法设置视频降噪效果的相关选项。

信息

• 此方法依赖图像增强动态库 libagora_clear_vision_extension.so。如果该动态库被删除，将无法正常启用该功能。
• 视频降噪对设备性能有一定要求。如果启用后设备出现过热，声网建议你将降噪选项调整为较低性能消耗的等级，或关闭视频降噪功能。
• 如果该方法实现的降噪效果无法满足你的需求，声网建议你调用 setBeautyEffectOptions 方法启用美颜和磨皮功能，以获得更好的降噪效果。推荐用于强降噪效果的 BeautyOptions 设置如下：
  • lighteningContrastLevel: LIGHTENING_CONTRAST_NORMAL
  • lighteningLevel: 0.0
  • smoothnessLevel: 0.5
  • rednessLevel: 0.0
  • sharpnessLevel: 0.1

适用场景

在光线较暗的环境中或使用低端视频采集设备时，视频图像可能会出现明显噪点，影响视频质量。在实时互动场景中，视频噪点还会占用码流资源，降低编码效率。该方法适用于多频道场景。

调用时机

调用 enableVideo 方法后调用此方法。

参数

enabled

是否启用视频降噪功能：

• true：启用视频降噪。
• false：（默认）关闭视频降噪。

options

视频降噪选项。详见 VideoDenoiserOptions。

返回值

• 0：方法调用成功。
• < 0：方法调用失败。详见错误码了解详情和解决建议。

所属接口类

• RtcEngine

setVideoDenoiserOptions [2/2]

设置视频降噪并指定媒体源。

Java

public abstract int setVideoDenoiserOptions(boolean enabled, VideoDenoiserOptions options, Constants.MediaSourceType sourceType);

自从

自 v3.6.2 版本新增。

你可以调用此方法启用视频降噪功能并设置视频降噪效果的选项。该方法与 setVideoDenoiserOptions [1/2] 类似，但支持你指定应用降噪的媒体源类型。

信息

• 此方法依赖图像增强动态库 libagora_clear_vision_extension.so。如果该动态库被删除，则无法正常启用该功能。
• 视频降噪对设备性能有一定要求。如果启用视频降噪后设备出现过热，声网建议你将视频降噪选项设置为较低的性能消耗等级，或完全关闭视频降噪功能。
• 如果该方法实现的视频降噪效果无法满足你的需求，声网建议你调用 setBeautyEffectOptions 方法启用美颜和磨皮功能，以获得更好的视频降噪效果。推荐用于强降噪效果的 BeautyOptions 设置如下：
  • lighteningContrastLevel: LIGHTENING_CONTRAST_NORMAL。
  • lighteningLevel: 0.0。
  • smoothnessLevel: 0.5。
  • rednessLevel: 0.0。
  • sharpnessLevel: 0.1。

适用场景

在光线较暗的环境中或使用低端视频采集设备时，视频图像可能会出现明显噪点，影响视频质量。在实时互动场景中，视频噪点还会占用码流资源，降低编码效率。

调用时机

请在调用 enableVideo 方法之后调用此方法。

参数

enabled

是否启用视频降噪功能：

• true：启用视频降噪。
• false：（默认）关闭视频降噪。

options

视频降噪选项，详见 VideoDenoiserOptions。

sourceType

应用滤镜效果的媒体源类型，详见 MediaSourceType。

信息

在此方法中，该参数仅支持以下两种设置：

• 默认值为 PRIMARY_CAMERA_SOURCE。
• 如果你使用自定义视频源，请将该参数设置为 CUSTOM_VIDEO_SOURCE。

返回值

• 0：方法调用成功。
• < 0：方法调用失败。详见错误码了解详情和解决建议。

所属接口类

• RtcEngine

setVideoEffectBoolParam

设置视频特效的布尔参数。

Java

int setVideoEffectBoolParam(String option, String key, boolean value);

自从

自 v4.6.0 版本新增。

参数

option

参数类别的标识符。

key

参数的键名。

value

要设置的布尔值：

• true：设置为启用。
• false：设置为禁用。

返回值

• 0：方法调用成功。
• < 0：方法调用失败。详见错误码了解详情和解决建议。

所属接口类

• IVideoEffectObject

setVideoEffectFloatParam

设置视频特效的浮点参数。

Java

int setVideoEffectFloatParam(String option, String key, float value);

自从

自 v4.6.0 版本新增。

参数

option

参数类别标识符。

key

参数键名。

value

要设置的浮点型参数值。

返回值

• 0：方法调用成功。
• < 0：方法调用失败。详见错误码了解详情和解决建议。

所属接口类

• IVideoEffectObject

setVideoEffectIntParam

设置视频特效的整数参数。

Java

int setVideoEffectIntParam(String option, String key, int value);

自从

自 v4.6.0 版本新增。

参数

option

参数类别的标识符。

key

参数的键名。

value

要设置的整数值。

返回值

• 0：方法调用成功。
• < 0：方法调用失败。详见错误码了解详情和解决建议。

所属接口类

• IVideoEffectObject