腾讯特效 SDK uni-app 版本核心接口类 XmagicApi,用于更新美颜数值、调用动效等功能。
接口说明:
API | 描述 |
设置资源存放的路径,用于把美颜资源复制到此路径下,如果不设置此路径,SDK 内部会有一个默认路径 | |
初始化美颜,用于复制美颜资源 | |
美颜鉴权 | |
设置日志级别 | |
打开或关闭美颜 | |
恢复美颜 | |
暂停美颜 | |
设置美颜属性(V0.3.5.0版本新增) | |
@Deprecated | 设置美颜属性效果(此接口已废弃) |
调用此方法开启高性能模式。高性能模式开启后,美颜占用的系统 CPU/GPU 资源更少,可减少手机的发热和卡顿现象,更适合低端机长时间使用。此方法需要在 enableCustomVideoProcess 方法之前调用 | |
设置静音 | |
开启某些特性 | |
添加 AI 模型文件,将下载好的AI模型文件复制到对应的文件夹下。如果 AI 模型放在工程中,则不需要调用此接口 | |
动态加载网络下载的 so 文件,这里只需要出入存放 so 的文件夹即可,仅支持 Android | |
订阅 SDK 的回调事件 | |
取消订阅的事件 |
成员函数说明
setResPath
设置资源存放的路径,用于把美颜资源复制到此路径下,如果不设置此路径,SDK 内部会有一个默认路径。
/*** 设置存放美颜资源的路径,* @param {String} resourceDir 用于存放美颜资源的路径文件夹(绝对路径),可参考demo*/static setResPath(resourceDir)
参数
参数 | 含义 |
resourceDir | 资源文件放置的目录 |
copyXmaigcRes
用于复制美颜资源。
/*** 用于复制美颜资源* @param {Function(result)} callback result===true表示成功,false 表示失败*/static copyXmaigcRes(callback)
参数
参数 | 含义 |
callback | 由于资源复制是耗时任务,处理完成之后通过此接口回调结果 |
setLicense
进行美颜鉴权,app 启动之后,需要成功鉴权一次才能使用美颜功能。
/*** 鉴权* @param {String} licenseUrl* @param {String} licenseKey* @param {Function(code,message)} callback code===0表示成功,其他错误码请参考*/static setLicense(licenseUrl, licenseKey, callback)
参数
参数 | 含义 |
licenseUrl | 官网申请的用于美颜鉴权的 licenseUrl |
licenseKey | 官网申请的用于美颜鉴权的 licenseKey |
callback | 鉴权结果回调方法,code==0表示鉴权成功 |
setLogLevel
设置 native SDK 的日志级别。
/*** 设置日志级别* @param {number} logLevel 参见{@link LogLevel}*/static setLogLevel(logLevel)
参数 | 含义 |
logLevel | 日志级别,具体参考 SDK 中的 LogLevel |
enableCustomVideoProcess
开启或关闭美颜。
/*** 打开或关闭美颜* @param {boolean} enable* @returns*/static enableCustomVideoProcess(enable)
参数 | 含义 |
enable | 开启或关闭美颜,true 表示开启美颜,false 表示关闭美颜 |
onResume
恢复美颜处理。
static onResume()
onPause
暂停美颜处理。
static onPause()
setEffect(V0.3.5.0新增)
/** * 更新美颜对象 * @param effect 对象结构如下 * { * effectName:"",不为空的字符串,参考美颜参数表 * effectValue: 数值,一般为-100---100的值,可参考官网的美颜参数表 * resourcePath: 资源文件的路径,请参考美颜参数表 https://cloud.tencent.com/document/product/616/103616 * extraInfo:一个map集合,具体数值请参考美颜参数表 * } */ static setEffect(effect)
updateProperty(此接口已废弃)
设置美颜属性。
/*** 设置美颜属性* @param {null} property*/static updateProperty(property)
参数 | 含义 |
property |
enableEnhancedMode
/*** 开启增强模式*/static enableEnhancedMode()
setDowngradePerformance
调用此方法开启高性能模式。高性能模式开启后,美颜占用的系统 CPU/GPU 资源更少,可减少手机的发热和卡顿现象,更适合低端机长时间使用。
/*** 开启性能模式,如果要使用此方法,此方法需要在 enableCustomVideoProcess 方法之前调用*/static setDowngradePerformance()
setAudioMute
设置静音。
/*** 设置静音*/static setAudioMute(isMute)
参数 | 含义 |
isMute | true:静音 |
setFeatureEnableDisable
调用此方法开启高性能模式。高性能模式开启后,美颜占用的系统 CPU/GPU 资源更少,可减少手机的发热和卡顿现象,更适合低端机长时间使用。
/*** 开启性能模式,如果要使用此方法,此方法需要在 enableCustomVideoProcess 方法之前调用*/static setDowngradePerformance(feature)
参数 | 含义 |
feature | feature 为 object 对象,key 的值参考 SDK 中的 FeatureName 对象,value 设置为 true 开启,false 关闭 |
addAiMode
设置模型文件,入股模型文件是动态下载的,则需要在下载成功之后通过此接口将模型文件设置为 SDK,下次启动时不需要再设置。
/***设置模型文件路径、** @param {String} aiModePath 模型文件路径(绝对路径)* @param callback*/static addAiMode(aiModePath, callback)
参数 | 含义 |
aiModePath | 模型文件路径(绝对路径) |
callback | 结果回调方法 |
setLibPathAndLoad
设置网络下载的 so 文件,只支持 Android 平台。
/*** 动态加载网络下载的so文件,这里只需要出入存放so的文件夹即可* @param {String} soDir 下载好的so文件的存放目录路径*/static setLibPathAndLoad(soDir)
参数 | 含义 |
soDir | soDir 下载好的 so 文件的存放目录路径 |
on
订阅 SDK 返回的事件。
/*** 订阅回调事件** @param {String} event 事件名称* @param {Function} callback 事件名称以及回到方法可参考 {@link EventName}*/static on(event, callback)
参数 | 含义 |
event | 事件名称,可以参考 EventName 类,订阅对应的事件 |
callback | SDK 通过此方法将订阅的事件返回给 JS 侧 |
off
取消对应的事件。
/*** 取消回调事件** @param {String} event 事件名称 可参考 {@link EventName}*/static off(event)
参数 | 含义 |
event | 事件名称,可以参考 EventName 类 |