Lens Scripting API
    Preparing search index...

    Class SoundSyncTracker

    Tracks music beats and provides events for beat occurrences and playback state changes.

    Returned By: ExternalMusicModule#getSoundSyncTracker

    Hierarchy (View Summary)

    Index

    Properties

    fullSoundSync isPlaying onBeat onDownBeat onPlaybackReset onPlaybackStarted onSoundSyncAvailable onSoundSyncCleared playbackPosition

    Methods

    getTypeName isOfType isSame

    Properties

    fullSoundSync: SoundSync

    The complete beat synchronization data for the current music track.

    isPlaying: boolean

    Indicates whether music is currently playing.

    onBeat: event1<SoundSyncBeat, void>

    Event triggered when any beat occurs in the music.

    onDownBeat: event1<SoundSyncBeat, void>

    Event triggered when a down beat (first beat within a measure) occurs in the music.

    onPlaybackReset: event0<void>

    Event triggered when music playback is stopped or reset.

    onPlaybackStarted: event1<ExternalMusicInfo, void>

    Event triggered when music playback begins, providing information about the track.

    onSoundSyncAvailable: event0<void>

    Event triggered when beat synchronization data becomes available for the track.

    onSoundSyncCleared: event0<void>

    Event triggered when beat synchronization data is cleared, such as when changing tracks.

    playbackPosition: number

    Current playback position (in seconds) of the tracked music.

    Methods

    • Returns true if the object matches or derives from the passed in type.

      Parameters

      • type: string

      Returns boolean

    • Returns true if this object is the same as other. Useful for checking if two references point to the same thing.

      Parameters

      Returns boolean

    Settings

    Member Visibility

    On This Page

    Properties
    Methods