Text Capture Session

Defined in namespace Scandit.DataCapture.Text.Capture

class TextCaptureSession

Added in version 6.5.0

The text capture session is responsible for determining the list of relevant texts by filtering out duplicates. This filtering of duplicates is completely time-based and doesn’t use any information about the location of the text. By default, all the texts captured in a frame are always reported. It is possible to filter out texts recently captured by changing TextCaptureSettings.DuplicateFilter.

When the text capture mode is disabled, the session’s duplicate filter is reset.


The tracking session should only be accessed from within OnTextCaptured() 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 NewlyCapturedTexts should be kept and traversed outside of OnTextCaptured(). Instead a copy of the list should be made to avoid concurrent modification. The individual captured texts can be referenced without copying as they are not further modified.

IList<CapturedText> NewlyCapturedTexts { get; }

Added in version 6.5.0

List of texts that were newly captured in the last processed frame.

long FrameSequenceId { get; }

Added in version 6.5.0

The identifier of the current frame sequence.


As long as there is no interruptions of frames coming from the camera, the FrameSequenceId will stay the same.

string ToJson()

Added in version 6.5.0

Returns the JSON representation of the text capture session.