QueenEngine Class Reference

Inherits from NSObject
Declared in QueenEngine.h

Overview

Queen美颜引擎类

  delegate

Queen回调代理对象

@property (nonatomic, weak) id<QueenEngineDelegate> delegate

Discussion

Queen回调代理对象

Declared In

QueenEngine.h

+ getVersion

获取版本号

+ (NSString *)getVersion

Declared In

QueenEngine.h

– initWithConfigInfo:

初始化引擎

- (instancetype)initWithConfigInfo:(QueenEngineConfigInfo *)configInfo

Parameters

configInfo

初始化配置

Declared In

QueenEngine.h

– destroyEngine

销毁引擎,需要在渲染线程调用

- (void)destroyEngine

Declared In

QueenEngine.h

– powerSavingEnabled:

高性能模式,效果会稍微差点,默认为NO

- (void)powerSavingEnabled:(BOOL)enabled

Parameters

enabled

YES: 打开,NO:关闭

Declared In

QueenEngine.h

– setQueenBeautyType:enable:

打开或者关闭某个美颜类型

- (void)setQueenBeautyType:(kQueenBeautyType)type enable:(BOOL)isOpen

Parameters

type

QueenBeautyType 类型的一个值

isOpen

YES: 打开,NO:关闭

Declared In

QueenEngine.h

– setQueenBeautyParams:value:

设置美颜参数

- (void)setQueenBeautyParams:(kQueenBeautyParams)param value:(float)value

Parameters

param

美颜参数类型,QueenBeautyParams 中的一个

value

需要设置的数值,值的范围都是[0,1],小于0的置0,大于1的置1

Declared In

QueenEngine.h

– getQueenBeautyParams:

获取美颜参数

- (float)getQueenBeautyParams:(kQueenBeautyParams)param

Parameters

param

美颜参数类型,QueenBeautyParams 中的一个

Declared In

QueenEngine.h

– setLutImagePath:

设置滤镜图片,设置滤镜图片前需要将kQueenBeautyTypeLUT打开

- (void)setLutImagePath:(NSString *)imagePath

Parameters

imagePath

所要设置的滤镜图片的地址

Declared In

QueenEngine.h

– setFaceShape:value:

设置美型类型,设置前需要将kQueenBeautyTypeFaceShape打开

- (void)setFaceShape:(kQueenBeautyFaceShapeType)faceShapeType value:(float)value

Parameters

faceShapeType

需要设置美型的类型,参考QueenBeautyFaceShapeType

value

需要设置的值

Declared In

QueenEngine.h

– setBodyShape:value:

设置美体类型,设置前需要将kQueenBeautyTypeBodyShape打开

- (void)setBodyShape:(kQueenBeautyBodyShapeType)bodyShapeType value:(float)value

Parameters

bodyShapeType

需要设置美体的类型,参考QueenBeautyBodyShapeType

value

需要设置的值

Declared In

QueenEngine.h

– setMakeupWithType:paths:blendType:

设置美妆类型和图片素材路径,设置美妆需要将kQueenBeautyTypeMakeup 打开

- (void)setMakeupWithType:(kQueenBeautyMakeupType)makeupType paths:(NSArray<NSString*> *)imagePaths blendType:(kQueenBeautyBlend)blend

Parameters

makeupType

美妆类型

imagePaths

美妆素材地址集合

blend

混合类型

Declared In

QueenEngine.h

– setMakeupWithType:paths:blendType:fps:

设置美妆类型和图片素材路径

- (void)setMakeupWithType:(kQueenBeautyMakeupType)makeupType paths:(NSArray<NSString*> *)imagePaths blendType:(kQueenBeautyBlend)blend fps:(int)fps

Parameters

makeupType

美妆类型

imagePaths

美妆素材地址集合

blend

混合类型

fps

对应的帧率

Declared In

QueenEngine.h

– setMakeupAlphaWithType:female:alpha:

设置美妆透明度,可指定性别

- (void)setMakeupAlphaWithType:(kQueenBeautyMakeupType)makeupType female:(BOOL)isFeMale alpha:(float)alpha

Parameters

makeupType

美妆类型

isFeMale

是否是女性,女性:YES,男性:NO,(男性为接口预留,这里均传女性即YES即可)

alpha

妆容透明度

Declared In

QueenEngine.h

– setMakeupBlendWithType:blendType:

设置美妆类型的混合类型

- (void)setMakeupBlendWithType:(kQueenBeautyMakeupType)makeupType blendType:(kQueenBeautyBlend)blend

Parameters

makeupType

美妆类型

blend

混合类型

Declared In

QueenEngine.h

– resetAllMakeupType

清除所有美妆

- (void)resetAllMakeupType

Declared In

QueenEngine.h

– addMaterialWithPath:

增加贴纸/贴图/实景抠图需要替换的背景,素材统一接口,支持GLTF,TAOPAI,MEDIAAI 类型

- (void)addMaterialWithPath:(NSString *)materialPath

Parameters

materialPath

要添加的素材的路径

Declared In

QueenEngine.h

– removeMaterialWithPath:

删除贴纸/贴图/实景抠图需要替换的背景

- (void)removeMaterialWithPath:(NSString *)materialPath

Parameters

materialPath

要删除的素材的路径

Declared In

QueenEngine.h

– setGreenScreen:blueScreenEnabled:threshold:autoThresholdEnabled:

绿幕/蓝幕抠图,注意:开启此抠图功能

- (void)setGreenScreen:(NSString *)backgroundImagePath blueScreenEnabled:(BOOL)blueScreenEnabled threshold:(float)threshold autoThresholdEnabled:(BOOL)autoThresholdEnabled

Parameters

backgroundImagePath

需要绿/蓝幕替换的背景资源路径,传空即为取消抠图功能

blueScreenEnabled

是否蓝幕抠图

threshold

幕布敏感度[1,10],默认1

autoThresholdEnabled

是否根据环境动态计算幕布敏感度,为true时调节参数threshold失效,为false时调节参数threshold生效

Declared In

QueenEngine.h

– setSegmentBackgroundProcessType:

调整实景抠图的背景处理方式

- (void)setSegmentBackgroundProcessType:(kQueenBackgroundProcessType)backgroundProcessType

Parameters

backgroundProcessType

背景处理方式,默认为背景虚化

Declared In

QueenEngine.h

– setAISegmentForegroundPadding:

调整实景抠图的前景边距

- (void)setAISegmentForegroundPadding:(int)foregroundPadding

Parameters

foregroundPadding

前景边距,[0,15],默认0

Declared In

QueenEngine.h

– setFaceRenderFlipY:faceInfoFlipY:

人脸识别信息和渲染是否翻转以Y轴方向翻转

- (void)setFaceRenderFlipY:(BOOL)faceRenderFlipY faceInfoFlipY:(BOOL)faceInfoFlipY

Parameters

faceRenderFlipY

需要关键点确定位置的图像渲染时是否反转,默认NO

faceInfoFlipY

关键点数据是否翻转,默认NO

Discussion

人脸识别信息和渲染是否翻转以Y轴方向翻转

Declared In

QueenEngine.h

– processPixelBuffer:

处理PixelBuffer类型数据

- (kQueenResultCode)processPixelBuffer:(QEPixelBufferData *)pixelBufferData

Parameters

pixelBufferData

需要处理的数据

Return Value

接口调用状态码

Discussion

处理PixelBuffer类型数据

Declared In

QueenEngine.h

– processTexture:

处理Texture类型数据

- (kQueenResultCode)processTexture:(QETextureData *)textureData

Parameters

textureData

需要处理的数据

Return Value

接口调用状态码

Discussion

处理Texture类型数据

Declared In

QueenEngine.h

– updateInputDataAndRunAlg:withImgFormat:withWidth:withHeight:withStride:withInputAngle:withOutputAngle:withFlipAxis:

视频帧数据更新处理,用于做engine算法层的数据处理,注:如处理Texture类型数据时需高级美颜处理需要调用此接口,处理PixelBuffer类型数据不需要调用此接口

- (void)updateInputDataAndRunAlg:(uint8_t *)imageData withImgFormat:(kQueenImageFormat)format withWidth:(int)width withHeight:(int)height withStride:(int)stride withInputAngle:(int)intputAngle withOutputAngle:(int)outputAngle withFlipAxis:(int)flipAxis

Parameters

imageData

帧图片流

format

帧图片流格式

width

帧图片宽度

height

帧图片高度

stride

用于检测的图像的跨度(以像素为单位),即每行的字节数, 默认情况下设为 0

intputAngle

当前输入帧图片需旋转的角度,计算方式参考Sample工程,注:仅当QueenEngineConfigInfo的autoSettingImgAngle设置为NO才会生效

outputAngle

算法输出结果所需旋转的角度,计算方式参考Sample工程,注:仅当QueenEngineConfigInfo的autoSettingImgAngle设置为NO才会生效

flipAxis

输出数据的xy轴翻转处理,0为不旋转,1为x轴翻转,2为y轴翻转

Discussion

视频帧数据更新处理,用于做engine算法层的数据处理,注:如处理Texture类型数据时需高级美颜处理需要调用此接口,处理PixelBuffer类型数据不需要调用此接口

Declared In

QueenEngine.h

– showFaceDetectPoint:

展示人脸识别点位

- (void)showFaceDetectPoint:(BOOL)show

Parameters

show

是否展示

Declared In

QueenEngine.h

– showBodyDetectPoint:

展示人体识别点位

- (void)showBodyDetectPoint:(BOOL)show

Parameters

show

是否展示

Declared In

QueenEngine.h

– showHandDetectPoint:

展示手部识别点位

- (void)showHandDetectPoint:(BOOL)show

Parameters

show

是否展示

Declared In

QueenEngine.h

– showMakeupLine:

展示人脸区域三角剖分线

- (void)showMakeupLine:(BOOL)show

Parameters

show

是否展示

Declared In

QueenEngine.h