SoundSyncTracker
ClassTracks music beats and provides events for beat occurrences and playback state changes.
- Available on all platforms
Index
Properties
Methods
Extends
Properties
fullSoundSync
readonlyfullSoundSync:SoundSync
The complete beat synchronization data for the current music track.
isPlaying
readonlyisPlaying:boolean
Indicates whether music is currently playing.
onBeat
readonlyonBeat:event1<SoundSyncBeat,void>
Event triggered when any beat occurs in the music.
onDownBeat
readonlyonDownBeat:event1<SoundSyncBeat,void>
Event triggered when a down beat (first beat within a measure) occurs in the music.
onPlaybackReset
readonlyonPlaybackReset:event0<void>
Event triggered when music playback is stopped or reset.
onPlaybackStarted
readonlyonPlaybackStarted:event1<ExternalMusicInfo,void>
Event triggered when music playback begins, providing information about the track.
onSoundSyncAvailable
readonlyonSoundSyncAvailable:event0<void>
Event triggered when beat synchronization data becomes available for the track.
onSoundSyncCleared
readonlyonSoundSyncCleared:event0<void>
Event triggered when beat synchronization data is cleared, such as when changing tracks.
playbackPosition
readonlyplaybackPosition:number
Current playback position (in seconds) of the tracked music.
Methods
getTypeName()
staticgetTypeName():TypeName<SoundSyncTracker>
Returns the fully-qualified JavaScript type name for this class (for example, "Component.Camera"). This is a static accessor (no instance required) and returns the same value as the instance getTypeName().
Returns
TypeName<SoundSyncTracker>
Overrides
getTypeName()
getTypeName():
string
Returns the name of this object's type.
Returns
string
Inherited from
isOfType()
isOfType(
type):boolean
Returns true if the object matches or derives from the passed in type.
Parameters
| Parameter | Type |
|---|---|
type | string |
Returns
boolean
Inherited from
isSame()
isSame(
other):boolean
Returns true if this object is the same as other. Useful for checking if two references point to the same thing.
Parameters
| Parameter | Type |
|---|---|
other | ScriptObject |
Returns
boolean