SBSDKDocumentDetectorResult

@interface SBSDKDocumentDetectorResult : NSObject <NSCopying>

This class represents the result of a document detection on an image.

  • The status of the detection.

    Declaration

    Objective-C

    @property (nonatomic, readonly) SBSDKDocumentDetectionStatus status;

    Swift

    var status: SBSDKDocumentDetectionStatus { get }

  • The detected polygon or nil, if no polygon was detected.

    Declaration

    Objective-C

    @property (nonatomic, readonly, nullable) SBSDKPolygon *polygon;

    Swift

    var polygon: SBSDKPolygon? { get }

  • The metrics of the detection. *

    Declaration

    Objective-C

    @property (nonatomic, readonly, nullable) SBSDKDocumentDetectionMetrics *metrics;

    Swift

    var metrics: SBSDKDocumentDetectionMetrics? { get }

  • The size of the detector input image. For convenience.

    Declaration

    Objective-C

    @property (nonatomic, readonly) CGSize detectorImageSize;

    Swift

    var detectorImageSize: CGSize { get }

  • Is YES, if the receiver has one of the following states: SBSDKDocumentDetectionStatusOK, SBSDKDocumentDetectionStatusOK_SmallSize, SBSDKDocumentDetectionStatusOK_BadAngles, SBSDKDocumentDetectionStatusOK_BadAspectRatio or SBSDKDocumentDetectionStatusOK_OffCenter. Otherwise it is NO.

    Declaration

    Objective-C

    @property (nonatomic, readonly) BOOL isDetectionStatusOK;

    Swift

    var isDetectionStatusOK: Bool { get }