Label Capture Session
Defined in framework ScanditLabelCapture
- LabelCaptureSession
open class LabelCaptureSession : NSObject
Added in version 6.0.0
Holds the ongoing state of capturing data contained in one or more labels. An instance of this class is passed to LabelCaptureListener.labelCapture() when new labels are captured, or existing labels are updated or lost.
The session provides access to all currently tracked labels, including those that are still being progressively captured (incomplete) and those that have all required fields captured (complete). Labels maintain their tracking IDs across multiple frames until they are no longer visible.
Important
The capture session should only be accessed from within labelCapture() to which it is provided as an argument. It is not safe to be accessed from anywhere else since it may be concurrently modified.
Specifically no reference to capturedLabels should be kept and traversed outside of labelCapture(). Instead a copy of the list should be made to avoid concurrent modification. The individual labels can be referenced without copying as they are not further modified.
- capturedLabels
open var capturedLabels: Array<CapturedLabel> { get }
Added in version 6.0.0
List of currently captured labels.
- lastProcessedFrameId
open var lastProcessedFrameId:
Int{ get }Added in version 6.0.0
The identifier of the last processed frame.
- frameSequenceId
open var frameSequenceId:
Int{ get }Added in version 6.1.0
The identifier of the current frame sequence.
Important
As long as there is no interruptions of frames coming from the camera, the frameSequenceId will stay the same, whereas the lastProcessedFrameId will be incremented for every processed frame.