renoise.PatternTrackAutomation
Graphical automation of a device parameter within a pattern track.
General remarks: Automation “time” is specified in lines + optional 1/256 line fraction for the sub line grid. The sub line grid has 256 units per line. All times are internally quantized to this sub line grid. For example a time of 1.5 means: line 1 with a note column delay of 128
- Constants
- Properties
- dest_device :
renoise.AudioDevice - dest_parameter :
renoise.DeviceParameter - playmode :
renoise.PatternTrackAutomation.Playmode - playmode_observable :
renoise.Document.Observable - length :
integer - selection_start :
integer - selection_start_observable :
renoise.Document.Observable - selection_end :
integer - selection_end_observable :
renoise.Document.Observable - selection_range : { 1 :
integer, 2 :integer} - selection_range_observable :
renoise.Document.Observable - points :
EnvelopePoint[] - points_observable :
renoise.Document.ObservableList
- dest_device :
- Functions
- Structs
Constants
Playmode
{ PLAYMODE_POINTS: integer = 1, PLAYMODE_LINES: integer = 2, PLAYMODE_CURVES: integer = 3, }
Properties
dest_device : renoise.AudioDevice
Destination device. Can in some rare circumstances be nil, i.e. when a device or track is about to be deleted.
dest_parameter : renoise.DeviceParameter
Destination device’s parameter. Can in some rare circumstances be nil, i.e. when a device or track is about to be deleted.
playmode : renoise.PatternTrackAutomation.Playmode
play-mode (interpolation mode).
playmode_observable : renoise.Document.Observable
READ-ONLY
length : integer
Max length (time in lines) of the automation. Will always fit the patterns length. Range: (1 - NUM_LINES_IN_PATTERN) READ-ONLY
selection_start : integer
Selection range as visible in the automation editor, always valid. 1 when no selection is present. Range: (1 - automation.length + 1)
selection_start_observable : renoise.Document.Observable
READ-ONLY
selection_end : integer
Selection range as visible in the automation editor, always valid. The automation’s length + 1 when no selection is present. Range: (1 - automation.length + 1)
selection_end_observable : renoise.Document.Observable
READ-ONLY
selection_range : { 1 : integer, 2 : integer }
Selection range as visible in the automation editor, always valid. Get or set selection range. when setting an empty table, the existing selection, if any, will be cleared. The whole automation range when no selection is present. Range: (1 - automation.length + 1)
selection_range_observable : renoise.Document.Observable
READ-ONLY
points : EnvelopePoint[]
Get all points of the automation. When setting a new list of points, items may be unsorted by time, but there may not be multiple points for the same time. Returns a copy of the list, so changing
points[1].valuewill not do anything. Instead, change them viapoints = { modified_points }.
points_observable : renoise.Document.ObservableList
READ-ONLY
Functions
clear(self)
Removes all points from the automation. Will not delete the automation from tracks[]:automation, instead the resulting automation will not do anything at all.
clear_range(self, from_time : integer, to_time : integer)
Remove all existing points in the given [from, to) time range from the automation.
copy_from(self, other : renoise.PatternTrackAutomation)
Copy all points and playback settings from another track automation.
has_point_at(self, time : integer)
->boolean
Test if a point exists at the given time
add_point_at(self, time : integer, value : number, scaling : number?)
Insert a new point, or change an existing one, if a point in time already exists.
remove_point_at(self, time : integer)
Removes a point at the given time. Point must exist.
Structs
EnvelopePoint
Single point within a pattern track automation envelope.
Properties
time : integer
Automation point’s time in pattern lines in Range: (1 - NUM_LINES_IN_PATTERN).
value : number
Automation point value in Range: (0 - 1.0)
scaling : number
Automation point scaling. Used in ‘lines’ playback mode only - 0.0 is linear.