Image Frame Source

Defined in library scandit_datacapture_core

ImageFrameSource

class ImageFrameSource : FrameSource

Added in version 6.15.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.

Creating an ImageFrameSource per frame and setting it on the DataCaptureContext every time is orders of magnitude slower on this platform: each image has to be encoded to be passed over the bridge, and setting a frame source re-serializes the whole context.

create(bytes)

static ImageFrameSource create(Uint8List bytes)

Added in version 6.15.0

desiredState

FrameSourceState get desiredState

Added in version 6.15.0

Implemented from FrameSource. See FrameSource.desiredState.

currentState

Future<FrameSourceState> get currentState

Added in version 6.15.0

Implemented from FrameSource. See FrameSource.currentState.

addListener(listener)

void addListener(FrameSourceListener? listener)

Added in version 6.15.0

Implemented from FrameSource. See FrameSource.addListener().

removeListener(listener)

void removeListener(FrameSourceListener? listener)

Added in version 6.15.0

Implemented from FrameSource. See FrameSource.removeListener().

switchToDesiredState(state)

Future<void> switchToDesiredState(FrameSourceState state)

Added in version 6.15.0

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

context

DataCaptureContext? context

Added in version 6.7.0

The context this frame source is attached to. When the frame source is currently not attached to a context, null is returned.