Interface IBarcodeScannerHandle

interface IBarcodeScannerHandle {
    dispose(): void;
    fetchAvailableCameras(): Promise<CameraInfo[]>;
    getActiveCameraInfo(): CameraInfo;
    getCapabilities(): MediaTrackCapabilities;
    getResolution(): Promise<Size>;
    isDetectionPaused(): boolean;
    pauseDetection(): void;
    resumeDetection(): void;
    saveExtractedImageData(): void;
    setFinderVisible(isVisible): void;
    setRecognitionResolution(resolution): void;
    setTorchState(state): Promise<void>;
    setZoom(zoom): void;
    swapCameraFacing(force?): void;
    switchCamera(deviceId, mirrored?): void;
    updateTorch(enabled): void;
}

Hierarchy

  • IScannerCommon
    • IBarcodeScannerHandle

Methods

dispose fetchAvailableCameras getActiveCameraInfo getCapabilities getResolution isDetectionPaused pauseDetection resumeDetection saveExtractedImageData setFinderVisible setRecognitionResolution setTorchState setZoom swapCameraFacing switchCamera updateTorch

Methods

dispose

  • dispose(): void

  • Returns void

fetchAvailableCameras

  • fetchAvailableCameras(): Promise<CameraInfo[]>

  • Returns Promise<CameraInfo[]>

getActiveCameraInfo

  • getActiveCameraInfo(): CameraInfo

  • Returns CameraInfo

getCapabilities

  • getCapabilities(): MediaTrackCapabilities

  • Returns MediaTrackCapabilities

getResolution

  • getResolution(): Promise<Size>

  • Returns Promise<Size>

isDetectionPaused

  • isDetectionPaused(): boolean

  • Returns boolean

pauseDetection

  • pauseDetection(): void

  • Returns void

resumeDetection

  • resumeDetection(): void

  • Returns void

saveExtractedImageData

  • saveExtractedImageData(): void

  • Returns void

setFinderVisible

  • setFinderVisible(isVisible): void

  • Parameters

    • isVisible: boolean

    Returns void

setRecognitionResolution

  • setRecognitionResolution(resolution): void

  • Parameters

    • resolution: number

    Returns void

setTorchState

  • setTorchState(state): Promise<void>

  • Parameters

    • state: boolean

    Returns Promise<void>

setZoom

  • setZoom(zoom): void

  • Parameters

    • zoom: number

    Returns void

swapCameraFacing

  • swapCameraFacing(force?): void

  • Parameters

    • Optional force: boolean

    Returns void

switchCamera

  • switchCamera(deviceId, mirrored?): void

  • Parameters

    • deviceId: string
    • Optional mirrored: boolean

    Returns void

updateTorch

  • updateTorch(enabled): void

  • Parameters

    • enabled: boolean

    Returns void

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc