@magiclane/maps-sdk
    Preparing search index...

    Class TextMark

    Represents a textual annotation at a specific moment in a recording.

    A TextMark stores an offset timestamp, geographic Coordinates, and a textual report describing the moment. Text marks are useful for bookmarks, notes, or labeling events during a recording session.

    Text marks are added by calling the Recorder.addTextMark method while recording.

    • SoundMark — Time intervals associated with recorded audio.
    • LogMetadata.textMarks — Retrieve text marks from a log's metadata.
    • Recorder.addTextMark — Add text marks during recording.

    Implements

    Index

    Constructors

    Properties

    Methods

    Constructors

    • Creates a TextMark with the specified offset, coordinates, and report.

      API users typically do not create TextMark instances directly.

      Parameters

      • offset: number

        Timestamp (in milliseconds) of the text mark within the log.

      • coordinates: Coordinates

        Coordinates where the text mark was created.

      • report: string

        The textual note or annotation associated with the mark.

      Returns TextMark

    Properties

    coordinates: Coordinates

    The geographical coordinates where the text mark was recorded.

    offset: number

    The timestamp (in milliseconds) of the text mark within the log.

    report: string

    A textual note or annotation associated with the mark.

    Methods

    • Internal

      Serializes this instance to a JSON-compatible object.

      Used internally, not intended for direct use by consumers. The object structure may change without notice.

      Returns Record<string, any>

    • Internal

      Deserializes a JSON-compatible object to create an instance.

      Used internally, not intended for direct use by consumers. The expected object structure may change without notice.

      Parameters

      • json: any

      Returns TextMark