obj = Session:route_by_name("Audio") obj:set_name("Guitar").
Lua automatically follows C++ class inheritance. e.g one can directly call all SessionObject and Route methods on Track object. However lua does not automatically promote objects. A Route object which just happens to be a Track needs to be explicitly cast to a Track. Methods for casts are provided with each class. Note that the cast may fail and return a nil reference.
-Likewise multiple inheritance is a non-trivial issue in lua. To avoid performance penalties involved with lookups, explicit casts are required in this case. One example is ARDOUR:SessionObject which is-a StatefulDestructible which inherits from both Stateful and Destructible. +Likewise multiple inheritance is a non-trivial issue in Lua. To avoid performance penalties involved with lookups, explicit casts are required in this case. One example is ARDOUR:SessionObject which is-a StatefulDestructible which inherits from both Stateful and Destructible.
Object lifetimes are managed by the Session. Most Objects cannot be directly created, but one asks the Session to create or destroy them. This is mainly due to realtime constrains: @@ -43,7 +43,7 @@ you cannot simply remove a track that is currently processing audio. There are v
-Since lua functions are closures, C++ methods that pass arguments by reference cannot be used as-is. +Since Lua functions are closures, C++ methods that pass arguments by reference cannot be used as-is. All parameters passed to a C++ method which uses references are returned as Lua Table. If the C++ method also returns a value it is prefixed. Two parameters are returned: the value and a Lua Table holding the parameters.
@@ -95,12 +95,12 @@ print (rv, ref[1], ref[2])
Libardour makes extensive use of reference counted boost::shared_ptr to manage lifetimes.
-The Lua bindings provide a complete abstraction of this. There are no pointers in lua.
-For example a ARDOUR:Route is a pointer in C++, but lua functions operate on it like it was a class instance.
+The Lua bindings provide a complete abstraction of this. There are no pointers in Lua.
+For example a ARDOUR:Route is a pointer in C++, but Lua functions operate on it like it was a class instance.
-shared_ptr are reference counted. Once assigned to a lua variable, the C++ object will be kept and remains valid.
-It is good practice to assign references to lua local variables or reset the variable to nil to drop the ref.
+shared_ptr are reference counted. Once assigned to a Lua variable, the C++ object will be kept and remains valid.
+It is good practice to assign references to Lua local variables or reset the variable to nil to drop the ref.
All pointer classes have a isnil () method. This is for two cases:
@@ -110,13 +110,13 @@ may not be able to find the given plugin and hence cannot create an object.
The second case if for boost::weak_ptr. As opposed to boost::shared_ptr weak-pointers are not reference counted.
The object may vanish at any time.
-If lua code calls a method on a nil object, the interpreter will raise an exception and the script will not continue.
+If Lua code calls a method on a nil object, the interpreter will raise an exception and the script will not continue.
This is not unlike a = nil a:test() which results in en error "attempt to index a nil value".
-From the lua side of things there is no distinction between weak and shared pointers. They behave identically. +From the Lua side of things there is no distinction between weak and shared pointers. They behave identically. Below they're indicated in orange and have an arrow to indicate the pointer type. -Pointer Classes cannot be created in lua scripts. It always requires a call to C++ to create the Object and obtain a reference to it. +Pointer Classes cannot be created in Lua scripts. It always requires a call to C++ to create the Object and obtain a reference to it.
@@ -126,14 +126,19 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C| Methods | ||
|---|---|---|
| RCConfiguration | config () | |
| std::string | user_cache_directory (std::string) | |
Returns the path to the directory used to store user specific caches (e.g. plugin indices, blacklist/whitelist) it defaults to XDG_CACHE_HOME | ||
| std::string | user_config_directory (int) | |
user_config_directory() exists IF version was negative.
Returns the path to the directory used to store user specific configuration files for the given | ||
C‡: boost::shared_ptr< ARDOUR::Amp >, boost::weak_ptr< ARDOUR::Amp >
is-a: ARDOUR:Processor
-Applies a declick operation to all audio inputs, passing the same number of audio outputs, and passing through any other types unchanged.
Gain Stage (Fader, Trim).
| Methods | ||
|---|---|---|
| float | apply_gain (AudioBuffer&, long, long, float, float, long) | |
| GainControl | gain_control () | |
| bool | isnil () | |
C‡: boost::shared_ptr< ARDOUR::AsyncMIDIPort >, boost::weak_ptr< ARDOUR::AsyncMIDIPort >
+is-a: ARDOUR:MidiPort
+ +| Methods | ||
|---|---|---|
| bool | isnil () | |
| int | write (unsigned char*, unsigned long, unsigned int) | |
| Methods | ||
|---|---|---|
| MidiBuffer | get_midi_buffer (unsigned int) | |
| bool | input_active () | |
| void | set_input_active (bool) | |
| Cast | ||
| AsyncMIDIPort | to_asyncmidiport () | |
| Methods | ||
|---|---|---|
| int | connect (std::string) | |
| bool | connected () | |
Returns true if this port is connected to anything | ||
| bool | connected_to (std::string) | |
Returns true if this port is connected to o, otherwise false. | ||
| int | disconnect (std::string) | |
| int | disconnect_all () | |
| LuaTable(...) | get_connected_latency_range (LatencyRange&, bool) | |
| std::string | name () | |
Returns Port short name | ||
| bool | physically_connected () | |
| std::string | pretty_name (bool) | |
Returns Port human readable name | ||
| LatencyRange | private_latency_range (bool) | |
| LatencyRange | public_latency_range (bool) | |
| bool | receives_input () | |
Returns true if this Port receives input, otherwise false | ||
| bool | sends_output () | |
Returns true if this Port sends output, otherwise false | ||
| Cast | ||
| AsyncMIDIPort | to_asyncmidiport () | |
| AudioPort | to_audioport () | |
| MidiPort | to_midiport () | |
C‡: boost::shared_ptr< ARDOUR::AudioBackend >, boost::weak_ptr< ARDOUR::AudioBackend >
@@ -188,7 +250,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to CReturns a collection of DeviceStatuses identifying output devices discovered by this backend since the start of the process.
Any of the names in each DeviceStatus may be used to identify a device in other calls to the backend, though any of them may become invalid at any time.
Return the AudioBackendInfo object from which this backend was constructed.
Return the AudioBackendInfo object from which this backend was constructed.
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).
Set the name of the device to be used
Set the name of the device to be used
Returns zero if the backend can successfully use
Should not be used unless the backend returns true from requires_driver_selection()
Returns zero if the backend can successfully use drivername as the driver, non-zero otherwise.
Should not be used unless the backend returns true from requires_driver_selection()
Set the name of the input device to be used if using separate input/output devices.
use_separate_input_and_output_devices()
Set the period size to be used. must be called before starting the backend.
Set the sample rate to be used
Set the sample rate to be used
An optional alternate interface for backends to provide a facility to select separate input and output devices.
If a backend returns true then enumerate_input_devices() and enumerate_output_devices() will be used instead of enumerate_devices() to enumerate devices. Similarly set_input/output_device_name() should be used to set devices instead of set_device_name().
| Methods | ||
|---|---|---|
| void | apply_gain (float, long) | |
Apply a fixed gain factor to the audio buffer
| ||
| bool | check_silence (unsigned int, unsigned int&) | |
check buffer for silence
Returns true if all samples are zero | ||
Check buffer for silence
Returns true if all samples are zero | ||
| FloatArray | data (long) | |
| void | read_from (FloatArray, long, long, long) | |
| void | silence (long, long) | |
| Methods | ||
| bool | isnil () | |
| long | read (FloatArray, FloatArray, FloatArray, long, long, unsigned int) | |
| ||
| ||
| void | duplicate_range (AudioRange&, float) | |
| void | duplicate_until (Region, long, long, long) | |
| ||
| ||
| bool | empty () | |
| Region | find_next_region (long, RegionPoint, int) | |
| long | find_next_region_boundary (long, int) | |
| long | find_next_transient (long, int) | |
| ID | get_orig_track_id () | |
| bool | hidden () | |
| void | lower_region (Region) | |
| void | lower_region_to_bottom (Region) | |
| unsigned int | n_regions () | |
| RegionListPtr | regions_with_end_within (Range) | |
| RegionListPtr | regions_with_start_within (Range) | |
| void | remove_region (Region) | |
| void | split (long) | |
| void | split_region (Region, MusicFrame) | |
| bool | shared () | |
| void | split_region (Region, MusicSample) | |
| Region | top_region_at (long) | |
| Region | top_unmuted_region_at (long) | |
| void | uncombine (Region) | |
| bool | used () | |
| Cast | ||
|---|---|---|
| AudioPlaylist | to_audioplaylist () | |
| MidiPlaylist | to_midiplaylist () | |
Returns true if this port is connected to o, otherwise false. | ||
| int | disconnect (std::string) | |
| int | disconnect_all () | |
| LuaTable(...) | get_connected_latency_range (LatencyRange&, bool) | |
| std::string | name () | |
Returns Port short name | ||
| bool | physically_connected () | |
| std::string | pretty_name (bool) | |
Returns Port human readable name | ||
| LatencyRange | private_latency_range (bool) | |
| LatencyRange | public_latency_range (bool) | |
| bool | receives_input () | |
Returns true if this Port receives input, otherwise false | ||
| bool | sends_output () | |
Returns true if this Port sends output, otherwise false | ||
| Cast | ||
| AsyncMIDIPort | to_asyncmidiport () | |
| AudioPort | to_audioport () | |
| MidiPort | to_midiport () | |
| Methods | ||
|---|---|---|
| AudioSource | audio_source (unsigned int) | |
| bool | fade_in_active () | |
| bool | fade_out_active () | |
| bool | isnil () | |
| double | maximum_amplitude (Progress) | |
Returns the maximum (linear) amplitude of the region, or a -ve number if the Progress object reports that the process was cancelled. | ||
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_fade_in_active (bool) | |
| void | set_fade_in_length (long) | |
| void | set_fade_in_shape (FadeShape) | |
| void | set_fade_out_active (bool) | |
| void | set_fade_out_length (long) | |
| void | set_fade_out_shape (FadeShape) | |
| void | set_scale_amplitude (float) | |
How the region parameters play together:
POSITION: first frame of the region along the timeline START: first frame of the region within its source(s) LENGTH: number of frames the region represents
How the region parameters play together:
POSITION: first sample of the region along the timeline START: first sample of the region within its source(s) LENGTH: number of samples the region represents
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.
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.
Note: changing the name of a Region does not constitute an edit
C‡: boost::shared_ptr< ARDOUR::AudioRom >, boost::weak_ptr< ARDOUR::AudioRom >
+is-a: ARDOUR:Readable
+ +| Methods | ||
|---|---|---|
| bool | isnil () | |
| AudioRom | new_rom (FloatArray, unsigned long) | |
| Methods | ||
|---|---|---|
| ReadableList | load (Session&, std::string) | |
| unsigned int | n_channels () | |
| long | read (FloatArray, long, long, int) | |
| long | readable_length () | |
C‡: boost::shared_ptr< ARDOUR::AudioSource >, boost::weak_ptr< ARDOUR::AudioSource >
is-a: ARDOUR:Source
@@ -490,7 +591,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to CA 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 | captured_for () | |
| std::string | captured_for () | |
| bool | empty () | |
| bool | isnil () | |
| bool | isnil () | |
| Methods | ||
| std::string | ancestor_name () | |
| bool | can_be_analysed () | |
| bool | destructive () | |
| bool | has_been_analysed () | |
| long | natural_position () | |
| long | timeline_position () | |
| Methods | ||
|---|---|---|
| bool | isnil () | |
| 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 | can_record () | |
| int | find_and_use_playlist (DataType, ID) | |
| Playlist | playlist () | |
| bool | set_name (std::string) | |
| int | use_copy_playlist () | |
| int | use_new_playlist (DataType) | |
| int | use_playlist (DataType, Playlist) | |
| Cast | ||
| AudioTrack | to_audio_track () | |
| MidiTrack | to_midi_track () | |
| std::string | comment () | |
| bool | customize_plugin_insert (Processor, unsigned int, ChanCount, ChanCount) | |
enable custom plugin-insert configuration
Returns true if successful | ||
| DataType | data_type () | |
| IO | input () | |
| Delivery | main_outs () | |
the signal processor at at end of the processing chain which produces output | ||
the signal processorat at end of the processing chain which produces output | ||
| bool | muted () | |
| ChanCount | n_inputs () | |
| ChanCount | n_outputs () | |
| PannerShell | panner_shell () | |
| PeakMeter | peak_meter () | |
************************************************************* Pure interface begins here************************************************************* | ||
| long | playback_latency (bool) | |
| int | remove_processor (Processor, ProcessorStreams, bool) | |
remove plugin/processor
Returns 0 on success | ||
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 | ||
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 | ||
| void | set_active (bool, void*) | |
| void | set_comment (std::string, void*) | |
| void | set_meter_point (MeterPoint, bool) | |
| bool | set_strict_io (bool) | |
| long | signal_latency () | |
| bool | soloed () | |
| bool | strict_io () | |
| Processor | the_instrument () | |
Return the first processor that accepts has at least one MIDI input and at least one audio output. In the vast majority of cases, this will be "the instrument". This does not preclude other MIDI->audio processors later in the processing chain, but that would be a special case not covered by this utility function. | ||
| Amp | trim () | |
| Cast | ||
| Automatable | to_automatable () | |
| Slavable | to_slavable () | |
| Track | to_track () | |
| Methods | ||
|---|---|---|
| AutomationControl | comp_enable_control () | |
| AutomationControl | comp_makeup_control () | |
| AutomationControl | comp_mode_control () | |
| AutomationControl | comp_enable_controllable () | |
| AutomationControl | comp_makeup_controllable () | |
| AutomationControl | comp_mode_controllable () | |
| std::string | comp_mode_name (unsigned int) | |
| ReadOnlyControl | comp_redux_control () | |
| AutomationControl | comp_speed_control () | |
| ReadOnlyControl | comp_redux_controllable () | |
| AutomationControl | comp_speed_controllable () | |
| std::string | comp_speed_name (unsigned int) | |
| AutomationControl | comp_threshold_control () | |
| AutomationControl | comp_threshold_controllable () | |
| 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 | eq_enable_controllable () | |
| AutomationControl | eq_freq_controllable (unsigned int) | |
| AutomationControl | eq_gain_controllable (unsigned int) | |
| AutomationControl | eq_q_controllable (unsigned int) | |
| AutomationControl | eq_shape_controllable (unsigned int) | |
| AutomationControl | filter_enable_controllable (bool) | |
| AutomationControl | filter_freq_controllable (bool) | |
| AutomationControl | filter_slope_controllable (bool) | |
| bool | is_hidden () | |
| bool | is_master () | |
| bool | is_monitor () | |
| bool | is_private_route () | |
| bool | is_selected () | |
| AutomationControl | master_send_enable_control () | |
| AutomationControl | master_send_enable_controllable () | |
| MonitorProcessor | monitor_control () | |
| MuteControl | mute_control () | |
| AutomationControl | pan_azimuth_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) | |
| AutomationControl | send_enable_controllable (unsigned int) | |
| AutomationControl | send_level_controllable (unsigned int) | |
| std::string | send_name (unsigned int) | |
| AutomationControl | send_pan_azimuth_controllable (unsigned int) | |
| AutomationControl | send_pan_azimuth_enable_controllable (unsigned int) | |
| void | set_presentation_order (unsigned int) | |
| bool | slaved () | |
| bool | slaved_to (VCA) | |
| SoloControl | solo_control () | |
| SoloIsolateControl | solo_isolate_control () | |
| SoloSafeControl | solo_safe_control () | |
| GainControl | trim_control () | |
| Cast | ||
| Automatable | to_automatable () | |
| Route | to_route () | |
| Slavable | to_slavable () | |
| VCA | to_vca () | |
C‡: boost::shared_ptr< ARDOUR::AutomatableSequence<Evoral::Beats> >, boost::weak_ptr< ARDOUR::AutomatableSequence<Evoral::Beats> >
+C‡: boost::shared_ptr< ARDOUR::AutomatableSequence<Temporal::Beats> >, boost::weak_ptr< ARDOUR::AutomatableSequence<Temporal::Beats> >
is-a: ARDOUR:Automatable
| Methods | ||
|---|---|---|
| bool | isnil () | |
| Cast | ||
| Sequence | to_sequence () | |
| Sequence | to_sequence () | |
| Methods | ||
|---|---|---|
| AutomationList | alist () | |
| AutoState | automation_state () | |
| ParameterDescriptor | desc () | |
| double | get_value () | |
Get the current effective `user' value based on automation state | ||
Get `internal' value Returns raw value as used for the plugin/processor control port | ||
| bool | isnil () | |
| double | lower () | |
| double | normal () | |
| void | set_automation_state (AutoState) | |
| void | set_value (double, GroupControlDisposition) | |
Get and Set `internal' value All derived classes must implement this. Basic derived classes will ignore
| ||
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 () | |
| void | clear (double, double) | |
remove all automation events between the given time range
| ||
| void | clear_list () | |
| bool | editor_add (double, double, bool) | |
| double | eval (double) | |
query value at given time (takes a read-lock, not safe while writing automation)
Returns parameter value | ||
| EventList | events () | |
| unsigned long | size () | |
| LuaTable | table () | |
C‡: ARDOUR::BeatsFramesConverter
+C‡: ARDOUR::BeatsSamplesConverter
-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.
Converter between quarter-note beats and samples. Takes distances in quarter-note beats or samples from some origin (supplied to the constructor in samples), and converts them to the opposite unit, taking tempo changes into account.
| Constructor | ||
|---|---|---|
| ℂ | ARDOUR.BeatsFramesConverter (TempoMap, long) | |
| ℂ | ARDOUR.BeatsSamplesConverter (TempoMap, long) | |
| Methods | ||
| Beats | from (long) | |
| Beats | from (long) | |
Convert B time to A time (A from B) | ||
| long | to (Beats) | |
| long | to (Beats) | |
Convert A time to B time (A to B) | ||
C‡: ARDOUR::BufferSet
-A set of buffers of various types.
These are mainly accessed from Session and passed around as scratch buffers (e.g. as parameters to run() methods) to do in-place signal processing.
There are two types of counts associated with a BufferSet - available, and the 'use count'. Available is the actual number of allocated buffers (and so is the maximum acceptable value for the use counts).
The use counts are how things determine the form of their input and inform others the form of their output (e.g. what they did to the BufferSet). Setting the use counts is realtime safe.
A set of buffers of various types.
These are mainly accessed from Session and passed around as scratch buffers (eg as parameters to run() methods) to do in-place signal processing.
There are two types of counts associated with a BufferSet - available, and the 'use count'. Available is the actual number of allocated buffers (and so is the maximum acceptable value for the use counts).
The use counts are how things determine the form of their input and inform others the form of their output (eg what they did to the BufferSet). Setting the use counts is realtime safe.
| Methods | ||
|---|---|---|
| ChanCount | available () | |
| ChanCount | count () | |
| AudioBuffer | get_audio (unsigned long) | |
| MidiBuffer | get_midi (unsigned long) | |
Convenience constructor for making single-typed streams (mono, stereo, midi, etc)
| ||
| Methods | ||
| unsigned int | get (DataType) | |
query channel count for given type
Returns channel count for given type | ||
query channel count for given type
Returns channel count for given type | ||
| unsigned int | n_audio () | |
query number of audio channels Returns number of audio channels | ||
| unsigned int | n_midi () | |
| void | reset () | |
zero count of all data types | ||
| void | set (DataType, unsigned int) | |
set channel count for given type
| ||
set channel count for given type
| ||
| void | set_audio (unsigned int) | |
set number of audio channels
| ||
| void | set_midi (unsigned int) | |
set number of audio channels
| ||
C‡: ARDOUR::ChanMapping
@@ -853,12 +976,12 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to Cget buffer mapping for given data type and pin
Returns mapped buffer number (or ChanMapping::Invalid)
get buffer mapping for given data type and pin
Returns mapped buffer number (or ChanMapping::Invalid)
Test if this mapping is monotonic (useful to see if inplace processing is feasible)
Returns true if the map is a strict monotonic set
set buffer mapping for given data type
set buffer mapping for given data type
C‡: std::list<boost::shared_ptr<ARDOUR::AutomationControl> >
@@ -868,9 +991,9 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to Cmatrix multiply multiply every sample of `data' with the corresponding sample at `mult'.
C‡: ARDOUR::DSP::Biquad
@@ -938,6 +1061,45 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to Cprocess audio data
C‡: ARDOUR::DSP::Convolution
+ +| Constructor | ||
|---|---|---|
| ℂ | ARDOUR.DSP.Convolution (Session&, unsigned int, unsigned int) | |
| Methods | ||
| bool | add_impdata (unsigned int, unsigned int, Readable, float, unsigned int, long, long, unsigned int) | |
| unsigned int | latency () | |
| unsigned int | n_inputs () | |
| unsigned int | n_outputs () | |
| bool | ready () | |
| void | restart () | |
| void | run (BufferSet&, ChanMapping, ChanMapping, unsigned int, long) | |
C‡: ARDOUR::DSP::Convolver
+is-a: ARDOUR:DSP:Convolution
+ +| Constructor | ||
|---|---|---|
| ℂ | ARDOUR.DSP.Convolver (Session&, std::string, IRChannelConfig, IRSettings) | |
| Methods | ||
| void | run_mono (FloatArray, unsigned int) | |
| void | run_stereo (FloatArray, FloatArray, unsigned int) | |
| Constructor | ||
|---|---|---|
| ℂ | ARDOUR.DSP.Convolution (Session&, unsigned int, unsigned int) | |
| Methods | ||
| bool | add_impdata (unsigned int, unsigned int, Readable, float, unsigned int, long, long, unsigned int) | |
| unsigned int | latency () | |
| unsigned int | n_inputs () | |
| unsigned int | n_outputs () | |
| bool | ready () | |
| void | restart () | |
| void | run (BufferSet&, ChanMapping, ChanMapping, unsigned int, long) | |
C‡: ARDOUR::DSP::DspShm
@@ -970,9 +1132,44 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to Cprocess current data in buffer
query
Returns signal power at given bin (in dBFS)
query
Returns signal power at given bin (in dBFS)
C‡: ARDOUR::DSP::Generator
+ +| Constructor | ||
|---|---|---|
| ℂ | ARDOUR.DSP.Generator () | |
| Methods | ||
| void | run (FloatArray, unsigned int) | |
| void | set_type (Type) | |
C‡: ARDOUR::DSP::Convolver::IRSettings
+ +| Constructor | ||
|---|---|---|
| ℂ | ARDOUR.DSP.IRSettings () | |
| Methods | ||
| unsigned int | get_channel_delay (unsigned int) | |
| float | get_channel_gain (unsigned int) | |
| void | set_channel_delay (unsigned int, unsigned int) | |
| void | set_channel_gain (unsigned int, float) | |
| Data Members | ||
| float | gain | |
| unsigned int | pre_delay | |
C‡: ARDOUR::LTCReader
+ +| Constructor | ||
|---|---|---|
| ℂ | ARDOUR.DSP.LTCReader (int, LTC_TV_STANDARD) | |
| Methods | ||
| LuaTable(long, ...) | read (unsigned int&, unsigned int&, unsigned int&, unsigned int&) | |
| void | write (FloatArray, long, long) | |
C‡: ARDOUR::DSP::LowPass
@@ -983,7 +1180,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to Cinstantiate a LPF
filter control data
This is useful for parameter smoothing.
filter control data
This is useful for parameter smoothing.
process audio data
Inverse of the from-string constructor
C‡: boost::shared_ptr< ARDOUR::DelayLine >, boost::weak_ptr< ARDOUR::DelayLine >
+is-a: ARDOUR:Processor
+ +Meters peaks on the input and stores them for access.
| Methods | ||
|---|---|---|
| long | delay () | |
| bool | isnil () | |
| Methods | ||
|---|---|---|
| void | activate () | |
| bool | active () | |
| long | capture_offset () | |
| void | deactivate () | |
| std::string | display_name () | |
| bool | display_to_user () | |
| long | input_latency () | |
| ChanCount | input_streams () | |
| long | output_latency () | |
| ChanCount | output_streams () | |
| long | playback_offset () | |
| long | signal_latency () | |
| Cast | ||
| Amp | to_amp () | |
| Automatable | to_automatable () | |
| DelayLine | to_delayline () | |
| DiskIOProcessor | to_diskioprocessor () | |
| DiskReader | to_diskreader () | |
| DiskWriter | to_diskwriter () | |
| PluginInsert | to_insert () | |
| IOProcessor | to_ioprocessor () | |
| Latent | to_latent () | |
| PeakMeter | to_meter () | |
| MonitorProcessor | to_monitorprocessor () | |
| PeakMeter | to_peakmeter () | |
| PluginInsert | to_plugininsert () | |
| PolarityProcessor | to_polarityprocessor () | |
| Send | to_send () | |
| SideChain | to_sidechain () | |
| UnknownProcessor | to_unknownprocessor () | |
| Methods | ||
|---|---|---|
| std::string | name () | |
| Cast | ||
| Stateful | to_stateful () | |
| StatefulDestructible | to_statefuldestructible () | |
C‡: boost::shared_ptr< ARDOUR::Delivery >, boost::weak_ptr< ARDOUR::Delivery >
is-a: ARDOUR:IOProcessor
-A mixer strip element (Processor) with 1 or 2 IO elements.
A mixer strip element (Processor) with 1 or 2 IO elements.
| Methods | ||
|---|---|---|
| bool | isnil () | |
| Methods | ||
| void | activate () | |
| bool | active () | |
| long | capture_offset () | |
| void | deactivate () | |
| std::string | display_name () | |
| bool | display_to_user () | |
| ChanCount | input_streams () | |
| ChanCount | output_streams () | |
| long | input_latency () | |
| ChanCount | input_streams () | |
| long | output_latency () | |
| ChanCount | output_streams () | |
| long | playback_offset () | |
| long | signal_latency () | |
| Cast | ||
| Amp | to_amp () | |
| Automatable | to_automatable () | |
| DelayLine | to_delayline () | |
| DiskIOProcessor | to_diskioprocessor () | |
| DiskReader | to_diskreader () | |
| DiskWriter | to_diskwriter () | |
| PluginInsert | to_insert () | |
| IOProcessor | to_ioprocessor () | |
| Latent | to_latent () | |
| PeakMeter | to_meter () | |
| MonitorProcessor | to_monitorprocessor () | |
| PeakMeter | to_peakmeter () | |
| PluginInsert | to_plugininsert () | |
| PolarityProcessor | to_polarityprocessor () | |
| Send | to_send () | |
| SideChain | to_sidechain () | |
| UnknownProcessor | to_unknownprocessor () | |
C‡: ARDOUR::DoubleBeatsFramesConverter
+C‡: boost::shared_ptr< ARDOUR::DiskIOProcessor >, boost::weak_ptr< ARDOUR::DiskIOProcessor >
+is-a: ARDOUR:Processor
-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.
A mixer strip element - plugin, send, meter, etc
| Methods | ||
|---|---|---|
| bool | isnil () | |
| Methods | ||
|---|---|---|
| void | activate () | |
| bool | active () | |
| long | capture_offset () | |
| void | deactivate () | |
| std::string | display_name () | |
| bool | display_to_user () | |
| long | input_latency () | |
| ChanCount | input_streams () | |
| long | output_latency () | |
| ChanCount | output_streams () | |
| long | playback_offset () | |
| long | signal_latency () | |
| Cast | ||
| Amp | to_amp () | |
| Automatable | to_automatable () | |
| DelayLine | to_delayline () | |
| DiskIOProcessor | to_diskioprocessor () | |
| DiskReader | to_diskreader () | |
| DiskWriter | to_diskwriter () | |
| PluginInsert | to_insert () | |
| IOProcessor | to_ioprocessor () | |
| Latent | to_latent () | |
| PeakMeter | to_meter () | |
| MonitorProcessor | to_monitorprocessor () | |
| PeakMeter | to_peakmeter () | |
| PluginInsert | to_plugininsert () | |
| PolarityProcessor | to_polarityprocessor () | |
| Send | to_send () | |
| SideChain | to_sidechain () | |
| UnknownProcessor | to_unknownprocessor () | |
| Methods | ||
|---|---|---|
| std::string | name () | |
| Cast | ||
| Stateful | to_stateful () | |
| StatefulDestructible | to_statefuldestructible () | |
C‡: boost::shared_ptr< ARDOUR::DiskReader >, boost::weak_ptr< ARDOUR::DiskReader >
+is-a: ARDOUR:DiskIOProcessor
+ +A mixer strip element - plugin, send, meter, etc
| Methods | ||
|---|---|---|
| bool | isnil () | |
| Methods | ||
|---|---|---|
| void | activate () | |
| bool | active () | |
| long | capture_offset () | |
| void | deactivate () | |
| std::string | display_name () | |
| bool | display_to_user () | |
| long | input_latency () | |
| ChanCount | input_streams () | |
| long | output_latency () | |
| ChanCount | output_streams () | |
| long | playback_offset () | |
| long | signal_latency () | |
| Cast | ||
| Amp | to_amp () | |
| Automatable | to_automatable () | |
| DelayLine | to_delayline () | |
| DiskIOProcessor | to_diskioprocessor () | |
| DiskReader | to_diskreader () | |
| DiskWriter | to_diskwriter () | |
| PluginInsert | to_insert () | |
| IOProcessor | to_ioprocessor () | |
| Latent | to_latent () | |
| PeakMeter | to_meter () | |
| MonitorProcessor | to_monitorprocessor () | |
| PeakMeter | to_peakmeter () | |
| PluginInsert | to_plugininsert () | |
| PolarityProcessor | to_polarityprocessor () | |
| Send | to_send () | |
| SideChain | to_sidechain () | |
| UnknownProcessor | to_unknownprocessor () | |
| Methods | ||
|---|---|---|
| std::string | name () | |
| Cast | ||
| Stateful | to_stateful () | |
| StatefulDestructible | to_statefuldestructible () | |
C‡: boost::shared_ptr< ARDOUR::DiskWriter >, boost::weak_ptr< ARDOUR::DiskWriter >
+is-a: ARDOUR:DiskIOProcessor
+ +A mixer strip element - plugin, send, meter, etc
| Methods | ||
|---|---|---|
| bool | isnil () | |
| Methods | ||
|---|---|---|
| void | activate () | |
| bool | active () | |
| long | capture_offset () | |
| void | deactivate () | |
| std::string | display_name () | |
| bool | display_to_user () | |
| long | input_latency () | |
| ChanCount | input_streams () | |
| long | output_latency () | |
| ChanCount | output_streams () | |
| long | playback_offset () | |
| long | signal_latency () | |
| Cast | ||
| Amp | to_amp () | |
| Automatable | to_automatable () | |
| DelayLine | to_delayline () | |
| DiskIOProcessor | to_diskioprocessor () | |
| DiskReader | to_diskreader () | |
| DiskWriter | to_diskwriter () | |
| PluginInsert | to_insert () | |
| IOProcessor | to_ioprocessor () | |
| Latent | to_latent () | |
| PeakMeter | to_meter () | |
| MonitorProcessor | to_monitorprocessor () | |
| PeakMeter | to_peakmeter () | |
| PluginInsert | to_plugininsert () | |
| PolarityProcessor | to_polarityprocessor () | |
| Send | to_send () | |
| SideChain | to_sidechain () | |
| UnknownProcessor | to_unknownprocessor () | |
| Methods | ||
|---|---|---|
| std::string | name () | |
| Cast | ||
| Stateful | to_stateful () | |
| StatefulDestructible | to_statefuldestructible () | |
C‡: ARDOUR::DoubleBeatsSamplesConverter
+ +Converter between quarter-note beats and samples. Takes distances in quarter-note beats or samples from some origin (supplied to the constructor in samples), and converts them to the opposite unit, taking tempo changes into account.
| Constructor | ||
|---|---|---|
| ℂ | ARDOUR.DoubleBeatsFramesConverter (TempoMap, long) | |
| ℂ | ARDOUR.DoubleBeatsSamplesConverter (TempoMap, long) | |
| Methods | ||
| double | from (long) | |
| double | from (long) | |
Convert B time to A time (A from B) | ||
| long | to (double) | |
| long | to (double) | |
Convert A time to B time (A to B) | ||
| Constructor | ||
|---|---|---|
| ℂ | ARDOUR.FluidSynth (float, int) | |
instantiate a Synth
| ||
instantiate a Synth
| ||
| Methods | ||
| bool | load_sf2 (std::string) | |
| bool | midi_event (unsigned char*, unsigned long) | |
| Methods | ||
| AutomationList | alist () | |
| AutoState | automation_state () | |
| ParameterDescriptor | desc () | |
| double | get_value () | |
Get the current effective `user' value based on automation state | ||
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) | |
Get and Set `internal' value All derived classes must implement this. Basic derived classes will ignore
| ||
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 () | |
| Methods | ||
|---|---|---|
| bool | active () | |
| int | disconnect_all (void*) | |
| bool | has_port (Port) | |
| bool | isnil () | |
| long | latency () | |
| MidiPort | midi (unsigned int) | |
| ChanCount | n_ports () | |
| Port | nth (unsigned int) | |
| bool | physically_connected () | |
| Port | port_by_name (unsigned int) | |
| long | public_latency () | |
| int | remove_port (Port, void*) | |
C‡: boost::shared_ptr< ARDOUR::IOProcessor >, boost::weak_ptr< ARDOUR::IOProcessor >
is-a: ARDOUR:Processor
-A mixer strip element (Processor) with 1 or 2 IO elements.
A mixer strip element (Processor) with 1 or 2 IO elements.
| Methods | ||
|---|---|---|
| IO | input () | |
| Methods | ||
| void | activate () | |
| bool | active () | |
| long | capture_offset () | |
| void | deactivate () | |
| std::string | display_name () | |
| bool | display_to_user () | |
| ChanCount | input_streams () | |
| ChanCount | output_streams () | |
| long | input_latency () | |
| ChanCount | input_streams () | |
| long | output_latency () | |
| ChanCount | output_streams () | |
| long | playback_offset () | |
| long | signal_latency () | |
| Cast | ||
| Amp | to_amp () | |
| Automatable | to_automatable () | |
| DelayLine | to_delayline () | |
| DiskIOProcessor | to_diskioprocessor () | |
| DiskReader | to_diskreader () | |
| DiskWriter | to_diskwriter () | |
| PluginInsert | to_insert () | |
| IOProcessor | to_ioprocessor () | |
| Latent | to_latent () | |
| PeakMeter | to_meter () | |
| MonitorProcessor | to_monitorprocessor () | |
| PeakMeter | to_peakmeter () | |
| PluginInsert | to_plugininsert () | |
| PolarityProcessor | to_polarityprocessor () | |
| Send | to_send () | |
| SideChain | to_sidechain () | |
| UnknownProcessor | to_unknownprocessor () | |
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.
| Methods | ||
|---|---|---|
| bool | isnil () | |
| Methods | ||
|---|---|---|
| IO | input () | |
| ChanCount | natural_input_streams () | |
| ChanCount | natural_output_streams () | |
| IO | output () | |
| Methods | ||
|---|---|---|
| void | activate () | |
| bool | active () | |
| long | capture_offset () | |
| void | deactivate () | |
| std::string | display_name () | |
| bool | display_to_user () | |
| long | input_latency () | |
| ChanCount | input_streams () | |
| long | output_latency () | |
| ChanCount | output_streams () | |
| long | playback_offset () | |
| long | signal_latency () | |
| Cast | ||
| Amp | to_amp () | |
| Automatable | to_automatable () | |
| DelayLine | to_delayline () | |
| DiskIOProcessor | to_diskioprocessor () | |
| DiskReader | to_diskreader () | |
| DiskWriter | to_diskwriter () | |
| PluginInsert | to_insert () | |
| IOProcessor | to_ioprocessor () | |
| Latent | to_latent () | |
| PeakMeter | to_meter () | |
| MonitorProcessor | to_monitorprocessor () | |
| PeakMeter | to_peakmeter () | |
| PluginInsert | to_plugininsert () | |
| PolarityProcessor | to_polarityprocessor () | |
| Send | to_send () | |
| SideChain | to_sidechain () | |
| UnknownProcessor | to_unknownprocessor () | |
| Methods | ||
|---|---|---|
| std::string | name () | |
| Cast | ||
| Stateful | to_stateful () | |
| StatefulDestructible | to_statefuldestructible () | |
C‡: boost::shared_ptr< ARDOUR::InternalSend >, boost::weak_ptr< ARDOUR::InternalSend >
+is-a: ARDOUR:Send
+ +A mixer strip element (Processor) with 1 or 2 IO elements.
| Methods | ||
|---|---|---|
| bool | isnil () | |
| Methods | ||
|---|---|---|
| long | get_delay_in () | |
| long | get_delay_out () | |
| Methods | ||
|---|---|---|
| PannerShell | panner_shell () | |
| Methods | ||
|---|---|---|
| IO | input () | |
| ChanCount | natural_input_streams () | |
| ChanCount | natural_output_streams () | |
| IO | output () | |
| Methods | ||
|---|---|---|
| void | activate () | |
| bool | active () | |
| long | capture_offset () | |
| void | deactivate () | |
| std::string | display_name () | |
| bool | display_to_user () | |
| long | input_latency () | |
| ChanCount | input_streams () | |
| long | output_latency () | |
| ChanCount | output_streams () | |
| long | playback_offset () | |
| long | signal_latency () | |
| Cast | ||
| Amp | to_amp () | |
| Automatable | to_automatable () | |
| DelayLine | to_delayline () | |
| DiskIOProcessor | to_diskioprocessor () | |
| DiskReader | to_diskreader () | |
| DiskWriter | to_diskwriter () | |
| PluginInsert | to_insert () | |
| IOProcessor | to_ioprocessor () | |
| Latent | to_latent () | |
| PeakMeter | to_meter () | |
| MonitorProcessor | to_monitorprocessor () | |
| PeakMeter | to_peakmeter () | |
| PluginInsert | to_plugininsert () | |
| PolarityProcessor | to_polarityprocessor () | |
| Send | to_send () | |
| SideChain | to_sidechain () | |
| UnknownProcessor | to_unknownprocessor () | |
| Methods | ||
|---|---|---|
| std::string | name () | |
| Cast | ||
| Stateful | to_stateful () | |
| StatefulDestructible | to_statefuldestructible () | |
C‡: ARDOUR::LatencyRange
+ +| Constructor | ||
|---|---|---|
| ℂ | ARDOUR.LatencyRange () | |
| Data Members | ||
| unsigned int | max | |
| unsigned int | min | |
C‡: boost::shared_ptr< ARDOUR::Latent >, boost::weak_ptr< ARDOUR::Latent >
+ +| Methods | ||
|---|---|---|
| long | effective_latency () | |
| bool | isnil () | |
| void | set_user_latency (long) | |
| void | unset_user_latency () | |
| long | user_latency () | |
C‡: ARDOUR::Location
is-a: PBD:StatefulDestructible
@@ -1324,9 +1908,12 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to CSet end position.
Set location name
Set start position.
Look for the `marks' (either locations which are marks, or start/end points of range markers) either side of a frame. Note that if frame is exactly on a `mark', that mark will not be considered for returning as before/after.
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.
| Methods | |||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| std::string | ascii_dtostr (double) | ||||||||||||||||||||||||||||||||||
| ... | 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) | |||||||||||||||||||||||||||||||||||
| std::string | file_get_contents (std::string) | ||||||||||||||||||||||||||||||||||
| bool | file_test (std::string, FileTest) | ||||||||||||||||||||||||||||||||||
| LuaTable(float, ...) | get_plugin_insert_param (PluginInsert, unsigned int, bool&) | ||||||||||||||||||||||||||||||||||
get a plugin control parameter value
Returns value | |||||||||||||||||||||||||||||||||||
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) | |||||||||||||||||||||||||||||||||||
| PluginInfoList | list_plugins () | ||||||||||||||||||||||||||||||||||
List all installed plugins | |||||||||||||||||||||||||||||||||||
| 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) | ||||||||||||||||||||||||||||||||||
| NotePtr | new_noteptr (unsigned char, Beats, Beats, unsigned char, unsigned char) | ||||||||||||||||||||||||||||||||||
| Processor | new_plugin (Session, std::string, PluginType, std::string) | ||||||||||||||||||||||||||||||||||
create a new Plugin Instance
Returns Processor or nil | |||||||||||||||||||||||||||||||||||
create a new Plugin Instance
Returns Processor or nil | |||||||||||||||||||||||||||||||||||
| PluginInfo | new_plugin_info (std::string, PluginType) | ||||||||||||||||||||||||||||||||||
search a Plugin
Returns PluginInfo or nil if not found | |||||||||||||||||||||||||||||||||||
| Processor | nil_proc () | ||||||||||||||||||||||||||||||||||
| NotePtrList | note_list (MidiModel) | ||||||||||||||||||||||||||||||||||
| 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 () @@ -1422,13 +2015,27 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C | |||||||||||||||||||||||||||||||||||
C‡: ARDOUR::LuaAPI::Rubberband
+ +| Constructor | ||
|---|---|---|
| ℂ | ARDOUR.LuaAPI.Rubberband (AudioRegion, bool) | |
| Methods | ||
| unsigned int | n_channels () | |
| AudioRegion | process (Lua-Function) | |
| Readable | readable () | |
| long | readable_length () | |
| bool | set_mapping (Lua-Function) | |
| bool | set_strech_and_pitch (double, double) | |
C‡: ARDOUR::LuaAPI::Vamp
@@ -1437,7 +2044,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to Chigh-level abstraction to process a single channel of the given Readable.
If the plugin is not yet initialized, initialize() is called.
if is not nil, it is called with the immediate Vamp::Plugin::Features on every process call.
Returns 0 on success
high-level abstraction to process a single channel of the given Readable.
If the plugin is not yet initialized, initialize() is called.
if fn is not nil, it is called with the immediate Vamp::Plugin::Features on every process call.
Returns 0 on success
initialize the plugin for use with analyze().
This is equivalent to plugin():initialise (1, ssiz, bsiz) and prepares a plugin for analyze. (by preferred step and block sizes are used. if the plugin does not specify them or they're larger than 8K, both are set to 1024)
Manual initialization is only required to set plugin-parameters which depend on prior initialization of the plugin.
vamp:reset () vamp:initialize () @@ -1524,9 +2131,9 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to Cℂ ARDOUR.Meter (double, double) Methods - double divisions_per_bar () - double frames_per_bar (Tempo, long) double frames_per_grid (Tempo, long) + double note_divisor () + double samples_per_bar (Tempo, long) double samples_per_grid (Tempo, long) ∁ ARDOUR:MeterSection
C‡: ARDOUR::MeterSection
@@ -1535,15 +2142,23 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to CA section of timeline with a certain Meter.
| Methods | ||
|---|---|---|
| BBT_TIME | bbt () | |
| double | beat () | |
| void | set_beat (double) | |
| void | set_pulse (double) | |
| Cast | ||
| Meter | to_meter () | |
| Methods | ||
|---|---|---|
| bool | initial () | |
| bool | is_tempo () | |
| double | minute () | |
| double | minute_at_sample (long) | |
| double | pulse () | |
| long | sample () | |
| long | sample_at_minute (double) | |
| void | set_pulse (double) | |
C‡: ARDOUR::MetricSection
@@ -1551,7 +2166,13 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to CA section of timeline with a certain Tempo or Meter.
| Methods | ||
|---|---|---|
| bool | initial () | |
| bool | is_tempo () | |
| double | minute () | |
| double | minute_at_sample (long) | |
| double | pulse () | |
| long | sample () | |
| long | sample_at_minute (double) | |
| void | set_pulse (double) | |
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.
Clear (e.g. zero, or empty) buffer
Clear (eg zero, or empty) buffer
| Cast | ||
|---|---|---|
| Sequence | to_sequence () | |
| Sequence | to_sequence () | |
| Methods | ||
|---|---|---|
| void | add (NotePtr) | |
| void | remove (NotePtr) | |
| void | add (NotePtr) | |
| void | remove (NotePtr) | |
| ||
| void | duplicate_range (AudioRange&, float) | |
| void | duplicate_until (Region, long, long, long) | |
| ||
| ||
| bool | empty () | |
| Region | find_next_region (long, RegionPoint, int) | |
| long | find_next_region_boundary (long, int) | |
| long | find_next_transient (long, int) | |
| ID | get_orig_track_id () | |
| bool | hidden () | |
| void | lower_region (Region) | |
| void | lower_region_to_bottom (Region) | |
| unsigned int | n_regions () | |
| RegionListPtr | regions_with_end_within (Range) | |
| RegionListPtr | regions_with_start_within (Range) | |
| void | remove_region (Region) | |
| void | split (long) | |
| void | split_region (Region, MusicFrame) | |
| bool | shared () | |
| void | split_region (Region, MusicSample) | |
| Region | top_region_at (long) | |
| Region | top_unmuted_region_at (long) | |
| void | uncombine (Region) | |
| bool | used () | |
| Cast | ||
|---|---|---|
| AudioPlaylist | to_audioplaylist () | |
| MidiPlaylist | to_midiplaylist () | |
| bool | input_active () | |
| bool | isnil () | |
| void | set_input_active (bool) | |
| Cast | ||
| AsyncMIDIPort | to_asyncmidiport () | |
Returns true if this port is connected to o, otherwise false. | ||
| int | disconnect (std::string) | |
| int | disconnect_all () | |
| LuaTable(...) | get_connected_latency_range (LatencyRange&, bool) | |
| std::string | name () | |
Returns Port short name | ||
| bool | physically_connected () | |
| std::string | pretty_name (bool) | |
Returns Port human readable name | ||
| LatencyRange | private_latency_range (bool) | |
| LatencyRange | public_latency_range (bool) | |
| bool | receives_input () | |
Returns true if this Port receives input, otherwise false | ||
| bool | sends_output () | |
Returns true if this Port sends output, otherwise false | ||
| Cast | ||
|---|---|---|
| AsyncMIDIPort | to_asyncmidiport () | |
| AudioPort | to_audioport () | |
| MidiPort | to_midiport () | |
How the region parameters play together:
POSITION: first frame of the region along the timeline START: first frame of the region within its source(s) LENGTH: number of frames the region represents
How the region parameters play together:
POSITION: first sample of the region along the timeline START: first sample of the region within its source(s) LENGTH: number of samples the region represents
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.
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.
Note: changing the name of a Region does not constitute an edit
C‡: boost::shared_ptr< ARDOUR::MidiTrack >, boost::weak_ptr< ARDOUR::MidiTrack >
is-a: ARDOUR:Track
-A track is an route (bus) with a recordable diskstream and related objects relevant to tracking, playback and editing.
Specifically a track has regions and playlist objects.
A track is an route (bus) with a recordable diskstream and related objects relevant to recording, playback and editing.
Specifically a track has a playlist object that describes material to be played from disk, and modifies that object during recording and editing.
| Methods | ||
|---|---|---|
| bool | isnil () | |
| 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 | can_record () | |
| int | find_and_use_playlist (DataType, ID) | |
| Playlist | playlist () | |
| bool | set_name (std::string) | |
| int | use_copy_playlist () | |
| int | use_new_playlist (DataType) | |
| int | use_playlist (DataType, Playlist) | |
| Cast | ||
| AudioTrack | to_audio_track () | |
| MidiTrack | to_midi_track () | |
| std::string | comment () | |
| bool | customize_plugin_insert (Processor, unsigned int, ChanCount, ChanCount) | |
enable custom plugin-insert configuration
Returns true if successful | ||
| DataType | data_type () | |
| IO | input () | |
| Delivery | main_outs () | |
the signal processorat at end of the processing chain which produces output | ||
| PannerShell | panner_shell () | |
| PeakMeter | peak_meter () | |
************************************************************* Pure interface begins here************************************************************* | ||
| long | playback_latency (bool) | |
| int | remove_processor (Processor, ProcessorStreams, bool) | |
remove plugin/processor
Returns 0 on success | ||
| int | remove_processors (ProcessorList, ProcessorStreams) | |
| void | set_comment (std::string, void*) | |
| void | set_meter_point (MeterPoint, bool) | |
| bool | set_strict_io (bool) | |
| long | signal_latency () | |
| bool | soloed () | |
| bool | strict_io () | |
| Processor | the_instrument () | |
Return the first processor that accepts has at least one MIDI input and at least one audio output. In the vast majority of cases, this will be "the instrument". This does not preclude other MIDI->audio processors later in the processing chain, but that would be a special case not covered by this utility function. | ||
| Amp | trim () | |
| Cast | ||
| Automatable | to_automatable () | |
| Slavable | to_slavable () | |
| Track | to_track () | |
| Methods | ||
|---|---|---|
| AutomationControl | comp_enable_control () | |
| AutomationControl | comp_makeup_control () | |
| AutomationControl | comp_mode_control () | |
| AutomationControl | comp_enable_controllable () | |
| AutomationControl | comp_makeup_controllable () | |
| AutomationControl | comp_mode_controllable () | |
| std::string | comp_mode_name (unsigned int) | |
| ReadOnlyControl | comp_redux_control () | |
| AutomationControl | comp_speed_control () | |
| ReadOnlyControl | comp_redux_controllable () | |
| AutomationControl | comp_speed_controllable () | |
| std::string | comp_speed_name (unsigned int) | |
| AutomationControl | comp_threshold_control () | |
| AutomationControl | comp_threshold_controllable () | |
| 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 | eq_enable_controllable () | |
| AutomationControl | eq_freq_controllable (unsigned int) | |
| AutomationControl | eq_gain_controllable (unsigned int) | |
| AutomationControl | eq_q_controllable (unsigned int) | |
| AutomationControl | eq_shape_controllable (unsigned int) | |
| AutomationControl | filter_enable_controllable (bool) | |
| AutomationControl | filter_freq_controllable (bool) | |
| AutomationControl | filter_slope_controllable (bool) | |
| bool | is_hidden () | |
| bool | is_master () | |
| bool | is_monitor () | |
| bool | is_private_route () | |
| bool | is_selected () | |
| AutomationControl | master_send_enable_control () | |
| AutomationControl | master_send_enable_controllable () | |
| MonitorProcessor | monitor_control () | |
| MuteControl | mute_control () | |
| AutomationControl | pan_azimuth_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) | |
| AutomationControl | send_enable_controllable (unsigned int) | |
| AutomationControl | send_level_controllable (unsigned int) | |
| std::string | send_name (unsigned int) | |
| AutomationControl | send_pan_azimuth_controllable (unsigned int) | |
| AutomationControl | send_pan_azimuth_enable_controllable (unsigned int) | |
| void | set_presentation_order (unsigned int) | |
| bool | slaved () | |
| bool | slaved_to (VCA) | |
| SoloControl | solo_control () | |
| SoloIsolateControl | solo_isolate_control () | |
| SoloSafeControl | solo_safe_control () | |
| GainControl | trim_control () | |
| Cast | ||
| Automatable | to_automatable () | |
| Route | to_route () | |
| Slavable | to_slavable () | |
| VCA | to_vca () | |
C‡: ARDOUR::MusicFrame
+C‡: ARDOUR::MusicSample
| Constructor | ||
|---|---|---|
| ℂ | ARDOUR.MusicFrame (long, int) | |
| ℂ | ARDOUR.MusicSample (long, int) | |
| Methods | ||
| void | set (long, int) | |
| void | set (long, int) | |
| Data Members | ||
| int | division | |
| long | frame | |
| long | sample | |
C‡: boost::shared_ptr< ARDOUR::MuteControl >, boost::weak_ptr< ARDOUR::MuteControl >
@@ -2112,13 +2770,18 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to CGet the current effective `user' value based on automation state
Get `internal' value
Returns raw value as used for the plugin/processor control port
Get and Set `internal' value
All derived classes must implement this.
Basic derived classes will ignore
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.
C‡: std::list<boost::shared_ptr<Evoral::Note<Evoral::Beats> > > >
+C‡: std::list<boost::shared_ptr<Evoral::Note<Temporal::Beats> > > >
| Constructor | ||
|---|---|---|
| ℂ | ARDOUR.NotePtrList () | |
| Methods | ||
| LuaTable | add (LuaTable {Beats}) | |
| NotePtr | back () | |
| bool | empty () | |
| NotePtr | front () | |
| NotePtr | back () | |
| bool | empty () | |
| NotePtr | front () | |
| LuaIter | iter () | |
| void | push_back (NotePtr) | |
| void | reverse () | |
| unsigned long | size () | |
| void | push_back (NotePtr) | |
| void | reverse () | |
| unsigned long | size () | |
| LuaTable | table () | |
| void | unique () | |
| void | unique () | |
C‡: PBD::OwnedPropertyList
@@ -2161,6 +2824,14 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to CPersistent 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‡: ARDOUR::Latent
+ +| Methods | ||
|---|---|---|
| void | force_zero_latency (bool) | |
| bool | zero_latency () | |
C‡: boost::shared_ptr< ARDOUR::PannerShell >, boost::weak_ptr< ARDOUR::PannerShell >
is-a: ARDOUR:SessionObjectPtr
@@ -2218,28 +2889,41 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C| Methods | ||
|---|---|---|
| void | activate () | |
| bool | active () | |
| long | capture_offset () | |
| void | deactivate () | |
| std::string | display_name () | |
| bool | display_to_user () | |
| ChanCount | input_streams () | |
| ChanCount | output_streams () | |
| long | input_latency () | |
| ChanCount | input_streams () | |
| long | output_latency () | |
| ChanCount | output_streams () | |
| long | playback_offset () | |
| long | signal_latency () | |
| Cast | ||
| Amp | to_amp () | |
| Automatable | to_automatable () | |
| DelayLine | to_delayline () | |
| DiskIOProcessor | to_diskioprocessor () | |
| DiskReader | to_diskreader () | |
| DiskWriter | to_diskwriter () | |
| PluginInsert | to_insert () | |
| IOProcessor | to_ioprocessor () | |
| Latent | to_latent () | |
| PeakMeter | to_meter () | |
| MonitorProcessor | to_monitorprocessor () | |
| PeakMeter | to_peakmeter () | |
| PluginInsert | to_plugininsert () | |
| PolarityProcessor | to_polarityprocessor () | |
| Send | to_send () | |
| SideChain | to_sidechain () | |
| UnknownProcessor | to_unknownprocessor () | |
Get the current effective `user' value based on automation state
Get `internal' value
Returns raw value as used for the plugin/processor control port
Get and Set `internal' value
All derived classes must implement this.
Basic derived classes will ignore
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.
C‡: std::vector<boost::shared_ptr<ARDOUR::Playlist> >
+ +| Constructor | ||
|---|---|---|
| ℂ | ARDOUR.PlaylistList () | |
| ℂ | ARDOUR.PlaylistList () | |
| Methods | ||
| LuaTable | add (LuaTable {Playlist}) | |
| Playlist | at (unsigned long) | |
| void | clear () | |
| bool | empty () | |
| LuaIter | iter () | |
| void | push_back (Playlist) | |
| unsigned long | size () | |
| LuaTable | table () | |
| ... | to_array (--lua--) | |
C‡: boost::shared_ptr< ARDOUR::Plugin >, boost::weak_ptr< ARDOUR::Plugin >
is-a: PBD:StatefulDestructiblePtr
@@ -2408,13 +3119,18 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to CGet the current effective `user' value based on automation state
Get `internal' value
Returns raw value as used for the plugin/processor control port
Get and Set `internal' value
All derived classes must implement this.
Basic derived classes will ignore
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.
C‡: std::list<boost::shared_ptr<ARDOUR::PluginInfo> >
+ +| Constructor | ||
|---|---|---|
| ℂ | ARDOUR.PluginInfoList () | |
| Methods | ||
| LuaTable | add (LuaTable {PluginInfo}) | |
| PluginInfo | back () | |
| bool | empty () | |
| PluginInfo | front () | |
| LuaIter | iter () | |
| void | push_back (PluginInfo) | |
| void | reverse () | |
| unsigned long | size () | |
| LuaTable | table () | |
| void | unique () | |
C‡: boost::shared_ptr< ARDOUR::PluginInsert >, boost::weak_ptr< ARDOUR::PluginInsert >
is-a: ARDOUR:Processor
@@ -2461,8 +3195,16 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C| Methods | ||
|---|---|---|
| void | activate () | |
| void | clear_stats () | |
| void | deactivate () | |
| void | enable (bool) | |
| bool | enabled () | |
| unsigned int | get_count () | |
| LuaTable(bool, ...) | get_stats (unsigned long&, unsigned long&, double&, double&) | |
| bool | has_sidechain () | |
| ChanMapping | input_map (unsigned int) | |
| bool | is_channelstrip () | |
| bool | is_instrument () | |
| bool | isnil () | |
| ChanCount | natural_input_streams () | |
| ChanCount | natural_output_streams () | |
| bool | reset_parameters_to_default () | |
| void | set_input_map (unsigned int, ChanMapping) | |
| void | set_output_map (unsigned int, ChanMapping) | |
| long | signal_latency () | |
| bool | strict_io_configured () | |
| PluginType | type () | |
| Methods | ||
|---|---|---|
| bool | active () | |
| long | capture_offset () | |
| std::string | display_name () | |
| bool | display_to_user () | |
| ChanCount | input_streams () | |
| ChanCount | output_streams () | |
| long | input_latency () | |
| ChanCount | input_streams () | |
| long | output_latency () | |
| ChanCount | output_streams () | |
| long | playback_offset () | |
| Cast | ||
| Amp | to_amp () | |
| Automatable | to_automatable () | |
| DelayLine | to_delayline () | |
| DiskIOProcessor | to_diskioprocessor () | |
| DiskReader | to_diskreader () | |
| DiskWriter | to_diskwriter () | |
| PluginInsert | to_insert () | |
| IOProcessor | to_ioprocessor () | |
| Latent | to_latent () | |
| PeakMeter | to_meter () | |
| MonitorProcessor | to_monitorprocessor () | |
| PeakMeter | to_peakmeter () | |
| PluginInsert | to_plugininsert () | |
| PolarityProcessor | to_polarityprocessor () | |
| Send | to_send () | |
| SideChain | to_sidechain () | |
| UnknownProcessor | to_unknownprocessor () | |
| Methods | ||
|---|---|---|
| std::string | name () | |
| Cast | ||
| Stateful | to_stateful () | |
| StatefulDestructible | to_statefuldestructible () | |
C‡: boost::shared_ptr< ARDOUR::PolarityProcessor >, boost::weak_ptr< ARDOUR::PolarityProcessor >
+is-a: ARDOUR:Processor
+ +A mixer strip element - plugin, send, meter, etc
| Methods | ||
|---|---|---|
| bool | isnil () | |
| Methods | ||
|---|---|---|
| void | activate () | |
| bool | active () | |
| long | capture_offset () | |
| void | deactivate () | |
| std::string | display_name () | |
| bool | display_to_user () | |
| long | input_latency () | |
| ChanCount | input_streams () | |
| long | output_latency () | |
| ChanCount | output_streams () | |
| long | playback_offset () | |
| long | signal_latency () | |
| Cast | ||
| Amp | to_amp () | |
| Automatable | to_automatable () | |
| DelayLine | to_delayline () | |
| DiskIOProcessor | to_diskioprocessor () | |
| DiskReader | to_diskreader () | |
| DiskWriter | to_diskwriter () | |
| PluginInsert | to_insert () | |
| IOProcessor | to_ioprocessor () | |
| Latent | to_latent () | |
| PeakMeter | to_meter () | |
| MonitorProcessor | to_monitorprocessor () | |
| PeakMeter | to_peakmeter () | |
| PluginInsert | to_plugininsert () | |
| PolarityProcessor | to_polarityprocessor () | |
| Send | to_send () | |
| SideChain | to_sidechain () | |
| UnknownProcessor | to_unknownprocessor () | |
Returns true if this port is connected to o, otherwise false.
Returns Port short name
Returns Port human readable name
Returns true if this Port receives input, otherwise false
Returns true if this Port sends output, otherwise false
C‡: boost::shared_ptr< ARDOUR::Processor >, boost::weak_ptr< ARDOUR::Processor >
@@ -2644,21 +3457,33 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to CC‡: ARDOUR::Progress
@@ -2717,7 +3544,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to CC‡: PBD::PropertyDescriptor<float>
This class object is only used indirectly as return-value and function-parameter. It provides no methods by itself.
-C‡: PBD::PropertyDescriptor<long>
This class object is only used indirectly as return-value and function-parameter. It provides no methods by itself.
@@ -2729,7 +3556,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to CC‡: PBD::PropertyList
@@ -2754,6 +3581,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C| ID | id () | |
| OwnedPropertyList | properties () |
C‡: ARDOUR::RawMidiParser
+ +| Constructor | ||
|---|---|---|
| ℂ | ARDOUR.RawMidiParser () | |
| Methods | ||
| unsigned long | buffer_size () | |
| unsigned char* | midi_buffer () | |
| bool | process_byte (unsigned char) | |
| void | reset () | |
C‡: boost::shared_ptr< ARDOUR::ReadOnlyControl >, boost::weak_ptr< ARDOUR::ReadOnlyControl >
is-a: PBD:StatefulDestructiblePtr
@@ -3234,10 +4079,29 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C| Methods | ||
|---|---|---|
| bool | isnil () | |
| ReadableList | load (Session&, std::string) | |
| unsigned int | n_channels () | |
| long | read (FloatArray, long, long, int) | |
| long | readable_length () | |
C‡: std::vector<boost::shared_ptr<ARDOUR::Readable> >
+ +| Constructor | ||
|---|---|---|
| ℂ | ARDOUR.ReadableList () | |
| ℂ | ARDOUR.ReadableList () | |
| Methods | ||
| LuaTable | add (LuaTable {Readable}) | |
| Readable | at (unsigned long) | |
| void | clear () | |
| bool | empty () | |
| LuaIter | iter () | |
| void | push_back (Readable) | |
| unsigned long | size () | |
| LuaTable | table () | |
| ... | to_array (--lua--) | |
C‡: boost::shared_ptr< ARDOUR::Region >, boost::weak_ptr< ARDOUR::Region >
is-a: ARDOUR:SessionObjectPtr
@@ -3274,18 +4138,21 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to CHow the region parameters play together:
POSITION: first frame of the region along the timeline START: first frame of the region within its source(s) LENGTH: number of frames the region represents
How the region parameters play together:
POSITION: first sample of the region along the timeline START: first sample of the region within its source(s) LENGTH: number of samples the region represents
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.
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.
Note: changing the name of a Region does not constitute an edit
C‡: boost::shared_ptr< ARDOUR::Return >, boost::weak_ptr< ARDOUR::Return >
+is-a: ARDOUR:IOProcessor
+ +A mixer strip element (Processor) with 1 or 2 IO elements.
| Methods | ||
|---|---|---|
| bool | isnil () | |
| Methods | ||
|---|---|---|
| IO | input () | |
| ChanCount | natural_input_streams () | |
| ChanCount | natural_output_streams () | |
| IO | output () | |
| Methods | ||
|---|---|---|
| void | activate () | |
| bool | active () | |
| long | capture_offset () | |
| void | deactivate () | |
| std::string | display_name () | |
| bool | display_to_user () | |
| long | input_latency () | |
| ChanCount | input_streams () | |
| long | output_latency () | |
| ChanCount | output_streams () | |
| long | playback_offset () | |
| long | signal_latency () | |
| Cast | ||
| Amp | to_amp () | |
| Automatable | to_automatable () | |
| DelayLine | to_delayline () | |
| DiskIOProcessor | to_diskioprocessor () | |
| DiskReader | to_diskreader () | |
| DiskWriter | to_diskwriter () | |
| PluginInsert | to_insert () | |
| IOProcessor | to_ioprocessor () | |
| Latent | to_latent () | |
| PeakMeter | to_meter () | |
| MonitorProcessor | to_monitorprocessor () | |
| PeakMeter | to_peakmeter () | |
| PluginInsert | to_plugininsert () | |
| PolarityProcessor | to_polarityprocessor () | |
| Send | to_send () | |
| SideChain | to_sidechain () | |
| UnknownProcessor | to_unknownprocessor () | |
| Methods | ||
|---|---|---|
| std::string | name () | |
| Cast | ||
| Stateful | to_stateful () | |
| StatefulDestructible | to_statefuldestructible () | |
C‡: boost::shared_ptr< ARDOUR::Route >, boost::weak_ptr< ARDOUR::Route >
is-a: ARDOUR:Stripable
@@ -3407,6 +4335,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to Cenable custom plugin-insert configuration
Returns true if successful
************************************************************* Pure interface begins here*************************************************************
remove plugin/processor
Returns 0 on success
Return the first processor that accepts has at least one MIDI input and at least one audio output. In the vast majority of cases, this will be "the instrument". This does not preclude other MIDI->audio processors later in the processing chain, but that would be a special case not covered by this utility function.
| Methods | ||
|---|---|---|
| AutomationControl | comp_enable_control () | |
| AutomationControl | comp_makeup_control () | |
| AutomationControl | comp_mode_control () | |
| AutomationControl | comp_enable_controllable () | |
| AutomationControl | comp_makeup_controllable () | |
| AutomationControl | comp_mode_controllable () | |
| std::string | comp_mode_name (unsigned int) | |
| ReadOnlyControl | comp_redux_control () | |
| AutomationControl | comp_speed_control () | |
| ReadOnlyControl | comp_redux_controllable () | |
| AutomationControl | comp_speed_controllable () | |
| std::string | comp_speed_name (unsigned int) | |
| AutomationControl | comp_threshold_control () | |
| AutomationControl | comp_threshold_controllable () | |
| 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 | eq_enable_controllable () | |
| AutomationControl | eq_freq_controllable (unsigned int) | |
| AutomationControl | eq_gain_controllable (unsigned int) | |
| AutomationControl | eq_q_controllable (unsigned int) | |
| AutomationControl | eq_shape_controllable (unsigned int) | |
| AutomationControl | filter_enable_controllable (bool) | |
| AutomationControl | filter_freq_controllable (bool) | |
| AutomationControl | filter_slope_controllable (bool) | |
| bool | is_hidden () | |
| bool | is_master () | |
| bool | is_monitor () | |
| bool | is_private_route () | |
| bool | is_selected () | |
| AutomationControl | master_send_enable_control () | |
| AutomationControl | master_send_enable_controllable () | |
| MonitorProcessor | monitor_control () | |
| MuteControl | mute_control () | |
| AutomationControl | pan_azimuth_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) | |
| AutomationControl | send_enable_controllable (unsigned int) | |
| AutomationControl | send_level_controllable (unsigned int) | |
| std::string | send_name (unsigned int) | |
| AutomationControl | send_pan_azimuth_controllable (unsigned int) | |
| AutomationControl | send_pan_azimuth_enable_controllable (unsigned int) | |
| void | set_presentation_order (unsigned int) | |
| bool | slaved () | |
| bool | slaved_to (VCA) | |
| SoloControl | solo_control () | |
| SoloIsolateControl | solo_isolate_control () | |
| SoloSafeControl | solo_safe_control () | |
| GainControl | trim_control () | |
| Cast | ||
| Automatable | to_automatable () | |
| Route | to_route () | |
| Slavable | to_slavable () | |
| VCA | to_vca () | |
C‡: boost::shared_ptr< ARDOUR::Send >, boost::weak_ptr< ARDOUR::Send >
+is-a: ARDOUR:Delivery
+ +A mixer strip element (Processor) with 1 or 2 IO elements.
| Methods | ||
|---|---|---|
| long | get_delay_in () | |
| long | get_delay_out () | |
| bool | isnil () | |
| Methods | ||
|---|---|---|
| PannerShell | panner_shell () | |
| Methods | ||
|---|---|---|
| IO | input () | |
| ChanCount | natural_input_streams () | |
| ChanCount | natural_output_streams () | |
| IO | output () | |
| Methods | ||
|---|---|---|
| void | activate () | |
| bool | active () | |
| long | capture_offset () | |
| void | deactivate () | |
| std::string | display_name () | |
| bool | display_to_user () | |
| long | input_latency () | |
| ChanCount | input_streams () | |
| long | output_latency () | |
| ChanCount | output_streams () | |
| long | playback_offset () | |
| long | signal_latency () | |
| Cast | ||
| Amp | to_amp () | |
| Automatable | to_automatable () | |
| DelayLine | to_delayline () | |
| DiskIOProcessor | to_diskioprocessor () | |
| DiskReader | to_diskreader () | |
| DiskWriter | to_diskwriter () | |
| PluginInsert | to_insert () | |
| IOProcessor | to_ioprocessor () | |
| Latent | to_latent () | |
| PeakMeter | to_meter () | |
| MonitorProcessor | to_monitorprocessor () | |
| PeakMeter | to_peakmeter () | |
| PluginInsert | to_plugininsert () | |
| PolarityProcessor | to_polarityprocessor () | |
| Send | to_send () | |
| SideChain | to_sidechain () | |
| UnknownProcessor | to_unknownprocessor () | |
| Methods | ||
|---|---|---|
| std::string | name () | |
| Cast | ||
| Stateful | to_stateful () | |
| StatefulDestructible | to_statefuldestructible () | |
C‡: ARDOUR::Session
@@ -3621,7 +4623,6 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to Ccreate 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)
finalize an undo command and commit pending transactions
This must only be called after begin_reversible_command ()
"actual" sample rate of session, set by current audioengine rate, pullup/down etc.
"native" sample rate of session, regardless of current audioengine rate, pullup/down etc
"actual" sample rate of session, set by current audioengine rate, pullup/down etc.
save session
Returns zero on success
save session
Returns zero on success
C‡: ARDOUR::SessionConfiguration
@@ -3721,7 +4727,6 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to CC‡: boost::shared_ptr< ARDOUR::SessionPlaylists >, boost::weak_ptr< ARDOUR::SessionPlaylists >
+ +| Methods | ||
|---|---|---|
| Playlist | by_id (ID) | |
| Playlist | by_name (std::string) | |
| PlaylistList | get_unused () | |
| PlaylistList | get_used () | |
| bool | isnil () | |
| unsigned int | n_playlists () | |
| PlaylistList | playlists_for_track (Track) | |
Returns list of Playlists that are associated with a track | ||
| unsigned int | region_use_count (Region) | |
| unsigned int | source_use_count (Source) | |
C‡: boost::shared_ptr< ARDOUR::SideChain >, boost::weak_ptr< ARDOUR::SideChain >
is-a: ARDOUR:IOProcessor
-A mixer strip element (Processor) with 1 or 2 IO elements.
A mixer strip element (Processor) with 1 or 2 IO elements.
| Methods | ||
|---|---|---|
| bool | isnil () | |
| Methods | ||
| void | activate () | |
| bool | active () | |
| long | capture_offset () | |
| void | deactivate () | |
| std::string | display_name () | |
| bool | display_to_user () | |
| ChanCount | input_streams () | |
| ChanCount | output_streams () | |
| long | input_latency () | |
| ChanCount | input_streams () | |
| long | output_latency () | |
| ChanCount | output_streams () | |
| long | playback_offset () | |
| long | signal_latency () | |
| Cast | ||
| Amp | to_amp () | |
| Automatable | to_automatable () | |
| DelayLine | to_delayline () | |
| DiskIOProcessor | to_diskioprocessor () | |
| DiskReader | to_diskreader () | |
| DiskWriter | to_diskwriter () | |
| PluginInsert | to_insert () | |
| IOProcessor | to_ioprocessor () | |
| Latent | to_latent () | |
| PeakMeter | to_meter () | |
| MonitorProcessor | to_monitorprocessor () | |
| PeakMeter | to_peakmeter () | |
| PluginInsert | to_plugininsert () | |
| PolarityProcessor | to_polarityprocessor () | |
| Send | to_send () | |
| SideChain | to_sidechain () | |
| UnknownProcessor | to_unknownprocessor () | |
| Methods | ||
|---|---|---|
| void | assign (VCA) | |
| bool | assigned_to (VCAManager, VCA) | |
recursively test for master assignment to given VCA | ||
| bool | isnil () | |
| VCAVector | masters (VCAManager) | |
| void | unassign (VCA) | |
Get the current effective `user' value based on automation state
Get `internal' value
Returns raw value as used for the plugin/processor control port
Get and Set `internal' value
All derived classes must implement this.
Basic derived classes will ignore
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.
Get the current effective `user' value based on automation state
Get `internal' value
Returns raw value as used for the plugin/processor control port
Get and Set `internal' value
All derived classes must implement this.
Basic derived classes will ignore
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.
Get the current effective `user' value based on automation state
Get `internal' value
Returns raw value as used for the plugin/processor control port
Get and Set `internal' value
All derived classes must implement this.
Basic derived classes will ignore
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.
Get the current effective `user' value based on automation state
Get `internal' value
Returns raw value as used for the plugin/processor control port
Get and Set `internal' value
All derived classes must implement this.
Basic derived classes will ignore
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.
C‡: boost::shared_ptr< ARDOUR::Stripable >, boost::weak_ptr< ARDOUR::Stripable >
@@ -4218,21 +5273,21 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to CA named object associated with a Session. Objects derived from this class are expected to be destroyed before the session calls drop_references().
| Methods | ||
|---|---|---|
| AutomationControl | comp_enable_control () | |
| AutomationControl | comp_makeup_control () | |
| AutomationControl | comp_mode_control () | |
| AutomationControl | comp_enable_controllable () | |
| AutomationControl | comp_makeup_controllable () | |
| AutomationControl | comp_mode_controllable () | |
| std::string | comp_mode_name (unsigned int) | |
| ReadOnlyControl | comp_redux_control () | |
| AutomationControl | comp_speed_control () | |
| ReadOnlyControl | comp_redux_controllable () | |
| AutomationControl | comp_speed_controllable () | |
| std::string | comp_speed_name (unsigned int) | |
| AutomationControl | comp_threshold_control () | |
| AutomationControl | comp_threshold_controllable () | |
| 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 | eq_enable_controllable () | |
| AutomationControl | eq_freq_controllable (unsigned int) | |
| AutomationControl | eq_gain_controllable (unsigned int) | |
| AutomationControl | eq_q_controllable (unsigned int) | |
| AutomationControl | eq_shape_controllable (unsigned int) | |
| AutomationControl | filter_enable_controllable (bool) | |
| AutomationControl | filter_freq_controllable (bool) | |
| AutomationControl | filter_slope_controllable (bool) | |
| bool | is_hidden () | |
| bool | is_master () | |
| bool | is_monitor () | |
| bool | is_private_route () | |
| bool | is_selected () | |
| bool | isnil () | |
| AutomationControl | master_send_enable_control () | |
| AutomationControl | master_send_enable_controllable () | |
| MonitorProcessor | monitor_control () | |
| MuteControl | mute_control () | |
| AutomationControl | pan_azimuth_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) | |
| AutomationControl | send_enable_controllable (unsigned int) | |
| AutomationControl | send_level_controllable (unsigned int) | |
| std::string | send_name (unsigned int) | |
| AutomationControl | send_pan_azimuth_controllable (unsigned int) | |
| AutomationControl | send_pan_azimuth_enable_controllable (unsigned int) | |
| void | set_presentation_order (unsigned int) | |
| bool | slaved () | |
| bool | slaved_to (VCA) | |
| SoloControl | solo_control () | |
| SoloIsolateControl | solo_isolate_control () | |
| SoloSafeControl | solo_safe_control () | |
| GainControl | trim_control () | |
| Cast | ||
| Automatable | to_automatable () | |
| Route | to_route () | |
| Slavable | to_slavable () | |
| VCA | to_vca () | |
audio samples per note type. if you want an instantaneous value for this, use TempoMap::frames_per_quarter_note_at() instead.
audio samples per quarter note. if you want an instantaneous value for this, use TempoMap::frames_per_quarter_note_at() instead.
audio samples per note type. if you want an instantaneous value for this, use TempoMap::samples_per_quarter_note_at() instead.
audio samples per quarter note. if you want an instantaneous value for this, use TempoMap::samples_per_quarter_note_at() instead.
C‡: ARDOUR::TempoMap
@@ -4314,18 +5377,19 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to CReturns the BBT time corresponding to the supplied frame position.
Returns the BBT time at the frame position .
Add some (fractional) Beats to a session frame position, and return the result in frames. pos can be -ve, if required.
Count the number of beats that are equivalent to distance when going forward, starting at pos.
Returns the BBT time corresponding to the supplied sample position.
Returns the BBT time at the sample position .
Count the number of beats that are equivalent to distance when going forward, starting at pos.
Add some (fractional) Beats to a session sample position, and return the result in samples. pos can be -ve, if required.
C‡: ARDOUR::TempoSection
@@ -4334,19 +5398,30 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to CA section of timeline with a certain Tempo.
| Methods | ||
|---|---|---|
| bool | active () | |
| double | c () | |
| bool | clamped () | |
| bool | locked_to_meter () | |
| Cast | ||
| Tempo | to_tempo () | |
| Methods | ||
|---|---|---|
| bool | initial () | |
| bool | is_tempo () | |
| double | minute () | |
| double | minute_at_sample (long) | |
| double | pulse () | |
| long | sample () | |
| long | sample_at_minute (double) | |
| void | set_pulse (double) | |
C‡: boost::shared_ptr< ARDOUR::Track >, boost::weak_ptr< ARDOUR::Track >
is-a: ARDOUR:Route
-A track is an route (bus) with a recordable diskstream and related objects relevant to tracking, playback and editing.
Specifically a track has regions and playlist objects.
A track is an route (bus) with a recordable diskstream and related objects relevant to recording, playback and editing.
Specifically a track has a playlist object that describes material to be played from disk, and modifies that object during recording and editing.
| Methods | ||
|---|---|---|
| Region | bounce (InterThreadInfo&) | |
| 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 | can_record () | |
| int | find_and_use_playlist (DataType, ID) | |
| bool | isnil () | |
| Playlist | playlist () | |
| bool | set_name (std::string) | |
| int | use_copy_playlist () | |
| int | use_new_playlist (DataType) | |
| int | use_playlist (DataType, Playlist) | |
| Cast | ||
| AudioTrack | to_audio_track () | |
| MidiTrack | to_midi_track () | |
| std::string | comment () | |
| bool | customize_plugin_insert (Processor, unsigned int, ChanCount, ChanCount) | |
enable custom plugin-insert configuration
Returns true if successful | ||
| DataType | data_type () | |
| IO | input () | |
| Delivery | main_outs () | |
the signal processorat at end of the processing chain which produces output | ||
| PannerShell | panner_shell () | |
| PeakMeter | peak_meter () | |
************************************************************* Pure interface begins here************************************************************* | ||
| long | playback_latency (bool) | |
| int | remove_processor (Processor, ProcessorStreams, bool) | |
remove plugin/processor
Returns 0 on success | ||
| int | remove_processors (ProcessorList, ProcessorStreams) | |
| void | set_comment (std::string, void*) | |
| void | set_meter_point (MeterPoint, bool) | |
| bool | set_strict_io (bool) | |
| long | signal_latency () | |
| bool | soloed () | |
| bool | strict_io () | |
| Processor | the_instrument () | |
Return the first processor that accepts has at least one MIDI input and at least one audio output. In the vast majority of cases, this will be "the instrument". This does not preclude other MIDI->audio processors later in the processing chain, but that would be a special case not covered by this utility function. | ||
| Amp | trim () | |
| Cast | ||
| Automatable | to_automatable () | |
| Slavable | to_slavable () | |
| Track | to_track () | |
| Methods | ||
|---|---|---|
| AutomationControl | comp_enable_control () | |
| AutomationControl | comp_makeup_control () | |
| AutomationControl | comp_mode_control () | |
| AutomationControl | comp_enable_controllable () | |
| AutomationControl | comp_makeup_controllable () | |
| AutomationControl | comp_mode_controllable () | |
| std::string | comp_mode_name (unsigned int) | |
| ReadOnlyControl | comp_redux_control () | |
| AutomationControl | comp_speed_control () | |
| ReadOnlyControl | comp_redux_controllable () | |
| AutomationControl | comp_speed_controllable () | |
| std::string | comp_speed_name (unsigned int) | |
| AutomationControl | comp_threshold_control () | |
| AutomationControl | comp_threshold_controllable () | |
| 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 | eq_enable_controllable () | |
| AutomationControl | eq_freq_controllable (unsigned int) | |
| AutomationControl | eq_gain_controllable (unsigned int) | |
| AutomationControl | eq_q_controllable (unsigned int) | |
| AutomationControl | eq_shape_controllable (unsigned int) | |
| AutomationControl | filter_enable_controllable (bool) | |
| AutomationControl | filter_freq_controllable (bool) | |
| AutomationControl | filter_slope_controllable (bool) | |
| bool | is_hidden () | |
| bool | is_master () | |
| bool | is_monitor () | |
| bool | is_private_route () | |
| bool | is_selected () | |
| AutomationControl | master_send_enable_control () | |
| AutomationControl | master_send_enable_controllable () | |
| MonitorProcessor | monitor_control () | |
| MuteControl | mute_control () | |
| AutomationControl | pan_azimuth_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) | |
| AutomationControl | send_enable_controllable (unsigned int) | |
| AutomationControl | send_level_controllable (unsigned int) | |
| std::string | send_name (unsigned int) | |
| AutomationControl | send_pan_azimuth_controllable (unsigned int) | |
| AutomationControl | send_pan_azimuth_enable_controllable (unsigned int) | |
| void | set_presentation_order (unsigned int) | |
| bool | slaved () | |
| bool | slaved_to (VCA) | |
| SoloControl | solo_control () | |
| SoloIsolateControl | solo_isolate_control () | |
| SoloSafeControl | solo_safe_control () | |
| GainControl | trim_control () | |
| Cast | ||
| Automatable | to_automatable () | |
| Route | to_route () | |
| Slavable | to_slavable () | |
| VCA | to_vca () | |
| Methods | ||
|---|---|---|
| AutomationControl | comp_enable_control () | |
| AutomationControl | comp_makeup_control () | |
| AutomationControl | comp_mode_control () | |
| AutomationControl | comp_enable_controllable () | |
| AutomationControl | comp_makeup_controllable () | |
| AutomationControl | comp_mode_controllable () | |
| std::string | comp_mode_name (unsigned int) | |
| ReadOnlyControl | comp_redux_control () | |
| AutomationControl | comp_speed_control () | |
| ReadOnlyControl | comp_redux_controllable () | |
| AutomationControl | comp_speed_controllable () | |
| std::string | comp_speed_name (unsigned int) | |
| AutomationControl | comp_threshold_control () | |
| AutomationControl | comp_threshold_controllable () | |
| 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 | eq_enable_controllable () | |
| AutomationControl | eq_freq_controllable (unsigned int) | |
| AutomationControl | eq_gain_controllable (unsigned int) | |
| AutomationControl | eq_q_controllable (unsigned int) | |
| AutomationControl | eq_shape_controllable (unsigned int) | |
| AutomationControl | filter_enable_controllable (bool) | |
| AutomationControl | filter_freq_controllable (bool) | |
| AutomationControl | filter_slope_controllable (bool) | |
| bool | is_hidden () | |
| bool | is_master () | |
| bool | is_monitor () | |
| bool | is_private_route () | |
| bool | is_selected () | |
| AutomationControl | master_send_enable_control () | |
| AutomationControl | master_send_enable_controllable () | |
| MonitorProcessor | monitor_control () | |
| AutomationControl | pan_azimuth_control () | |
| AutomationControl | pan_elevation_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) | |
| AutomationControl | send_enable_controllable (unsigned int) | |
| AutomationControl | send_level_controllable (unsigned int) | |
| std::string | send_name (unsigned int) | |
| AutomationControl | send_pan_azimuth_controllable (unsigned int) | |
| AutomationControl | send_pan_azimuth_enable_controllable (unsigned int) | |
| void | set_presentation_order (unsigned int) | |
| bool | slaved () | |
| bool | slaved_to (VCA) | |
| SoloIsolateControl | solo_isolate_control () | |
| SoloSafeControl | solo_safe_control () | |
| GainControl | trim_control () | |
| Cast | ||
| Automatable | to_automatable () | |
| Route | to_route () | |
| Slavable | to_slavable () | |
| VCA | to_vca () | |
Base class for objects with saveable and undoable state with destruction notification
| Methods | ||
|---|---|---|
| int | create_vca (unsigned int, std::string) | |
| VCAList | create_vca (unsigned int, std::string) | |
| unsigned long | n_vcas () | |
| void | remove_vca (VCA) | |
| VCA | vca_by_name (std::string) | |
| ID | id () | |
| OwnedPropertyList | properties () | |
C‡: std::vector<boost::shared_ptr<ARDOUR::VCA> >
+ +| Constructor | ||
|---|---|---|
| ℂ | ARDOUR.VCAVector () | |
| Methods | ||
| VCA | at (unsigned long) | |
| bool | empty () | |
| LuaIter | iter () | |
| unsigned long | size () | |
| LuaTable | table () | |
C‡: std::list<boost::weak_ptr<ARDOUR::AudioSource> >
@@ -4622,9 +5741,9 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C| Methods | ||
|---|---|---|
| LuaTable | actionlist () | |
| UIConfiguration | config () | |
| std::string | http_get (std::string) | |
| void | mixer_screenshot (std::string) | |
| ProcessorVector | processor_selection () | |
| unsigned int | translate_order (InsertAt) | |
Possibly start the audition of a region. If
Possibly 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)
Set whether the editor should follow the playhead.
Set the mouse mode (gain, object, range, timefx etc.)
Set the snap mode.
Set the snap threshold.
Open stem export dialog
Undo some transactions.
Class to represent list of selected regions.
| Methods | ||
|---|---|---|
| long | end_frame () | |
| long | end_sample () | |
| unsigned long | n_midi_regions () | |
| RegionList | regionlist () | |
| long | start () | |
| bool | empty () | |
| Selectable | front () | |
| LuaIter | iter () | |
| void | push_back (Selectable) | |
| ... | push_back (--lua--) | |
| void | reverse () | |
| unsigned long | size () | |
| LuaTable | table () | |
| Methods | ||
|---|---|---|
| unsigned int | current_height () | |
| unsigned int | effective_height () | |
Returns effective height (taking children into account) in canvas units, or 0 if this TimeAxisView has not yet been shown | ||
| int | order () | |
Returns index of this TimeAxisView within its parent | ||
| void | set_height (unsigned int, TrackHeightMode) | |
| double | y_position () | |
Returns y position, or -1 if hidden | ||
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.
+| Methods | ||
|---|---|---|
| unsigned int | current_height () | |
| unsigned int | effective_height () | |
Returns effective height (taking children into account) in canvas units, or 0 if this TimeAxisView has not yet been shown | ||
| int | order () | |
Returns index of this TimeAxisView within its parent | ||
| void | set_height (unsigned int, TrackHeightMode) | |
| double | y_position () | |
Returns y position, or -1 if hidden | ||
C‡: TimeAxisViewItem
is-a: ArdourUI:Selectable
@@ -4931,7 +6071,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C| Methods | ||
|---|---|---|
| long | end_frame () | |
| long | end_sample () | |
| long | length () | |
| long | start () | |
| 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 () | |
| Cast | ||
| TrackViewStdList | to_tav_list () | |
C‡: TrackViewList
-is-a: ArdourUI:TrackViewStdList
| Methods | ||
|---|---|---|
| bool | contains (TimeAxisView) | |
| RouteList | routelist () | |
| Cast | ||
| TrackViewStdList | to_tav_list () | |
| 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* >
@@ -5009,11 +6122,323 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to CC‡: UIConfiguration
+ +Base class for objects with saveable and undoable state
| Methods | ||
|---|---|---|
| unsigned int | get_action_table_columns () | |
| bool | get_all_floating_windows_are_dialogs () | |
| bool | get_allow_non_quarter_pulse () | |
| bool | get_autoplay_files () | |
| bool | get_autoscroll_editor () | |
| bool | get_blink_alert_indicators () | |
| bool | get_blink_rec_arm () | |
| bool | get_boxy_buttons () | |
| bool | get_buggy_gradients () | |
| bool | get_cairo_image_surface () | |
| unsigned long | get_clock_display_limit () | |
| std::string | get_color_file () | |
| bool | get_color_regions_using_track_color () | |
| std::string | get_default_bindings () | |
| bool | get_default_narrow_ms () | |
| bool | get_draggable_playhead () | |
| float | get_draggable_playhead_speed () | |
| bool | get_editor_stereo_only_meters () | |
| float | get_extra_ui_extents_time () | |
| bool | get_flat_buttons () | |
| bool | get_floating_monitor_section () | |
| bool | get_follow_edits () | |
| int | get_font_scale () | |
| bool | get_grid_follows_internal () | |
| bool | get_hiding_groups_deactivates_groups () | |
| std::string | get_icon_set () | |
| 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 () | |
| float | get_meter_hold () | |
| --MISSING (ARDOUR::MeterLineUp)-- | get_meter_line_up_din () | |
| --MISSING (ARDOUR::MeterLineUp)-- | get_meter_line_up_level () | |
| float | get_meter_peak () | |
| bool | get_meter_style_led () | |
| --MISSING (ARDOUR::VUMeterStandard)-- | get_meter_vu_standard () | |
| std::string | get_mixer_strip_visibility () | |
| bool | get_name_new_markers () | |
| bool | get_never_display_periodic_midi () | |
| bool | get_new_automation_points_on_lane () | |
| bool | get_no_new_session_dialog () | |
| bool | get_only_copy_imported_files () | |
| 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 () | |
| int | get_recent_session_sort () | |
| bool | get_rubberbanding_snaps_to_grid () | |
| 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 () | |
| 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_gain () | |
| bool | get_show_region_name () | |
| bool | get_show_secondary_clock () | |
| bool | get_show_snapped_cursor () | |
| bool | get_show_toolbar_latency () | |
| bool | get_show_toolbar_monitoring () | |
| bool | get_show_toolbar_recpunch () | |
| bool | get_show_toolbar_selclock () | |
| bool | get_show_track_meters () | |
| bool | get_show_waveform_clipping () | |
| bool | get_show_waveforms () | |
| bool | get_show_waveforms_while_recording () | |
| bool | get_show_zoom_tools () | |
| unsigned int | get_snap_threshold () | |
| bool | get_snap_to_grid () | |
| bool | get_snap_to_marks () | |
| bool | get_snap_to_region_end () | |
| bool | get_snap_to_region_start () | |
| bool | get_snap_to_region_sync () | |
| bool | get_sound_midi_notes () | |
| std::string | get_stripable_color_palette () | |
| bool | get_super_rapid_clock_update () | |
| float | get_timeline_item_gradient_depth () | |
| bool | get_transients_follow_front () | |
| std::string | get_ui_font_family () | |
| std::string | get_ui_rc_file () | |
| bool | get_update_editor_during_summary_drag () | |
| bool | get_use_double_click_to_zoom_to_selection () | |
| bool | get_use_mouse_position_as_zoom_focus_on_scroll () | |
| bool | get_use_note_bars_for_velocity () | |
| bool | get_use_note_color_for_velocity () | |
| bool | get_use_time_rulers_to_zoom_with_vertical_drag () | |
| bool | get_use_tooltips () | |
| bool | get_use_wm_visibility () | |
| unsigned int | get_vertical_region_gap () | |
| std::string | get_vkeybd_layout () | |
| 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 () | |
| 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_autoplay_files (bool) | |
| bool | set_autoscroll_editor (bool) | |
| bool | set_blink_alert_indicators (bool) | |
| bool | set_blink_rec_arm (bool) | |
| bool | set_boxy_buttons (bool) | |
| bool | set_buggy_gradients (bool) | |
| bool | set_cairo_image_surface (bool) | |
| bool | set_clock_display_limit (unsigned long) | |
| bool | set_color_file (std::string) | |
| bool | set_color_regions_using_track_color (bool) | |
| bool | set_default_bindings (std::string) | |
| bool | set_default_narrow_ms (bool) | |
| bool | set_draggable_playhead (bool) | |
| bool | set_draggable_playhead_speed (float) | |
| bool | set_editor_stereo_only_meters (bool) | |
| bool | set_extra_ui_extents_time (float) | |
| bool | set_flat_buttons (bool) | |
| bool | set_floating_monitor_section (bool) | |
| bool | set_follow_edits (bool) | |
| bool | set_font_scale (int) | |
| bool | set_grid_follows_internal (bool) | |
| bool | set_hiding_groups_deactivates_groups (bool) | |
| bool | set_icon_set (std::string) | |
| 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_meter_hold (float) | |
| bool | set_meter_line_up_din (--MISSING (ARDOUR::MeterLineUp)--) | |
| bool | set_meter_line_up_level (--MISSING (ARDOUR::MeterLineUp)--) | |
| bool | set_meter_peak (float) | |
| bool | set_meter_style_led (bool) | |
| bool | set_meter_vu_standard (--MISSING (ARDOUR::VUMeterStandard)--) | |
| bool | set_mixer_strip_visibility (std::string) | |
| bool | set_name_new_markers (bool) | |
| bool | set_never_display_periodic_midi (bool) | |
| bool | set_new_automation_points_on_lane (bool) | |
| bool | set_no_new_session_dialog (bool) | |
| bool | set_only_copy_imported_files (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_recent_session_sort (int) | |
| bool | set_rubberbanding_snaps_to_grid (bool) | |
| 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_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_gain (bool) | |
| bool | set_show_region_name (bool) | |
| bool | set_show_secondary_clock (bool) | |
| bool | set_show_snapped_cursor (bool) | |
| bool | set_show_toolbar_latency (bool) | |
| bool | set_show_toolbar_monitoring (bool) | |
| bool | set_show_toolbar_recpunch (bool) | |
| bool | set_show_toolbar_selclock (bool) | |
| bool | set_show_track_meters (bool) | |
| bool | set_show_waveform_clipping (bool) | |
| bool | set_show_waveforms (bool) | |
| bool | set_show_waveforms_while_recording (bool) | |
| bool | set_show_zoom_tools (bool) | |
| bool | set_snap_threshold (unsigned int) | |
| bool | set_snap_to_grid (bool) | |
| bool | set_snap_to_marks (bool) | |
| bool | set_snap_to_region_end (bool) | |
| bool | set_snap_to_region_start (bool) | |
| bool | set_snap_to_region_sync (bool) | |
| bool | set_sound_midi_notes (bool) | |
| bool | set_stripable_color_palette (std::string) | |
| bool | set_super_rapid_clock_update (bool) | |
| bool | set_timeline_item_gradient_depth (float) | |
| bool | set_transients_follow_front (bool) | |
| bool | set_ui_font_family (std::string) | |
| bool | set_ui_rc_file (std::string) | |
| bool | set_update_editor_during_summary_drag (bool) | |
| bool | set_use_double_click_to_zoom_to_selection (bool) | |
| bool | set_use_mouse_position_as_zoom_focus_on_scroll (bool) | |
| bool | set_use_note_bars_for_velocity (bool) | |
| bool | set_use_note_color_for_velocity (bool) | |
| bool | set_use_time_rulers_to_zoom_with_vertical_drag (bool) | |
| bool | set_use_tooltips (bool) | |
| bool | set_use_wm_visibility (bool) | |
| bool | set_vertical_region_gap (unsigned int) | |
| bool | set_vkeybd_layout (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_widget_prelight (bool) | |
| Properties | ||
| unsigned int | action_table_columns | |
| bool | all_floating_windows_are_dialogs | |
| bool | allow_non_quarter_pulse | |
| bool | autoplay_files | |
| bool | autoscroll_editor | |
| bool | blink_alert_indicators | |
| bool | blink_rec_arm | |
| bool | boxy_buttons | |
| bool | buggy_gradients | |
| bool | cairo_image_surface | |
| unsigned long | clock_display_limit | |
| std::string | color_file | |
| bool | color_regions_using_track_color | |
| std::string | default_bindings | |
| bool | default_narrow_ms | |
| bool | draggable_playhead | |
| float | draggable_playhead_speed | |
| bool | editor_stereo_only_meters | |
| float | extra_ui_extents_time | |
| bool | flat_buttons | |
| bool | floating_monitor_section | |
| bool | follow_edits | |
| int | font_scale | |
| bool | grid_follows_internal | |
| bool | hiding_groups_deactivates_groups | |
| std::string | icon_set | |
| 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 | |
| float | meter_hold | |
| --MISSING (ARDOUR::MeterLineUp)-- | meter_line_up_din | |
| --MISSING (ARDOUR::MeterLineUp)-- | meter_line_up_level | |
| float | meter_peak | |
| bool | meter_style_led | |
| --MISSING (ARDOUR::VUMeterStandard)-- | meter_vu_standard | |
| std::string | mixer_strip_visibility | |
| bool | name_new_markers | |
| bool | never_display_periodic_midi | |
| bool | new_automation_points_on_lane | |
| bool | no_new_session_dialog | |
| bool | only_copy_imported_files | |
| bool | open_gui_after_adding_plugin | |
| bool | prefer_inline_over_gui | |
| bool | preview_video_frame_on_drag | |
| --MISSING (ARDOUR::ClockDeltaMode)-- | primary_clock_delta_mode | |
| int | recent_session_sort | |
| bool | rubberbanding_snaps_to_grid | |
| 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 | |
| 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_gain | |
| bool | show_region_name | |
| bool | show_secondary_clock | |
| bool | show_snapped_cursor | |
| bool | show_toolbar_latency | |
| bool | show_toolbar_monitoring | |
| bool | show_toolbar_recpunch | |
| bool | show_toolbar_selclock | |
| bool | show_track_meters | |
| bool | show_waveform_clipping | |
| bool | show_waveforms | |
| bool | show_waveforms_while_recording | |
| bool | show_zoom_tools | |
| unsigned int | snap_threshold | |
| bool | snap_to_grid | |
| bool | snap_to_marks | |
| bool | snap_to_region_end | |
| bool | snap_to_region_start | |
| bool | snap_to_region_sync | |
| bool | sound_midi_notes | |
| std::string | stripable_color_palette | |
| bool | super_rapid_clock_update | |
| float | timeline_item_gradient_depth | |
| bool | transients_follow_front | |
| std::string | ui_font_family | |
| std::string | ui_rc_file | |
| bool | update_editor_during_summary_drag | |
| bool | use_double_click_to_zoom_to_selection | |
| bool | use_mouse_position_as_zoom_focus_on_scroll | |
| bool | use_note_bars_for_velocity | |
| bool | use_note_color_for_velocity | |
| bool | use_time_rulers_to_zoom_with_vertical_drag | |
| bool | use_tooltips | |
| bool | use_wm_visibility | |
| unsigned int | vertical_region_gap | |
| std::string | vkeybd_layout | |
| unsigned long | waveform_cache_size | |
| double | waveform_clip_level | |
| float | waveform_gradient_depth | |
| --MISSING (ARDOUR::WaveformScale)-- | waveform_scale | |
| --MISSING (ARDOUR::WaveformShape)-- | waveform_shape | |
| bool | widget_prelight | |
C‡: unsigned char*
@@ -5025,6 +6450,34 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to CC‡: std::vector<unsigned char >
+ +| Constructor | ||
|---|---|---|
| ℂ | C.ByteVector () | |
| ℂ | C.ByteVector () | |
| Methods | ||
| LuaTable | add (LuaTable {unsigned char}) | |
| unsigned char | at (unsigned long) | |
| void | clear () | |
| bool | empty () | |
| LuaIter | iter () | |
| void | push_back (unsigned char) | |
| unsigned long | size () | |
| LuaTable | table () | |
| ... | to_array (--lua--) | |
C‡: double*
+ +| Methods | ||
|---|---|---|
| LuaMetaTable | array () | |
| LuaTable | get_table () | |
| DoubleArray | offset (unsigned int) | |
| void | set_table (LuaTable {double}) | |
C‡: std::vector<double >
@@ -5035,11 +6488,13 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to CC‡: float*
@@ -5061,11 +6516,13 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to CC‡: std::vector<float >
@@ -5077,11 +6534,13 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to CC‡: std::list<long >
@@ -5091,9 +6550,9 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to CC‡: Cairo::Context
@@ -5249,6 +6710,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to CGets the width of the ImageSurface in pixels
Set this surface as source for another context. This allows to draw this surface
C‡: LuaCairo::PangoLayout
@@ -5257,6 +6719,8 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to CGets the alignment for the layout: how partial lines are positioned within the horizontal space available.
Returns The alignment.
Gets the type of ellipsization being performed for layout. See set_ellipsize()
Use is_ellipsized() to query whether any paragraphs were actually ellipsized.
Returns The current ellipsization mode for layout.
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.
Sets the alignment for the layout: how partial lines are positioned within the horizontal space available.
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.
Sets the layout text and attribute list from marked-up text (see markup format). Replaces the current text and attribute list.
Set the text of the layout.
Sets the width to which the lines of the Pango::Layout should wrap or ellipsized. The default value is -1: no width set.
Sets the wrap mode; the wrap mode only has effect if a width is set on the layout with set_width(). To turn off wrapping, set the width to -1.
Draws a Layout in the specified Cairo context. The top-left corner of the Layout will be drawn at the current point of the cairo context.
C‡: Evoral::Beats
+C‡: Temporal::Beats
Musical time in beats.
| Constructor | ||
|---|---|---|
| ℂ | Evoral.Beats (double) | |
Create from a real number of beats. | ||
| Methods | ||
| double | to_double () | |
| double | to_double () | |
C‡: boost::shared_ptr< Evoral::Control >, boost::weak_ptr< Evoral::Control >
@@ -5322,6 +6788,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to Cremove 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
C‡: boost::shared_ptr< Evoral::Note<Evoral::Beats> >, boost::weak_ptr< Evoral::Note<Evoral::Beats> >
+C‡: boost::shared_ptr< Evoral::Note<Temporal::Beats> >, boost::weak_ptr< Evoral::Note<Temporal::Beats> >
| Methods | ||
|---|---|---|
| unsigned char | channel () | |
| unsigned char | channel () | |
| bool | isnil () | |
| Beats | length () | |
| unsigned char | note () | |
| unsigned char | off_velocity () | |
| Beats | time () | |
| unsigned char | velocity () | |
| Beats | length () | |
| unsigned char | note () | |
| unsigned char | off_velocity () | |
| Beats | time () | |
| unsigned char | velocity () | |
C‡: Evoral::Parameter
@@ -5417,7 +6884,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to CC‡: boost::shared_ptr< Evoral::Sequence<Evoral::Beats> >, boost::weak_ptr< Evoral::Sequence<Evoral::Beats> >
+C‡: boost::shared_ptr< Evoral::Sequence<Temporal::Beats> >, boost::weak_ptr< Evoral::Sequence<Temporal::Beats> >
is-a: Evoral:ControlSet
| Methods | ||
|---|---|---|
| int | run () | |
C‡: LuaDialog::ProgressWindow
+ +Synchronous GUI-thread Progress dialog
This shows a modal progress dialog with an optional "Cancel" button. Since it runs in the UI thread the script needs to regularly call progress(), as well as close the dialog, as needed.
| Constructor | ||
|---|---|---|
| ℂ | LuaDialog.ProgressWindow (std::string, bool) | |
| Methods | ||
| bool | canceled () | |
| void | done () | |
Close and hide the dialog. This is required to be at the end, since the dialog is modal and prevents other UI operations while visible. | ||
| bool | progress (float, std::string) | |
Report progress and update GUI.
Returns true if cancel was clicked, false otherwise | ||
C‡: std::bitset<48ul>
+C‡: std::bitset<49ul>
| Constructor | ||
|---|---|---|
| ℂ | LuaSignal.Set () | |
| Methods | ||
| LuaTable | add (48ul) | |
| bool | any () | |
| unsigned long | count () | |
| bool | none () | |
| Set | reset () | |
| Set | set (unsigned long, bool) | |
| unsigned long | size () | |
| LuaTable | add (49ul) | |
| bool | any () | |
| unsigned long | count () | |
| bool | none () | |
| Set | reset () | |
| Set | set (unsigned long, bool) | |
| unsigned long | size () | |
| LuaTable | table () | |
| bool | test (unsigned long) | |
| bool | test (unsigned long) | |
C‡: boost::shared_ptr< PBD::Controllable >, boost::weak_ptr< PBD::Controllable >
is-a: PBD:StatefulDestructiblePtr
-This is a pure virtual class to represent a scalar control.
Note that it contains no storage/state for the controllable thing that it represents. Derived classes must provide set_value()/get_value() methods, which will involve (somehow) an actual location to store the value.
In essence, this is an interface, not a class.
Without overriding upper() and lower(), a derived class will function as a control whose value can range between 0 and 1.0.
This is a pure virtual class to represent a scalar control.
Note that it contains no storage/state for the controllable thing that it represents. Derived classes must provide set_value()/get_value() methods, which will involve (somehow) an actual location to store the value.
In essence, this is an interface, not a class.
Without overriding upper() and lower(), a derived class will function as a control whose value can range between 0 and 1.0.
We express Controllable values in one of three ways: 1. `user' --- as presented to the user (e.g. dB, Hz, etc.) 2. `interface' --- as used in some cases for the UI representation (in order to make controls behave logarithmically). 3. `internal' --- as passed to a processor, track, plugin, or whatever.
Note that in some cases user and internal may be the same (and interface different) e.g. frequency, which is presented to the user and passed to the processor in linear terms, but which needs log scaling in the interface.
In other cases, user and interface may be the same (and internal different) e.g. gain, which is presented to the user in log terms (dB) but passed to the processor as a linear quantity.
| Methods | ||
|---|---|---|
| double | get_value () | |
Get `internal' value Returns raw value as used for the plugin/processor control port | ||
| bool | isnil () | |
| std::string | name () | |
C‡: PBD::RingBufferNPT<unsigned char>
@@ -5684,9 +7168,9 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to CC‡: Timecode::Time
@@ -5698,7 +7182,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to CWhether this Time uses dropframe Timecode
Timecode frames (not audio samples)
Timecode frames (not audio frames)
C‡: std::map<int, std::vector<Vamp::Plugin::Feature > > > >
@@ -5858,11 +7344,13 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to CC‡: Vamp::PluginBase
@@ -5933,11 +7421,13 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to CC‡: Vamp::RealTime
@@ -6023,6 +7513,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C