Returns true if this port is connected to o, otherwise false.
Returns flags
Returns Port short name
C‡: boost::shared_ptr< ARDOUR::AudioPlaylist >, boost::weak_ptr< ARDOUR::AudioPlaylist >
@@ -380,6 +387,7 @@ Pointer Classes cannot be created in Lua scripts. It always requires a call to CReturns true if this port is connected to o, otherwise false.
Returns flags
Returns Port short name
C‡: std::map<std::string, ARDOUR::PortManager::DPM >
+ +| Constructor | ||
|---|---|---|
| ℂ | ARDOUR.AudioPortMeters () | |
| Methods | ||
| LuaTable | add (std::string, ARDOUR::PortManager::DPM ) | |
| ... | at (--lua--) | |
| void | clear () | |
| unsigned long | count (std::string) | |
| bool | empty () | |
| LuaIter | iter () | |
| unsigned long | size () | |
| LuaTable | table () | |
C‡: ARDOUR::AudioRange
@@ -443,7 +469,7 @@ Pointer Classes cannot be created in Lua scripts. It always requires a call to C| Methods | |||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| AudioSource | audio_source (unsigned int) | ||||||||||||||||||||||||||||||||||||||||
| AutomationList | envelope () | ||||||||||||||||||||||||||||||||||||||||
| bool | envelope_active () | ||||||||||||||||||||||||||||||||||||||||
| bool | fade_in_active () | ||||||||||||||||||||||||||||||||||||||||
| bool | fade_out_active () | ||||||||||||||||||||||||||||||||||||||||
| bool | isnil () | ||||||||||||||||||||||||||||||||||||||||
Returns the maximum (rms) signal power of the region, or a -1 if the Progress object reports that the process was cancelled. | |||||||||||||||||||||||||||||||||||||||||
| float | scale_amplitude () | ||||||||||||||||||||||||||||||||||||||||
| LuaTable(int, ...) | separate_by_channel (RegionVector&) | ||||||||||||||||||||||||||||||||||||||||
| void | set_envelope_active (bool) | ||||||||||||||||||||||||||||||||||||||||
| void | set_fade_in_active (bool) | ||||||||||||||||||||||||||||||||||||||||
| void | set_fade_in_length (long) | ||||||||||||||||||||||||||||||||||||||||
| void | set_fade_in_shape (FadeShape) | ||||||||||||||||||||||||||||||||||||||||
| bool | automatic () | ||||||||||||||||||||||||||||||||||||||||
| bool | can_move () | ||||||||||||||||||||||||||||||||||||||||
| bool | captured () | ||||||||||||||||||||||||||||||||||||||||
| void | captured_xruns (XrunPositions&, bool) | ||||||||||||||||||||||||||||||||||||||||
| void | clear_sync_position () | ||||||||||||||||||||||||||||||||||||||||
| Control | control (Parameter, bool) | ||||||||||||||||||||||||||||||||||||||||
| bool | covers (long) | ||||||||||||||||||||||||||||||||||||||||
| Methods | |||||||||||||||||||||||||||||||||||||||||
| std::string | ancestor_name () | ||||||||||||||||||||||||||||||||||||||||
| bool | can_be_analysed () | ||||||||||||||||||||||||||||||||||||||||
| XrunPositions | captured_xruns () | ||||||||||||||||||||||||||||||||||||||||
| bool | has_been_analysed () | ||||||||||||||||||||||||||||||||||||||||
| long | natural_position () | ||||||||||||||||||||||||||||||||||||||||
| long | timeline_position () | ||||||||||||||||||||||||||||||||||||||||
| Methods | |||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Region | bounce (InterThreadInfo&) | ||||||||||||||||||||||||||||||||||||||||
| Region | bounce (InterThreadInfo&, std::string) | ||||||||||||||||||||||||||||||||||||||||
bounce track from session start to session end to new region
Returns a new audio region (or nil in case of error) | |||||||||||||||||||||||||||||||||||||||||
| Region | bounce_range (long, long, InterThreadInfo&, Processor, bool) | ||||||||||||||||||||||||||||||||||||||||
| Region | bounce_range (long, long, InterThreadInfo&, Processor, bool, std::string) | ||||||||||||||||||||||||||||||||||||||||
Bounce the given range to a new audio region.
Returns a new audio region (or nil in case of error) | |||||||||||||||||||||||||||||||||||||||||
| bool | bounceable (Processor, bool) | ||||||||||||||||||||||||||||||||||||||||
Test if the track can be bounced with the given settings. If sends/inserts/returns are present in the signal path or the given track has no audio outputs bouncing is not possible.
Returns true if the track can be bounced, or false otherwise. | |||||||||||||||||||||||||||||||||||||||||
| bool | set_name (std::string) | ||||||||||||||||||||||||||||||||||||||||
| int | use_copy_playlist () | ||||||||||||||||||||||||||||||||||||||||
| int | use_new_playlist (DataType) | ||||||||||||||||||||||||||||||||||||||||
| int | use_playlist (DataType, Playlist) | ||||||||||||||||||||||||||||||||||||||||
| int | use_playlist (DataType, Playlist, bool) | ||||||||||||||||||||||||||||||||||||||||
| Cast | |||||||||||||||||||||||||||||||||||||||||
| AudioTrack | to_audio_track () | ||||||||||||||||||||||||||||||||||||||||
| MidiTrack | to_midi_track () | ||||||||||||||||||||||||||||||||||||||||
| Methods | |||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| bool | active () | ||||||||||||||||||||||||||||||||||||||||
| int | add_aux_send (Route, Processor) | ||||||||||||||||||||||||||||||||||||||||
Add an aux send to a route.
| |||||||||||||||||||||||||||||||||||||||||
| int | add_foldback_send (Route, bool) | ||||||||||||||||||||||||||||||||||||||||
| int | add_processor_by_index (Processor, int, ProcessorStreams, bool) | ||||||||||||||||||||||||||||||||||||||||
Add a processor to a route such that it ends up with a given index into the visible processors.
Returns 0 on success, non-0 on failure. | |||||||||||||||||||||||||||||||||||||||||
| bool | add_sidechain (Processor) | ||||||||||||||||||||||||||||||||||||||||
| IO | input () | ||||||||||||||||||||||||||||||||||||||||
| Delivery | main_outs () | ||||||||||||||||||||||||||||||||||||||||
the signal processorat at end of the processing chain which produces output | |||||||||||||||||||||||||||||||||||||||||
| MonitorControl | monitoring_control () | ||||||||||||||||||||||||||||||||||||||||
| MonitorState | monitoring_state () | ||||||||||||||||||||||||||||||||||||||||
| bool | muted () | ||||||||||||||||||||||||||||||||||||||||
| ChanCount | n_inputs () | ||||||||||||||||||||||||||||||||||||||||
| ChanCount | n_outputs () | ||||||||||||||||||||||||||||||||||||||||
reset plugin-insert configuration to default, disable customizations. This is equivalent to calling customize_plugin_insert (proc, 0, unused)
Returns true if successful | |||||||||||||||||||||||||||||||||||||||||
| void | set_active (bool, void*) | ||||||||||||||||||||||||||||||||||||||||
| void | set_comment (std::string, void*) | ||||||||||||||||||||||||||||||||||||||||
| void | set_meter_point (MeterPoint, bool) | ||||||||||||||||||||||||||||||||||||||||
| void | set_meter_point (MeterPoint) | ||||||||||||||||||||||||||||||||||||||||
| bool | set_strict_io (bool) | ||||||||||||||||||||||||||||||||||||||||
| long | signal_latency () | ||||||||||||||||||||||||||||||||||||||||
| bool | soloed () | ||||||||||||||||||||||||||||||||||||||||
| Methods | ||
|---|---|---|
| ParameterList | all_automatable_params () | |
API for Lua binding | ||
| AutomationControl | automation_control (Parameter, bool) | |
| bool | isnil () | |
| Cast | ||
| Methods | ||
|---|---|---|
| ParameterList | all_automatable_params () | |
API for Lua binding | ||
| AutomationControl | automation_control (Parameter, bool) | |
| Cast | ||
| Slavable | to_slavable () | |
| Methods | ||
|---|---|---|
| void | add (double, double, bool, bool) | |
add automation events
| ||
Add an event to this list. This method is intended to write automation in realtime. If the transport is stopped, guard-points will be added regardless of parameter with_guards.
| ||
| void | clear (double, double) | |
remove all automation events between the given time range
| ||
Remove all events in the given time range from this list.
| ||
| void | clear_list () | |
| bool | editor_add (double, double, bool) | |
Add an event to this list. This method is intended for making manual changes from the GUI. An event will only be created if no other event exists at the given time.
Returns true if an event was added. | ||
| double | eval (double) | |
query value at given time (takes a read-lock, not safe while writing automation)
Returns parameter value | ||
Queries the event value at the given time (takes a read-lock, not safe while writing automation).
Returns parameter value | ||
| EventList | events () | |
Returns the list of events | ||
| bool | in_write_pass () | |
Returns true if transport is running and this list is in write mode | ||
| InterpolationStyle | interpolation () | |
query interpolation style of the automation data Returns Interpolation Style | ||
| LuaTable(double, ...) | rt_safe_eval (double, bool&) | |
realtime safe version of eval, may fail if read-lock cannot be taken
Returns parameter value | ||
Realtime safe version of eval(). This may fail if a read-lock cannot be taken.
Returns parameter value | ||
| bool | set_interpolation (InterpolationStyle) | |
set the interpolation style of the automation data. This will fail when asking for Logarithmic scale and min,max crosses 0 or Exponential scale with min != 0.
Returns true if style change was successful | ||
Sets the interpolation style of the automation data. This will fail when asking for Logarithmic scale and min,max crosses 0 or Exponential scale with min != 0.
Returns true if style change was successful | ||
| unsigned long | size () | |
| void | thin (double) | |
Thin the number of events in this list. The thinning factor corresponds to the area of a triangle computed between three points in the list (time-difference * value-difference). If the area is large, it indicates significant non-linearity between the points. Time is measured in samples, value is usually normalized to 0..1. During automation recording we thin the recorded points using this value. If a point is sufficiently co-linear with its neighbours (as defined by the area of the triangle formed by three of them), we will not include it in the list. The larger the value, the more points are excluded, so this effectively measures the amount of thinning to be done.
| ||
| void | truncate_end (double) | |
truncate the event list after the given time
| ||
Remove all events after the given time from this list.
| ||
| void | truncate_start (double) | |
truncate the event list to the given time
| ||
Remove all events up to to the given time from this list.
| ||
| Cast | ||
| AutomationList | to_automationlist () | |
C‡: std::vector<ARDOUR::AudioBackendInfo const* >
@@ -940,6 +986,40 @@ Pointer Classes cannot be created in Lua scripts. It always requires a call to CC‡: boost::shared_ptr< ARDOUR::Bundle >, boost::weak_ptr< ARDOUR::Bundle >
+ +A set of `channels', each of which is associated with 0 or more ports. Each channel has a name which can be anything useful, and a data type. Intended for grouping things like, for example, a buss' outputs. `Channel' is a rather overloaded term but I can't think of a better one right now.
| Methods | ||
|---|---|---|
| std::string | channel_name (unsigned int) | |
Returns Channel name. | ||
| bool | isnil () | |
| unsigned int | n_total () | |
| std::string | name () | |
Returns Bundle name | ||
| ChanCount | nchannels () | |
Returns Number of channels that this Bundle has | ||
| bool | ports_are_inputs () | |
| bool | ports_are_outputs () | |
| Cast | ||
| UserBundle | to_userbundle () | |
C‡: boost::shared_ptr<std::vector<boost::shared_ptr<ARDOUR::Bundle> > >
+ +| Constructor | ||
|---|---|---|
| ℂ | ARDOUR.BundleListPtr () | |
| Methods | ||
| LuaTable | add (LuaTable {Bundle}) | |
| Bundle | at (unsigned long) | |
| bool | empty () | |
| LuaIter | iter () | |
| void | push_back (Bundle) | |
| unsigned long | size () | |
| LuaTable | table () | |
C‡: ARDOUR::ChanCount
@@ -1051,7 +1131,7 @@ Pointer Classes cannot be created in Lua scripts. It always requires a call to CInstantiate Biquad Filter
setup filter, compute coefficients
setup filter, compute coefficients
setup filter, set coefficients directly
process current data in buffer | ||
| float | freq_at_bin (unsigned int) | |
| float | power_at_bin (unsigned int, float) | |
query
Returns signal power at given bin (in dBFS) | ||
query
Returns signal power at given bin (in dBFS) | ||
| void | set_data_hann (FloatArray, unsigned int, unsigned int) | |
C‡: boost::shared_ptr< ARDOUR::InternalReturn >, boost::weak_ptr< ARDOUR::InternalReturn >
is-a: ARDOUR:Return
-A mixer strip element (Processor) with 1 or 2 IO elements.
A mixer strip element - plugin, send, meter, etc
| Methods | |||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| bool | isnil () | ||||||||||||||||||||||||||||||||||||||||
| DiskReader | to_diskreader () | ||||||||||||||||||||||||||||||||||||||||
| DiskWriter | to_diskwriter () | ||||||||||||||||||||||||||||||||||||||||
| PluginInsert | to_insert () | ||||||||||||||||||||||||||||||||||||||||
| InternalSend | to_internalsend () | ||||||||||||||||||||||||||||||||||||||||
| IOProcessor | to_ioprocessor () | ||||||||||||||||||||||||||||||||||||||||
| Latent | to_latent () | ||||||||||||||||||||||||||||||||||||||||
| PeakMeter | to_meter () | ||||||||||||||||||||||||||||||||||||||||
| Methods | ||
|---|---|---|
| bool | allow_feedback () | |
| std::string | display_name () | |
| bool | feeds (Route) | |
| bool | isnil () | |
| void | set_allow_feedback (bool) | |
| bool | set_name (std::string) | |
| Route | source_route () | |
| Route | target_route () | |
| Methods | ||
|---|---|---|
| GainControl | gain_control () | |
| long | get_delay_in () | |
| long | get_delay_out () | |
| bool | is_foldback () | |
| void | set_remove_on_disconnect (bool) | |
| Cast | ||
| InternalSend | to_internalsend () | |
| bool | active () | ||||||||||||||||||||||||||||||||||||||||
| long | capture_offset () | ||||||||||||||||||||||||||||||||||||||||
| void | deactivate () | ||||||||||||||||||||||||||||||||||||||||
| std::string | display_name () | ||||||||||||||||||||||||||||||||||||||||
| bool | display_to_user () | ||||||||||||||||||||||||||||||||||||||||
| long | input_latency () | ||||||||||||||||||||||||||||||||||||||||
| ChanCount | input_streams () | ||||||||||||||||||||||||||||||||||||||||
| DiskReader | to_diskreader () | ||||||||||||||||||||||||||||||||||||||||
| DiskWriter | to_diskwriter () | ||||||||||||||||||||||||||||||||||||||||
| PluginInsert | to_insert () | ||||||||||||||||||||||||||||||||||||||||
| InternalSend | to_internalsend () | ||||||||||||||||||||||||||||||||||||||||
| IOProcessor | to_ioprocessor () | ||||||||||||||||||||||||||||||||||||||||
| Latent | to_latent () | ||||||||||||||||||||||||||||||||||||||||
| PeakMeter | to_meter () | ||||||||||||||||||||||||||||||||||||||||
| Methods | |||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| long | end () | ||||||||||||||||||||||||||||||||||||||||
| long | _end () | ||||||||||||||||||||||||||||||||||||||||
| Flags | flags () | ||||||||||||||||||||||||||||||||||||||||
| bool | is_auto_loop () | ||||||||||||||||||||||||||||||||||||||||
| bool | is_auto_punch () | ||||||||||||||||||||||||||||||||||||||||
| Methods | ||
|---|---|---|
| Location | add_range (long, long) | |
Add new range to the collection
Returns New location object | ||
| Location | auto_loop_location () | |
| Location | auto_punch_location () | |
| LuaTable(...) | find_all_between (long, long, LocationList&, Flags) | |
| Location | mark_at (long, long) | |
| LuaTable(...) | marks_either_side (long, long&, long&) | |
Look for the `marks' (either locations which are marks, or start/end points of range markers) either side of a sample. Note that if sample is exactly on a `mark', that mark will not be considered for returning as before/after.
| ||
| Location | range_starts_at (long, long, bool) | |
Return range with closest start pos to the where argument
Returns Location object or nil | ||
| void | remove (Location) | |
| Location | session_range_location () | |
A convenience function to expand RGBA parameters from an integer
convert a Canvas::Color (uint32_t 0xRRGGBBAA) into double RGBA values which can be passed as parameters to Cairo::Context::set_source_rgba
Example:
local r, g, b, a = ARDOUR.LuaAPI.color_to_rgba (0x88aa44ff) cairo_ctx:set_source_rgba (ARDOUR.LuaAPI.color_to_rgba (0x11336699)
Returns 4 parameters: red, green, blue, alpha (in range 0..1)
Write a list of untagged plugins to a file, so we can bulk-tag them
Returns path to XML file or empty string on error
List all installed plugins
create a new Lua Processor (Plugin)
Returns Processor object (may be nil)
create a new Lua Processor (Plugin)
Returns Processor object (may be nil)
create a new Plugin Instance
Returns Processor or nil
search a Plugin
Returns PluginInfo or nil if not found
create a new Plugin Instance
Returns Processor or nil
search a Plugin
Returns PluginInfo or nil if not found
add a new [external] Send to the given Route
A convenience function to get a Automation Lists and ParamaterDescriptor for a given plugin control.
This is equivalent to the following lua code
function (processor, param_id) local plugininsert = processor:to_insert () @@ -2014,6 +2126,8 @@ Pointer Classes cannot be created in Lua scripts. It always requires a call to Creset a processor to its default values (only works for plugins )
This is a wrapper which looks up the Processor by plugin-insert.
- proc
- Plugin-Insert
Returns true on success, false when the processor is not a plugin
... sample_to_timecode (--lua--) + Generic conversion from audio sample count to timecode. (TimecodeType, sample-rate, sample-pos)
+ void segfault () Crash Test Dummy
bool set_plugin_insert_param (PluginInsert, unsigned int, float) set a plugin control-input parameter value
This is a wrapper around set_processor_param which looks up the Processor by plugin-insert.
- pi
- Plugin-Insert
- which
- control-input to set (starting at 0)
- value
- value to set
Returns true on success, false on error or out-of-bounds value
@@ -2021,6 +2135,8 @@ Pointer Classes cannot be created in Lua scripts. It always requires a call to C bool set_processor_param (Processor, unsigned int, float) ... timecode_to_sample (--lua--) Generic conversion from timecode to audio sample count. (TimecodeType, sample-rate, hh, mm, ss, ff)
+ void usleep (unsigned long) + bool wait_for_process_callback (unsigned long, long) Delay execution until next prcess cycle starts.
- n_cycles
- process-cycles to wait for. 0: means wait until next cycle-start, otherwise skip given number of cycles.
- timeout_ms
- wait at most this many milliseconds
Returns true on success, false if timeout was reached or engine was not running
C‡: ARDOUR::LuaAPI::Rubberband
@@ -2089,6 +2205,8 @@ Pointer Classes cannot be created in Lua scripts. It always requires a call to CReturns Last preset to be requested; the settings may have been changed since; find out with parameter_changed_since_last_preset.
Set parameters using a preset
C‡: std::map<std::string, ARDOUR::PortManager::MPM >
+ +| Constructor | ||
|---|---|---|
| ℂ | ARDOUR.MIDIPortMeters () | |
| Methods | ||
| LuaTable | add (std::string, ARDOUR::PortManager::MPM ) | |
| ... | at (--lua--) | |
| void | clear () | |
| unsigned long | count (std::string) | |
| bool | empty () | |
| LuaIter | iter () | |
| unsigned long | size () | |
| LuaTable | table () | |
C‡: ARDOUR::Meter
@@ -2183,7 +2317,7 @@ Pointer Classes cannot be created in Lua scripts. It always requires a call to CReallocate the buffer used internally to handle at least size_t units of data.
The buffer is not silent after this operation. the capacity argument passed to the constructor must have been non-zero.
| Methods | ||
|---|---|---|
| ParameterList | all_automatable_params () | |
API for Lua binding | ||
| AutomationControl | automation_control (Parameter, bool) | |
| Cast | ||
| Slavable | to_slavable () | |
| RegionListPtr | regions_with_end_within (Range) | |
| RegionListPtr | regions_with_start_within (Range) | |
| void | remove_region (Region) | |
| bool | set_name (std::string) | |
| bool | shared () | |
| void | split_region (Region, MusicSample) | |
| Region | top_region_at (long) | |
Returns true if this port is connected to o, otherwise false. | ||
| int | disconnect (std::string) | |
| int | disconnect_all () | |
| PortFlags | flags () | |
Returns flags | ||
| LuaTable(...) | get_connected_latency_range (LatencyRange&, bool) | |
| std::string | name () | |
Returns Port short name | ||
| bool | automatic () | |
| bool | can_move () | |
| bool | captured () | |
| void | captured_xruns (XrunPositions&, bool) | |
| void | clear_sync_position () | |
| Control | control (Parameter, bool) | |
| bool | covers (long) | |
| Methods | ||
| std::string | ancestor_name () | |
| bool | can_be_analysed () | |
| XrunPositions | captured_xruns () | |
| bool | has_been_analysed () | |
| long | natural_position () | |
| long | timeline_position () | |
| Methods | ||
|---|---|---|
| bool | isnil () | |
| bool | write_immediate_event (EventType, unsigned long, unsigned char*) | |
| Methods | ||
|---|---|---|
| Region | bounce (InterThreadInfo&) | |
| Region | bounce (InterThreadInfo&, std::string) | |
bounce track from session start to session end to new region
Returns a new audio region (or nil in case of error) | ||
| Region | bounce_range (long, long, InterThreadInfo&, Processor, bool) | |
| Region | bounce_range (long, long, InterThreadInfo&, Processor, bool, std::string) | |
Bounce the given range to a new audio region.
Returns a new audio region (or nil in case of error) | ||
| bool | bounceable (Processor, bool) | |
Test if the track can be bounced with the given settings. If sends/inserts/returns are present in the signal path or the given track has no audio outputs bouncing is not possible.
Returns true if the track can be bounced, or false otherwise. | ||
| bool | set_name (std::string) | |
| int | use_copy_playlist () | |
| int | use_new_playlist (DataType) | |
| int | use_playlist (DataType, Playlist) | |
| int | use_playlist (DataType, Playlist, bool) | |
| Cast | ||
| AudioTrack | to_audio_track () | |
| MidiTrack | to_midi_track () | |
| Methods | ||
|---|---|---|
| bool | active () | |
| int | add_aux_send (Route, Processor) | |
Add an aux send to a route.
| ||
| int | add_foldback_send (Route, bool) | |
| int | add_processor_by_index (Processor, int, ProcessorStreams, bool) | |
Add a processor to a route such that it ends up with a given index into the visible processors.
Returns 0 on success, non-0 on failure. | ||
| bool | add_sidechain (Processor) | |
| IO | input () | |
| Delivery | main_outs () | |
the signal processorat at end of the processing chain which produces output | ||
| MonitorControl | monitoring_control () | |
| MonitorState | monitoring_state () | |
| bool | muted () | |
| ChanCount | n_inputs () | |
| ChanCount | n_outputs () | |
reset plugin-insert configuration to default, disable customizations. This is equivalent to calling customize_plugin_insert (proc, 0, unused)
Returns true if successful | ||
| void | set_active (bool, void*) | |
| void | set_comment (std::string, void*) | |
| void | set_meter_point (MeterPoint, bool) | |
| void | set_meter_point (MeterPoint) | |
| bool | set_strict_io (bool) | |
| long | signal_latency () | |
| bool | soloed () | |
| LuaTable | table () | |
| void | unique () | |
C‡: boost::shared_ptr< ARDOUR::MonitorControl >, boost::weak_ptr< ARDOUR::MonitorControl >
+is-a: ARDOUR:SlavableAutomationControl
+ +A PBD::Controllable with associated automation data (AutomationList)
| Methods | ||
|---|---|---|
| bool | isnil () | |
| MonitorChoice | monitoring_choice () | |
| Methods | ||
|---|---|---|
| void | add_master (AutomationControl) | |
| void | clear_masters () | |
| int | get_boolean_masters () | |
| double | get_masters_value () | |
| void | remove_master (AutomationControl) | |
| bool | slaved () | |
| bool | slaved_to (AutomationControl) | |
| Methods | ||
|---|---|---|
| AutomationList | alist () | |
| AutoState | automation_state () | |
| ParameterDescriptor | desc () | |
| double | get_value () | |
Get `internal' value Returns raw value as used for the plugin/processor control port | ||
| double | lower () | |
| double | normal () | |
| void | set_automation_state (AutoState) | |
| void | set_value (double, GroupControlDisposition) | |
Set `internal' value All derived classes must implement this. Basic derived classes will ignore group_override but more sophisticated children, notably those that proxy the value setting logic via an object that is aware of group relationships between this control and others, will find it useful.
| ||
| void | start_touch (double) | |
| void | stop_touch (double) | |
| bool | toggled () | |
| double | upper () | |
| bool | writable () | |
| Cast | ||
| Control | to_ctrl () | |
| SlavableAutomationControl | to_slavable () | |
| Methods | ||
|---|---|---|
| std::string | name () | |
| Methods | ||
|---|---|---|
| void | clear_changes () | |
Forget about any changes to this object's properties | ||
| ID | id () | |
| OwnedPropertyList | properties () | |
C‡: boost::shared_ptr< ARDOUR::MonitorProcessor >, boost::weak_ptr< ARDOUR::MonitorProcessor >
is-a: ARDOUR:Processor
@@ -2712,6 +2915,7 @@ Pointer Classes cannot be created in Lua scripts. It always requires a call to Chigher is more important http://lv2plug.in/ns/ext/port-props#displayPriority
format string for pretty printing
| float | upper | |
Maximum value (in Hz, for frequencies) | ||
C‡: std::vector<Evoral::Parameter >
+ +| Constructor | ||
|---|---|---|
| ℂ | ARDOUR.ParameterList () | |
| Methods | ||
| Parameter | at (unsigned long) | |
| bool | empty () | |
| LuaIter | iter () | |
| unsigned long | size () | |
| LuaTable | table () | |
C‡: boost::shared_ptr< ARDOUR::PeakMeter >, boost::weak_ptr< ARDOUR::PeakMeter >
is-a: ARDOUR:Processor
@@ -2916,6 +3144,7 @@ Pointer Classes cannot be created in Lua scripts. It always requires a call to CReturns Last preset to be requested; the settings may have been changed since; find out with parameter_changed_since_last_preset.
Set parameters using a preset
| DiskReader | to_diskreader () | |
| DiskWriter | to_diskwriter () | |
| PluginInsert | to_insert () | |
| InternalSend | to_internalsend () | |
| IOProcessor | to_ioprocessor () | |
| Latent | to_latent () | |
| PeakMeter | to_meter () | |
| Stateful | to_stateful () | |
| StatefulDestructible | to_statefuldestructible () |
| Methods | ||
|---|---|---|
| std::string | name (PluginType, bool) | |
C‡: boost::shared_ptr< ARDOUR::PolarityProcessor >, boost::weak_ptr< ARDOUR::PolarityProcessor >
is-a: ARDOUR:Processor
@@ -3288,6 +3531,7 @@ Pointer Classes cannot be created in Lua scripts. It always requires a call to CReturns true if this port is connected to o, otherwise false.
Returns flags
C‡: ARDOUR::PortEngine
-PortEngine is an abstract base class that defines the functionality required by Ardour.
A Port is basically an endpoint for a datastream (which can either be continuous, like audio, or event-based, like MIDI). Ports have buffers associated with them into which data can be written (if they are output ports) and from which data can be read (if they input ports). Ports can be connected together so that data written to an output port can be read from an input port. These connections can be 1:1, 1:N OR N:1.
Ports may be associated with software only, or with hardware. Hardware related ports are often referred to as physical, and correspond to some relevant physical entity on a hardware device, such as an audio jack or a MIDI connector. Physical ports may be potentially asked to monitor their inputs, though some implementations may not support this.
Most physical ports will also be considered "terminal", which means that data delivered there or read from there will go to or comes from a system outside of the PortEngine implementation's control (e.g. the analog domain for audio, or external MIDI devices for MIDI). Non-physical ports can also be considered "terminal". For example, the output port of a software synthesizer is a terminal port, because the data contained in its buffer does not and cannot be considered to come from any other port - it is synthesized by its owner.
Ports also have latency associated with them. Each port has a playback latency and a capture latency:
capture latency: how long since the data read from the buffer of a port arrived at at a terminal port. The data will have come from the "outside world" if the terminal port is also physical, or will have been synthesized by the entity that owns the terminal port.
playback latency: how long until the data written to the buffer of port will reach a terminal port.
For more detailed questions about the PortEngine API, consult the JACK API documentation, on which this entire object is based.
This class object is only used indirectly as return-value and function-parameter. It provides no methods by itself.
C‡: std::list<boost::shared_ptr<ARDOUR::Port> >
@@ -3379,6 +3624,7 @@ Pointer Classes cannot be created in Lua scripts. It always requires a call to CC‡: boost::shared_ptr< ARDOUR::PortSet >, boost::weak_ptr< ARDOUR::PortSet >
@@ -3476,6 +3722,7 @@ Pointer Classes cannot be created in Lua scripts. It always requires a call to C| Methods | ||
|---|---|---|
| bool | active () | |
| int | add_aux_send (Route, Processor) | |
Add an aux send to a route.
| ||
| int | add_foldback_send (Route, bool) | |
| int | add_processor_by_index (Processor, int, ProcessorStreams, bool) | |
Add a processor to a route such that it ends up with a given index into the visible processors.
Returns 0 on success, non-0 on failure. | ||
| bool | add_sidechain (Processor) | |
| bool | isnil () | |
| Delivery | main_outs () | |
the signal processorat at end of the processing chain which produces output | ||
| MonitorControl | monitoring_control () | |
| MonitorState | monitoring_state () | |
| bool | muted () | |
| ChanCount | n_inputs () | |
| ChanCount | n_outputs () | |
reset plugin-insert configuration to default, disable customizations. This is equivalent to calling customize_plugin_insert (proc, 0, unused)
Returns true if successful | ||
| void | set_active (bool, void*) | |
| void | set_comment (std::string, void*) | |
| void | set_meter_point (MeterPoint, bool) | |
| void | set_meter_point (MeterPoint) | |
| bool | set_name (std::string) | |
| bool | set_strict_io (bool) | |
| long | signal_latency () | |
| Methods | ||
|---|---|---|
| GainControl | gain_control () | |
| long | get_delay_in () | |
| long | get_delay_out () | |
| bool | is_foldback () | |
| bool | isnil () | |
| void | set_remove_on_disconnect (bool) | |
| Cast | ||
| InternalSend | to_internalsend () | |
| DiskReader | to_diskreader () | |
| DiskWriter | to_diskwriter () | |
| PluginInsert | to_insert () | |
| InternalSend | to_internalsend () | |
| IOProcessor | to_ioprocessor () | |
| Latent | to_latent () | |
| PeakMeter | to_meter () | |
| Methods | ||
|---|---|---|
| bool | abort_empty_reversible_command () | |
Abort reversible commend IFF no undo changes have been collected. Returns true if undo operation was aborted. | ||
| void | abort_reversible_command () | |
abort an open undo command This must only be called after begin_reversible_command () | ||
| bool | actively_recording () | |
| double | actual_speed () | |
| void | add_command (Command) | |
| void | add_internal_send (Route, Processor, Route) | |
| void | add_internal_sends (Route, Placement, RouteListPtr) | |
| int | add_master_bus (ChanCount) | |
| StatefulDiffCommand | add_stateful_diff_command (StatefulDestructiblePtr) | |
create an StatefulDiffCommand from the given object and add it to the stack. This function must only be called after begin_reversible_command. Failing to do so may lead to a crash.
Returns the allocated StatefulDiffCommand (already added via add_command) | ||
| void | begin_reversible_command (std::string) | |
begin collecting undo information This call must always be followed by either begin_reversible_command() or commit_reversible_command()
| ||
| BundleListPtr | bundles () | |
| void | cancel_all_solo () | |
| SessionConfiguration | cfg () | |
| void | clear_all_solo_state (RouteListPtr) | |
| bool | collected_undo_commands () | |
Test if any undo commands were added since the call to begin_reversible_command () This is is useful to determine if an undoable action was performed before adding additional information (e.g. selection changes) to the undo transaction. Returns true if undo operation is valid but empty | ||
| void | commit_reversible_command (Command) | |
finalize an undo command and commit pending transactions This must only be called after begin_reversible_command ()
| ||
| Controllable | controllable_by_id (ID) | |
| long | current_start_sample () | |
| void | disable_record (bool, bool) | |
| AudioEngine | engine () | |
| double | engine_speed () | |
| bool | export_track_state (RouteListPtr, std::string) | |
| unsigned int | get_block_size () | |
| bool | get_play_loop () | |
| Route | monitor_out () | |
| std::string | name () | |
| RouteList | new_audio_route (int, int, RouteGroup, unsigned int, std::string, Flag, unsigned int) | |
| AudioTrackList | new_audio_track (int, int, RouteGroup, unsigned int, std::string, unsigned int, TrackMode) | |
| AudioTrackList | new_audio_track (int, int, RouteGroup, unsigned int, std::string, unsigned int, TrackMode, bool) | |
| RouteList | new_midi_route (RouteGroup, unsigned int, std::string, bool, PluginInfo, PresetRecord, Flag, unsigned int) | |
| MidiTrackList | new_midi_track (ChanCount, ChanCount, bool, PluginInfo, PresetRecord, RouteGroup, unsigned int, std::string, unsigned int, TrackMode) | |
| MidiTrackList | new_midi_track (ChanCount, ChanCount, bool, PluginInfo, PresetRecord, RouteGroup, unsigned int, std::string, unsigned int, TrackMode, bool) | |
| RouteList | new_route_from_template (unsigned int, unsigned int, std::string, std::string, PlaylistDisposition) | |
| RouteGroup | new_route_group (std::string) | |
| long | nominal_sample_rate () | |
| Processor | processor_by_id (ID) | |
| RecordState | record_status () | |
| void | remove_route_group (RouteGroup) | |
| int | rename (std::string) | |
| void | request_bounded_roll (long, long) | |
| void | request_locate (long, LocateTransportDisposition, TransportRequestSource) | |
| void | request_play_loop (bool, bool) | |
| void | request_roll (TransportRequestSource) | |
| void | request_stop (bool, bool, TransportRequestSource) | |
| void | request_transport_speed (double, bool, TransportRequestSource) | |
| void | request_transport_speed (double, TransportRequestSource) | |
| void | reset_xrun_count () | |
| Route | route_by_id (ID) | |
| Route | route_by_name (std::string) | |
| double | timecode_frames_per_second () | |
| ... | timecode_to_sample_lua (--lua--) | |
| bool | transport_rolling () | |
Returns true if the the transport is actively (audible) rolling. playback speed is not zero, and count-in as well as latency-preroll is complete, and _transport_sample changes every process cycle. | ||
| long | transport_sample () | |
| double | transport_speed () | |
| bool | transport_state_rolling () | |
Returns true if the transport state (TFSM) is rolling. Note: the transport may not yet move if pre-roll or count-in in ongoing. | ||
| bool | transport_stopped () | |
Returns true if the transport state (TFSM) is stopped | ||
| bool | transport_stopped_or_stopping () | |
Returns true if the transport state (TFSM) is stopped or stopping | ||
| bool | transport_will_roll_forwards () | |
| StringList | unknown_processors () | |
| VCAManager | vca_manager () | |
| long | worst_input_latency () | |
| DiskReader | to_diskreader () | |
| DiskWriter | to_diskwriter () | |
| PluginInsert | to_insert () | |
| InternalSend | to_internalsend () | |
| IOProcessor | to_ioprocessor () | |
| Latent | to_latent () | |
| PeakMeter | to_meter () | |
| Methods | ||
| std::string | ancestor_name () | |
| bool | can_be_analysed () | |
| XrunPositions | captured_xruns () | |
| bool | empty () | |
| bool | has_been_analysed () | |
| bool | isnil () | |
| Methods | ||
| MeterSection | add_meter (Meter, BBT_TIME, long, PositionLockStyle) | |
| TempoSection | add_tempo (Tempo, double, long, PositionLockStyle) | |
| BBT_TIME | bbt_at_sample (long) | |
| BBT_TIME | bbt_at_sample (long) | |
Returns the BBT time corresponding to the supplied sample position.
Returns the BBT time at the sample position . | ||
| double | exact_beat_at_sample (long, int) | |
| double | exact_qn_at_sample (long, int) | |
| Methods | ||
|---|---|---|
| Region | bounce (InterThreadInfo&) | |
| Region | bounce (InterThreadInfo&, std::string) | |
bounce track from session start to session end to new region
Returns a new audio region (or nil in case of error) | ||
| Region | bounce_range (long, long, InterThreadInfo&, Processor, bool) | |
| Region | bounce_range (long, long, InterThreadInfo&, Processor, bool, std::string) | |
Bounce the given range to a new audio region.
Returns a new audio region (or nil in case of error) | ||
| bool | bounceable (Processor, bool) | |
Test if the track can be bounced with the given settings. If sends/inserts/returns are present in the signal path or the given track has no audio outputs bouncing is not possible.
Returns true if the track can be bounced, or false otherwise. | ||
| bool | set_name (std::string) | |
| int | use_copy_playlist () | |
| int | use_new_playlist (DataType) | |
| int | use_playlist (DataType, Playlist) | |
| int | use_playlist (DataType, Playlist, bool) | |
| Cast | ||
| AudioTrack | to_audio_track () | |
| MidiTrack | to_midi_track () | |
| Methods | ||
|---|---|---|
| bool | active () | |
| int | add_aux_send (Route, Processor) | |
Add an aux send to a route.
| ||
| int | add_foldback_send (Route, bool) | |
| int | add_processor_by_index (Processor, int, ProcessorStreams, bool) | |
Add a processor to a route such that it ends up with a given index into the visible processors.
Returns 0 on success, non-0 on failure. | ||
| bool | add_sidechain (Processor) | |
| IO | input () | |
| Delivery | main_outs () | |
the signal processorat at end of the processing chain which produces output | ||
| MonitorControl | monitoring_control () | |
| MonitorState | monitoring_state () | |
| bool | muted () | |
| ChanCount | n_inputs () | |
| ChanCount | n_outputs () | |
reset plugin-insert configuration to default, disable customizations. This is equivalent to calling customize_plugin_insert (proc, 0, unused)
Returns true if successful | ||
| void | set_active (bool, void*) | |
| void | set_comment (std::string, void*) | |
| void | set_meter_point (MeterPoint, bool) | |
| void | set_meter_point (MeterPoint) | |
| bool | set_strict_io (bool) | |
| long | signal_latency () | |
| bool | soloed () | |
| DiskReader | to_diskreader () | |
| DiskWriter | to_diskwriter () | |
| PluginInsert | to_insert () | |
| InternalSend | to_internalsend () | |
| IOProcessor | to_ioprocessor () | |
| Latent | to_latent () | |
| PeakMeter | to_meter () | |
| Stateful | to_stateful () | |
| StatefulDestructible | to_statefuldestructible () | |
C‡: boost::shared_ptr< ARDOUR::UserBundle >, boost::weak_ptr< ARDOUR::UserBundle >
+is-a: ARDOUR:Bundle
+ +A set of `channels', each of which is associated with 0 or more ports. Each channel has a name which can be anything useful, and a data type. Intended for grouping things like, for example, a buss' outputs. `Channel' is a rather overloaded term but I can't think of a better one right now.
| Methods | ||
|---|---|---|
| bool | isnil () | |
| Methods | ||
|---|---|---|
| std::string | channel_name (unsigned int) | |
Returns Channel name. | ||
| unsigned int | n_total () | |
| std::string | name () | |
Returns Bundle name | ||
| ChanCount | nchannels () | |
Returns Number of channels that this Bundle has | ||
| bool | ports_are_inputs () | |
| bool | ports_are_outputs () | |
| Cast | ||
| UserBundle | to_userbundle () | |
C‡: boost::shared_ptr< ARDOUR::VCA >, boost::weak_ptr< ARDOUR::VCA >
is-a: ARDOUR:Stripable
@@ -5779,6 +6122,24 @@ Pointer Classes cannot be created in Lua scripts. It always requires a call to CC‡: std::vector<long >
+ +| Constructor | ||
|---|---|---|
| ℂ | ARDOUR.XrunPositions () | |
| ℂ | ARDOUR.XrunPositions () | |
| Methods | ||
| LuaTable | add (LuaTable {long}) | |
| long | at (unsigned long) | |
| void | clear () | |
| bool | empty () | |
| LuaIter | iter () | |
| void | push_back (long) | |
| unsigned long | size () | |
| LuaTable | table () | |
| ... | to_array (--lua--) | |
| Methods | ||
|---|---|---|
| std::string | name () | |
| long | position () | |
| Type | type () | |
| Type | _type () | |
C‡: std::list<ArdourMarker* >
@@ -5830,19 +6191,19 @@ Pointer Classes cannot be created in Lua scripts. It always requires a call to CPossibly start the audition of a region.
If r is 0, or not an AudioRegion any current audition is cancelled. If we are currently auditioning r , the audition will be cancelled. Otherwise an audition of r will start.
Returns The current mouse mode (gain, object, range, timefx etc.) (defined in editing_syms.h)
Import existing media
Returns true if the playhead is currently being dragged, otherwise false
| Methods | ||
|---|---|---|
| long | end_sample () | |
| long | length () | |
| long | start () | |
| long | end_sample () | |
| long | length () | |
| long | start () | |
| unsigned int | get_action_table_columns () | |
| bool | get_all_floating_windows_are_dialogs () | |
| bool | get_allow_non_quarter_pulse () | |
| bool | get_automation_edit_cancels_auto_hide () | |
| bool | get_autoplay_files () | |
| bool | get_autoscroll_editor () | |
| bool | get_blink_alert_indicators () | |
| bool | get_boxy_buttons () | |
| bool | get_buggy_gradients () | |
| bool | get_cairo_image_surface () | |
| bool | get_check_announcements () | |
| unsigned long | get_clock_display_limit () | |
| std::string | get_color_file () | |
| bool | get_color_regions_using_track_color () | |
| bool | get_follow_edits () | |
| int | get_font_scale () | |
| bool | get_grid_follows_internal () | |
| bool | get_hide_splash_screen () | |
| bool | get_hiding_groups_deactivates_groups () | |
| std::string | get_icon_set () | |
| InputMeterLayout | get_input_meter_layout () | |
| bool | get_input_meter_scopes () | |
| std::string | get_keyboard_layout () | |
| std::string | get_keyboard_layout_name () | |
| bool | get_link_region_and_track_selection () | |
| unsigned int | get_lock_gui_after_seconds () | |
| unsigned int | get_max_inline_controls () | |
| int | get_max_plugin_chart () | |
| int | get_max_plugin_recent () | |
| float | get_meter_hold () | |
| --MISSING (ARDOUR::MeterLineUp)-- | get_meter_line_up_din () | |
| --MISSING (ARDOUR::MeterLineUp)-- | get_meter_line_up_level () | |
| MeterLineUp | get_meter_line_up_din () | |
| MeterLineUp | get_meter_line_up_level () | |
| float | get_meter_peak () | |
| bool | get_meter_style_led () | |
| --MISSING (ARDOUR::VUMeterStandard)-- | get_meter_vu_standard () | |
| VUMeterStandard | get_meter_vu_standard () | |
| std::string | get_mixer_strip_visibility () | |
| bool | get_name_new_markers () | |
| bool | get_never_display_periodic_midi () | |
| bool | get_open_gui_after_adding_plugin () | |
| bool | get_prefer_inline_over_gui () | |
| bool | get_preview_video_frame_on_drag () | |
| --MISSING (ARDOUR::ClockDeltaMode)-- | get_primary_clock_delta_mode () | |
| ClockDeltaMode | get_primary_clock_delta_mode () | |
| int | get_recent_session_sort () | |
| bool | get_rubberbanding_snaps_to_grid () | |
| unsigned int | get_ruler_granularity () | |
| bool | get_rulers_follow_grid () | |
| bool | get_save_export_analysis_image () | |
| bool | get_save_export_mixer_screenshot () | |
| --MISSING (ARDOUR::ScreenSaverMode)-- | get_screen_saver_mode () | |
| --MISSING (ARDOUR::ClockDeltaMode)-- | get_secondary_clock_delta_mode () | |
| ScreenSaverMode | get_screen_saver_mode () | |
| ClockDeltaMode | get_secondary_clock_delta_mode () | |
| bool | get_show_editor_meter () | |
| bool | get_show_grids_ruler () | |
| bool | get_show_inline_display_by_default () | |
| bool | get_show_mini_timeline () | |
| bool | get_show_name_highlight () | |
| bool | get_show_plugin_scan_window () | |
| bool | get_show_region_cue_markers () | |
| bool | get_show_region_gain () | |
| bool | get_show_region_name () | |
| bool | get_show_region_xrun_markers () | |
| bool | get_show_secondary_clock () | |
| bool | get_show_snapped_cursor () | |
| bool | get_show_toolbar_latency () | |
| bool | get_show_toolbar_monitor_info () | |
| bool | get_show_toolbar_monitoring () | |
| bool | get_show_toolbar_recpunch () | |
| bool | get_show_toolbar_selclock () | |
| bool | get_sound_midi_notes () | |
| std::string | get_stripable_color_palette () | |
| bool | get_super_rapid_clock_update () | |
| int | get_time_axis_name_ellipsize_mode () | |
| float | get_timeline_item_gradient_depth () | |
| bool | get_transients_follow_front () | |
| std::string | get_ui_font_family () | |
| unsigned long | get_waveform_cache_size () | |
| double | get_waveform_clip_level () | |
| float | get_waveform_gradient_depth () | |
| --MISSING (ARDOUR::WaveformScale)-- | get_waveform_scale () | |
| --MISSING (ARDOUR::WaveformShape)-- | get_waveform_shape () | |
| WaveformScale | get_waveform_scale () | |
| WaveformShape | get_waveform_shape () | |
| bool | get_widget_prelight () | |
| bool | set_action_table_columns (unsigned int) | |
| bool | set_all_floating_windows_are_dialogs (bool) | |
| bool | set_allow_non_quarter_pulse (bool) | |
| bool | set_automation_edit_cancels_auto_hide (bool) | |
| bool | set_autoplay_files (bool) | |
| bool | set_autoscroll_editor (bool) | |
| bool | set_blink_alert_indicators (bool) | |
| bool | set_boxy_buttons (bool) | |
| bool | set_buggy_gradients (bool) | |
| bool | set_cairo_image_surface (bool) | |
| bool | set_check_announcements (bool) | |
| bool | set_clock_display_limit (unsigned long) | |
| bool | set_color_file (std::string) | |
| bool | set_color_regions_using_track_color (bool) | |
| bool | set_follow_edits (bool) | |
| bool | set_font_scale (int) | |
| bool | set_grid_follows_internal (bool) | |
| bool | set_hide_splash_screen (bool) | |
| bool | set_hiding_groups_deactivates_groups (bool) | |
| bool | set_icon_set (std::string) | |
| bool | set_input_meter_layout (InputMeterLayout) | |
| bool | set_input_meter_scopes (bool) | |
| bool | set_keyboard_layout (std::string) | |
| bool | set_keyboard_layout_name (std::string) | |
| bool | set_link_region_and_track_selection (bool) | |
| bool | set_lock_gui_after_seconds (unsigned int) | |
| bool | set_max_inline_controls (unsigned int) | |
| bool | set_max_plugin_chart (int) | |
| bool | set_max_plugin_recent (int) | |
| bool | set_meter_hold (float) | |
| bool | set_meter_line_up_din (--MISSING (ARDOUR::MeterLineUp)--) | |
| bool | set_meter_line_up_level (--MISSING (ARDOUR::MeterLineUp)--) | |
| bool | set_meter_line_up_din (MeterLineUp) | |
| bool | set_meter_line_up_level (MeterLineUp) | |
| bool | set_meter_peak (float) | |
| bool | set_meter_style_led (bool) | |
| bool | set_meter_vu_standard (--MISSING (ARDOUR::VUMeterStandard)--) | |
| bool | set_meter_vu_standard (VUMeterStandard) | |
| bool | set_mixer_strip_visibility (std::string) | |
| bool | set_name_new_markers (bool) | |
| bool | set_never_display_periodic_midi (bool) | |
| bool | set_open_gui_after_adding_plugin (bool) | |
| bool | set_prefer_inline_over_gui (bool) | |
| bool | set_preview_video_frame_on_drag (bool) | |
| bool | set_primary_clock_delta_mode (--MISSING (ARDOUR::ClockDeltaMode)--) | |
| bool | set_primary_clock_delta_mode (ClockDeltaMode) | |
| bool | set_recent_session_sort (int) | |
| bool | set_rubberbanding_snaps_to_grid (bool) | |
| bool | set_ruler_granularity (unsigned int) | |
| bool | set_rulers_follow_grid (bool) | |
| bool | set_save_export_analysis_image (bool) | |
| bool | set_save_export_mixer_screenshot (bool) | |
| bool | set_screen_saver_mode (--MISSING (ARDOUR::ScreenSaverMode)--) | |
| bool | set_secondary_clock_delta_mode (--MISSING (ARDOUR::ClockDeltaMode)--) | |
| bool | set_screen_saver_mode (ScreenSaverMode) | |
| bool | set_secondary_clock_delta_mode (ClockDeltaMode) | |
| bool | set_show_editor_meter (bool) | |
| bool | set_show_grids_ruler (bool) | |
| bool | set_show_inline_display_by_default (bool) | |
| bool | set_show_mini_timeline (bool) | |
| bool | set_show_name_highlight (bool) | |
| bool | set_show_plugin_scan_window (bool) | |
| bool | set_show_region_cue_markers (bool) | |
| bool | set_show_region_gain (bool) | |
| bool | set_show_region_name (bool) | |
| bool | set_show_region_xrun_markers (bool) | |
| bool | set_show_secondary_clock (bool) | |
| bool | set_show_snapped_cursor (bool) | |
| bool | set_show_toolbar_latency (bool) | |
| bool | set_show_toolbar_monitor_info (bool) | |
| bool | set_show_toolbar_monitoring (bool) | |
| bool | set_show_toolbar_recpunch (bool) | |
| bool | set_show_toolbar_selclock (bool) | |
| bool | set_sound_midi_notes (bool) | |
| bool | set_stripable_color_palette (std::string) | |
| bool | set_super_rapid_clock_update (bool) | |
| bool | set_time_axis_name_ellipsize_mode (int) | |
| bool | set_timeline_item_gradient_depth (float) | |
| bool | set_transients_follow_front (bool) | |
| bool | set_ui_font_family (std::string) | |
| bool | set_waveform_cache_size (unsigned long) | |
| bool | set_waveform_clip_level (double) | |
| bool | set_waveform_gradient_depth (float) | |
| bool | set_waveform_scale (--MISSING (ARDOUR::WaveformScale)--) | |
| bool | set_waveform_shape (--MISSING (ARDOUR::WaveformShape)--) | |
| bool | set_waveform_scale (WaveformScale) | |
| bool | set_waveform_shape (WaveformShape) | |
| bool | set_widget_prelight (bool) | |
| Properties | ||
|---|---|---|
| unsigned int | action_table_columns | |
| bool | all_floating_windows_are_dialogs | |
| bool | allow_non_quarter_pulse | |
| bool | automation_edit_cancels_auto_hide | |
| bool | autoplay_files | |
| bool | autoscroll_editor | |
| bool | blink_alert_indicators | |
| bool | boxy_buttons | |
| bool | buggy_gradients | |
| bool | cairo_image_surface | |
| bool | check_announcements | |
| unsigned long | clock_display_limit | |
| std::string | color_file | |
| bool | color_regions_using_track_color | |
| bool | follow_edits | |
| int | font_scale | |
| bool | grid_follows_internal | |
| bool | hide_splash_screen | |
| bool | hiding_groups_deactivates_groups | |
| std::string | icon_set | |
| ARDOUR.InputMeterLayout | input_meter_layout | |
| bool | input_meter_scopes | |
| std::string | keyboard_layout | |
| std::string | keyboard_layout_name | |
| bool | link_region_and_track_selection | |
| unsigned int | lock_gui_after_seconds | |
| unsigned int | max_inline_controls | |
| int | max_plugin_chart | |
| int | max_plugin_recent | |
| float | meter_hold | |
| --MISSING (ARDOUR::MeterLineUp)-- | meter_line_up_din | |
| --MISSING (ARDOUR::MeterLineUp)-- | meter_line_up_level | |
| ARDOUR.MeterLineUp | meter_line_up_din | |
| ARDOUR.MeterLineUp | meter_line_up_level | |
| float | meter_peak | |
| bool | meter_style_led | |
| --MISSING (ARDOUR::VUMeterStandard)-- | meter_vu_standard | |
| ARDOUR.VUMeterStandard | meter_vu_standard | |
| std::string | mixer_strip_visibility | |
| bool | name_new_markers | |
| bool | never_display_periodic_midi | |
| bool | open_gui_after_adding_plugin | |
| bool | prefer_inline_over_gui | |
| bool | preview_video_frame_on_drag | |
| --MISSING (ARDOUR::ClockDeltaMode)-- | primary_clock_delta_mode | |
| ARDOUR.ClockDeltaMode | primary_clock_delta_mode | |
| int | recent_session_sort | |
| bool | rubberbanding_snaps_to_grid | |
| unsigned int | ruler_granularity | |
| bool | rulers_follow_grid | |
| bool | save_export_analysis_image | |
| bool | save_export_mixer_screenshot | |
| --MISSING (ARDOUR::ScreenSaverMode)-- | screen_saver_mode | |
| --MISSING (ARDOUR::ClockDeltaMode)-- | secondary_clock_delta_mode | |
| ARDOUR.ScreenSaverMode | screen_saver_mode | |
| ARDOUR.ClockDeltaMode | secondary_clock_delta_mode | |
| bool | show_editor_meter | |
| bool | show_grids_ruler | |
| bool | show_inline_display_by_default | |
| bool | show_mini_timeline | |
| bool | show_name_highlight | |
| bool | show_plugin_scan_window | |
| bool | show_region_cue_markers | |
| bool | show_region_gain | |
| bool | show_region_name | |
| bool | show_region_xrun_markers | |
| bool | show_secondary_clock | |
| bool | show_snapped_cursor | |
| bool | show_toolbar_latency | |
| bool | show_toolbar_monitor_info | |
| bool | show_toolbar_monitoring | |
| bool | show_toolbar_recpunch | |
| bool | show_toolbar_selclock | |
| bool | sound_midi_notes | |
| std::string | stripable_color_palette | |
| bool | super_rapid_clock_update | |
| int | time_axis_name_ellipsize_mode | |
| float | timeline_item_gradient_depth | |
| bool | transients_follow_front | |
| std::string | ui_font_family | |
| unsigned long | waveform_cache_size | |
| double | waveform_clip_level | |
| float | waveform_gradient_depth | |
| --MISSING (ARDOUR::WaveformScale)-- | waveform_scale | |
| --MISSING (ARDOUR::WaveformShape)-- | waveform_shape | |
| ARDOUR.WaveformScale | waveform_scale | |
| ARDOUR.WaveformShape | waveform_shape | |
| bool | widget_prelight | |
| Methods | ||
|---|---|---|
| void | add (double, double, bool, bool) | |
add automation events
| ||
Add an event to this list. This method is intended to write automation in realtime. If the transport is stopped, guard-points will be added regardless of parameter with_guards.
| ||
| void | clear (double, double) | |
remove all automation events between the given time range
| ||
Remove all events in the given time range from this list.
| ||
| void | clear_list () | |
| bool | editor_add (double, double, bool) | |
Add an event to this list. This method is intended for making manual changes from the GUI. An event will only be created if no other event exists at the given time.
Returns true if an event was added. | ||
| double | eval (double) | |
query value at given time (takes a read-lock, not safe while writing automation)
Returns parameter value | ||
Queries the event value at the given time (takes a read-lock, not safe while writing automation).
Returns parameter value | ||
| EventList | events () | |
Returns the list of events | ||
| bool | in_write_pass () | |
Returns true if transport is running and this list is in write mode | ||
| InterpolationStyle | interpolation () | |
query interpolation style of the automation data Returns Interpolation Style | ||
| bool | isnil () | |
| LuaTable(double, ...) | rt_safe_eval (double, bool&) | |
realtime safe version of eval, may fail if read-lock cannot be taken
Returns parameter value | ||
Realtime safe version of eval(). This may fail if a read-lock cannot be taken.
Returns parameter value | ||
| bool | set_interpolation (InterpolationStyle) | |
set the interpolation style of the automation data. This will fail when asking for Logarithmic scale and min,max crosses 0 or Exponential scale with min != 0.
Returns true if style change was successful | ||
Sets the interpolation style of the automation data. This will fail when asking for Logarithmic scale and min,max crosses 0 or Exponential scale with min != 0.
Returns true if style change was successful | ||
| unsigned long | size () | |
| void | thin (double) | |
Thin the number of events in this list. The thinning factor corresponds to the area of a triangle computed between three points in the list (time-difference * value-difference). If the area is large, it indicates significant non-linearity between the points. Time is measured in samples, value is usually normalized to 0..1. During automation recording we thin the recorded points using this value. If a point is sufficiently co-linear with its neighbours (as defined by the area of the triangle formed by three of them), we will not include it in the list. The larger the value, the more points are excluded, so this effectively measures the amount of thinning to be done.
| ||
| void | truncate_end (double) | |
truncate the event list after the given time
| ||
Remove all events after the given time from this list.
| ||
| void | truncate_start (double) | |
truncate the event list to the given time
| ||
Remove all events up to to the given time from this list.
| ||
| Cast | ||
| AutomationList | to_automationlist () | |
C‡: boost::shared_ptr< Evoral::ControlSet >, boost::weak_ptr< Evoral::ControlSet >
@@ -6827,7 +7233,7 @@ Pointer Classes cannot be created in Lua scripts. It always requires a call to CC‡: boost::shared_ptr< Evoral::Note<Temporal::Beats> >, boost::weak_ptr< Evoral::Note<Temporal::Beats> >
@@ -6852,7 +7258,7 @@ Pointer Classes cannot be created in Lua scripts. It always requires a call to CC‡: Evoral::ParameterDescriptor
@@ -7481,6 +7887,12 @@ Pointer Classes cannot be created in Lua scripts. It always requires a call to C