File Duplex/Automation.lua
Functions
Automation:_get_extrapolation_strength () | Retrieve the extrapolation strength from Duplex setting |
Automation:_remove_notifiers (new_song) | Remove all notifiers associated with this class instance |
Automation:add_automation (track_idx, parameter, value) | Add a point at current time (will add new automations on the fly) |
Automation:add_point (ptrack_auto, line, value, automation_lane) | This method is an enhanced version of add_point_at(), as it will wrap at pattern boundaries and create automation on the fly |
Automation:attach_to_song (new_song) | Attach to song (call this from the host application) |
Automation:find_or_create (ptrack, autolane, seq_idx, register) | Find_or_create will always return a PatternTrackAutomation index when provided with a valid PatternTrack. |
Automation:get_automation_index (ptrack, ptrack_auto) | Figure out the track automation's index |
Automation:get_device_by_param (track_idx, parameter) | Figure out the device by supplying a parameter |
Automation:stop_automation () | Stop all currently recording automation |
Automation:update () | Update currently recording automation lanes (this method is designed to be called from within an idle loop) |
Automation:writeahead (amount, ptrack_auto, lane) | "Write-ahead" using extrapolated values (enabled when dealing with cubic/linear envelopes) |
Functions
- Automation:_get_extrapolation_strength ()
- Retrieve the extrapolation strength from Duplex setting
- Automation:_remove_notifiers (new_song)
-
Remove all notifiers associated with this class instance
Parameters:
-
new_song
: (Boolean) if defined, do not attempt to remove notifiers
-
- Automation:add_automation (track_idx, parameter, value)
-
Add a point at current time (will add new automations on the fly)
Parameters:
-
track_idx
: (Number) the track index -
parameter
: (DeviceParameter object) -
value
: (number between 0-1)
-
- Automation:add_point (ptrack_auto, line, value, automation_lane)
-
This method is an enhanced version of add_point_at(), as it will wrap at pattern boundaries and create automation on the fly
Parameters:
-
ptrack_auto
: (PatternTrackAutomation) -
line
: (number), line in pattern -
value
: (number), between 0 and 1 -
automation_lane
: (AutomationLane), when called from update()
-
- Automation:attach_to_song (new_song)
-
Attach to song (call this from the host application)
Parameters:
-
new_song
:
-
- Automation:find_or_create (ptrack, autolane, seq_idx, register)
-
Find_or_create will always return a PatternTrackAutomation index when provided with a valid PatternTrack. The PatternTrackAutomation object is created on-the-fly if not already present note: when playback progress into pattern that does not (yet) contain any automation, supply a negative value ("waiting for observable")
Parameters:
-
ptrack
: (PatternTrack) -
autolane
: (AutomationLane) -
seq_idx
: (number) the sequence index -
register
: (boolean) register as "waiting for observable"
Return value:
- (number), the resulting index
-
- Automation:get_automation_index (ptrack, ptrack_auto)
-
Figure out the track automation's index
Parameters:
-
ptrack
: (PatternTrack) -
ptrack_auto
: (PatternTrackAutomation)
Return value:
- (number) the automation index
-
- Automation:get_device_by_param (track_idx, parameter)
-
Figure out the device by supplying a parameter
Parameters:
-
track_idx
: (number) -
parameter
: (DeviceParameter)
Return value:
- TrackDevice
-
- Automation:stop_automation ()
- Stop all currently recording automation
- Automation:update ()
- Update currently recording automation lanes (this method is designed to be called from within an idle loop)
- Automation:writeahead (amount, ptrack_auto, lane)
-
"Write-ahead" using extrapolated values (enabled when dealing with cubic/linear envelopes)
Parameters:
-
amount
: (int), number of extrapolated points, 0 and up -
ptrack_auto
: (PatternTrackAutomation) -
lane
: (AutomationLane)
-