RFSDetectFacesRequest

Objective-C


@interface RFSDetectFacesRequest : NSObject

Swift

class DetectFacesRequest : NSObject

Detect Faces Request. Could be created by predefined scenarios (e.g: qualityICAORequest, cropAllFacesRequest etc. ) or by using custom RFSDetectFacesConfiguration.

  • tag

    Defines tag that can be used in detect faces processing. Defaults to nil.

    Declaration

    Objective-C

    @property (nonatomic, strong, nullable) NSString *tag;

    Swift

    var tag: String? { get set }

  • Base64 image to process.

    Declaration

    Objective-C

    @property (nonatomic, strong, readonly, nonnull) UIImage *image;

    Swift

    var image: UIImage { get }

  • Current Face Detection scenario. nil for custom RFSDetectFacesRequest

    Declaration

    Objective-C

    @property (nonatomic, readonly, nullable) NSString *scenario;

    Swift

    var scenario: String? { get }

  • Custom Request configuration to specify image, quality, attributes parameters. nil for request with predefined scenario (like ICAO, VisaSchengen etc.).

    Declaration

    Objective-C

    @property (nonatomic, copy, nullable) RFSDetectFacesConfiguration *configuration;

    Swift

    @NSCopying var configuration: RFSDetectFacesConfiguration? { get set }

  • Creates a request to check all the available quality characteristics.

    Declaration

    Objective-C

    + (nonnull instancetype)qualityFullRequestForImage:(nonnull UIImage *)image;

    Swift

    class func qualityFullRequest(for image: UIImage) -> Self

  • Creates a request to check the quality characteristics based on the ICAO standard.

    Declaration

    Objective-C

    + (nonnull instancetype)qualityICAORequestForImage:(nonnull UIImage *)image;

    Swift

    class func qualityICAORequest(for image: UIImage) -> Self

  • Creates a request to check the quality characteristics based on the Schengen visa standard.

    Declaration

    Objective-C

    + (nonnull instancetype)qualityVisaSchengenRequestForImage:
    (nonnull UIImage *)image;

    Swift

    class func qualityVisaSchengenRequest(for image: UIImage) -> Self

  • Creates a request to check the quality characteristics based on the USA visa standard.

    Declaration

    Objective-C

    + (nonnull instancetype)qualityVisaUSARequestForImage:(nonnull UIImage *)image;

    Swift

    class func qualityVisaUSARequest(for image: UIImage) -> Self

  • Creates a request for a cropped portrait of the person whose face is the most central.

    Declaration

    Objective-C

    + (nonnull instancetype)cropCentralFaceRequestForImage:(nonnull UIImage *)image;

    Swift

    class func cropCentralFace(for image: UIImage) -> Self

  • Creates a request for cropped portraits of all the people in the image.

    Declaration

    Objective-C

    + (nonnull instancetype)cropAllFacesRequestForImage:(nonnull UIImage *)image;

    Swift

    class func cropAllFacesRequest(for image: UIImage) -> Self

  • Creates a request for a cropped portrait of the person whose face is the most central in the image in the original size.

    Declaration

    Objective-C

    + (nonnull instancetype)thumbnailRequestForImage:(nonnull UIImage *)image;

    Swift

    class func thumbnailRequest(for image: UIImage) -> Self

  • Creates a request for all available attribute results.

    Declaration

    Objective-C

    + (nonnull instancetype)allAttributesRequestForImage:(nonnull UIImage *)image;

    Swift

    class func allAttributesRequest(for image: UIImage) -> Self

  • 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

  • Creates a request with custom configuration (custom quality, output image params, attributes etc.).

    Declaration

    Objective-C

    - (nonnull instancetype)initWithImage:(nonnull UIImage *)image
                        configuration:(nonnull RFSDetectFacesConfiguration *)
                                          configuration;

    Swift

    init(image: UIImage, configuration: RFSDetectFacesConfiguration)