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

    Class SoundMark

    Represents a time interval in a recording where sound was captured.

    A SoundMark identifies the start and end offsets (in milliseconds) of a section of a log that contains recorded audio and the geographic Coordinates associated with that interval.

    Soundmarks are generated automatically during audio recording sessions. Play the .mp4 file with an external media player to play the audio content from the start to the end offsets.

    • TextMark — Textual annotations at specific timestamps in the log.
    • LogMetadata.soundMarks — Retrieve sound marks from a log's metadata.

    Implements

    Index

    Constructors

    Properties

    Methods

    Constructors

    • Creates a SoundMark with the specified start and end offsets and coordinates.

      API users typically do not create SoundMark instances directly.

      Parameters

      • start: number

        Start offset in milliseconds (relative to the beginning of the log).

      • end: number

        End offset in milliseconds (relative to the beginning of the log).

      • coordinates: Coordinates

        Coordinates where the sound was recorded.

      Returns SoundMark

    Properties

    coordinates: Coordinates

    Coordinates associated with the sound interval.

    end: number

    End offset in milliseconds (between 0 and log length).

    start: number

    Start offset in milliseconds (between 0 and log length).

    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 SoundMark