本文档是关于秀图(Xiusdk)的BeautyEngine开发文档,版本为3.1,更新日期为2019年1月1日。该引擎主要提供了图像美化功能,包括但不限于人脸美化、滤镜应用以及参数调整。文档详细介绍了以下几个关键接口:
1. **Beauty_InitBeautyEngine**:
- 名称:ZBEAUTY_API BeautyHandle Beauty_InitBeautyEngine(const char* filePath)
- 描述:用于初始化美颜引擎,接受一个参数`filePath`,即资源文件路径,返回一个BeautyHandle,表示引擎实例句柄。此函数是程序开始使用的入口点,用于创建并配置引擎。
2. **Beauty_UninitBeautyEngine**:
- 名称:ZBEAUTY_API void Beauty_UninitBeautyEngine(BeautyHandle handle)
- 描述:用于销毁或关闭已创建的美颜引擎实例。传入`handle`作为实例句柄,该函数将释放相关资源,确保引擎的正确清理。
3. **Beauty_ProcessBuffer** 和 **Beauty_ProcessNV21**:
- Beauty_ProcessBuffer 是处理内存缓冲区中的图像数据,返回一个整数值,可能是处理结果或错误代码。
- Beauty_ProcessNV21 则是对NV21格式的图像数据进行处理,这种格式常用于摄像头采集的视频流,这两个接口共同实现了实时美颜功能。
4. **其他设置接口**:
- Beauty_ClearParams: 清空引擎的默认参数,以便于重新配置。
- Beauty_SetFacePoints: 设置人脸的关键点,用于更精确的人脸美化。
- Beauty_SetSoftenRatio, Beauty_SetWhitenRatio, Beauty_SetFilterID, Beauty_SetFilterRatio 等:分别用于设置美颜引擎的不同参数,如柔肤程度、美白效果、滤镜选择和比例等。
- Beauty_SetDefreckleAutoEnable, Beauty_SetDefreckleMenualRadiusAndPosition 等:控制痘印去除和手动调整痘印位置的功能。
- 对眼睛、嘴唇、鼻子等部分的美化参数也有所设定,如去眼袋、提亮眼睛、瘦脸、唇色调整和增高鼻梁等。
文档还包含了(附录)滤镜效果Id列表,供开发者根据需求选择不同的美化效果。异常列表文档列出了可能遇到的错误码和对应的含义,这对于错误处理和调试非常有帮助。最后,文档还提供了一个返回值类型列表,以便开发者了解各个接口可能的返回值类型。
秀图BeautyEngine开发文档提供了完整的API调用指南和配置选项,开发者可以根据实际项目需求,通过这些接口来实现定制化的图像美化功能。