ValueRegion
interface ValueRegion extends LoopableRegion, ValueEventOwner {
uuid: string
position: number
duration: number
complete: number
mute: boolean
label: string
hue: number
loopDuration: number
loopOffset: number
events: readonly ValueEvent[]
track: ValueTrack
remove(): void
addEvent(props?: ValueEventProps): ValueEvent
addEvents(events: readonly Partial<Pick<ValueEvent, 'value' | 'position' | 'interpolation'>>[]): readonly ValueEvent[]
clearEvents(): void
}Region holding automation points
Hierarchy
Properties
uuid: string
Inherited from uuid
Unique id
position: number
Inherited from position
Start position in PPQN
duration: number
Inherited from duration
Length in PPQN (seconds for non-synced audio regions)
complete: number
Inherited from complete
End position (position + duration)
mute: boolean
Inherited from mute
Mute the region
label: string
Inherited from label
Custom label
hue: number
Inherited from hue
Color hue (0 to 360)
loopDuration: number
Inherited from loopDuration
Loop cycle length in PPQN (seconds for non-synced audio regions)
loopOffset: number
Inherited from loopOffset
Loop start offset in PPQN (seconds for non-synced audio regions)
events: readonly ValueEvent[]
Inherited from events
All events sorted by position
track: ValueTrack
The automation track this region belongs to
- See:
Methods
remove(): void
Inherited from remove
Remove the region
Returns
void
addEvent(props?: ValueEventProps): ValueEvent
Inherited from addEvent
Add an automation point (defaults: position 0, value 0, linear). Two points at the same position form a step
Parameters
props(ValueEventProps, optional)
Returns
addEvents(
events: readonly Partial<Pick<ValueEvent, 'value' | 'position' | 'interpolation'>>[],
): readonly ValueEvent[]
Inherited from addEvents
Add many points at once
Parameters
events(readonly Partial<Pick<ValueEvent, "value" | "position" | "interpolation">>[])
Returns
clearEvents(): void
Inherited from clearEvents
Remove all points
Returns
void