Type Alias AutomationEvent

A point created when clicking on an automation region

type AutomationEvent = {
    collection: PrimitiveField<NexusLocation, "immut">;
    interpolation: PrimitiveField<number, "mut">;
    positionTicks: PrimitiveField<number, "mut">;
    slope: PrimitiveField<number, "mut">;
    value: PrimitiveField<number, "mut">;
}

Properties

The collection to which this event belongs

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

interpolation: PrimitiveField<number, "mut">

Interpolation mode

key	value
default	1
range	[1, 2]

positionTicks: PrimitiveField<number, "mut">

The position of this event in ticks in the collection.

position_ticks must be unique among all automation events pointing to the same automation collection.

key	value
default	0
range	full

slope: PrimitiveField<number, "mut">

If interpolation is set to "sloped", then this value controls how much the value is sloped in on or the other direction:

key	value
default	0
range	[-1, 1]

value: PrimitiveField<number, "mut">

The value of the automation event.

key	value
default	0
range	[0, 1]