capacitor-plugin-scanbot-sdk
    Preparing search index...

    Type Alias DocumentCustomUIResultCallbacks

    type DocumentCustomUIResultCallbacks = {
        onError?: (error: SBError) => Promise<void> | void;
        onFrameDetectionResult?: (
            detectionResult: DocumentDetectionStatus,
        ) => Promise<void> | void;
        onSnappedDocumentResult: (
            originalImage: ImageRef,
            documentImage?: ImageRef,
            detectionResult?: DocumentDetectionResult,
        ) => Promise<void> | void;
    }
    Index

    Properties

    onError? onFrameDetectionResult? onSnappedDocumentResult

    Properties

    onError?: (error: SBError) => Promise<void> | void

    Called when an error is reported.

    onFrameDetectionResult?: (
        detectionResult: DocumentDetectionStatus,
    ) => Promise<void> | void

    Called whenever the document frame detection status changes.

    onSnappedDocumentResult: (
        originalImage: ImageRef,
        documentImage?: ImageRef,
        detectionResult?: DocumentDetectionResult,
    ) => Promise<void> | void

    Called when a document is snapped. Provides the original image and, when enabled, the detected document crop and detection result.

    Settings

    Member Visibility

    On This Page

    Properties