火山引擎智能美化特效插件接口说明

API 参考（Android）

addExtension

添加插件。

public void addExtension(String providerName) {
    mExtensionList.add(providerName);
}

该方法是 RtcEngineConfig 类的成员函数。

参数

参数名	参数描述
providerName	插件的 so 或 aar 文件名

enableExtension

启用/禁用插件。

public abstract int enableExtension(String provider, String extension, boolean enable);

参数

参数名	参数描述	你需要传入的值
provider	提供插件的服务商名称	ByteDance
extension	插件的名称	Effect
enable	是否启用插件	true: 启用插件。 false: 禁用插件。

返回值

• 0: 方法调用成功
• < 0: 方法调用失败

setExtensionProperty

设置插件的属性。需要在启用插件后调用。

public abstract int setExtensionProperty(String provider, String extension, String key, String value);

参数

参数名	参数描述	你需要传入的值
provider	提供插件的服务商名称	ByteDance
extension	插件的名称	Effect
key	插件属性的 Key	详见 key-value 列表
value	插件属性 Key 对应的值	详见 key-value 列表

返回值

• 0: 方法调用成功
• < 0: 方法调用失败

API 参考（iOS）

enableExtensionWithVendor

启用/禁用插件。

- (int)enableExtensionWithVendor:(NSString * __nonnull)provider extension:(NSString * __nonnull)extension enabled:(BOOL)enabled;

参数

参数名	参数描述	你需要传入的值
provider	提供插件的服务商名称	ByteDance
extension	插件的名称	Effect
enabled	是否启用插件	YES: 启用插件。 NO: 禁用插件。

返回值

• 0: 方法调用成功
• < 0: 方法调用失败

setExtensionPropertyWithVendor

设置插件的属性。需要在启用插件后调用。

- (int)setExtensionPropertyWithVendor:(NSString * __nonnull)provider extension:(NSString * __nonnull)extension key:(NSString * __nonnull)key value:(NSString * __nonnull)value;

参数

参数名	参数描述	你需要传入的值
provider	提供插件的服务商名称	ByteDance
extension	插件的名称	Effect
key	插件属性的 Key	详见 key-value 列表
value	插件属性 Key 对应的值	详见 key-value 列表

返回值

• 0: 方法调用成功
• < 0: 方法调用失败

key-value 列表

调用 setExtensionProperty 或 setExtensionPropertyWithVendor 方法传入对应的 key 和 value，可以使用火山引擎智能美化特效插件的如下功能：

授权

• key：bef_effect_ai_check_license
• value：licensePath，String 型，授权文件的路径。

更多信息请参考特效句柄授权。

初始化

• key：bef_effect_ai_init
• value：包含以下参数
  • strModelDir：String 型，资源文件目录路径。
  • deviceName：String 型，设备名。一般输入空字符串（""）即可。

更多信息请参考初始化特效句柄。

设置叠加特效是否与贴纸共存

• key：bef_effect_ai_composer_set_mode
• value：包含以下参数
  • mode：int 型，模式，0 表示 composer 与贴纸不可共存，1 表示二者可以共存。
  • orderType：int 型，特效与贴纸渲染顺序，必须传 0。

更多信息请参考设置叠加特效是否与贴纸共存。

设置手机角度

• key：bef_effect_ai_set_orientation
• value：orientation，bef_ai_rotate_type 类型，代表旋转角度。可以设为 0（不旋转）、1（顺时针旋转 90 度）、2（顺时针旋转 180 度）、3（顺时针旋转 270 度）。

更多信息请参考设置手机角度。

设置叠加特效（美颜、美形、美妆）

• key：bef_effect_ai_composer_set_nodes
• value：nodePaths，特效资源路径的数组。

更多信息请参考设置叠加特效（美颜、美形、美妆）。

设置特效强度（美颜、美形、美妆）

• key：bef_effect_ai_composer_update_node
• value：包含以下参数
  • nodePath：String 型，特效资源的路径。
  • nodeTag：String 型，特效的 key，详见素材 key 对应说明。
  • value：float 型，设置组合特效的单个节点的强度。

更多信息请参考设置特效强度（美颜、美形、美妆）。

设置贴纸

• key：bef_effect_ai_set_effect
• value：strPath，String 型，特效资源路径。

更多信息请参考设置贴纸。

设置滤镜

• key：bef_effect_ai_set_color_filter_v2
• value：strPath，String 型，特效资源路径。

更多信息请参考设置滤镜。

设置滤镜强度

• key：bef_effect_ai_set_intensity
• value：fIntensity，float 型，取值范围 [0.0, 1.0] 。设为 0 代表不工作。

更多信息请参考设置强度。