Interface IDocumentScannerHandle

interface IDocumentScannerHandle {
    detectAndCrop(): Promise<DocumentDetectionResult>;
    disableAutoCapture(): void;
    dispose(): void;
    enableAutoCapture(): void;
    fetchAvailableCameras(): Promise<CameraInfo[]>;
    getActiveCameraInfo(): CameraInfo;
    isAutoCaptureEnabled(): boolean;
    setTorchState(state): Promise<void>;
    swapCameraFacing(force?): void;
    switchCamera(deviceId, mirrored?): void;
}

Hierarchy

  • IScannerCommon
    • IDocumentScannerHandle

Methods

detectAndCrop disableAutoCapture dispose enableAutoCapture fetchAvailableCameras getActiveCameraInfo isAutoCaptureEnabled setTorchState swapCameraFacing switchCamera

Methods

detectAndCrop

disableAutoCapture

  • disableAutoCapture(): void

  • Returns void

dispose

  • dispose(): void

  • Returns void

enableAutoCapture

  • enableAutoCapture(): void

  • Returns void

fetchAvailableCameras

  • fetchAvailableCameras(): Promise<CameraInfo[]>

  • Returns Promise<CameraInfo[]>

getActiveCameraInfo

  • getActiveCameraInfo(): CameraInfo

  • Returns CameraInfo

isAutoCaptureEnabled

  • isAutoCaptureEnabled(): boolean

  • Returns boolean

setTorchState

  • setTorchState(state): Promise<void>

  • Parameters

    • state: boolean

    Returns Promise<void>

swapCameraFacing

  • swapCameraFacing(force?): void

  • Parameters

    • Optional force: boolean

    Returns void

switchCamera

  • switchCamera(deviceId, mirrored?): void

  • Parameters

    • deviceId: string
    • Optional mirrored: boolean

    Returns void

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc