Interface SignalTrackBuilder

Builder for signal tracks. Provides .signal() for callback-based signals and .marker() for asset-based markers.

interface SignalTrackBuilder {
    activationTrack(
        name: string,
        binding?: null | Object3D<Object3DEventMap>,
    ): ActivationTrackBuilder;
    animationTrack(
        name: string,
        binding?: null | Object3D<Object3DEventMap> | Animator,
    ): AnimationTrackBuilder;
    audioTrack(
        name: string,
        binding?: null | Object3D<Object3DEventMap> | AudioSource,
        volume?: number,
    ): AudioTrackBuilder;
    build(): TimelineAssetModel;
    controlTrack(name: string): ControlTrackBuilder;
    install(director: PlayableDirector): TimelineAssetModel;
    marker(
        time: number,
        asset: string,
        options?: SignalMarkerOptions,
    ): SignalTrackBuilder;
    markerTrack(name: string): MarkerTrackBuilder;
    muted(muted?: boolean): SignalTrackBuilder;
    signal(
        time: number,
        callback: Function,
        options?: SignalMarkerOptions,
    ): SignalTrackBuilder;
    signalTrack(
        name: string,
        binding?: null | Object3D<Object3DEventMap> | SignalReceiver,
    ): SignalTrackBuilder;
}

Hierarchy (View Summary)

TimelineBuilderBase
- SignalTrackBuilder

Index

Methods

activationTrack animationTrack audioTrack build controlTrack install marker markerTrack muted signal signalTrack

Methods

activationTrack

activationTrack(
name: string,
binding?: null | Object3D<Object3DEventMap>,
): ActivationTrackBuilder
Adds an activation track. Chain .clip() to define activation windows.
Parameters
- name: string
- Optionalbinding: null | Object3D<Object3DEventMap>
Returns ActivationTrackBuilder
Inherited from TimelineBuilderBase.activationTrack

animationTrack

animationTrack(
name: string,
binding?: null | Object3D<Object3DEventMap> | Animator,
): AnimationTrackBuilder
Adds an animation track. Chain .clip() or .track() to add content.
Parameters
- name: string
- Optionalbinding: null | Object3D<Object3DEventMap> | Animator
Returns AnimationTrackBuilder
Inherited from TimelineBuilderBase.animationTrack

audioTrack

audioTrack(
    name: string,
    binding?: null | Object3D<Object3DEventMap> | AudioSource,
    volume?: number,
): AudioTrackBuilder
Adds an audio track. Chain .clip() to add audio clips.
Parameters
- name: string
- Optionalbinding: null | Object3D<Object3DEventMap> | AudioSource
- Optionalvolume: number
Returns AudioTrackBuilder
Inherited from TimelineBuilderBase.audioTrack

build

build(): TimelineAssetModel
Builds and returns the TimelineAssetModel.

Returns TimelineAssetModel
Inherited from TimelineBuilderBase.build

controlTrack

controlTrack(name: string): ControlTrackBuilder
Adds a control track. Chain .clip() to control nested objects/timelines.
Parameters
- name: string
Returns ControlTrackBuilder
Inherited from TimelineBuilderBase.controlTrack

install

install(director: PlayableDirector): TimelineAssetModel
Builds the timeline, assigns it to the director, and wires up signal callbacks.
Parameters
- director: PlayableDirector
Returns TimelineAssetModel
Inherited from TimelineBuilderBase.install

marker

marker(
    time: number,
    asset: string,
    options?: SignalMarkerOptions,
): SignalTrackBuilder
Adds a signal marker referencing a signal asset by guid
Parameters
- time: number
- asset: string
- Optionaloptions: SignalMarkerOptions
Returns SignalTrackBuilder

markerTrack

markerTrack(name: string): MarkerTrackBuilder
Adds a marker track. Chain .marker() to add markers.
Parameters
- name: string
Returns MarkerTrackBuilder
Inherited from TimelineBuilderBase.markerTrack

muted

muted(muted?: boolean): SignalTrackBuilder
Mutes this track so it is skipped during playback
Parameters
- Optionalmuted: boolean
Returns SignalTrackBuilder

signal

signal(
    time: number,
    callback: Function,
    options?: SignalMarkerOptions,
): SignalTrackBuilder
Adds a signal with a callback that fires at the given time
Parameters
- time: number
- callback: Function
- Optionaloptions: SignalMarkerOptions
Returns SignalTrackBuilder

signalTrack

signalTrack(
name: string,
binding?: null | Object3D<Object3DEventMap> | SignalReceiver,
): SignalTrackBuilder
Adds a signal track. Chain .signal() or .marker() to add events.
Parameters
- name: string
- Optionalbinding: null | Object3D<Object3DEventMap> | SignalReceiver
Returns SignalTrackBuilder
Inherited from TimelineBuilderBase.signalTrack