@audiotool/nexus - v0.0.12
    Preparing search index...

    Type Alias AudioTrack

    key value
    type entity
    key "audioTrack"
    is api.TargetType.AudioTrack

    A track on the timeline that can contain audio regions. Must be attached to an AudioDevice.

    type AudioTrack = {
        groove: PrimitiveField<NexusLocation, "mut">;
        isEnabled: PrimitiveField<boolean, "mut">;
        orderAmongTracks: PrimitiveField<number, "mut">;
        player: PrimitiveField<NexusLocation, "immut">;
    }
    Index

    Properties

    Optionally apply a Groove to the audio.

    key value
    default empty location
    required false
    targets api.TargetType.Groove, meaning one of:
    entities.Groove
    isEnabled: PrimitiveField<boolean, "mut">

    Whether the audio track is enabled or not. When is_enabled=false, no audio is played back on the track.

    key value
    default true
    orderAmongTracks: PrimitiveField<number, "mut">

    Orders the track visually among all tracks (including audio, automation, pattern, and note tracks). If this value isn't unique, the frontend might update it to make it unique.

    key value
    default 0
    range full
    player: PrimitiveField<NexusLocation, "immut">

    The audio track player that receives the audio from this track and forwards it on the processing graph. Currently can only point to an AudioDevice.

    key value
    default no default, required
    required true
    targets api.TargetType.AudioTrackPlayer, meaning one of:
    entities.AudioDevice
    immutable true