Captured Label
Defined under the namespace Scandit.Datacapture.Label
- CapturedLabel
class CapturedLabelAdded in version 7.2.0
A captured label tracked over multiple frames. This class holds the list of label fields as well as the predicted boundary of the label. Each instance of a found label has a unique tracking Id which remains constant over multiple frames.
Captured labels represent the result of successfully identifying and tracking a label based on a LabelDefinition. The label becomes “complete” when all required fields have been captured, though optional fields may still be added in subsequent frames.
The tracking system allows labels to be followed across multiple camera frames, enabling progressive capture where individual fields are recognized over time until the complete label structure is assembled.
- fields
get fields(): LabelField[]
Added in version 7.2.0
List of fields in the label. For each field defined in the corresponding LabelDefinition, exactly one captured field is returned. The fields contain the actual captured data (barcode values, text content, etc.).
- name
get name(): string
Added in version 7.2.0
The name of this label, e.g. label-a. This property can be used in case multiple different label definitions are used at the same time.
- isComplete
get isComplete(): boolean
Added in version 7.2.0
Whether the label has been completely scanned. Returns true as soon as all the required fields defined in the LabelDefinition are present and successfully captured. Optional fields do not need to be present for this property to be true.
This property is useful for determining when to stop scanning and process the captured label data.
- predictedBounds
get predictedBounds(): Quadrilateral
Added in version 7.2.0
The predicted label bounds in image coordinates. These coordinates represent the estimated outline of the entire label area and will need to be converted to view coordinates before they can be visualized in UI overlays.
The prediction takes into account the label’s movement across frames and provides a more stable bounding box for display purposes.
- deltaTimeToPrediction
get deltaTimeToPrediction(): number
Added in version 7.2.0
The delta time used for predicting the label bounds (predictedBounds) as well as the field locations (available as LabelField.predictedLocation).