RTC 提供基础美颜插件,你可以通过此插件实现美白、磨皮、锐化等基础美颜功能。
enable 变更为 enableBeauty,关闭美颜的接口名由 disable 变更为 disableBeauty,原接口废弃。增加鉴权步骤,你需要在创建美颜插件实例时传入鉴权文件,请联系技术支持团队获取。
浏览器兼容性变动,变更后的浏览器最低版本要求如下表。
设备类型 | 浏览器 | 浏览器最低版本要求 |
|---|---|---|
桌面端 | Chrome | 78 |
Safari | 15 | |
Firefox | 80 | |
Edge | 83 | |
移动端 | Chrome | 78 |
Safari | 15.4 | |
微信内嵌浏览器 | 8.0.32 |
在你的项目中引入美颜插件:
可以直接引入。
import RTCBeautyExtension from '@volcengine/rtc/extension-beauty';
自 v4.51.1 版本起,可以通过 UMD 方式引入。
const {EffectBeautyMode, RTCBeautyExtension} = window.VERTCExtensions;
注册美颜插件。
注意
注册插件后,无法动态修改视频流帧率。你可以在注册插件前调用 setVideoEncoderConfig 修改帧率。
import VERTC from '@volcengine/rtc'; // 创建引擎实例 const engine = VERTC.createEngine('appid'); // 创建美颜插件实例,4.60.2 及之后版本需传入鉴权文件 const beautyExtension = new RTCBeautyExtension({ authFileUrl: 'xx.auth', }); // 创建美颜插件实例,4.60.1 及之前版本无需传入鉴权文件 // const beautyExtension = new RTCBeautyExtension(); // 注册美颜插件 try { await engine.registerExtension(beautyExtension); } catch (error) { // 注册失败,详细信息:error.message }
注意
基础美颜仅对主流、本地流生效,不支持屏幕流、远端流。即 StreamIndex 必须为 STREAM_INDEX_MAIN。
// 开启内部视频采集 engine.startVideoCapture(); // 设置本地视频渲染时使用的视图,并设置渲染模式。 engine.setLocalVideoPlayer(StreamIndex.STREAM_INDEX_MAIN, { renderDom: 'yourDomId' });
import { EffectBeautyMode } from '@volcengine/rtc/extension-beauty'; // 美颜参数设置-美白 beautyExtension.setBeautyIntensity(EffectBeautyMode.EFFECT_WHITE_MODE, 0.2); // 美颜参数设置-磨皮 beautyExtension.setBeautyIntensity(EffectBeautyMode.EFFECT_SMOOTH_MODE, 0.2); // 美颜参数设置-锐化 beautyExtension.setBeautyIntensity(EffectBeautyMode.EFFECT_SHARPEN_MODE, 0.2);
说明
如调用本方法前未调用 setBeautyIntensity 设置参数,则基础美颜强度使用默认值。
// 开启美颜 beautyExtension.enableBeauty();
说明
若关闭基础美颜后再次调用 enableBeauty 开启基础美颜,则保留上次的美颜强度设置。若销毁引擎,则美颜强度恢复为默认值。
// 关闭美颜 beautyExtension.disableBeauty();
类型: interface
方法 | 描述 |
|---|---|
测试当前浏览器兼容性情况。 | |
开启基础美颜。 | |
关闭基础美颜。 | |
设置基础美颜强度。 |
测试当前浏览器兼容性情况。
类型
() => Promise<CompatibilityCheckResult>
返回值
类型: Promise<CompatibilityCheckResult>
兼容性测试结果。
开启基础美颜。
类型
() => void
注意
关闭基础美颜。
() => void
设置基础美颜强度。
类型
(beautyMode: EffectBeautyMode, intensity: number) => void
注意
参数
number类型: interface
兼容性测试结果。
isCompatible
类型: boolean
是否兼容。
true:符合兼容性最低要求,可正常运行。false:不兼容,无法正常运行。
reasons
类型: number[]
不兼容的原因。
类型: enum
基础美颜模式。
成员
属性 | 值 | 描述 |
|---|---|---|
EFFECT_WHITE_MODE |
| 美白。 |
EFFECT_SMOOTH_MODE |
| 磨皮。 |
EFFECT_SHARPEN_MODE |
| 锐化。 |