RGLFaceAPIParams

Objective-C

@interface RGLFaceAPIParams : NSObject

/// The URL of the Regula Face SDK service instance to be used. Default: "https://faceapi.regulaforensics.com".
@property(nonatomic, strong) NSString *url;

/// The processing mode: "match" or "match+search". Default: "match".
@property(nonatomic, strong) NSString *mode;

/// The similarity threshold, 0-100. Above 75 means that the faces' similarity is verified, below 75 is not. Default: 75.
@property(nonatomic, strong) NSNumber *threshold;

/// A search filter that can be applied if the "match+search" mode is enabled.
@property(nonatomic, strong, nullable) RGLFaceAPISearchParams *searchParams;

/// The service request timeout, ms. Default: 3000.
@property(nonatomic, strong) NSNumber *serviceTimeout;

/// Proxy to use, should be set according to the cURL standart.
@property(nonatomic, strong, nullable) NSString *proxy;

/// Username and password to use for proxy authentication, should be set according to the cURL standart.
@property(nonatomic, strong, nullable) NSString *proxyPassword;

/// Proxy protocol type, should be set according to the cURL standart.
@property(nonatomic, strong, nullable) NSNumber *proxyType;


- (instancetype)init RGL_DEPRECATED(7.1, "Use `[RGLFaceAPIParams defaultParams]` instead");

+ (instancetype)defaultParams;

@end

Swift

class FaceAPIParams : NSObject

Undocumented

  • url

    The URL of the Regula Face SDK service instance to be used. Default: “https://faceapi.regulaforensics.com”.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nonnull url;

    Swift

    var url: String { get set }

  • The processing mode: “match” or “match+search”. Default: “match”.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nonnull mode;

    Swift

    var mode: String { get set }

  • The similarity threshold, 0-100. Above 75 means that the faces’ similarity is verified, below 75 is not. Default: 75.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSNumber *_Nonnull threshold;

    Swift

    var threshold: NSNumber { get set }

  • A search filter that can be applied if the “match+search” mode is enabled.

    Declaration

    Objective-C

    @property (nonatomic, strong, nullable) RGLFaceAPISearchParams *searchParams;

    Swift

    var searchParams: RGLFaceAPISearchParams? { get set }

  • The service request timeout, ms. Default: 3000.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSNumber *_Nonnull serviceTimeout;

    Swift

    var serviceTimeout: NSNumber { get set }

  • Proxy to use, should be set according to the cURL standart.

    Declaration

    Objective-C

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

    Swift

    var proxy: String? { get set }

  • Username and password to use for proxy authentication, should be set according to the cURL standart.

    Declaration

    Objective-C

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

    Swift

    var proxyPassword: String? { get set }

  • Proxy protocol type, should be set according to the cURL standart.

    Declaration

    Objective-C

    @property (nonatomic, strong, nullable) NSNumber *proxyType;

    Swift

    var proxyType: NSNumber? { get set }

  • Deprecated

    Deprecated in DocumentReader 7.1. Use [RGLFaceAPIParams defaultParams] instead

    Undocumented

    Declaration

    Objective-C

    - (instancetype)init RGL_DEPRECATED(7.1, "Use `[RGLFaceAPIParams defaultParams]` instead");

    Swift

    init()

  • Undocumented

    Declaration

    Objective-C

    + (instancetype)defaultParams;

    Swift

    class func `default`() -> Self