---

createContext

bool createContext(const std::string& serialNumber, const std::string& licensePath, const std::string& resDir, VenusType aiType = VN_All)

初始化SDK环境

参数

参数	描述
serialNumber	授权序列号,购买OrangeFilter时获取
licensePath	可写入的路径，用于保存授权信息
resDir	资源存放根路径，包括特效包，AI模型文件等
aiType	AI识别类型

返回值

成功返回true， 否则false

说明

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

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

SDK初始化失败原因：

1.实例创建失败

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

---

destroyContext

void destroyContext()

销毁SDK环境

---

isContextValid

bool isContextValid()

Orange美颜SDK环境是否可用

返回值

成功返回true， 否则false

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

说明

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

---

enableEffect

bool enableEffect(EffectType effectType, bool enabled)

开启或关闭相应美颜特效类型

参数

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

返回值

成功返回true， 否则false

返回false，则开启失败，原因为特效创建失败，需检查特效包路径是否存在问题

---

releaseEffect

bool releaseEffect(EffectType effectType)

关闭并释放相应美颜特效类型资源内存

参数

参数	描述
effectType	美颜特效类型

返回值

成功返回true， 否则false

---

enableGesture

bool enableGesture(const std::string& path, bool enabled)

开启或关闭某手势特效

参数

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

返回值

成功返回true， 否则false

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

---

releaseGesture

bool releaseGesture(const std::string& path)

关闭并释放相应路径开启的手势特效包内存

参数

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

返回值

成功返回true， 否则false

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

---

enableSticker

bool enableSticker(const std::string& path, bool enabled)

开启或关闭某贴纸特效

参数

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

返回值

成功返回true， 否则false

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

---

releaseSticker

bool releaseSticker(const std::string& path)

关闭并释放并释放相应路径开启的贴纸特效包内存

参数

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

返回值

成功返回true， 否则false

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

---

getEffectParam

int getEffectParam(EffectParamType paramType)

获取某特效参数当前值

参数

参数	描述
paramType	美颜参数类型

返回值

当前参数值

---

setEffectParam

bool setEffectParam(EffectParamType paramType, int value)

设置某特效参数当前值

参数

参数	描述
paramType	美颜参数类型
value	美颜参数值

返回值

成功返回true， 否则false

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

---

getEffectParamDetail

bool getEffectParamDetail(EffectParamType paramType, EffectPram& paramVal)

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

参数

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

返回值

成功返回true， 否则false

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

---

updateFrameParams

bool updateFrameParams(const GLTexture& textureIn, const GLTexture& textureOut, const ImageInfo& image)

帧渲染特效回调函数

参数

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

返回值

成功返回true， 否则false

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

---

checkStickerResult

bool checkStickerResult(const std::vector<std::string>& paths, std::vector<int>& results)

查询贴纸的返回结果

参数

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

返回值

成功返回true， 否则false

目前只返回true，false用于后续扩展。

说明

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

---

setLogLevel

bool setLogLevel(int level)

设置日志等级

参数

参数	描述
level	日志级别

返回值

成功返回true， 否则false

---

setLogCallback

bool setLogCallback(void(*callback)(const char* msg))

重定向日志输出，可以传入回调函数将所需日志重定向输出

参数

参数	描述
callback	日志回调接口

返回值

成功返回true， 否则false

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

---