RFSDetectFaceResult

Objective-C

@interface RFSDetectFaceResult: NSObject

/// The array for the face image quality assessments
@property(nullable, nonatomic, readonly, copy) NSArray<RFSImageQualityResult *> *quality;

/// The array of the checked attributes.
@property(nullable, nonatomic, readonly, copy) NSArray<RFSDetectFacesAttributeResult *> *attributes;

/// Base64 image of the aligned and cropped portrait.
/// Returned if `RFSDetectFacesConfiguration.outputImageParams` is set or predefined scenario is used.
@property(nullable, nonatomic, readonly) UIImage *crop;

/// Сoordinates of the rectangular area that contains the face relative to the overall image.
@property(nonatomic, readonly, assign) CGRect faceRect;

/// Coordinates of the rectangle with the face on the original image prepared for the face crop.
/// Requires `RFSOutputImageCrop.returnOriginalRect` is set.
/// Returns 'CGRectZero' if `RFSOutputImageCrop.returnOriginalRect` isn't set.
@property(nonatomic, readonly, assign) CGRect originalRect;

/// Absolute coordinates of five points of each detected face: left eye, right eye, nose, left point of lips, right point of lips.
@property(nullable, nonatomic, readonly, copy) NSArray<RFSPoint *> *landmarks;

/// Summary of all image quality assessments.
/// Returns YES if all image quality assessments have success status.
/// Returns NO if any of image quality assessments have non-success status or none of quality assessments were requested.
@property(nonatomic, readonly, assign) BOOL isQualityCompliant;

RFS_EMPTY_INIT_UNAVAILABLE

@end

Swift

class DetectFaceResult : NSObject

Undocumented

  • The array for the face image quality assessments

    Declaration

    Objective-C

    @property (nonatomic, copy, readonly, nullable) NSArray<RFSImageQualityResult *> *quality;

    Swift

    var quality: [RFSImageQualityResult]? { get }

  • The array of the checked attributes.

    Declaration

    Objective-C

    @property (nonatomic, copy, readonly, nullable) NSArray<RFSDetectFacesAttributeResult *> *attributes;

    Swift

    var attributes: [RFSDetectFacesAttributeResult]? { get }

  • Base64 image of the aligned and cropped portrait. Returned if RFSDetectFacesConfiguration.outputImageParams is set or predefined scenario is used.

    Declaration

    Objective-C

    @property (nonatomic, readonly, nullable) UIImage *crop;

    Swift

    var crop: UIImage? { get }

  • Сoordinates of the rectangular area that contains the face relative to the overall image.

    Declaration

    Objective-C

    @property (nonatomic, readonly) CGRect faceRect;

    Swift

    var faceRect: CGRect { get }

  • Coordinates of the rectangle with the face on the original image prepared for the face crop. Requires RFSOutputImageCrop.returnOriginalRect is set. Returns ‘CGRectZero’ if RFSOutputImageCrop.returnOriginalRect isn’t set.

    Declaration

    Objective-C

    @property (nonatomic, readonly) CGRect originalRect;

    Swift

    var originalRect: CGRect { get }

  • Absolute coordinates of five points of each detected face: left eye, right eye, nose, left point of lips, right point of lips.

    Declaration

    Objective-C

    @property (nonatomic, copy, readonly, nullable) NSArray<RFSPoint *> *landmarks;

    Swift

    var landmarks: [RFSPoint]? { get }

  • Summary of all image quality assessments. Returns YES if all image quality assessments have success status. Returns NO if any of image quality assessments have non-success status or none of quality assessments were requested.

    Declaration

    Objective-C

    @property (nonatomic, readonly) BOOL isQualityCompliant;

    Swift

    var isQualityCompliant: Bool { get }

  • Unavailable

    Not the designated initializer

    Undocumented

    Declaration

    Objective-C

    RFS_EMPTY_INIT_UNAVAILABLE

  • Unavailable

    Not the designated initializer

    Undocumented

    Declaration

    Objective-C

    RFS_EMPTY_INIT_UNAVAILABLE