| bool | active () | |
| void | deactivate () | |
| std::string | display_name () | |
| bool | display_to_user () | |
| ChanCount | input_streams () | |
| ChanCount | output_streams () | |
| Cast | ||
|---|---|---|
| PeakMeter | to_meter () | |
| MonitorProcessor | to_monitorprocessor () | |
| PeakMeter | to_peakmeter () | |
| PluginInsert | to_plugininsert () | |
| SideChain | to_sidechain () | |
| UnknownProcessor | to_unknownprocessor () | |
| Methods | ||
|---|---|---|
| std::string | name () | |
| unsigned int | output_channels () | |
| std::string | output_device_name () | |
| unsigned int | period_size () | |
| bool | sameinstance (AudioBackend) | |
| float | sample_rate () | |
| int | set_buffer_size (unsigned int) | |
Set the buffer size to be used. The device is assumed to use a double buffering scheme, so that one buffer's worth of data can be processed by hardware while software works on the other buffer. All known suitable audio APIs support this model (though ALSA allows for alternate numbers of buffers, and CoreAudio doesn't directly expose the concept). | ||
check buffer for silence
Returns true if all samples are zero | ||
| FloatArray | data (long) | |
| void | read_from (FloatArray, long, long, long) | |
| bool | sameinstance (AudioBuffer) | |
| void | silence (long, long) | |
silence buffer
| ||
| ||
| Region | find_next_region (long, RegionPoint, int) | |
| long | find_next_region_boundary (long, int) | |
| long | find_next_transient (long, int) | |
| void | lower_region (Region) | |
| void | lower_region_to_bottom (Region) | |
| unsigned int | n_regions () | |
| RegionListPtr | regions_with_start_within (Range) | |
| void | remove_region (Region) | |
| void | split (long) | |
| void | split_region (Region, MusicFrame) | |
| void | split_region (Region, MusicFrame) | |
| Region | top_region_at (long) | |
| Region | top_unmuted_region_at (long) | |
| void | uncombine (Region) | |
| AudioPlaylist | to_audioplaylist () | |
| MidiPlaylist | to_midiplaylist () | |
| Methods | ||
|---|---|---|
| std::string | name () | |
| Methods | ||
|---|---|---|
| bool | isnil () | |
| bool | sameinstance (AudioPort) | |
| Constructor | ||
|---|---|---|
| ℂ | ARDOUR.AudioRangeList () | |
| Methods | ||
| AudioRange | back () | |
| bool | empty () | |
| AudioRange | front () | |
| LuaIter | iter () | |
| void | reverse () | |
| unsigned long | size () | |
Returns the maximum (linear) amplitude of the region, or a -ve number if the Progress object reports that the process was cancelled. | ||
| double | rms (Progress) | |
Returns the maximum (rms) signal power of the region, or a -1 if the Progress object reports that the process was cancelled. | ||
| bool | sameinstance (AudioRegion) | |
| float | scale_amplitude () | |
| void | set_scale_amplitude (float) | |
Returns Sync position in session time
| Methods | ||
|---|---|---|
| std::string | name () | |
| long | read (FloatArray, long, long, int) | |
| long | readable_length () | |
| long | readable_length () | |
| bool | sameinstance (AudioSource) | |
| bool | sameinstance (AudioSource) | |
| float | sample_rate () | |
| Cast | ||
| Readable | to_readable () | |
| bool | writable () | |
| Cast | ||
| AudioSource | to_audiosource () | |
| FileSource | to_filesource () | |
| MidiSource | to_midisource () | |
| Methods | ||
|---|---|---|
| std::string | name () | |
| Methods | ||
|---|---|---|
| bool | isnil () | |
| bool | sameinstance (AudioTrack) | |
************************************************************* Pure interface begins here************************************************************* | ||
| int | remove_processor (Processor, ProcessorStreams, bool) | |
remove plugin/processor
Returns 0 on success | ||
| int | remove_processors (ProcessorList, ProcessorStreams) | |
| bool | remove_sidechain (Processor) | |
| int | reorder_processors (ProcessorList, ProcessorStreams) | |
| int | replace_processor (Processor, Processor, ProcessorStreams) | |
replace plugin/processor with another
Returns 0 on success | ||
| bool | reset_plugin_insert (Processor) | |
| AutomationControl | comp_makeup_control () | |
| AutomationControl | comp_mode_control () | |
| std::string | comp_mode_name (unsigned int) | |
| AutomationControl | comp_redux_control () | |
| --MISSING (boost::shared_ptr<ARDOUR::ReadOnlyControl>)-- | comp_redux_control () | |
| AutomationControl | comp_speed_control () | |
| std::string | comp_speed_name (unsigned int) | |
| AutomationControl | comp_threshold_control () | |
| AutomationControl | eq_enable_control () | |
| AutomationControl | eq_freq_control (unsigned int) | |
| AutomationControl | eq_gain_control (unsigned int) | |
| AutomationControl | eq_hpf_control () | |
| AutomationControl | eq_q_control (unsigned int) | |
| AutomationControl | eq_shape_control (unsigned int) | |
| AutomationControl | filter_enable_controllable (bool) | |
| AutomationControl | filter_freq_controllable (bool) | |
| AutomationControl | filter_slope_controllable (bool) | |
| GainControl | gain_control () | |
| bool | is_auditioner () | |
| bool | is_hidden () | |
| GainControl | trim_control () | |
| Cast | ||
|---|---|---|
| Route | to_route () | |
| VCA | to_vca () | |
| Methods | ||
|---|---|---|
| std::string | name () | |
| ℂ | ARDOUR.AudioTrackList () | |
| Methods | ||
| LuaTable | add (LuaTable {AudioTrack}) | |
| AudioTrack | back () | |
| bool | empty () | |
| AudioTrack | front () | |
| LuaIter | iter () | |
| void | push_back (AudioTrack) | |
| void | reverse () | |
| Methods | ||
| AutomationControl | automation_control (Parameter, bool) | |
| bool | isnil () | |
| bool | sameinstance (Automatable) | |
C‡: boost::shared_ptr< ARDOUR::AutomatableSequence<Evoral::Beats> >, boost::weak_ptr< ARDOUR::AutomatableSequence<Evoral::Beats> >
@@ -681,7 +687,6 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C| Methods | ||
|---|---|---|
| bool | isnil () | |
| bool | sameinstance (AutomatableSequence) | |
| Cast | ||
| Sequence | to_sequence () | |
Get the current effective `user' value based on automation state
C‡: boost::shared_ptr< ARDOUR::AutomationList >, boost::weak_ptr< ARDOUR::AutomationList >
+is-a: Evoral:ControlList
AutomationList is a stateful wrapper around Evoral::ControlList. It includes session-specifics (such as automation state), control logic (e.g. touch, signals) and acts as proxy to the underlying ControlList which holds the actual data.
| XMLNode | get_state () | |
| bool | isnil () | |
| Command | memento_command (XMLNode, XMLNode) | |
| bool | sameinstance (AutomationList) | |
| bool | touch_enabled () | |
| bool | touching () | |
| bool | writing () | |
| Stateful | to_stateful () | |
| StatefulDestructible | to_statefuldestructible () |
| Methods | ||
|---|---|---|
| void | add (double, double, bool, bool) | |
add automation events
| ||
| void | clear (double, double) | |
remove all automation events between the given time range
| ||
| void | clear_list () | |
| double | eval (double) | |
query value at given time (takes a read-lock, not safe while writing automation)
Returns parameter value | ||
| EventList | events () | |
| bool | in_write_pass () | |
| 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 | ||
| void | set_interpolation (InterpolationStyle) | |
set the interpolation style of the automation data
| ||
| 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
| ||
| void | truncate_start (double) | |
truncate the event list to the given time
| ||
C‡: std::vector<ARDOUR::AudioBackendInfo const* >
@@ -752,14 +782,25 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to CC‡: ARDOUR::BeatsFramesConverter
+ +Converter between quarter-note beats and frames. Takes distances in quarter-note beats or frames from some origin (supplied to the constructor in frames), and converts them to the opposite unit, taking tempo changes into account.
| Constructor | ||
|---|---|---|
| ℂ | ARDOUR.BeatsFramesConverter (TempoMap, long) | |
| Methods | ||
| Beats | from (long) | |
Convert B time to A time (A from B) | ||
| long | to (Beats) | |
Convert A time to B time (A to B) | ||
C‡: ARDOUR::BufferSet
@@ -769,7 +810,6 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to CC‡: ARDOUR::ChanCount
@@ -810,6 +850,40 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to Cset buffer mapping for given data type
C‡: std::list<boost::shared_ptr<ARDOUR::AutomationControl> >
+ +| Constructor | ||
|---|---|---|
| ℂ | ARDOUR.ControlList () | |
| Methods | ||
| LuaTable | add (LuaTable {AutomationControl}) | |
| AutomationControl | back () | |
| bool | empty () | |
| AutomationControl | front () | |
| LuaIter | iter () | |
| void | push_back (AutomationControl) | |
| void | reverse () | |
| unsigned long | size () | |
| LuaTable | table () | |
| void | unique () | |
C‡: boost::shared_ptr<std::list<boost::shared_ptr<ARDOUR::AutomationControl> > >
+ +| Constructor | ||
|---|---|---|
| ℂ | ARDOUR.ControlListPtr () | |
| Methods | ||
| LuaTable | add (LuaTable {AutomationControl}) | |
| bool | empty () | |
| LuaIter | iter () | |
| void | push_back (AutomationControl) | |
| void | reverse () | |
| unsigned long | size () | |
| LuaTable | table () | |
| void | unique () | |
| Methods | ||
|---|---|---|
| bool | isnil () | |
| PannerShell | panner_shell () | |
| bool | sameinstance (Delivery) | |
| bool | active () | |
| void | deactivate () | |
| std::string | display_name () | |
| bool | display_to_user () | |
| ChanCount | input_streams () | |
| ChanCount | output_streams () | |
| Cast | ||
|---|---|---|
| PeakMeter | to_meter () | |
| MonitorProcessor | to_monitorprocessor () | |
| PeakMeter | to_peakmeter () | |
| PluginInsert | to_plugininsert () | |
| SideChain | to_sidechain () | |
| UnknownProcessor | to_unknownprocessor () | |
| Methods | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| std::string | name () | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Constructor | ||
|---|---|---|
| ℂ | ARDOUR.DeviceStatusVector () | |
| ℂ | ARDOUR.DeviceStatusVector () | |
| Methods | ||
| LuaTable | add (LuaTable {DeviceStatus}) | |
| DeviceStatus | at (unsigned long) | |
| unsigned long | size () | |
| LuaTable | table () | |
C‡: ARDOUR::DoubleBeatsFramesConverter
+ +Converter between quarter-note beats and frames. Takes distances in quarter-note beats or frames from some origin (supplied to the constructor in frames), and converts them to the opposite unit, taking tempo changes into account.
| Constructor | ||
|---|---|---|
| ℂ | ARDOUR.DoubleBeatsFramesConverter (TempoMap, long) | |
| Methods | ||
| double | from (long) | |
Convert B time to A time (A from B) | ||
| long | to (double) | |
Convert A time to B time (A to B) | ||
C‡: std::list<Evoral::ControlEvent* >
+ +| Constructor | ||
|---|---|---|
| ℂ | ARDOUR.EventList () | |
| Methods | ||
| ControlEvent | back () | |
| bool | empty () | |
| ControlEvent | front () | |
| LuaIter | iter () | |
| void | reverse () | |
| unsigned long | size () | |
| LuaTable | table () | |
C‡: boost::shared_ptr< ARDOUR::FileSource >, boost::weak_ptr< ARDOUR::FileSource >
+is-a: ARDOUR:Source
+ +A source associated with a file on disk somewhere
| Methods | ||
|---|---|---|
| unsigned short | channel () | |
| float | gain () | |
| bool | isnil () | |
| std::string | origin () | |
| std::string | path () | |
| std::string | take_id () | |
| bool | within_session () | |
| Methods | ||
|---|---|---|
| std::string | ancestor_name () | |
| bool | can_be_analysed () | |
| bool | destructive () | |
| bool | empty () | |
| bool | has_been_analysed () | |
| long | length (long) | |
| long | natural_position () | |
| long | timeline_position () | |
| long | timestamp () | |
| int | use_count () | |
| bool | used () | |
| bool | writable () | |
| Cast | ||
| AudioSource | to_audiosource () | |
| FileSource | to_filesource () | |
| MidiSource | to_midisource () | |
| Methods | ||
|---|---|---|
| std::string | name () | |
| Cast | ||
| Stateful | to_stateful () | |
| StatefulDestructible | to_statefuldestructible () | |
C‡: ARDOUR::FluidSynth
@@ -1019,7 +1166,6 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C| Methods | ||
|---|---|---|
| bool | isnil () | |
| bool | sameinstance (GainControl) | |
| bool | writable () | |
| Cast | ||
|---|---|---|
| Control | to_ctrl () | |
| SlavableAutomationControl, | to_slavable () | |
C‡: boost::shared_ptr< ARDOUR::IO >, boost::weak_ptr< ARDOUR::IO >
-is-a: ARDOUR:SessionObject
+is-a: ARDOUR:SessionObjectPtr
A collection of ports (all input or all output) with connections.
An IO can contain ports of varying types, making routes/inserts/etc with varied combinations of types (eg MIDI and audio) possible.
| bool | physically_connected () | |
| Port | port_by_name (unsigned int) | |
| int | remove_port (Port, void*) | |
| bool | sameinstance (IO) |
| Methods | ||
|---|---|---|
| std::string | name () | |
| ChanCount | natural_input_streams () | |
| ChanCount | natural_output_streams () | |
| IO | output () | |
| bool | sameinstance (IOProcessor) | |
| bool | active () | |
| void | deactivate () | |
| std::string | display_name () | |
| bool | display_to_user () | |
| ChanCount | input_streams () | |
| ChanCount | output_streams () | |
| Cast | ||
|---|---|---|
| PeakMeter | to_meter () | |
| MonitorProcessor | to_monitorprocessor () | |
| PeakMeter | to_peakmeter () | |
| PluginInsert | to_plugininsert () | |
| SideChain | to_sidechain () | |
| UnknownProcessor | to_unknownprocessor () | |
| Methods | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| std::string | name () | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Constructor | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ℂ | ARDOUR.LocationList () | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Methods | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Location | back () | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| bool | empty () | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Location | front () | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| LuaIter | iter () | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| void | reverse () | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| unsigned long | size () | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Methods | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ... | build_filename (--lua--) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Creates a filename from a series of elements using the correct separator for filenames. No attempt is made to force the resulting filename to be an absolute path. If the first element is a relative path, the result will be a relative path. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ... | color_to_rgba (--lua--) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| LuaTable(float, ...) | get_plugin_insert_param (PluginInsert, unsigned int, bool&) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
get a plugin control parameter value
Returns value | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| LuaTable(float, ...) | get_processor_param (Processor, unsigned int, bool&) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
get a plugin control parameter value
Returns value | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ... | hsla_to_rgba (--lua--) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
A convenience function for colorspace HSL to RGB conversion. All ranges are 0..1 Example: local r, g, b, a = ARDOUR.LuaAPI.hsla_to_rgba (hue, saturation, luminosity, alpha) Returns 4 parameters: red, green, blue, alpha (in range 0..1) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| long | monotonic_time () | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Processor | new_luaproc (Session, std::string) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
create a new Lua Processor (Plugin)
Returns Processor object (may be nil) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| NotePtr | new_noteptr (unsigned char, Beats, Beats, unsigned char, unsigned char) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| PluginInfo | new_plugin_info (std::string, PluginType) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
search a Plugin
Returns PluginInfo or nil if not found | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Processor | nil_proc () | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| NotePtrList | note_list (MidiModel) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ... | plugin_automation (--lua--) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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 () @@ -1308,7 +1462,6 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
char* | name () | LuaTable(unsigned int, ...) | nth_parameter (unsigned int, bool&) | unsigned int | parameter_count () | bool | parameter_is_audio (unsigned int) | bool | parameter_is_control (unsigned int) | bool | parameter_is_input (unsigned int) | bool | parameter_is_output (unsigned int) | std::string | parameter_label (unsigned int) | PresetRecord | preset_by_label (std::string) | PresetRecord | preset_by_uri (std::string) | std::string | unique_id () | bool | push_event (Event) | void | resize (unsigned long) | Reallocate 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. bool | sameinstance (MidiBuffer) | void | silence (long, long) | Clear (eg zero, or empty) buffer unsigned long | size () | bool | isnil () | NoteDiffCommand | new_note_diff_command (std::string) | Start a new NoteDiff command. This has no side-effects on the model or Session, the returned command can be held on to for as long as the caller wishes, or discarded without formality, until apply_command is called and ownership is taken. bool | sameinstance (MidiModel) | | |||||||||||||||||||||||||||||||||||||||||||||
| Methods | ||
|---|---|---|
| bool | isnil () | |
| bool | sameinstance (MidiPlaylist) | |
| void | set_note_mode (NoteMode) | |
| Methods | ||
|---|---|---|
| std::string | name () | |
| MidiBuffer | get_midi_buffer (unsigned int) | |
| bool | input_active () | |
| bool | isnil () | |
| bool | sameinstance (MidiPort) | |
| void | set_input_active (bool) | |
Returns Sync position in session time
| Methods | ||
|---|---|---|
| std::string | name () | |
| bool | isnil () | |
| long | length (long) | |
| MidiModel | model () | |
| bool | sameinstance (MidiSource) | |
| bool | writable () | |
| Cast | ||
|---|---|---|
| AudioSource | to_audiosource () | |
| FileSource | to_filesource () | |
| MidiSource | to_midisource () | |
| Methods | ||
|---|---|---|
| std::string | name () | |
| Methods | ||
|---|---|---|
| bool | isnil () | |
| bool | sameinstance (MidiTrack) | |
************************************************************* Pure interface begins here************************************************************* | ||
| int | remove_processor (Processor, ProcessorStreams, bool) | |
remove plugin/processor
Returns 0 on success | ||
| int | remove_processors (ProcessorList, ProcessorStreams) | |
| bool | remove_sidechain (Processor) | |
| int | reorder_processors (ProcessorList, ProcessorStreams) | |
| int | replace_processor (Processor, Processor, ProcessorStreams) | |
replace plugin/processor with another
Returns 0 on success | ||
| bool | reset_plugin_insert (Processor) | |
| AutomationControl | comp_makeup_control () | |
| AutomationControl | comp_mode_control () | |
| std::string | comp_mode_name (unsigned int) | |
| AutomationControl | comp_redux_control () | |
| --MISSING (boost::shared_ptr<ARDOUR::ReadOnlyControl>)-- | comp_redux_control () | |
| AutomationControl | comp_speed_control () | |
| std::string | comp_speed_name (unsigned int) | |
| AutomationControl | comp_threshold_control () | |
| AutomationControl | eq_enable_control () | |
| AutomationControl | eq_freq_control (unsigned int) | |
| AutomationControl | eq_gain_control (unsigned int) | |
| AutomationControl | eq_hpf_control () | |
| AutomationControl | eq_q_control (unsigned int) | |
| AutomationControl | eq_shape_control (unsigned int) | |
| AutomationControl | filter_enable_controllable (bool) | |
| AutomationControl | filter_freq_controllable (bool) | |
| AutomationControl | filter_slope_controllable (bool) | |
| GainControl | gain_control () | |
| bool | is_auditioner () | |
| bool | is_hidden () | |
| GainControl | trim_control () | |
| Cast | ||
|---|---|---|
| Route | to_route () | |
| VCA | to_vca () | |
| Methods | ||
|---|---|---|
| std::string | name () | |
| ℂ | ARDOUR.MidiTrackList () | |
| Methods | ||
| LuaTable | add (LuaTable {MidiTrack}) | |
| MidiTrack | back () | |
| bool | empty () | |
| MidiTrack | front () | |
| LuaIter | iter () | |
| void | push_back (MidiTrack) | |
| void | reverse () | |
| bool | monitor_active () | |
| bool | mono () | |
| Controllable | mono_control () | |
| bool | sameinstance (MonitorProcessor) | |
| void | set_cut (unsigned int, bool) | |
| void | set_cut_all (bool) | |
| void | set_dim (unsigned int, bool) | |
| bool | active () | |
| void | deactivate () | |
| std::string | display_name () | |
| bool | display_to_user () | |
| ChanCount | input_streams () | |
| ChanCount | output_streams () | |
| Cast | ||
| PeakMeter | to_meter () | |
| MonitorProcessor | to_monitorprocessor () | |
| PeakMeter | to_peakmeter () | |
| PluginInsert | to_plugininsert () | |
| SideChain | to_sidechain () | |
| UnknownProcessor | to_unknownprocessor () | |
| Methods | ||
|---|---|---|
| std::string | name () | |
| bool | isnil () | |
| bool | muted () | |
| bool | muted_by_self () | |
| bool | sameinstance (MuteControl) | |
| bool | writable () | |
| Cast | ||
|---|---|---|
| Control | to_ctrl () | |
| SlavableAutomationControl, | to_slavable () | |
| ID | id () | |
| OwnedPropertyList | properties () |
C‡: std::list<boost::shared_ptr<Evoral::Note<Evoral::Beats> > > >
+ +| Constructor | ||
|---|---|---|
| ℂ | ARDOUR.NotePtrList () | |
| Methods | ||
| LuaTable | add (LuaTable {Beats}) | |
| NotePtr | back () | |
| bool | empty () | |
| NotePtr | front () | |
| LuaIter | iter () | |
| void | push_back (NotePtr) | |
| void | reverse () | |
| unsigned long | size () | |
| LuaTable | table () | |
| void | unique () | |
C‡: PBD::OwnedPropertyList
is-a: ARDOUR:PropertyList
-A variant of PropertyList that does not delete its property list in its destructor. Objects with their own Properties store them in an OwnedPropertyList to avoid having them deleted at the wrong time.
Persistent Property List
A variant of PropertyList that does not delete its property list in its destructor. Objects with their own Properties store them in an OwnedPropertyList to avoid having them deleted at the wrong time.
This class object is only used indirectly as return-value and function-parameter. It provides no methods by itself.
C‡: boost::shared_ptr< ARDOUR::PannerShell >, boost::weak_ptr< ARDOUR::PannerShell >
-is-a: ARDOUR:SessionObject
+is-a: ARDOUR:SessionObjectPtr
Class to manage panning by instantiating and controlling an appropriate Panner object for a given in/out configuration.
| Methods | ||
|---|---|---|
| bool | bypassed () | |
| bool | isnil () | |
| bool | sameinstance (PannerShell) | |
| void | set_bypassed (bool) | |
| Methods | ||
|---|---|---|
| std::string | name () | |
| Constructor | ||
| ℂ | ARDOUR.ParameterDescriptor () | |
| Methods | ||
| std::string | midi_note_name (unsigned char) | |
| std::string | midi_note_name (unsigned char, bool) | |
| Data Members | ||
| std::string | label | |
| bool | logarithmic | |
| bool | isnil () | |
| float | meter_level (unsigned int, MeterType) | |
| void | reset_max () | |
| bool | sameinstance (PeakMeter) | |
| void | set_type (MeterType) | |
| Methods | ||
|---|---|---|
| std::string | name () | |
| Methods | ||
| bool | inverted (unsigned int) | |
| bool | isnil () | |
| bool | sameinstance (PhaseControl) | |
| void | set_phase_invert (unsigned int, bool) | |
| ||
C‡: boost::shared_ptr< ARDOUR::Playlist >, boost::weak_ptr< ARDOUR::Playlist >
-is-a: ARDOUR:SessionObject
+is-a: ARDOUR:SessionObjectPtr
A named object associated with a Session. Objects derived from this class are expected to be destroyed before the session calls drop_references().
| ||
| Region | find_next_region (long, RegionPoint, int) | |
| long | find_next_region_boundary (long, int) | |
| long | find_next_transient (long, int) | |
| bool | isnil () | |
| void | lower_region (Region) | |
| void | lower_region_to_bottom (Region) | |
| RegionListPtr | regions_with_end_within (Range) | |
| RegionListPtr | regions_with_start_within (Range) | |
| void | remove_region (Region) | |
| bool | sameinstance (Playlist) | |
| void | split (long) | |
| void | split_region (Region, MusicFrame) | |
| void | split_region (Region, MusicFrame) | |
| Region | top_region_at (long) | |
| Region | top_unmuted_region_at (long) | |
| void | uncombine (Region) | |
| AudioPlaylist | to_audioplaylist () | |
| MidiPlaylist | to_midiplaylist () | |
| Methods | ||
|---|---|---|
| std::string | name () | |
| char* | name () | |
| LuaTable(unsigned int, ...) | nth_parameter (unsigned int, bool&) | |
| unsigned int | parameter_count () | |
| bool | parameter_is_audio (unsigned int) | |
| bool | parameter_is_control (unsigned int) | |
| bool | parameter_is_input (unsigned int) | |
| bool | parameter_is_output (unsigned int) | |
| std::string | parameter_label (unsigned int) | |
| PresetRecord | preset_by_label (std::string) | |
| PresetRecord | preset_by_uri (std::string) | |
| bool | sameinstance (Plugin) | |
| std::string | unique_id () | |
| Cast | ||
| LuaProc | to_luaproc () | |
| Methods | ||
|---|---|---|
| bool | isnil () | |
| bool | sameinstance (PluginControl) | |
| bool | writable () | |
| Cast | ||
|---|---|---|
| Control | to_ctrl () | |
| SlavableAutomationControl, | to_slavable () | |
| PresetVector | get_presets (bool) | |
| bool | is_instrument () | |
| bool | isnil () | |
| bool | sameinstance (PluginInfo) | |
| Data Members | ||
|---|---|---|
| std::string | category | |
| std::string | creator | |
| ChanMapping | output_map (unsigned int) | |
| Plugin | plugin (unsigned int) | |
| bool | reset_parameters_to_default () | |
| bool | sameinstance (PluginInsert) | |
| void | set_input_map (unsigned int, ChanMapping) | |
| void | set_output_map (unsigned int, ChanMapping) | |
| bool | strict_io_configured () | |
| Methods | ||
| bool | active () | |
| std::string | display_name () | |
| bool | display_to_user () | |
| ChanCount | input_streams () | |
| ChanCount | output_streams () | |
| Cast | ||
| PeakMeter | to_meter () | |
| MonitorProcessor | to_monitorprocessor () | |
| PeakMeter | to_peakmeter () | |
| PluginInsert | to_plugininsert () | |
| SideChain | to_sidechain () | |
| UnknownProcessor | to_unknownprocessor () | |
| Methods | ||
|---|---|---|
| std::string | name () | |
Returns Port human readable name | ||
| bool | receives_input () | |
Returns true if this Port receives input, otherwise false | ||
| bool | sameinstance (Port) | |
| bool | sends_output () | |
Returns true if this Port sends output, otherwise false | ||
| Cast | ||
| Constructor | ||
| ℂ | ARDOUR.PortList () | |
| Methods | ||
| Port | back () | |
| bool | empty () | |
| Port | front () | |
| LuaIter | iter () | |
| void | reverse () | |
| unsigned long | size () | |
| Port | port (DataType, unsigned long) | |
nth port of type t, or nth port if t = NIL
| ||
| bool | remove (Port) | |
| bool | sameinstance (PortSet) | |
C‡: ARDOUR::PresentationInfo
@@ -2433,6 +2617,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C| Constructor | ||
|---|---|---|
| ℂ | ARDOUR.PresetVector () | |
| ℂ | ARDOUR.PresetVector () | |
| Methods | ||
| LuaTable | add (LuaTable {PresetRecord}) | |
| PresetRecord | at (unsigned long) | |
C‡: boost::shared_ptr< ARDOUR::Processor >, boost::weak_ptr< ARDOUR::Processor >
-is-a: ARDOUR:SessionObject
+is-a: ARDOUR:SessionObjectPtr
A mixer strip element - plugin, send, meter, etc
| bool | active () | |
| void | deactivate () | |
| std::string | display_name () | |
| bool | display_to_user () | |
| ChanCount | input_streams () | |
| bool | isnil () | |
| ChanCount | output_streams () | |
| bool | sameinstance (Processor) | |
| Cast | ||
|---|---|---|
| Amp | to_amp () | |
| Automatable | to_automatable () | |
| PeakMeter | to_meter () | |
| MonitorProcessor | to_monitorprocessor () | |
| PeakMeter | to_peakmeter () | |
| PluginInsert | to_plugininsert () | |
| SideChain | to_sidechain () | |
| UnknownProcessor | to_unknownprocessor () | |
| Methods | ||
|---|---|---|
| std::string | name () | |
| Stateful | to_stateful () | |
| StatefulDestructible | to_statefuldestructible () | |
C‡: std::list<boost::shared_ptr<ARDOUR::Processor> >
+ +| Constructor | ||
|---|---|---|
| ℂ | ARDOUR.ProcessorList () | |
| Methods | ||
| LuaTable | add (LuaTable {Processor}) | |
| Processor | back () | |
| bool | empty () | |
| Processor | front () | |
| LuaIter | iter () | |
| void | push_back (Processor) | |
| void | reverse () | |
| unsigned long | size () | |
| LuaTable | table () | |
| void | unique () | |
C‡: std::vector<boost::shared_ptr<ARDOUR::Processor> >
| Constructor | ||
|---|---|---|
| ℂ | ARDOUR.ProcessorVector () | |
| ℂ | ARDOUR.ProcessorVector () | |
| Methods | ||
| LuaTable | add (LuaTable {Processor}) | |
| Processor | at (unsigned long) | |
| unsigned int | n_channels () | |
| long | read (FloatArray, long, long, int) | |
| long | readable_length () | |
| bool | sameinstance (Readable) | |
C‡: boost::shared_ptr< ARDOUR::Region >, boost::weak_ptr< ARDOUR::Region >
-is-a: ARDOUR:SessionObject
+is-a: ARDOUR:SessionObjectPtr
A named object associated with a Session. Objects derived from this class are expected to be destroyed before the session calls drop_references().
| bool | can_move () | |
| bool | captured () | |
| void | clear_sync_position () | |
| Control | control (Parameter, bool) | |
| bool | covers (long) | |
| void | cut_end (long, int) | |
| void | cut_front (long, int) | |
| DataType | data_type () | |
| bool | external () | |
| bool | has_transients () | |
| bool | hidden () | |
| bool | import () | |
| bool | is_compound () | |
| double | quarter_note () | |
| void | raise () | |
| void | raise_to_top () | |
| bool | sameinstance (Region) | |
| void | set_hidden (bool) | |
| void | set_initial_position (long) | |
A gui may need to create a region, then place it in an initial position determined by the user. When this takes place within one gui operation, we have to reset _last_position to prevent an implied move. | ||
| LuaTable(long, ...) | sync_offset (int&) | |
| long | sync_position () | |
Returns Sync position in session time | ||
| Int64List | transients () | |
| void | trim_end (long, int) | |
| void | trim_front (long, int) | |
| void | trim_to (long, long, int) | |
| MidiRegion | to_midiregion () | |
| Readable | to_readable () | |
| Methods | ||
|---|---|---|
| std::string | name () | |
| Constructor | ||
| ℂ | ARDOUR.RegionList () | |
| Methods | ||
| Region | back () | |
| bool | empty () | |
| Region | front () | |
| LuaIter | iter () | |
| void | reverse () | |
| unsigned long | size () | |
************************************************************* Pure interface begins here************************************************************* | ||
| int | remove_processor (Processor, ProcessorStreams, bool) | |
remove plugin/processor
Returns 0 on success | ||
| int | remove_processors (ProcessorList, ProcessorStreams) | |
| bool | remove_sidechain (Processor) | |
| int | reorder_processors (ProcessorList, ProcessorStreams) | |
| int | replace_processor (Processor, Processor, ProcessorStreams) | |
replace plugin/processor with another
Returns 0 on success | ||
| bool | reset_plugin_insert (Processor) | |
reset plugin-insert configuration to default, disable customizations. This is equivalent to calling customize_plugin_insert (proc, 0, unused)
Returns true if successful | ||
| bool | sameinstance (Route) | |
| void | set_active (bool, void*) | |
| void | set_comment (std::string, void*) | |
| void | set_meter_point (MeterPoint, bool) | |
| AutomationControl | comp_makeup_control () | |
| AutomationControl | comp_mode_control () | |
| std::string | comp_mode_name (unsigned int) | |
| AutomationControl | comp_redux_control () | |
| --MISSING (boost::shared_ptr<ARDOUR::ReadOnlyControl>)-- | comp_redux_control () | |
| AutomationControl | comp_speed_control () | |
| std::string | comp_speed_name (unsigned int) | |
| AutomationControl | comp_threshold_control () | |
| AutomationControl | eq_enable_control () | |
| AutomationControl | eq_freq_control (unsigned int) | |
| AutomationControl | eq_gain_control (unsigned int) | |
| AutomationControl | eq_hpf_control () | |
| AutomationControl | eq_q_control (unsigned int) | |
| AutomationControl | eq_shape_control (unsigned int) | |
| AutomationControl | filter_enable_controllable (bool) | |
| AutomationControl | filter_freq_controllable (bool) | |
| AutomationControl | filter_slope_controllable (bool) | |
| GainControl | gain_control () | |
| bool | is_auditioner () | |
| bool | is_hidden () | |
| GainControl | trim_control () | |
| Cast | ||
| Route | to_route () | |
| VCA | to_vca () | |
| Methods | ||
|---|---|---|
| std::string | name () | |
C‡: ARDOUR::RouteGroup
+is-a: ARDOUR:SessionObject
A group identifier for routes.
RouteGroups permit to define properties which are shared among all Routes that use the given identifier.
A route can at most be in one group.
| bool | is_solo () | |
| void | make_subgroup (bool, Placement) | |
| int | remove (Route) | |
| unsigned int | rgba () | |
| RouteListPtr | route_list () | |
| void | set_active (bool, void*) | |
| void | set_color (bool) | |
| void | set_mute (bool) | |
| void | set_recenable (bool) | |
| void | set_relative (bool, void*) | |
| void | set_rgba (unsigned int) | |
set route-group color and notify UI about change | ||
| void | set_route_active (bool) | |
| void | set_select (bool) | |
| void | set_solo (bool) | |
| unsigned long | size () | |
| Methods | ||
|---|---|---|
| std::string | name () | |
| Cast | ||
| Stateful | to_stateful () | |
C‡: std::list<ARDOUR::RouteGroup* >
@@ -2812,7 +3035,9 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to Cabort an open undo command This must only be called after begin_reversible_command ()
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)
begin collecting undo information
This call must always be followed by either begin_reversible_command() or commit_reversible_command()
finalize an undo command and commit pending transactions
This must only be called after begin_reversible_command ()
save session
Returns zero on success
C‡: ARDOUR::SessionObject
+ +A named object associated with a Session. Objects derived from this class are expected to be destroyed before the session calls drop_references().
| Methods | ||
|---|---|---|
| std::string | name () | |
| Cast | ||
| Stateful | to_stateful () | |
C‡: boost::shared_ptr< ARDOUR::SessionObject >, boost::weak_ptr< ARDOUR::SessionObject >
A named object associated with a Session. Objects derived from this class are expected to be destroyed before the session calls drop_references().
| Methods | ||
|---|---|---|
| bool | isnil () | |
| bool | sameinstance (SideChain) | |
| bool | active () | |
| void | deactivate () | |
| std::string | display_name () | |
| bool | display_to_user () | |
| ChanCount | input_streams () | |
| ChanCount | output_streams () | |
| Cast | ||
|---|---|---|
| PeakMeter | to_meter () | |
| MonitorProcessor | to_monitorprocessor () | |
| PeakMeter | to_peakmeter () | |
| PluginInsert | to_plugininsert () | |
| SideChain | to_sidechain () | |
| UnknownProcessor | to_unknownprocessor () | |
| Methods | ||
|---|---|---|
| std::string | name () | |
| double | get_masters_value () | |
| bool | isnil () | |
| void | remove_master (AutomationControl) | |
| bool | sameinstance (SlavableAutomationControl,) | |
| bool | slaved () | |
| bool | slaved_to (AutomationControl) | |
| Methods | ||
|---|---|---|
| bool | can_solo () | |
| bool | isnil () | |
| bool | sameinstance (SoloControl) | |
| bool | self_soloed () | |
| bool | soloed () | |
| Methods | ||
|---|---|---|
| bool | isnil () | |
| bool | sameinstance (SoloIsolateControl) | |
| bool | self_solo_isolated () | |
| bool | solo_isolated () | |
| Methods | ||
|---|---|---|
| bool | isnil () | |
| bool | sameinstance (SoloSafeControl) | |
| bool | solo_safe () | |
C‡: boost::shared_ptr< ARDOUR::Source >, boost::weak_ptr< ARDOUR::Source >
-is-a: ARDOUR:SessionObject
+is-a: ARDOUR:SessionObjectPtr
A named object associated with a Session. Objects derived from this class are expected to be destroyed before the session calls drop_references().
| bool | isnil () | |
| long | length (long) | |
| long | natural_position () | |
| bool | sameinstance (Source) | |
| long | timeline_position () | |
| long | timestamp () | |
| int | use_count () | |
| bool | writable () | |
| Cast | ||
|---|---|---|
| AudioSource | to_audiosource () | |
| FileSource | to_filesource () | |
| MidiSource | to_midisource () | |
| Methods | ||
|---|---|---|
| std::string | name () | |
| Constructor | ||
|---|---|---|
| ℂ | ARDOUR.SourceList () | |
| ℂ | ARDOUR.SourceList () | |
| Methods | ||
| LuaTable | add (LuaTable {Source}) | |
| Source | at (unsigned long) | |
C‡: boost::shared_ptr< ARDOUR::Stripable >, boost::weak_ptr< ARDOUR::Stripable >
-is-a: ARDOUR:SessionObject
+is-a: ARDOUR:SessionObjectPtr
A named object associated with a Session. Objects derived from this class are expected to be destroyed before the session calls drop_references().
| AutomationControl | comp_makeup_control () | |
| AutomationControl | comp_mode_control () | |
| std::string | comp_mode_name (unsigned int) | |
| AutomationControl | comp_redux_control () | |
| --MISSING (boost::shared_ptr<ARDOUR::ReadOnlyControl>)-- | comp_redux_control () | |
| AutomationControl | comp_speed_control () | |
| std::string | comp_speed_name (unsigned int) | |
| AutomationControl | comp_threshold_control () | |
| AutomationControl | eq_enable_control () | |
| AutomationControl | eq_freq_control (unsigned int) | |
| AutomationControl | eq_gain_control (unsigned int) | |
| AutomationControl | eq_hpf_control () | |
| AutomationControl | eq_q_control (unsigned int) | |
| AutomationControl | eq_shape_control (unsigned int) | |
| AutomationControl | filter_enable_controllable (bool) | |
| AutomationControl | filter_freq_controllable (bool) | |
| AutomationControl | filter_slope_controllable (bool) | |
| GainControl | gain_control () | |
| bool | is_auditioner () | |
| bool | is_hidden () | |
| PresentationInfo | presentation_info_ptr () | |
| AutomationControl | rec_enable_control () | |
| AutomationControl | rec_safe_control () | |
| bool | sameinstance (Stripable) | |
| AutomationControl | send_enable_control (unsigned int) | |
| AutomationControl | send_level_control (unsigned int) | |
| std::string | send_name (unsigned int) | |
| GainControl | trim_control () | |
| Cast | ||
|---|---|---|
| Route | to_route () | |
| VCA | to_vca () | |
| Methods | ||
|---|---|---|
| std::string | name () | |
| Stateful | to_stateful () | |
| StatefulDestructible | to_statefuldestructible () | |
C‡: std::list<boost::shared_ptr<ARDOUR::Stripable> >
+ +| Constructor | ||
|---|---|---|
| ℂ | ARDOUR.StripableList () | |
| Methods | ||
| Stripable | back () | |
| bool | empty () | |
| Stripable | front () | |
| LuaIter | iter () | |
| void | reverse () | |
| unsigned long | size () | |
| LuaTable | table () | |
C‡: ARDOUR::Tempo
Tempo, the speed at which musical time progresses (BPM).
| Constructor | ||
|---|---|---|
| ℂ | ARDOUR.Tempo (double, double) | |
| ||
| ℂ | ARDOUR.Tempo (double, double, double) | |
| Methods | ||
| double | frames_per_note_type (long) | |
audio samples per note type. if you want an instantaneous value for this, use TempoMap::frames_per_quarter_note_at() instead.
| ||
| Methods | ||
|---|---|---|
| MeterSection | add_meter (Meter, double, BBT_TIME, long, PositionLockStyle) | |
| TempoSection | add_tempo (Tempo, double, long, Type, PositionLockStyle) | |
| TempoSection | add_tempo (Tempo, double, long, PositionLockStyle) | |
| BBT_TIME | bbt_at_frame (long) | |
Returns the BBT time corresponding to the supplied frame position.
Returns the BBT time at the frame position . | ||
| double | exact_beat_at_frame (long, int) | |
| double | exact_qn_at_frame (long, int) | |
| long | framepos_plus_qn (long, Beats) | |
Add some (fractional) Beats to a session frame position, and return the result in frames. pos can be -ve, if required. | ||
| Beats | framewalk_to_qn (long, long) | |
Count the number of beats that are equivalent to distance when going forward, starting at pos. | ||
| MeterSection | meter_section_at_beat (double) | |
| MeterSection | meter_section_at_frame (long) | |
| TempoSection | tempo_section_at_frame (long) | |
| bool | can_record () | |
| bool | isnil () | |
| Playlist | playlist () | |
| bool | sameinstance (Track) | |
| bool | set_name (std::string) | |
| Cast | ||
| AudioTrack | to_audio_track () | |
************************************************************* Pure interface begins here************************************************************* | ||
| int | remove_processor (Processor, ProcessorStreams, bool) | |
remove plugin/processor
Returns 0 on success | ||
| int | remove_processors (ProcessorList, ProcessorStreams) | |
| bool | remove_sidechain (Processor) | |
| int | reorder_processors (ProcessorList, ProcessorStreams) | |
| int | replace_processor (Processor, Processor, ProcessorStreams) | |
replace plugin/processor with another
Returns 0 on success | ||
| bool | reset_plugin_insert (Processor) | |
| AutomationControl | comp_makeup_control () | |
| AutomationControl | comp_mode_control () | |
| std::string | comp_mode_name (unsigned int) | |
| AutomationControl | comp_redux_control () | |
| --MISSING (boost::shared_ptr<ARDOUR::ReadOnlyControl>)-- | comp_redux_control () | |
| AutomationControl | comp_speed_control () | |
| std::string | comp_speed_name (unsigned int) | |
| AutomationControl | comp_threshold_control () | |
| AutomationControl | eq_enable_control () | |
| AutomationControl | eq_freq_control (unsigned int) | |
| AutomationControl | eq_gain_control (unsigned int) | |
| AutomationControl | eq_hpf_control () | |
| AutomationControl | eq_q_control (unsigned int) | |
| AutomationControl | eq_shape_control (unsigned int) | |
| AutomationControl | filter_enable_controllable (bool) | |
| AutomationControl | filter_freq_controllable (bool) | |
| AutomationControl | filter_slope_controllable (bool) | |
| GainControl | gain_control () | |
| bool | is_auditioner () | |
| bool | is_hidden () | |
| GainControl | trim_control () | |
| Cast | ||
| Route | to_route () | |
| VCA | to_vca () | |
| Methods | ||
|---|---|---|
| std::string | name () | |
| Methods | ||
|---|---|---|
| bool | isnil () | |
| bool | sameinstance (UnknownProcessor) | |
| bool | active () | |
| void | deactivate () | |
| std::string | display_name () | |
| bool | display_to_user () | |
| ChanCount | input_streams () | |
| ChanCount | output_streams () | |
| Cast | ||
|---|---|---|
| PeakMeter | to_meter () | |
| MonitorProcessor | to_monitorprocessor () | |
| PeakMeter | to_peakmeter () | |
| PluginInsert | to_plugininsert () | |
| SideChain | to_sidechain () | |
| UnknownProcessor | to_unknownprocessor () | |
| Methods | ||
|---|---|---|
| std::string | name () | |
| Stateful | to_stateful () | |
| StatefulDestructible | to_statefuldestructible () | |
C‡: boost::shared_ptr< ARDOUR::VCA >, boost::weak_ptr< ARDOUR::VCA >
+is-a: ARDOUR:Stripable
+ +A named object associated with a Session. Objects derived from this class are expected to be destroyed before the session calls drop_references().
| Methods | ||
|---|---|---|
| std::string | full_name () | |
| GainControl | gain_control () | |
| bool | isnil () | |
| MuteControl | mute_control () | |
| int | number () | |
| SoloControl | solo_control () | |
| Methods | ||
|---|---|---|
| AutomationControl | comp_enable_control () | |
| AutomationControl | comp_makeup_control () | |
| AutomationControl | comp_mode_control () | |
| std::string | comp_mode_name (unsigned int) | |
| --MISSING (boost::shared_ptr<ARDOUR::ReadOnlyControl>)-- | comp_redux_control () | |
| AutomationControl | comp_speed_control () | |
| std::string | comp_speed_name (unsigned int) | |
| AutomationControl | comp_threshold_control () | |
| unsigned int | eq_band_cnt () | |
| std::string | eq_band_name (unsigned int) | |
| AutomationControl | eq_enable_control () | |
| AutomationControl | eq_freq_control (unsigned int) | |
| AutomationControl | eq_gain_control (unsigned int) | |
| AutomationControl | eq_q_control (unsigned int) | |
| AutomationControl | eq_shape_control (unsigned int) | |
| AutomationControl | filter_enable_controllable (bool) | |
| AutomationControl | filter_freq_controllable (bool) | |
| AutomationControl | filter_slope_controllable (bool) | |
| bool | is_auditioner () | |
| bool | is_hidden () | |
| bool | is_master () | |
| bool | is_monitor () | |
| bool | is_selected () | |
| AutomationControl | master_send_enable_control () | |
| MonitorProcessor | monitor_control () | |
| AutomationControl | pan_azimuth_control () | |
| AutomationControl | pan_elevation_control () | |
| AutomationControl | pan_frontback_control () | |
| AutomationControl | pan_lfe_control () | |
| AutomationControl | pan_width_control () | |
| PhaseControl | phase_control () | |
| PresentationInfo | presentation_info_ptr () | |
| AutomationControl | rec_enable_control () | |
| AutomationControl | rec_safe_control () | |
| AutomationControl | send_enable_control (unsigned int) | |
| AutomationControl | send_level_control (unsigned int) | |
| std::string | send_name (unsigned int) | |
| void | set_presentation_order (unsigned int) | |
| SoloIsolateControl | solo_isolate_control () | |
| SoloSafeControl | solo_safe_control () | |
| GainControl | trim_control () | |
| Cast | ||
| Route | to_route () | |
| VCA | to_vca () | |
| Methods | ||
|---|---|---|
| std::string | name () | |
| Cast | ||
| Stateful | to_stateful () | |
| StatefulDestructible | to_statefuldestructible () | |
C‡: std::list<boost::shared_ptr<ARDOUR::VCA> >
+ +| Constructor | ||
|---|---|---|
| ℂ | ARDOUR.VCAList () | |
| Methods | ||
| VCA | back () | |
| bool | empty () | |
| VCA | front () | |
| LuaIter | iter () | |
| void | reverse () | |
| unsigned long | size () | |
| LuaTable | table () | |
C‡: ARDOUR::VCAManager
+is-a: PBD:StatefulDestructible
+ +Base class for objects with saveable and undoable state with destruction notification
| Methods | ||
|---|---|---|
| VCA | vca_by_number (int) | |
| VCAList | vcas () | |
| Methods | ||
|---|---|---|
| void | clear_changes () | |
Forget about any changes to this object's properties | ||
| ID | id () | |
| OwnedPropertyList | properties () | |
C‡: std::list<boost::weak_ptr<ARDOUR::AudioSource> >
@@ -3699,7 +4077,9 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to CC‡: AxisView
+ +AxisView defines the abstract base class for horizontal and vertical presentations of Stripables.
This class object is only used indirectly as return-value and function-parameter. It provides no methods by itself.
C‡: PublicEditor
@@ -3772,9 +4163,13 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to CPossibly start the audition of a region. If
Returns The current mouse mode (gain, object, range, timefx etc.) (defined in editing_syms.h)
Redo some transactions.
Set the mouse mode (gain, object, range, timefx etc.)
Set the snap mode.
Class to represent list of selected regions.
| Methods | ||
|---|---|---|
| void | clear_all () | |
Empty this RegionSelection. | ||
| long | end_frame () | |
| unsigned long | n_midi_regions () | |
| RegionList | regionlist () | |
| long | start () | |
C‡: RegionView
+is-a: ArdourUI:TimeAxisViewItem
+ +Base class for items that may appear upon a TimeAxisView.
This class object is only used indirectly as return-value and function-parameter. It provides no methods by itself.
+C‡: RouteTimeAxisView
+is-a: ArdourUI:RouteUI
+ +Base class for objects with auto-disconnection. trackable must be inherited when objects shall automatically invalidate slots referring to them on destruction. A slot built from a member function of a trackable derived type installs a callback that is invoked when the trackable object is destroyed or overwritten.
add_destroy_notify_callback() and remove_destroy_notify_callback() can be used to manually install and remove callbacks when notification of the object dying is needed.
notify_callbacks() invokes and removes all previously installed callbacks and can therefore be used to disconnect from all signals.
Note that there is no virtual destructor. Don't use trackable* as pointer type for managing your data or the destructors of your derived types won't be called when deleting your objects.
signal
| Cast | ||
|---|---|---|
| TimeAxisView | to_timeaxisview () | |
C‡: RouteUI
+is-a: ArdourUI:Selectable
+ +Base class for objects with auto-disconnection. trackable must be inherited when objects shall automatically invalidate slots referring to them on destruction. A slot built from a member function of a trackable derived type installs a callback that is invoked when the trackable object is destroyed or overwritten.
add_destroy_notify_callback() and remove_destroy_notify_callback() can be used to manually install and remove callbacks when notification of the object dying is needed.
notify_callbacks() invokes and removes all previously installed callbacks and can therefore be used to disconnect from all signals.
Note that there is no virtual destructor. Don't use trackable* as pointer type for managing your data or the destructors of your derived types won't be called when deleting your objects.
signal
This class object is only used indirectly as return-value and function-parameter. It provides no methods by itself.
+C‡: Selectable
+ +Base class for objects with auto-disconnection. trackable must be inherited when objects shall automatically invalidate slots referring to them on destruction. A slot built from a member function of a trackable derived type installs a callback that is invoked when the trackable object is destroyed or overwritten.
add_destroy_notify_callback() and remove_destroy_notify_callback() can be used to manually install and remove callbacks when notification of the object dying is needed.
notify_callbacks() invokes and removes all previously installed callbacks and can therefore be used to disconnect from all signals.
Note that there is no virtual destructor. Don't use trackable* as pointer type for managing your data or the destructors of your derived types won't be called when deleting your objects.
signal
This class object is only used indirectly as return-value and function-parameter. It provides no methods by itself.
C‡: Selection
@@ -3911,6 +4340,35 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to CC‡: std::list<Selectable* >
+ +| Constructor | ||
|---|---|---|
| ℂ | ArdourUI.SelectionList () | |
| Methods | ||
| Selectable | back () | |
| bool | empty () | |
| Selectable | front () | |
| LuaIter | iter () | |
| void | push_back (Selectable) | |
| void | reverse () | |
| unsigned long | size () | |
| LuaTable | table () | |
| void | unique () | |
C‡: TimeAxisView
+is-a: ArdourUI:AxisView
+ +Abstract base class for time-axis views (horizontal editor 'strips')
This class provides the basic LHS controls and display methods. This should be extended to create functional time-axis based views.
This class object is only used indirectly as return-value and function-parameter. It provides no methods by itself.
+C‡: TimeAxisViewItem
+is-a: ArdourUI:Selectable
+ +Base class for items that may appear upon a TimeAxisView.
This class object is only used indirectly as return-value and function-parameter. It provides no methods by itself.
C‡: TimeSelection
is-a: ARDOUR:AudioRangeList
@@ -3926,7 +4384,9 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C| Methods | ||
|---|---|---|
| bool | contains (TimeAxisView) | |
| RouteList | routelist () | |
| Constructor | ||
|---|---|---|
| ℂ | ArdourUI.TrackViewStdList () | |
| Methods | ||
| TimeAxisView | back () | |
| bool | empty () | |
| TimeAxisView | front () | |
| LuaIter | iter () | |
| void | push_back (TimeAxisView) | |
| void | reverse () | |
| unsigned long | size () | |
| LuaTable | table () | |
| void | unique () | |
C‡: TrackViewList
+is-a: ArdourUI:TrackViewStdList
| Methods | ||
|---|---|---|
| bool | contains (TimeAxisView) | |
| RouteList | routelist () | |
| Constructor | ||
|---|---|---|
| ℂ | ArdourUI.TrackViewStdList () | |
| Methods | ||
| TimeAxisView | back () | |
| bool | empty () | |
| TimeAxisView | front () | |
| LuaIter | iter () | |
| void | push_back (TimeAxisView) | |
| void | reverse () | |
| unsigned long | size () | |
| LuaTable | table () | |
| void | unique () | |
C‡: std::list<TimeAxisView* >
+ +| Constructor | ||
|---|---|---|
| ℂ | ArdourUI.TrackViewStdList () | |
| Methods | ||
| TimeAxisView | back () | |
| bool | empty () | |
| TimeAxisView | front () | |
| LuaIter | iter () | |
| void | push_back (TimeAxisView) | |
| void | reverse () | |
| unsigned long | size () | |
| LuaTable | table () | |
| void | unique () | |
C‡: unsigned char*
@@ -3957,7 +4467,6 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C| Constructor | ||
|---|---|---|
| ℂ | C.DoubleVector () | |
| ℂ | C.DoubleVector () | |
| Methods | ||
| LuaTable | add (LuaTable {double}) | |
| double | at (unsigned long) | |
| LuaMetaTable | array () | |
| LuaTable | get_table () | |
| FloatArray | offset (unsigned int) | |
| bool | sameinstance (FloatArray) | |
| void | set_table (LuaTable {float}) | |
| Constructor | ||
|---|---|---|
| ℂ | C.FloatArrayVector () | |
| ℂ | C.FloatArrayVector () | |
| Methods | ||
| LuaTable | add (LuaTable {FloatArray}) | |
| FloatArray | at (unsigned long) | |
| Constructor | ||
|---|---|---|
| ℂ | C.FloatVector () | |
| ℂ | C.FloatVector () | |
| Methods | ||
| LuaTable | add (LuaTable {float}) | |
| float | at (unsigned long) | |
| unsigned long | size () | |
| LuaTable | table () | |
C‡: std::list<long >
+ +| Constructor | ||
|---|---|---|
| ℂ | C.Int64List () | |
| Methods | ||
| LuaTable | add (LuaTable {long}) | |
| long | back () | |
| bool | empty () | |
| long | front () | |
| LuaIter | iter () | |
| void | push_back (long) | |
| void | reverse () | |
| unsigned long | size () | |
| LuaTable | table () | |
| void | unique () | |
C‡: int*
@@ -4024,7 +4553,6 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C| Constructor | ||
|---|---|---|
| ℂ | C.StringVector () | |
| ℂ | C.StringVector () | |
| Methods | ||
| LuaTable | add (LuaTable {std::string}) | |
| std::string | at (unsigned long) | |
Queries whether the layout had to ellipsize any paragraphs. This returns true if the ellipsization mode for layout is not Pango::ELLIPSIZE_NONE, a positive width is set on layout, and there are paragraphs exceeding that width that have to be ellipsized. Returns true if any paragraphs had to be ellipsized, false otherwise. | ||
| bool | is_wrapped () | |
Queries whether the layout had to wrap any paragraphs. This returns true if a positive width is set on layout, ellipsization mode of layout is set to Pango::ELLIPSIZE_NONE, and there are paragraphs exceeding the layout width that have to be wrapped. Returns true if any paragraphs had to be wrapped, false otherwise. | ||
| void | layout_cairo_path (Context) | |
| void | set_ellipsize (EllipsizeMode) | |
Sets the type of ellipsization being performed for layout. Depending on the ellipsization mode ellipsize text is removed from the start, middle, or end of text so they fit within the width and height of layout set with set_width() and set_height(). If the layout contains characters such as newlines that force it to be layed out in multiple paragraphs, then whether each paragraph is ellipsized separately or the entire layout is ellipsized as a whole depends on the set height of the layout. See set_height() for details.
| ||
| void | set_markup (std::string) | |
| Methods | ||
| bool | isnil () | |
| ControlList | list () | |
| bool | sameinstance (Control) | |
C‡: Evoral::ControlEvent
+ +A single event (time-stamped value) for a control
| Data Members | ||
|---|---|---|
| double | value | |
| double | when | |
C‡: boost::shared_ptr< Evoral::ControlList >, boost::weak_ptr< Evoral::ControlList >
@@ -4225,15 +4765,16 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to Cadd automation events
remove all automation events between the given time range
query value at given time (takes a read-lock, not safe while writing automation)
Returns parameter value
query interpolation style of the automation data
Returns Interpolation Style
realtime safe version of eval, may fail if read-lock cannot be taken
Returns parameter value
set the interpolation style of the automation data
| Methods | ||
|---|---|---|
| bool | isnil () | |
| bool | sameinstance (ControlSet) | |
C‡: Evoral::Event<long>
@@ -4276,7 +4816,6 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C| Methods | ||
|---|---|---|
| bool | isnil () | |
| bool | sameinstance (Sequence) | |
C‡: LuaDialog::Dialog
+ +| Constructor | ||
|---|---|---|
| ℂ | LuaDialog.Dialog (std::string, Lua-Function) | |
| Methods | ||
| ... | run (--lua--) | |
C‡: LuaDialog::Message
+ +| Constructor | ||
|---|---|---|
| ℂ | LuaDialog.Message (std::string, std::string, MessageType, ButtonType) | |
| Methods | ||
| int | run () | |
C‡: std::bitset<47ul>
@@ -4394,7 +4950,6 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C| Constructor | ||
|---|---|---|
| ℂ | PBD.IdVector () | |
| ℂ | PBD.IdVector () | |
| Methods | ||
| LuaTable | add (LuaTable {ID}) | |
| ID | at (unsigned long) | |
| Methods | ||
|---|---|---|
| bool | isnil () | |
| bool | sameinstance (StatefulDestructible) | |
| ID | id () | |
| bool | isnil () | |
| OwnedPropertyList | properties () | |
| bool | sameinstance (Stateful) |
C‡: XMLNode
@@ -4676,6 +5230,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C| Constructor | ||
|---|---|---|
| ℂ | Vamp.Plugin.FeatureList () | |
| ℂ | Vamp.Plugin.FeatureList () | |
| Methods | ||
| LuaTable | add (LuaTable {Feature}) | |
| Feature | at (unsigned long) | |
| Constructor | ||
|---|---|---|
| ℂ | Vamp.Plugin.OutputList () | |
| ℂ | Vamp.Plugin.OutputList () | |
| Methods | ||
| LuaTable | add (LuaTable {OutputDescriptor}) | |
| OutputDescriptor | at (unsigned long) | |
| Constructor | ||
|---|---|---|
| ℂ | Vamp.PluginBase.ParameterList () | |
| ℂ | Vamp.PluginBase.ParameterList () | |
| Methods | ||
| LuaTable | add (LuaTable {ParameterDescriptor}) | |
| ParameterDescriptor | at (unsigned long) | |