Class TimelineAudioTrack

Handles audio playback for a timeline audio track.

Runtime mutation: The track model is read fresh every frame during evaluate(). You can mutate track.volume, clip.start, clip.end, clip.asset.volume etc. at any time — changes take effect on the next frame without rebuilding the timeline.

Audio stopping: Audio clips are automatically stopped when:

  • Timeline time moves outside a clip's [start, end] range (e.g. jumping or normal playback advancing past a clip)
  • The track is muted (via muted = true)
  • The director is stopped (director.stop())
  • The director is paused (director.pause())
  • The director is disabled or destroyed

Hierarchy (View Summary)

Constructors

constructor

Accessors

muted volume

Methods

addModel evaluate evaluateWeight forEachClip getClipTime getClipTimeNormalized loadAudio onAllowAudioChanged onDestroy onDisable onEnable? onMuteChanged onPauseChanged onStateChanged? stop dispose

Constructors

constructor

Accessors

muted

  • get muted(): boolean

    Returns boolean

  • set muted(val: boolean): void

    Parameters

    • val: boolean

    Returns void

volume

  • get volume(): number

    Track-level volume multiplier (0–1). Applied on top of per-clip volume each frame.

    Returns number

  • set volume(val: number): void

    Parameters

    • val: number

    Returns void

Methods

addModel

evaluate

evaluateWeight

  • evaluateWeight(
        time: number,
        index: number,
        models: ClipModel[],
        isActive?: boolean,
    ): number

    Parameters

    • time: number
    • index: number
    • models: ClipModel[]
    • isActive: boolean = true

    Returns number

forEachClip

getClipTime

getClipTimeNormalized

loadAudio

  • loadAudio(
        time: number,
        lookAhead?: number,
        lookBehind?: number,
    ): null | Promise<(null | AudioBuffer)[]>

    Call to load audio buffer for a specific time in the track. Can be used to preload the timeline audio

    Parameters

    • time: number
    • lookAhead: number = 0
    • lookBehind: number = 0

    Returns null | Promise<(null | AudioBuffer)[]>

onAllowAudioChanged

  • onAllowAudioChanged(allow: boolean): void

    Parameters

    • allow: boolean

    Returns void

onDestroy

onDisable

OptionalonEnable

onMuteChanged

onPauseChanged

OptionalonStateChanged

  • onStateChanged(isPlaying: boolean): any

    invoked when PlayableDirectory playmode state changes (paused, playing, stopped)

    Parameters

    • isPlaying: boolean

    Returns any

stop

  • stop(): void

    Returns void

Staticdispose

  • dispose(): void

    Returns void

Settings

Member Visibility

On This Page

Constructors
Accessors
Methods