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

    Type Alias Note

    key value
    type entity
    key "note"
    is

    A note on the timeline

    type Note = {
        collection: PrimitiveField<NexusLocation, "immut">;
        doesSlide: PrimitiveField<boolean, "mut">;
        durationTicks: PrimitiveField<number, "mut">;
        pitch: PrimitiveField<number, "mut">;
        positionTicks: PrimitiveField<number, "mut">;
        velocity: PrimitiveField<number, "mut">;
    }
    Index

    Properties

    collection: PrimitiveField<NexusLocation, "immut">

    The collection to which this note belongs

    key value
    default no default, required
    required true
    targets api.TargetType.NoteCollection, meaning one of:
    entities.NoteCollection
    immutable true
    doesSlide: PrimitiveField<boolean, "mut">

    If does_slide is true, there's only one note playing at a given time, and if two notes overlap, the pitch slides from one pitch to the other for the duration of the overlap.

    key value
    default false
    durationTicks: PrimitiveField<number, "mut">

    The duration of the note in ticks.

    key value
    default 960
    range full
    pitch: PrimitiveField<number, "mut">

    Pitch according to MIDI standard. 60 = C4 (middle C). The actual frequency of the note depends on the base frequency in the config entity and potentially configs of audio producing devices.

    key value
    default 60
    range [0, 127]
    positionTicks: PrimitiveField<number, "mut">

    The position of the note in ticks.

    key value
    default 0
    range full
    velocity: PrimitiveField<number, "mut">

    Velocity between 0 and 1; the meaning of this value is up to whatever is using the note.

    key value
    default 0.699999988079071
    range [0, 1]