# 商汤高级美颜/特效键值说明 (/zh-CN/realtime-media/marketplace/reference/sensetime-ar-api)

> For AI agents: see the complete documentation index at [llms.txt](/llms.txt).

<_PlatformTabsGroup>
<_PlatformProcessedMarker groupMode="structured" canonicalPlatform="android" platform="android" />
在声网 SDK 提供的插件相关方法和回调中，`key` 和 `value` 参数取决于你使用的插件。本页提供商汤高级美颜/特效系列插件支持的 `key` 和 `value` 说明。

<a id="key-value"></a>
## 方法 key 的 value [#方法-key-的-value]

 :::warning[注意]
 本节提供的参数解释仅供参考，更准确详尽的解释请查看商汤 SenseAR Effects SDK 的文档（包含在商汤美颜插件的资源包内）。
 :::

调用 `setExtensionProperty` 方法时传入对应的 `key` 和 `value`，可以使用商汤高级美颜/特效系列插件的如下功能：

### 检查激活码 [#检查激活码]

- `key` ：`st_mobile_check_activecode`
- `value` ：`license_path`，String 型，本地 License 文件的路径。

### 创建人体行为检测句柄 [#创建人体行为检测句柄]

- `key` ：`st_mobile_human_action_create`
- `value` ：包含以下参数
  - `model_path`：String 型，模型文件的路径，例如 `models/action.model`。
  - `config`：Int 型，配置选项。检测视频设为 `ST_MOBILE_HUMAN_ACTION_DEFAULT_CONFIG_VIDEO`，检测图片设为 `ST_MOBILE_HUMAN_ACTION_DEFAULT_CONFIG_IMAGE`。

### 创建特效句柄 [#创建特效句柄]

- `key` ：`st_mobile_effect_create_handle`
- `value` ：无，设为 `{}` 即可。

### 设置美颜的强度 [#设置美颜的强度]

- `key` ：`st_mobile_effect_set_beauty_strength`
- `value` ：包含以下参数：

	- `param`：Int 型，美颜类型。可在[集成插件](/zh-CN/realtime-media/marketplace/build/integrate-extensions/sensetime-ar#1-集成-sdk-和插件)后引用 `STEffectBeautyType` 类。

	- `val`：Double 型，美颜强度。

### 加载美颜素材 [#加载美颜素材]

目前对美颜支持设置美白、红润两种自定义的素材。

- `key` ：`st_mobile_effect_set_beauty`
- `value` ：包含以下参数

	- `param`：Int 型，美颜类型。可在[集成插件](/zh-CN/realtime-media/marketplace/build/integrate-extensions/sensetime-ar#1-集成-sdk-和插件)后引用 `STEffectBeautyType` 类。

	- `path`：String 型，待添加的素材文件路径。将 `path` 参数设置为 `nullptr`，可以清空之前类型设置的对应素材（如美颜、美妆、滤镜素材）。

## 回调 key 的 value [#回调-key-的-value]

该插件暂时没有回调 `key`。
<_PlatformProcessedMarker close="true" />

<_PlatformProcessedMarker groupMode="structured" canonicalPlatform="android" platform="ios" />
在声网 SDK 提供的插件相关方法和回调中，`key` 和 `value` 参数取决于你使用的插件。本页提供商汤高级美颜/特效系列插件支持的 `key` 和 `value` 说明。

<a id="key-value"></a>
## 方法 key 的 value [#方法-key-的-value-1]

 :::warning[注意]
 本节提供的参数解释仅供参考，更准确详尽的解释请查看商汤 SenseAR Effects SDK 的文档（包含在商汤美颜插件的资源包内）。
 :::

调用 `setExtensionPropertyWithVendor` 方法时传入对应的 `key` 和 `value`，可以使用商汤高级美颜/特效系列插件的如下功能：

### 检查激活码 [#检查激活码-1]

- `key` ：`st_mobile_check_activecode`
- `value` ：`license_path`，String 型，本地 License 文件的路径。

### 创建人体行为检测句柄 [#创建人体行为检测句柄-1]

- `key` ：`st_mobile_human_action_create`
- `value` ：包含以下参数
  - `model_path`：String 型，模型文件的路径，例如 `models/action.model`。
  - `config`：Int 型，配置选项。检测视频设为 `ST_MOBILE_HUMAN_ACTION_DEFAULT_CONFIG_VIDEO`，检测图片设为 `ST_MOBILE_HUMAN_ACTION_DEFAULT_CONFIG_IMAGE`。

### 创建特效句柄 [#创建特效句柄-1]

- `key` ：`st_mobile_effect_create_handle`
- `value` ：无，设为 `{}` 即可。

### 设置美颜的强度 [#设置美颜的强度-1]

- `key` ：`st_mobile_effect_set_beauty_strength`
- `value` ：包含以下参数：

	- `param`：Int 型，美颜类型。详见 `st_effect_beauty_type_t` 枚举（在 iOS 资源包的 `include/st_mobile_effect.h` 文件中）。

	- `val`：Double 型，美颜强度。

### 加载美颜素材 [#加载美颜素材-1]

目前对美颜支持设置美白、红润两种自定义的素材。

- `key` ：`st_mobile_effect_set_beauty`
- `value` ：包含以下参数

	- `param`：Int 型，美颜类型。详见 `st_effect_beauty_type_t` 枚举（在 iOS 资源包的 `include/st_mobile_effect.h` 文件中）。

	- `path`：String 型，待添加的素材文件路径。将 `path` 参数设置为 `nullptr`，可以清空之前类型设置的对应素材（如美颜、美妆、滤镜素材）。

## 回调 key 的 value [#回调-key-的-value-1]

该插件暂时没有回调 `key`。
<_PlatformProcessedMarker close="true" />
</_PlatformTabsGroup>
