BaseBeautyStore 是 AtomicXCore 中负责管理人像基础美颜效果的模块。通过它,您可以轻松为您的直播或通话应用添加自然的美颜效果。核心功能
磨皮效果调节:设置磨皮强度 (0-9)。
美白效果调节:设置美白强度 (0-9)。
红润效果调节:设置红润强度 (0-9)。
效果重置:一键恢复所有美颜参数至默认值。
状态监听:实时获取当前生效的美颜参数。
核心概念
在开始集成之前,我们先通过下表了解一下 BaseBeautyStore 相关的核心概念:
核心概念 | 类型 | 核心职责与描述 |
BaseBeautyState | data class | 代表基础美颜模块的当前状态。包含了当前生效的磨皮 ( smoothLevel)、美白 (whitenessLevel) 和红润 (ruddyLevel) 的强度值。 |
BaseBeautyStore | abstract class | 这是与基础美颜功能交互的核心管理类。它是一个全局单例 ( shared),负责所有基础美颜参数的设置、重置和状态同步。 |
实现步骤
步骤1:组件集成
步骤2:获取实例并监听状态
获取
BaseBeautyStore 的全局单例,并设置订阅者以实时获取当前的美颜参数状态。实现方式:
1. 获取单例: 直接使用
BaseBeautyStore.shared() 获取全局唯一的 BaseBeautyStore 实例。2. 订阅状态: 订阅
baseBeautyStore.baseBeautyState 以实时获取 BaseBeautyState 的更新。代码示例:
import io.trtc.tuikit.atomicxcore.api.device.BaseBeautyStateimport io.trtc.tuikit.atomicxcore.api.device.BaseBeautyStoreimport kotlinx.coroutines.CoroutineScopeimport kotlinx.coroutines.Dispatchersimport kotlinx.coroutines.launchimport kotlinx.coroutines.flow.MutableStateFlowclass BeautyManager() {// 1. 获取单例private val baseBeautyStore = BaseBeautyStore.shared()private val coroutineScope = CoroutineScope(Dispatchers.Main)private val _smoothLevel = MutableStateFlow(0f)private val _whitenessLevel = MutableStateFlow(0f)private val _ruddyLevel = MutableStateFlow(0f)// 对外暴露美颜状态val baseBeautyState = BaseBeautyState(smoothLevel = _smoothLevel,whitenessLevel = _whitenessLevel,ruddyLevel = _ruddyLevel)init {// 2. 订阅状态subscribeToBeautyState()}private fun subscribeToBeautyState() {coroutineScope.launch(Dispatchers.Main) {baseBeautyStore.baseBeautyState.smoothLevel.collect { smoothLevel ->_smoothLevel.value = smoothLevel}}coroutineScope.launch(Dispatchers.Main) {baseBeautyStore.baseBeautyState.whitenessLevel.collect { whitenessLevel ->_whitenessLevel.value = whitenessLevel}}coroutineScope.launch(Dispatchers.Main) {baseBeautyStore.baseBeautyState.ruddyLevel.collect { ruddyLevel ->_ruddyLevel.value = ruddyLevel}}}// ... 后续方法}
步骤3:设置美颜参数
当用户拖动美颜滑块或点击预设按钮时,调用相应的接口设置美颜强度。
实现方式:
1. 获取强度值:从 UI 控件(例如
SeekBar)获取用户设定的强度值。请注意,SDK 接口接收的参数范围是 [0, 9],其中 0 表示关闭效果,9 表示效果最明显。您需要将 UI 控件的值(例如 SeekBar 的 0 - 100)映射到 0 - 9 的范围。2. 调用接口:分别调用
setSmoothLevel(smoothLevel:)、setWhitenessLevel(whitenessLevel:)、setRuddyLevel(ruddyLevel:) 来设置磨皮、美白、红润的强度。代码示例:
class BeautyManager() {private val baseBeautyStore = BaseBeautyStore.shared()/// 设置磨皮等级 (输入范围 0 ~ 100, 内部转换为 0 ~ 9)fun updateSmoothLevel(uiLevel: Int) {// 将 UI 的 0 ~ 100 映射到 SDK 的 0 ~ 9val sdkLevel = (uiLevel / 100.0f * 9.0f)baseBeautyStore.setSmoothLevel(sdkLevel)println("设置磨皮等级: UI=$uiLevel, SDK=$sdkLevel")}/// 设置美白等级 (输入范围 0 ~ 100, 内部转换为 0 ~ 9)fun updateWhitenessLevel(uiLevel: Int) {val sdkLevel = (uiLevel / 100.0f * 9.0f)baseBeautyStore.setWhitenessLevel(sdkLevel)println("设置美白等级: UI=$uiLevel, SDK=$sdkLevel")}/// 设置红润等级 (输入范围 0 ~ 100, 内部转换为 0 ~ 9)fun updateRuddyLevel(uiLevel: Int) {val sdkLevel = (uiLevel / 100.0f * 9.0f)baseBeautyStore.setRuddyLevel(sdkLevel)println("设置红润等级: UI=$uiLevel, SDK=$sdkLevel")}}
步骤4:重置美颜效果
当用户点击"重置"或"关闭美颜"按钮时,将所有美颜参数恢复到默认值(通常是0)。
实现方式
调用接口:直接调用 baseBeautyStore.reset() 方法。
代码示例
class BeautyManager() {private val baseBeautyStore = BaseBeautyStore.shared()/// 重置所有基础美颜效果fun resetBeautyEffects() {baseBeautyStore.reset()}}
功能进阶
基础美颜与高级美颜对比
AtomicXCore 也提供了高级美颜支持,以满足不同场景的需求:
对比项 | 基础美颜 (BaseBeautyStore) | 高级美颜 (TEBeautyKit 需额外集成) |
核心功能 | 磨皮、美白、红润 | 包含基础美颜,并增加 V脸、眼距、瘦鼻、3D 贴纸、滤镜、美妆等丰富效果 |
计费 | 免费 (包含在 AtomicXCore 授权内) | 付费(需要额外购买腾讯特效 SDK License) |
集成方式 | 默认内置,直接使用 BaseBeautyStore.shared() | 需要额外集成 TEBeautyKit 组件并进行鉴权 |
推荐场景 | 对美颜要求不高,需要快速实现基础美颜功能的场景 | 对美颜效果有较高要求,需要丰富的美型、贴纸、滤镜等高级功能的场景 |
集成高级美颜
API 文档
常见问题
我设置了美颜参数,为什么没有效果?
请检查以下几点:
1. 摄像头是否开启:必须先成功打开摄像头(例如通过
DeviceStore.shared().openLocalCamera),美颜效果才能应用到视频流上。2. 是否使用了高级美颜:如果您集成了
TEBeautyKit (高级美颜),请确保您使用的是 TEBeautyKit 提供的接口来调节美颜。3. 参数范围:如果您使用的是基础美颜功能,请确认您传入的强度值在有效的范围内(
0 到 9 之间的 Float 值)。