Classes
The following classes are available globally.
-
Base class for creating immutable configuration objects.
See moreDeclaration
Objective-C
@interface RFSBaseConfiguration<T : __kindof RFSBaseConfigurationBuilder *> : NSObject
Swift
class BaseConfiguration<T> : NSObject where T : BaseConfigurationBuilder
-
Base class for creating immutable configuration objects. This is a mutable part that is configured in the
See morebuilderBlock
of theRFSBaseConfiguration
.Declaration
Objective-C
@interface RFSBaseConfigurationBuilder : NSObject
Swift
class BaseConfigurationBuilder : NSObject
-
Undocumented
See moreDeclaration
Objective-C
@interface RFSCameraOverlayView : RFSPassthroughView
Swift
class CameraOverlayView : PassthroughView
-
Undocumented
See moreDeclaration
Objective-C
@interface RFSCameraToolbarView : UIView <RFSOverriding> @property(readwrite, nonatomic, assign) RFSCameraToolbarViewState state; #pragma mark - Overriding /// Defaults to not `nil`. Can be overriden directly or set to `nil` to hide a button from the toolbar. @property(readonly, nonatomic, nullable) UIButton *torchButton; /// Defaults to not `nil`. Can be overriden directly or set to `nil` to hide a button from the toolbar. @property(readonly, nonatomic, nullable) UIButton *switchCameraButton; /// Defaults to not `nil`. Can be overriden directly or set to `nil` to hide a button from the toolbar. @property(readonly, nonatomic, nullable) UIButton *closeButton; /// Setups default constraints. Can be overriden to provide custom layout constraints. - (void)setupConstraints; /// Updates CameraToolbarView state. Called when `state` propperty is changed. /// Can be overriden to provide custom appearance for different states of ToolbarView. - (void)updateState:(RFSCameraToolbarViewState)state; #pragma mark - Styling - (void)setTintColor:(nullable UIColor *)color forState:(RFSCameraToolbarViewState)state UI_APPEARANCE_SELECTOR; - (nullable UIColor *)tintColorForState:(RFSCameraToolbarViewState)state UI_APPEARANCE_SELECTOR; @end
Swift
class CameraToolbarView : UIView, Overriding
-
Undocumented
See moreDeclaration
Objective-C
@interface RFSCustomization : NSObject @property(nonatomic, strong, nullable) RFSUIConfiguration *configuration; @property(nonatomic, weak, nullable) id<RFSCustomizationActionDelegate> actionDelegate; @property(nonatomic, strong, nullable) NSDictionary *customUILayerJSON; @end
Swift
class RFSCustomization : NSObject
-
A base class for Person Database object
See moreDeclaration
Objective-C
@interface RFSDBBaseItem : NSObject
-
Abstract base response for PersonDatabase requests.
See moreDeclaration
Objective-C
@interface RFSBaseResponse : NSObject
Swift
class DBBaseResponse : NSObject
-
Response for paged requests.
See moreDeclaration
Objective-C
@interface RFSPageResponse<PageItem : RFSDBBaseItem *> : RFSBaseResponse
-
Response for single item request.
See moreDeclaration
Objective-C
@interface RFSItemResponse<Item : RFSDBBaseItem *> : RFSBaseResponse
-
Boolean response for PersonDatabase requests.
See moreDeclaration
Objective-C
@interface RFSComfirmResponse : RFSBaseResponse
-
Data response for PersonDatabase requests.
See moreDeclaration
Objective-C
@interface RFSDataResponse : RFSBaseResponse
-
Response for
See moreRFSSearchPersonRequest
.Declaration
Objective-C
@interface RFSSearchPersonResponse : RFSBaseResponse
-
Undocumented
See moreDeclaration
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
See moreDeclaration
Objective-C
@interface RFSDetectFacesAttributeResult: NSObject @property(nonnull, nonatomic, readonly) RFSDetectFacesAttribute attribute; @property(nullable, nonatomic, readonly) NSNumber *confidence; @property(nullable, nonatomic, readonly) NSString *value; @property(nullable, nonatomic, readonly) RFSImageQualityRange *range; RFS_EMPTY_INIT_UNAVAILABLE @end
Swift
class DetectFacesAttributeResult : NSObject
-
Custom configuration for
See moreRFSDetectFacesRequest
.Declaration
Objective-C
@interface RFSDetectFacesConfiguration : NSObject
Swift
class DetectFacesConfiguration : NSObject
-
Detect Faces Request. Could be created by predefined scenarios (e.g:
See morequalityICAORequest
,cropAllFacesRequest
etc. ) or by using customRFSDetectFacesConfiguration
.Declaration
Objective-C
@interface RFSDetectFacesRequest : NSObject
Swift
class DetectFacesRequest : NSObject
-
Undocumented
See moreDeclaration
Objective-C
@interface RFSDetectFacesResponse: NSObject /// Single Face Detection result. /// Preferred to use when Scenario supports only central face detection. @property(nullable, nonatomic, readonly) RFSDetectFaceResult *detection; /// All Face Detections Results. /// Preferred to use when Scenario supports multiple faces detection. @property(nullable, nonatomic, readonly, copy) NSArray<RFSDetectFaceResult *> *allDetections; /// Current Image Quality Assessment Scenario /// `nil` for Request with custom configuration. @property(nullable, nonatomic, readonly, copy) NSString *scenario; /// The error describes a failed detect faces request and contains `RFSDetectFacesErrorCode` codes. /// This error belongs to the `RFSDetectFacesErrorDomain`. @property(nullable, nonatomic, readonly, strong) NSError *error; RFS_EMPTY_INIT_UNAVAILABLE @end
Swift
class DetectFacesResponse : NSObject
-
Request object to configure PersonGroup editing.
See moreDeclaration
Objective-C
@interface RFSEditGroupPersonsRequest : NSObject
-
Mutable builder part of the
See moreRFSFaceCaptureConfiguration
.Declaration
Objective-C
@interface RFSFaceCaptureConfigurationBuilder : RFSBaseConfigurationBuilder
Swift
class FaceCaptureConfigurationBuilder : BaseConfigurationBuilder
-
Configuration for the FaceCapture.
This class is used as a parameters for
See more-[RFSFaceSDK presentFaceCaptureViewControllerFrom:animated:configuration:onCapture:completion:]
. The configuration provides convenient properties to change the behavior and the appearance of the FaceCapture UI module.Declaration
Objective-C
@interface RFSFaceCaptureConfiguration : RFSBaseConfiguration <RFSFaceCaptureConfigurationBuilder *> <NSObject>
Swift
class FaceCaptureConfiguration : BaseConfiguration<FaceCaptureConfigurationBuilder>, NSObjectProtocol
-
Undocumented
See moreDeclaration
Objective-C
@interface RFSFaceCaptureContentView : RFSPassthroughView <RFSOverriding>
Swift
class FaceCaptureContentView : PassthroughView, Overriding
-
The response from the Face Capture module. This object contains either an image or an error.
See moreDeclaration
Objective-C
@interface RFSFaceCaptureResponse : NSObject
Swift
class FaceCaptureResponse : NSObject
-
The entry point to the Face SDK features.
See moreDeclaration
Objective-C
@interface RFSFaceSDK : NSObject
Swift
class FaceSDK : NSObject
-
Undocumented
See moreDeclaration
Objective-C
@interface RFSFaceSDKVersion : NSObject /// Version of the API module. @property(nonatomic, readonly, strong, nullable) NSString *api; /// Version of the CORE module. @property(nonatomic, readonly, strong, nullable) NSString *core; /// CORE module variant. @property(nonatomic, readonly, strong, nullable) NSString *coreMode; @end
Swift
class RFSFaceSDKVersion : NSObject
-
Undocumented
See moreDeclaration
Objective-C
@interface RFSHintView : UIView @property(readwrite, nonatomic, assign) RFSHintViewState state; @property(readwrite, nonatomic, strong, nullable) NSString *text; #pragma mark - Styling @property(readwrite, nonatomic, assign) CGFloat cornerRadius UI_APPEARANCE_SELECTOR; - (void)setTextColor:(nullable UIColor *)color forState:(RFSHintViewState)state UI_APPEARANCE_SELECTOR; - (nullable UIColor *)textColorForState:(RFSHintViewState)state UI_APPEARANCE_SELECTOR; - (void)setBackgroundColor:(nullable UIColor *)color forState:(RFSHintViewState)state UI_APPEARANCE_SELECTOR; - (nullable UIColor *)backgroundColorForState:(RFSHintViewState)state UI_APPEARANCE_SELECTOR; @end
Swift
class HintView : UIView
-
The Image class wraps regular
See moreUIImage
and provides more information to the input and output data.Declaration
Objective-C
@interface RFSImage : NSObject
Swift
class Image : NSObject
-
Image Quality parameter to include in
See moreRFSDetectFacesConfiguration
ascustomQuality
.Declaration
Objective-C
@interface RFSImageQualityCharacteristic : NSObject
Swift
class ImageQualityCharacteristic : NSObject
-
Undocumented
See moreDeclaration
Objective-C
@interface RFSImageCharacteristics: NSObject /// The image width, pixels. /// Doesn't have recommended value. + (RFSImageQualityCharacteristic *)imageWidthWithRange:(NSArray<NSNumber *> *)range; /// The image height, pixels. /// Doesn't have recommended value. + (RFSImageQualityCharacteristic *)imageHeightWithRange:(NSArray<NSNumber *> *)range; /// The image width to height proportion. /// Doesn't have recommended value. + (RFSImageQualityCharacteristic *)imageWidthToHeightWithRange:(NSArray<NSNumber *> *)range; /// The image RGB channels number. /// Doesn't have recommended value. /// Range value [3, 3] is for RGB images. + (RFSImageQualityCharacteristic *)imageChannelsNumberWithValue:(NSNumber *)value; /// Whether the face in the image is a photo, not a drawing, sculpture, cartoon, etc. /// If the returned value is out of the recommended range, the image is not a photo. /// The range is from 0 to 1 where 0 means the image is a photo. + (RFSImageQualityCharacteristic *)artFace; /// The percentage of the area of the image that was "padded" during alignment. /// The characteristic is needed to determine if the head goes beyond the image. /// The range is from 0 to 1 where 0 is 0% of the image is "padded". /// Doesn't have recommended value. + (RFSImageQualityCharacteristic *)paddingRatioWithMinValue:(NSNumber *)minValue maxValue:(NSNumber *)maxValue; /// All Group characteristics with default (recommended) values. /// Doesn't include characteristics without default values. + (NSArray<RFSImageQualityCharacteristic *> *)allRecommended; RFS_EMPTY_INIT_UNAVAILABLE @end
Swift
class Image : NSObject
-
Undocumented
See moreDeclaration
Objective-C
@interface RFSHeadSizeAndPosition: NSObject /// The position of the "middle point" (the middle of the line connecting the eye centers) relative to the width of the image. /// The range is from 0 to 1 where range [0.5, 0.5] is for "middle point" strictly in the center . + (RFSImageQualityCharacteristic *)faceMidPointHorizontalPosition; /// The position of the "middle point" (the middle of the line connecting the eye centers) relative to the height of the image. /// The range is from 0 to 1 where range [0.5, 0.5] is for "middle point" strictly in the center . + (RFSImageQualityCharacteristic *)faceMidPointVerticalPosition; /// The head width to the image width ratio. /// The range is from 0 to 1. + (RFSImageQualityCharacteristic *)headWidthRatio; /// The head height to the image height ratio. /// The range is from 0 to 1. + (RFSImageQualityCharacteristic *)headHeightRatio; /// Inter-eye distance — the length of the line connecting the eye centers of the left and right eye, pixels. + (RFSImageQualityCharacteristic *)eyesDistance; /// The yaw of the head, degrees. /// The range is from -90 to 90. Range value [0, 0] for strictly stright head position. + (RFSImageQualityCharacteristic *)yaw; /// The pitch of the head, degrees. /// The range is from -90 to 90. Range value [0, 0] for strictly stright head position. + (RFSImageQualityCharacteristic *)pitch; /// The roll of the head, degrees. /// The range is from -90 to 90. Range value [0, 0] for strictly stright head position. + (RFSImageQualityCharacteristic *)roll; /// All Group characteristics with default (recommended) values. /// Doesn't include characteristics without default values. + (NSArray<RFSImageQualityCharacteristic *> *)allRecommended; RFS_EMPTY_INIT_UNAVAILABLE @end
Swift
class HeadSizeAndPosition : NSObject
-
Undocumented
See moreDeclaration
Objective-C
@interface RFSFaceImageQuality: NSObject /// The blur level. /// The range is from 0 to 1 where 0 is the absence of blur effect + (RFSImageQualityCharacteristic *)blurLevel; /// The noise level. /// The range is from 0 to 1 where 0 is minimal noise level. + (RFSImageQualityCharacteristic *)noiseLevel; /// The true-colour representation of the skin colour. /// The range is from 0 to 1. + (RFSImageQualityCharacteristic *)unnaturalSkinTone; /// The range of tonal difference between the lightest light and darkest dark of an image, bits. + (RFSImageQualityCharacteristic *)faceDynamicRange; /// All Group characteristics with default (recommended) values. /// Doesn't include characteristics without default values. + (NSArray<RFSImageQualityCharacteristic *> *)allRecommended; RFS_EMPTY_INIT_UNAVAILABLE @end
Swift
class FaceImage : NSObject
-
Undocumented
See moreDeclaration
Objective-C
@interface RFSEyesCharacteristics: NSObject /// Whether the right eye is closed. /// The range is from 0 to 1 where 1 is the eye is fully closed. + (RFSImageQualityCharacteristic *)eyeRightClosed; /// Whether the left eye is closed. /// The range is from 0 to 1 where 1 is the eye is fully closed. + (RFSImageQualityCharacteristic *)eyeLeftClosed; /// Whether the right eye is occluded. /// The range is from 0 to 1 where 1 is the eye is fully occluded. + (RFSImageQualityCharacteristic *)eyeRightOccluded; /// Whether the left eye is occluded. /// The range is from 0 to 1 where 1 is the eye is fully occluded. + (RFSImageQualityCharacteristic *)eyeLeftOccluded; /// Whether there is the red-eye effect. /// The range is from 0 to 1 where 0 is the absence of red-eye effect. + (RFSImageQualityCharacteristic *)eyesRed; /// Whether the right eye is covered with hair. /// The range is from 0 to 1 where 1 is 100% of the eye is covered by hair. + (RFSImageQualityCharacteristic *)eyeRightCoveredWithHair; /// Whether the left eye is covered with hair. /// The range is from 0 to 1 where 1 is 100% of the eye is covered by hair. + (RFSImageQualityCharacteristic *)eyeLeftCoveredWithHair; /// Whether the person is not looking directly at the camera. /// The range is from 0 to 1 where 0 is for absolutely direct look. + (RFSImageQualityCharacteristic *)offGaze; /// All Group characteristics with default (recommended) values. /// Doesn't include characteristics without default values. + (NSArray<RFSImageQualityCharacteristic *> *)allRecommended; RFS_EMPTY_INIT_UNAVAILABLE @end
Swift
class Eyes : NSObject
-
Undocumented
See moreDeclaration
Objective-C
@interface RFSShadowsAndLightning: NSObject /// Whether the photo is too dark. /// The range is from 0 to 1. + (RFSImageQualityCharacteristic *)tooDark; /// Whether the photo is overexposed. /// The range is from 0 to 1. + (RFSImageQualityCharacteristic *)tooLight; /// Whether there is glare on the face. /// The range is from 0 to 1 where 0 is the absence of glare. + (RFSImageQualityCharacteristic *)faceGlare; /// Whether there are shadows on the face. /// The range is from 0 to 1 where 0 is the absence of shadows on the face. + (RFSImageQualityCharacteristic *)shadowsOnFace; /// All Group characteristics with default (recommended) values. /// Doesn't include characteristics without default values. + (NSArray<RFSImageQualityCharacteristic *> *)allRecommended; RFS_EMPTY_INIT_UNAVAILABLE @end
Swift
class ShadowsAndLightning : NSObject
-
Undocumented
See moreDeclaration
Objective-C
@interface RFSPoseAndExpression: NSObject /// Checks the symmetry of the shoulders. /// The range is from 0 to 1 where 1 is for absolutely symmetrical shoulders. + (RFSImageQualityCharacteristic *)shouldersPose; /// Checks the presence of any emotional facial expression. /// The range is from 0 to 1 where 0 is for absolutely non-emotional expression. + (RFSImageQualityCharacteristic *)expressionLevel; /// Whether the mouth is open. /// The range is from 0 to 1 where 0 is closed mouth. + (RFSImageQualityCharacteristic *)mouthOpen; /// Whether the person smiles. /// The range is from 0 to 1 where 0 is smile absence. + (RFSImageQualityCharacteristic *)smile; /// All Group characteristics with default (recommended) values. /// Doesn't include characteristics without default values. + (NSArray<RFSImageQualityCharacteristic *> *)allRecommended; RFS_EMPTY_INIT_UNAVAILABLE @end
Swift
class PoseAndExpression : NSObject
-
Undocumented
See moreDeclaration
Objective-C
@interface RFSHeadOcclusion: NSObject /// Whether the person wears dark glasses. /// The range is from 0 to 1 where 0 is dark glasses absence. +(RFSImageQualityCharacteristic *)darkGlasses; /// Whether there are reflections on glasses. /// The range is from 0 to 1 where 0 is reflections absence. /// In the current release, always succeeds. Will be developed in the coming releases. +(RFSImageQualityCharacteristic *)reflectionOnGlasses; /// Whether the glasses frames do not obscure eye details and the irises of both eyes are visible. /// The range is from 0 to 20 where 0 the absence of frames (glasses). +(RFSImageQualityCharacteristic *)framesTooHeavy; /// Whether the face is visible and not occluded. /// The range is from 0 to 1 where 0 is face occlusion absence. +(RFSImageQualityCharacteristic *)faceOccluded; /// Whether there is any head coverage other than religious headwear. /// The range is from 0 to 1. +(RFSImageQualityCharacteristic *)headCovering; /// Whether the forehead is covered. /// The range is from 0 to 1. +(RFSImageQualityCharacteristic *)foreheadCovering; /// Whether the makeup is too strong. /// In the current release, always succeeds. Will be developed in the coming releases. /// The range is from 0 to 1. +(RFSImageQualityCharacteristic *)strongMakeup; /// Whether the person is wearing headphones. /// /// The range is from 0 to 1 where 0 is headphones absence. +(RFSImageQualityCharacteristic *)headphones; /// Whether the person is wearing a medical mask. /// The range is from 0 to 1 where 0 is medical mask absence. +(RFSImageQualityCharacteristic *)medicalMask; /// All Group characteristics with default (recommended) values. /// Doesn't include characteristics without default values. + (NSArray<RFSImageQualityCharacteristic *> *)allRecommended; @end
Swift
class HeadOcclusion : NSObject
-
Undocumented
See moreDeclaration
Objective-C
@interface RFSQualityBackground: NSObject /// Checks uniformity of the portrait background. /// The range is from 0 to 1 where 1 is absolute background uniformity. + (RFSImageQualityCharacteristic *)backgroundUniformity; /// Whether there are shadows on the portrait background. /// The range is from 0 to 1 where 1 is the absence of shadows on the portrait background. + (RFSImageQualityCharacteristic *)shadowsOnBackground; /// The number of faces on the photo. /// The range starts from 1. + (RFSImageQualityCharacteristic *)otherFaces; /// Whether the background color matches default background color. /// Default color is white (RGB(255,255,255) or hex #FFFFFF) /// The range is from 0 to 1 where 1 is full background color match. + (RFSImageQualityColorCharacteristic *)backgroundColorMatch; /// Whether the background color matches the required color. /// The range is from 0 to 1 where 1 is full background color match. + (RFSImageQualityColorCharacteristic *)backgroundColorMatchWithColor:(UIColor*)color; /// All Group characteristics with default (recommended) values. /// Doesn't include characteristics without default values. + (NSArray<RFSImageQualityCharacteristic *> *)allRecommended; RFS_EMPTY_INIT_UNAVAILABLE @end
Swift
class Background : NSObject
-
Image Quality Characteristic where a color is the parameter for Assessment.
See moreDeclaration
Objective-C
@interface RFSImageQualityColorCharacteristic : RFSImageQualityCharacteristic
Swift
class ImageQualityColorCharacteristic : ImageQualityCharacteristic
-
Base range value for Image Quality parameters
See moreDeclaration
Objective-C
@interface RFSImageQualityRange : NSObject
Swift
class ImageQualityRange : NSObject
-
Quality assessment result.
See moreDeclaration
Objective-C
@interface RFSImageQualityResult : NSObject
Swift
class ImageQualityResult : NSObject
-
An object that represents uploaded image with its settings.
See moreDeclaration
Objective-C
@interface RFSImageUpload : NSObject
-
Undocumented
See moreDeclaration
Objective-C
@interface RFSInitializationConfigurationBuilder : RFSBaseConfigurationBuilder
Swift
class InitConfigurationBuilder : BaseConfigurationBuilder
-
Undocumented
See moreDeclaration
Objective-C
@interface RFSInitializationConfiguration : RFSBaseConfiguration <RFSInitializationConfigurationBuilder *> <NSObject>
Swift
class InitializationConfiguration : BaseConfiguration<InitConfigurationBuilder>, NSObjectProtocol
-
Mutable builder part of the
See moreRFSLivenessConfiguration
.Declaration
Objective-C
@interface RFSLivenessConfigurationBuilder : RFSBaseConfigurationBuilder
Swift
class LivenessConfigurationBuilder : BaseConfigurationBuilder
-
Configuration for the Liveness processing.
This class is used as a parameters for
See more-[RFSFaceSDK startLivenessFrom:animated:configuration:onLiveness:completion:]
. The configuration provides convenient properties to change the behavior and the appearance of the Liveness UI module.Declaration
Objective-C
@interface RFSLivenessConfiguration : RFSBaseConfiguration <RFSLivenessConfigurationBuilder *> <NSObject>
Swift
class LivenessConfiguration : BaseConfiguration<LivenessConfigurationBuilder>, NSObjectProtocol
-
Undocumented
See moreDeclaration
Objective-C
@interface RFSLivenessContentView : RFSPassthroughView <RFSOverriding>
Swift
class LivenessContentView : PassthroughView, Overriding
-
Undocumented
See moreDeclaration
Objective-C
@interface RFSLivenessProcessingContentView : RFSPassthroughView <RFSOverriding>
Swift
class LivenessProcessingContentView : PassthroughView, Overriding
-
The response from the Liveness module.
See moreDeclaration
Objective-C
@interface RFSLivenessResponse : NSObject
Swift
class LivenessResponse : NSObject
-
See moreRFSMatchFacesComparedFace
represents a reference information of the compared face.Declaration
Objective-C
@interface RFSMatchFacesComparedFace : NSObject
Swift
class MatchFacesComparedFace : NSObject
-
See moreRFSMatchFacesComparedFacesPair
represents a result of theRFSMatchFacesRequest
attempt to compare input images.Declaration
Objective-C
@interface RFSMatchFacesComparedFacesPair : NSObject
Swift
class MatchFacesComparedFacesPair : NSObject
-
Undocumented
See moreDeclaration
Objective-C
@interface RFSMatchFacesConfigurationBuilder : RFSBaseConfigurationBuilder
Swift
class MatchFacesConfigurationBuilder : BaseConfigurationBuilder
-
Undocumented
See moreDeclaration
Objective-C
@interface RFSMatchFacesConfiguration : RFSBaseConfiguration <RFSMatchFacesConfigurationBuilder *> <NSObject>
Swift
class MatchFacesConfiguration : BaseConfiguration<MatchFacesConfigurationBuilder>, NSObjectProtocol
-
See moreRFSMatchFacesDetection
represents detection results on an input image as a part ofRFSMatchFacesResponse
.Declaration
Objective-C
@interface RFSMatchFacesDetection : NSObject
Swift
class MatchFacesDetection : NSObject
-
See moreRFSMatchFacesDetectionFace
represents face detection information as a part ofRFSMatchFacesResponse
.Declaration
Objective-C
@interface RFSMatchFacesDetectionFace : NSObject
Swift
class MatchFacesDetectionFace : NSObject
-
This class represents the input image and its attributes for
See moreRFSMatchFacesRequest
.Declaration
Objective-C
@interface RFSMatchFacesImage : NSObject
Swift
class MatchFacesImage : NSObject
-
RFSMatchFacesRequest
compares two or more images with faces on them to find out the similarity of pairs.The request is used as a parameter to
See more-[RFSFaceSDK matchFaces:completion:]
.Declaration
Objective-C
@interface RFSMatchFacesRequest : NSObject
Swift
class MatchFacesRequest : NSObject
-
The response from the
See moreRFSMatchFacesRequest
.Declaration
Objective-C
@interface RFSMatchFacesResponse : NSObject
Swift
class MatchFacesResponse : NSObject
-
See moreRFSMatchFacesSimilarityThresholdSplit
is a result of a splits operation Use splitPairs operation on matched faces pairs with similarityThreshold to split the results into matched and unmatched groups.Declaration
Objective-C
@interface RFSMatchFacesSimilarityThresholdSplit : NSObject
Swift
class MatchFacesSimilarityThresholdSplit : NSObject
-
Crop settings for
See moreRFSOutputImageParams
.Declaration
Objective-C
@interface RFSOutputImageCrop : NSObject
Swift
class OutputImageCrop : NSObject
-
Set of parameter for image processing.
See moreDeclaration
Objective-C
@interface RFSOutputImageParams : NSObject
Swift
class OutputImageParams : NSObject
-
The view that will only handle subview’s touch events. Other events are passed through.
Declaration
Objective-C
@interface RFSPassthroughView : UIView
Swift
class PassthroughView : UIView
-
A Person Database object that represents Person.
See moreDeclaration
Objective-C
@interface RFSPerson : RFSDBBaseItem
-
See moreRFSPersonDatabase
represents Regula Database layer and is the entry point for Person Database operations.Declaration
Objective-C
@interface RFSPersonDatabase : NSObject <RFSPersonDatabaseInterface>
Swift
class PersonDatabase : NSObject, PersonDatabaseInterface
-
Person Database object that represents Group of persons.
See moreDeclaration
Objective-C
@interface RFSPersonGroup : RFSDBBaseItem
-
A PersonData object that represents Image linked with a Person.
See moreDeclaration
Objective-C
@interface RFSPersonImage : RFSDBBaseItem
-
Point class represents a two number X, Y value.
See moreDeclaration
Objective-C
@interface RFSPoint : NSObject
Swift
class Point : NSObject
-
Undocumented
See moreDeclaration
Objective-C
@interface RFSSearchPersonDetection : NSObject /// Absolute coordinates of five points of each detected face: left eye, right eye, nose, left point of lips, right point of lips. @property (nonatomic, strong, readonly) NSArray<RFSPoint *> *landmarks; /// Rectangular area of the detected face in the original image. @property (nonatomic, assign, readonly) CGRect rect; /// Base64 image of the aligned and cropped portrait. /// Returned if `RFSDetectFacesConfiguration.outputImageParams` is set or predefined scenario is used. @property (nullable, nonatomic, strong, readonly) UIImage *crop; /// Rotation is measured counterclockwise in degrees, with zero indicating that a line drawn between the eyes is horizontal relative to the image orientation. @property (nonatomic, strong, readonly) NSNumber *rotationAngle; @end
-
A Person Database object that represents Image result of Person Search.
See moreDeclaration
Objective-C
@interface RFSSearchPersonImage : RFSPersonImage
-
Request object that configures Search settings.
See moreDeclaration
Objective-C
@interface RFSSearchPersonRequest : NSObject
-
Undocumented
See moreDeclaration
Objective-C
@interface RFSUIConfiguration : NSObject RFS_EMPTY_INIT_UNAVAILABLE - (instancetype)initWithBuilder:(RFSUIConfigurationBuilder *)builder NS_DESIGNATED_INITIALIZER; + (instancetype)defaultConfiguration; + (instancetype)configurationWithBuilderBlock:(void (^)(RFSUIConfigurationBuilder *))builderBlock; - (UIColor *)colorForItem:(RFSCustomizationColor)item; - (UIImage *)imageForItem:(RFSCustomizationImage)item; - (UIFont *)fontForItem:(RFSCustomizationFont)item; @end
Swift
class UIConfiguration : NSObject
-
Undocumented
See moreDeclaration
Objective-C
@interface RFSUIConfigurationBuilder : NSObject RFS_EMPTY_INIT_UNAVAILABLE - (void)setColor:(UIColor *)color forItem:(RFSCustomizationColor)item; - (void)setImage:(UIImage *)image forItem:(RFSCustomizationImage)item; - (void)setFont:(UIFont *)font forItem:(RFSCustomizationFont)item; @end
Swift
class UIConfigurationBuilder : NSObject