Image Frame Source

Defined in package com.scandit.datacapture.core

ImageFrameSource

class ImageFrameSource : FrameSource

Added in version 8.6.0

To emit the frame set this object as the frame source for the DataCaptureContext and turn it on by changing the desired state to FrameSourceState.ON. This frame source will turn off automatically after the frame is emitted.

Note

This frame source emits a single image and turns off again. To feed a continuous stream of frames from a camera your application owns, use SequenceFrameSource instead — see Sequence Frame Source.

withImage(image)

fun ImageFrameSource.withImage(image: InputImage): ImageFrameSource

Added in version 8.6.0

desiredState

val desiredState: FrameSourceState

Added in version 8.6.0

Implemented from FrameSource. See FrameSource.desiredState.

currentState

val currentState: FrameSourceState

Added in version 8.6.0

Implemented from FrameSource. See FrameSource.currentState.

addListener(listener)

fun addListener(listener: FrameSourceListener)

Added in version 8.6.0

Implemented from FrameSource. See FrameSource.addListener().

removeListener(listener)

fun removeListener(listener: FrameSourceListener)

Added in version 8.6.0

Implemented from FrameSource. See FrameSource.removeListener().

switchToDesiredState(state, callback)

fun switchToDesiredState(state: FrameSourceState,
        callback: ((Boolean) -> Unit)?)

Added in version 8.6.0

Convenience method for FrameSource.switchToDesiredState(): it is same as calling FrameSource.switchToDesiredState() with the second argument set to null.