包名 com.orangefilter

类名 OrangeFilter

基础方法

---

createContext

boolean createContext(Context activity, String ofSerialNumber, int aiType, String resDir, boolean bDownloadEffectsOnline)

初始化SDK环境

参数

参数	描述
activity	Android context
ofSerialNumber	授权序列号,购买OrangeFilter时获取
aiType	AI识别类型
resDir	资源存放根路径，包括特效包，venus模型文件，缓存授权信息等，默认值为activity.getFilesDir().getPath()，建议传递null
bDownloadEffectsOnline	(1.4.7版本增加该参数) 特效包是否从服务器下载，默认值为false（特效包本地随APP打包），设置为true时SDK不会在SDK版本变更时清理effects路径缓存

返回值

成功返回true， 否则false

说明

SDK的初始化前，需要具备渲染环境

SDK环境初始化失败，需终止后续操作

SDK初始化失败原因：

1.实例创建失败

2.模型文件路径、个数或者名称存在问题

---

destroyContext

boolean destroyContext()

销毁SDK环境

返回值

成功返回true， 否则false

当返回值为false时，说明引擎销毁出错。说明当前环境不可用，环境未被初始化或者已经被销毁

---

isContextValid

boolean isContextValid()

Orange美颜SDK是否可用

返回值

成功返回true， 否则false

当返回值为false时，说明当前环境不可用，环境未被初始化或者已经被销毁。

说明

查询渲染引擎是否已经初始化。

---

enableEffect

boolean enableEffect(EffectType et, boolean bEnable)

开启或关闭某美颜特效

参数

参数	描述
et	美颜特效类型
bEnable	true开启，false关闭

返回值

成功返回true， 否则false

返回fasle，则开启失败，需要检查特效包路径是否存在问题

---

releaseEffect

boolean releaseEffect(EffectType et)

关闭并释放某美颜特效内存

参数

参数	描述
et	美颜特效类型

返回值

成功返回true， 否则false

返回false，则说明传入path的特效包并未被开启

---

enableGesture

boolean enableGesture(String path, boolean bEnable)

开启或关闭某手势特效

参数

参数	描述
path	手势特效包文件的全路径
bEnable	true开启，false关闭

返回值

成功返回true， 否则false

返回fasle，则开启失败，需要检查特效包路径是否存在问题

---

releaseGesture

boolean releaseGesture(String path)

关闭并释放某手势特效包内存

参数

参数	描述
path	手势特效包文件的全路径

返回值

成功返回true， 否则false

返回false，则说明传入path的特效包并未被开启

---

enableSticker

boolean enableSticker(String path, boolean bEnable)

开启或关闭某贴纸特效

参数

参数	描述
path	贴纸特效包文件的全路径
bEnable	true开启，false关闭

返回值

成功返回true， 否则false

返回fasle，则开启失败，需要检查特效包路径是否存在问题

---

releaseSticker

boolean releaseSticker(String path)

关闭并释放某贴纸特效包内存

参数

参数	描述
path	贴纸特效包文件的全路径

返回值

成功返回true， 否则false

返回false，则说明传入path的特效包并未被开启

---

getEffectParam

int getEffectParam(EffectParamType ep)

获取某特效参数当前值

参数

参数	描述
ep	美颜参数类型

返回值

当前参数值

---

setEffectParam

boolean setEffectParam(EffectParamType ep, int curVal)

设置某特效参数当前值

参数

参数	描述
ep	美颜参数类型
curVal	美颜参数值

返回值

成功返回true， 否则false

返回false则表示设置失败，原因可能为传入特效类型错误

---

getEffectParamDetail

boolean getEffectParamDetail(EffectParamType ep, EffectPram effectPram)

获取某特效参数范围和默认值

参数

参数	描述
ep	美颜参数类型
effectPram	[out] EffectPram实例，包含取值范围信息、默认值、当前值

返回值

成功返回true， 否则false

返回false则表示获取失败，原因可能为传入特效类型错误

---

updateFrameParams

boolean updateFrameParams(GLTexture textureIn, GLTexture textureOut, ImageInfo image)

帧渲染特效回调函数

参数

参数	描述
textureIn	输入纹理信息的封装实例
textureOut	输出纹理信息的封装实例
image	识别图像信息的封装实例

返回值

成功返回true， 否则false

返回false，则数据帧渲染失败，原因可能为没有特效被开启使用

---

checkStickerResult

boolean checkStickerResult(String[] stickerPaths, int[] stickerResults)

查询贴纸的返回结果

参数

参数	描述
stickerPaths	需要查询结果的贴纸特效全路径
stickerResults	[out] 返回对应的贴纸特效的执行结果，通常用于关注贴纸动画的状态是否结束，如果返回7（OF_Result_AnimationStoped）表示动画结束

返回值

成功返回true， 否则false

返回false表明输入参数为空或查询的贴纸数量大于返回结果的数组长度。

说明

该接口常用于关注当前渲染贴纸的动画是否结束，可在updateFrameparams后，调用该接口。

---

setLogLevel

boolean setLogLevel(int logLevel)

设置日志等级

参数

参数	描述
logLevel	日志级别

返回值

成功返回true， 否则false

---

setLogCallback

boolean setLogCallback(OrangeFilter.OF_LogListener logListener))

重定向日志输出，可以使用listener里面的 logCallBackFunc 将所需日志重定向输出

参数

参数	描述
logListener	日志回调接口

返回值

成功返回true， 否则false

返回false则传入logListener接口不可用。

---