From: Robin Gareus Date: Thu, 26 Mar 2020 17:06:15 +0000 (+0100) Subject: Update Lua doc for 6.0-pre1 X-Git-Url: http://shamusworld.gotdns.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=94085e0ed8465b25f39c69f35c55544a9f3286d8;p=ardour-manual Update Lua doc for 6.0-pre1 --- diff --git a/include/class-reference.html b/include/class-reference.html index 6d324b8..75ff7d8 100644 --- a/include/class-reference.html +++ b/include/class-reference.html @@ -35,7 +35,7 @@ e.g 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

Pass by Reference

-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])

Pointer Classes

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
RCConfigurationconfig ()
std::stringuser_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::stringuser_config_directory (int)

user_config_directory() exists IF version was negative.

version
of the program. If
version
is negative, the build-time string PROGRAM_VERSION will be used to determine the version number.

Returns the path to the directory used to store user specific configuration files for the given

↠ ARDOUR:Amp

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
floatapply_gain (AudioBuffer&, long, long, float, float, long)
GainControlgain_control ()
boolisnil ()
@@ -142,20 +147,32 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C Methods voidactivate () boolactive () + longcapture_offset () voiddeactivate () std::stringdisplay_name () booldisplay_to_user () - ChanCountinput_streams () - ChanCountoutput_streams () + longinput_latency () + ChanCountinput_streams () + longoutput_latency () + ChanCountoutput_streams () + longplayback_offset () + longsignal_latency () Cast Ampto_amp () Automatableto_automatable () + DelayLineto_delayline () + DiskIOProcessorto_diskioprocessor () + DiskReaderto_diskreader () + DiskWriterto_diskwriter () PluginInsertto_insert () IOProcessorto_ioprocessor () + Latentto_latent () PeakMeterto_meter () MonitorProcessorto_monitorprocessor () PeakMeterto_peakmeter () PluginInsertto_plugininsert () + PolarityProcessorto_polarityprocessor () + Sendto_send () SideChainto_sidechain () UnknownProcessorto_unknownprocessor () @@ -167,6 +184,51 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C Statefulto_stateful () StatefulDestructibleto_statefuldestructible () +

↠ ARDOUR:AsyncMIDIPort

+

C‡: boost::shared_ptr< ARDOUR::AsyncMIDIPort >, boost::weak_ptr< ARDOUR::AsyncMIDIPort >

+

is-a: ARDOUR:MidiPort

+
+ + + + +
Methods
boolisnil ()
intwrite (unsigned char*, unsigned long, unsigned int)
+

Inherited from ARDOUR:MidiPort

+ + + + + + + +
Methods
MidiBufferget_midi_buffer (unsigned int)
boolinput_active ()
voidset_input_active (bool)
Cast
AsyncMIDIPortto_asyncmidiport ()
+

Inherited from ARDOUR:Port

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Methods
intconnect (std::string)
boolconnected ()

Returns true if this port is connected to anything

boolconnected_to (std::string)
o
Port name

Returns true if this port is connected to o, otherwise false.

intdisconnect (std::string)
intdisconnect_all ()
LuaTable(...)get_connected_latency_range (LatencyRange&, bool)
std::stringname ()

Returns Port short name

boolphysically_connected ()
std::stringpretty_name (bool)

Returns Port human readable name

LatencyRangeprivate_latency_range (bool)
LatencyRangepublic_latency_range (bool)
boolreceives_input ()

Returns true if this Port receives input, otherwise false

boolsends_output ()

Returns true if this Port sends output, otherwise false

Cast
AsyncMIDIPortto_asyncmidiport ()
AudioPortto_audioport ()
MidiPortto_midiport ()

↠ ARDOUR:AudioBackend

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 C DeviceStatusVectorenumerate_output_devices ()

Returns 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.

AudioBackendInfoinfo () -

Return the AudioBackendInfo object from which this backend was constructed.

+

Return the AudioBackendInfo object from which this backend was constructed.

unsigned intinput_channels () std::stringinput_device_name () boolisnil () @@ -199,9 +261,9 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C intset_buffer_size (unsigned int)

Set the buffer size to be used.

The device is assumed to use a double buffering scheme, so that one buffer's worth of data can be processed by hardware while software works on the other buffer. All known suitable audio APIs support this model (though ALSA allows for alternate numbers of buffers, and CoreAudio doesn't directly expose the concept).

intset_device_name (std::string) -

Set the name of the device to be used

+

Set the name of the device to be used

intset_driver (std::string) -

Returns zero if the backend can successfully use

Should not be used unless the backend returns true from requires_driver_selection()

name
as the driver, non-zero otherwise.
+

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()

intset_input_device_name (std::string)

Set the name of the input device to be used if using separate input/output devices.

use_separate_input_and_output_devices()

intset_output_device_name (std::string) @@ -209,7 +271,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C intset_peridod_size (unsigned int)

Set the period size to be used. must be called before starting the backend.

intset_sample_rate (float) -

Set the sample rate to be used

+

Set the sample rate to be used

booluse_separate_input_and_output_devices ()

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().

@@ -227,8 +289,9 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C + - + @@ -282,6 +345,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C +
Methods
voidapply_gain (float, long)

Apply a fixed gain factor to the audio buffer

gain
gain factor
len
number of samples to amplify
boolcheck_silence (unsigned int, unsigned int&)

check buffer for silence

nframes
number of frames to check
n
first non zero sample (if any)

Returns true if all samples are zero

Check buffer for silence

nframes
number of samples to check
n
first non zero sample (if any)

Returns true if all samples are zero

FloatArraydata (long)
voidread_from (FloatArray, long, long, long)
voidsilence (long, long)
Methods
boolisnil ()
longread (FloatArray, FloatArray, FloatArray, long, long, unsigned int)
start
Start position in session samples.
cnt
Number of samples to read.

Inherited from ARDOUR:Playlist

@@ -296,10 +360,13 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C - + + + + @@ -313,11 +380,12 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C - - + + + @@ -348,15 +416,20 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C + + + + +
gap
from the beginning of the region to the next beginning
voidduplicate_range (AudioRange&, float)
voidduplicate_until (Region, long, long, long)
gap
from the beginning of the region to the next beginning
end
the first frame that does _not_ contain a duplicated frame
gap
from the beginning of the region to the next beginning
end
the first sample that does _not_ contain a duplicated sample
boolempty ()
Regionfind_next_region (long, RegionPoint, int)
longfind_next_region_boundary (long, int)
longfind_next_transient (long, int)
IDget_orig_track_id ()
boolhidden ()
voidlower_region (Region)
voidlower_region_to_bottom (Region)
unsigned intn_regions ()
RegionListPtrregions_with_end_within (Range)
RegionListPtrregions_with_start_within (Range)
voidremove_region (Region)
voidsplit (long)
voidsplit_region (Region, MusicFrame)
boolshared ()
voidsplit_region (Region, MusicSample)
Regiontop_region_at (long)
Regiontop_unmuted_region_at (long)
voiduncombine (Region)
boolused ()
Cast
AudioPlaylistto_audioplaylist ()
MidiPlaylistto_midiplaylist ()
o
Port name

Returns true if this port is connected to o, otherwise false.

intdisconnect (std::string)
intdisconnect_all ()
LuaTable(...)get_connected_latency_range (LatencyRange&, bool)
std::stringname ()

Returns Port short name

boolphysically_connected ()
std::stringpretty_name (bool)

Returns Port human readable name

LatencyRangeprivate_latency_range (bool)
LatencyRangepublic_latency_range (bool)
boolreceives_input ()

Returns true if this Port receives input, otherwise false

boolsends_output ()

Returns true if this Port sends output, otherwise false

Cast
AsyncMIDIPortto_asyncmidiport ()
AudioPortto_audioport ()
MidiPortto_midiport ()
@@ -381,9 +454,9 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C Constructor ℂARDOUR.AudioRangeList () Methods - AudioRangeback () + AudioRangeback () boolempty () - AudioRangefront () + AudioRangefront () LuaIteriter () voidreverse () unsigned longsize () @@ -397,6 +470,8 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C + + @@ -404,6 +479,12 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C + + + + + +
Methods
AudioSourceaudio_source (unsigned int)
boolfade_in_active ()
boolfade_out_active ()
boolisnil ()
doublemaximum_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.

floatscale_amplitude ()
LuaTable(int, ...)separate_by_channel (RegionVector&)
voidset_fade_in_active (bool)
voidset_fade_in_length (long)
voidset_fade_in_shape (FadeShape)
voidset_fade_out_active (bool)
voidset_fade_out_length (long)
voidset_fade_out_shape (FadeShape)
voidset_scale_amplitude (float)

Inherited from ARDOUR:Region

@@ -437,18 +518,21 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C unsigned intn_channels () voidnudge_position (long) boolopaque () + Playlistplaylist () longposition () -

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

boolposition_locked () doublequarter_note () voidraise () voidraise_to_top () voidset_hidden (bool) voidset_initial_position (long) -

A gui may need to create a region, then place it in an initial position determined by the user. When this takes place within one gui operation, we have to reset _last_position to prevent an implied move.

+

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.

voidset_length (long, int) voidset_locked (bool) voidset_muted (bool) + boolset_name (std::string) +

Note: changing the name of a Region does not constitute an edit

voidset_opaque (bool) voidset_position (long, int) voidset_position_locked (bool) @@ -483,6 +567,23 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C Statefulto_stateful () StatefulDestructibleto_statefuldestructible () +

↠ ARDOUR:AudioRom

+

C‡: boost::shared_ptr< ARDOUR::AudioRom >, boost::weak_ptr< ARDOUR::AudioRom >

+

is-a: ARDOUR:Readable

+
+ + + + +
Methods
boolisnil ()
AudioRomnew_rom (FloatArray, unsigned long)
+

Inherited from ARDOUR:Readable

+ + + + + + +
Methods
ReadableListload (Session&, std::string)
unsigned intn_channels ()
longread (FloatArray, long, long, int)
longreadable_length ()

↠ ARDOUR:AudioSource

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 C

A named object associated with a Session. Objects derived from this class are expected to be destroyed before the session calls drop_references().

- + @@ -509,7 +610,6 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C - @@ -534,7 +634,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C

C‡: boost::shared_ptr< ARDOUR::AudioTrack >, boost::weak_ptr< ARDOUR::AudioTrack >

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
std::stringcaptured_for ()
std::stringcaptured_for ()
boolempty ()
boolisnil ()
boolisnil ()
Methods
std::stringancestor_name ()
boolcan_be_analysed ()
booldestructive ()
boolhas_been_analysed ()
longnatural_position ()
longtimeline_position ()
@@ -549,8 +649,12 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C + + + + @@ -566,9 +670,10 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C + - + @@ -579,47 +684,47 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C + - + - + + - -
Methods
boolisnil ()
boolbounceable (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.

endpoint
the processor to tap the signal off (or nil for the top)
include_endpoint
include the given processor in the bounced audio.

Returns true if the track can be bounced, or false otherwise.

boolcan_record ()
intfind_and_use_playlist (DataType, ID)
Playlistplaylist ()
boolset_name (std::string)
intuse_copy_playlist ()
intuse_new_playlist (DataType)
intuse_playlist (DataType, Playlist)
Cast
AudioTrackto_audio_track ()
MidiTrackto_midi_track ()
std::stringcomment ()
boolcustomize_plugin_insert (Processor, unsigned int, ChanCount, ChanCount)

enable custom plugin-insert configuration

proc
Processor to customize
count
number of plugin instances to use (if zero, reset to default)
outs
output port customization
sinks
input pins for variable-I/O plugins

Returns true if successful

DataTypedata_type ()
IOinput ()
Deliverymain_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

boolmuted ()
ChanCountn_inputs ()
ChanCountn_outputs ()
PannerShellpanner_shell ()
PeakMeterpeak_meter ()

************************************************************* Pure interface begins here*************************************************************

longplayback_latency (bool)
intremove_processor (Processor, ProcessorStreams, bool)

remove plugin/processor

proc
processor to remove
err
error report (index where removal failed, channel-count why it failed) may be nil
need_process_lock
if locking is required (set to true, unless called from RT context with lock)

Returns 0 on success

remove plugin/processor

proc
processor to remove
err
error report (index where removal vailed, channel-count why it failed) may be nil
need_process_lock
if locking is required (set to true, unless called from RT context with lock)

Returns 0 on success

intremove_processors (ProcessorList, ProcessorStreams)
boolremove_sidechain (Processor)
intreorder_processors (ProcessorList, ProcessorStreams)
intreplace_processor (Processor, Processor, ProcessorStreams)

replace plugin/processor with another

old
processor to remove
sub
processor to substitute the old one with
err
error report (index where removal failed, channel-count why it failed) may be nil

Returns 0 on success

replace plugin/processor with another

old
processor to remove
sub
processor to substitute the old one with
err
error report (index where removal vailed, channel-count why it failed) may be nil

Returns 0 on success

boolreset_plugin_insert (Processor)

reset plugin-insert configuration to default, disable customizations.

This is equivalent to calling 

 customize_plugin_insert (proc, 0, unused)
proc
Processor to reset

Returns true if successful

voidset_active (bool, void*)
voidset_comment (std::string, void*)
voidset_meter_point (MeterPoint, bool)
boolset_strict_io (bool)
longsignal_latency ()
boolsoloed ()
boolstrict_io ()
Processorthe_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.

Amptrim ()
Cast
Automatableto_automatable ()
Slavableto_slavable ()
Trackto_track ()

Inherited from ARDOUR:Stripable

- - - + + + - - + + - + - - - - - + + + + + @@ -628,8 +733,9 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C + - + @@ -641,16 +747,22 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C - - + + + + + + + +
Methods
AutomationControlcomp_enable_control ()
AutomationControlcomp_makeup_control ()
AutomationControlcomp_mode_control ()
AutomationControlcomp_enable_controllable ()
AutomationControlcomp_makeup_controllable ()
AutomationControlcomp_mode_controllable ()
std::stringcomp_mode_name (unsigned int)
ReadOnlyControlcomp_redux_control ()
AutomationControlcomp_speed_control ()
ReadOnlyControlcomp_redux_controllable ()
AutomationControlcomp_speed_controllable ()
std::stringcomp_speed_name (unsigned int)
AutomationControlcomp_threshold_control ()
AutomationControlcomp_threshold_controllable ()
unsigned inteq_band_cnt ()
std::stringeq_band_name (unsigned int)
AutomationControleq_enable_control ()
AutomationControleq_freq_control (unsigned int)
AutomationControleq_gain_control (unsigned int)
AutomationControleq_q_control (unsigned int)
AutomationControleq_shape_control (unsigned int)
AutomationControleq_enable_controllable ()
AutomationControleq_freq_controllable (unsigned int)
AutomationControleq_gain_controllable (unsigned int)
AutomationControleq_q_controllable (unsigned int)
AutomationControleq_shape_controllable (unsigned int)
AutomationControlfilter_enable_controllable (bool)
AutomationControlfilter_freq_controllable (bool)
AutomationControlfilter_slope_controllable (bool)
boolis_hidden ()
boolis_master ()
boolis_monitor ()
boolis_private_route ()
boolis_selected ()
AutomationControlmaster_send_enable_control ()
AutomationControlmaster_send_enable_controllable ()
MonitorProcessormonitor_control ()
MuteControlmute_control ()
AutomationControlpan_azimuth_control ()
PresentationInfopresentation_info_ptr ()
AutomationControlrec_enable_control ()
AutomationControlrec_safe_control ()
AutomationControlsend_enable_control (unsigned int)
AutomationControlsend_level_control (unsigned int)
AutomationControlsend_enable_controllable (unsigned int)
AutomationControlsend_level_controllable (unsigned int)
std::stringsend_name (unsigned int)
AutomationControlsend_pan_azimuth_controllable (unsigned int)
AutomationControlsend_pan_azimuth_enable_controllable (unsigned int)
voidset_presentation_order (unsigned int)
boolslaved ()
boolslaved_to (VCA)
SoloControlsolo_control ()
SoloIsolateControlsolo_isolate_control ()
SoloSafeControlsolo_safe_control ()
GainControltrim_control ()
Cast
Automatableto_automatable ()
Routeto_route ()
Slavableto_slavable ()
VCAto_vca ()

Inherited from ARDOUR:SessionObjectPtr

@@ -669,9 +781,9 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C ℂARDOUR.AudioTrackList () Methods LuaTableadd (LuaTable {AudioTrack}) - AudioTrackback () + AudioTrackback () boolempty () - AudioTrackfront () + AudioTrackfront () LuaIteriter () voidpush_back (AudioTrack) voidreverse () @@ -691,14 +803,14 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C Slavableto_slavable ()

↠ ARDOUR:AutomatableSequence

-

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
boolisnil ()
Cast
Sequenceto_sequence ()
Sequenceto_sequence ()

Inherited from ARDOUR:Automatable

@@ -716,14 +828,19 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C + - + + + - + + + @@ -768,6 +885,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C + @@ -798,25 +916,26 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
Methods
AutomationListalist ()
AutoStateautomation_state ()
ParameterDescriptordesc ()
doubleget_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

boolisnil ()
doublelower ()
doublenormal ()
voidset_automation_state (AutoState)
voidset_value (double, GroupControlDisposition)

Get and 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.

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.

value
raw numeric value to set
group_override
if and how to propagate value to grouped controls
voidstart_touch (double)
voidstop_touch (double)
booltoggled ()
doubleupper ()
boolwritable ()
Cast
Controlto_ctrl ()
voidclear (double, double)

remove all automation events between the given time range

start
start of range (inclusive) in audio samples
end
end of range (inclusive) in audio samples
voidclear_list ()
booleditor_add (double, double, bool)
doubleeval (double)

query value at given time (takes a read-lock, not safe while writing automation)

where
absolute time in samples

Returns parameter value

EventListevents ()
unsigned longsize ()
LuaTabletable ()
-

∁ ARDOUR:BeatsFramesConverter

-

C‡: ARDOUR::BeatsFramesConverter

+

∁ ARDOUR:BeatsSamplesConverter

+

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
Beatsfrom (long)
Beatsfrom (long)

Convert B time to A time (A from B)

longto (Beats)
longto (Beats)

Convert A time to B time (A to B)

∁ ARDOUR:BufferSet

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.

+ @@ -831,7 +950,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C - + @@ -841,7 +960,11 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C - + + + + +
Methods
ChanCountavailable ()
ChanCountcount ()
AudioBufferget_audio (unsigned long)
MidiBufferget_midi (unsigned long)

Convenience constructor for making single-typed streams (mono, stereo, midi, etc)

type
data type
count
number of channels
Methods
unsigned intget (DataType)

query channel count for given type

type
data type

Returns channel count for given type

query channel count for given type

t
data type

Returns channel count for given type

unsigned intn_audio ()

query number of audio channels

Returns number of audio channels

unsigned intn_midi ()
voidreset ()

zero count of all data types

voidset (DataType, unsigned int)

set channel count for given type

count
number of channels
type
data type

set channel count for given type

t
data type
count
number of channels
voidset_audio (unsigned int)

set number of audio channels

a
number of audio channels
voidset_midi (unsigned int)

set number of audio channels

m
number of midi channels

∁ ARDOUR:ChanMapping

C‡: ARDOUR::ChanMapping

@@ -853,12 +976,12 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C Methods ChanCountcount () unsigned intget (DataType, unsigned int) -

get buffer mapping for given data type and pin

from
numeric source id
type
data type

Returns mapped buffer number (or ChanMapping::Invalid)

+

get buffer mapping for given data type and pin

type
data type
from
numeric source id

Returns mapped buffer number (or ChanMapping::Invalid)

boolis_monotonic ()

Test if this mapping is monotonic (useful to see if inplace processing is feasible)

Returns true if the map is a strict monotonic set

unsigned intn_total () voidset (DataType, unsigned int, unsigned int) -

set buffer mapping for given data type

from
numeric source id
to
buffer
type
data type
+

set buffer mapping for given data type

type
data type
from
numeric source id
to
buffer

∁ ARDOUR:ControlList

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 C ℂARDOUR.ControlList () Methods LuaTableadd (LuaTable {AutomationControl}) - AutomationControlback () + AutomationControlback () boolempty () - AutomationControlfront () + AutomationControlfront () LuaIteriter () voidpush_back (AutomationControl) voidreverse () @@ -916,7 +1039,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C voidmmult (FloatArray, FloatArray, unsigned int)

matrix multiply multiply every sample of `data' with the corresponding sample at `mult'.

data
multiplicand
mult
multiplicand
n_samples
number of samples in data and mmult
LuaTable(...)peaks (FloatArray, float&, float&, unsigned int) - voidprocess_map (BufferSet, ChanMapping, ChanMapping, unsigned int, long, DataType) + voidprocess_map (BufferSet, ChanCount, ChanMapping, ChanMapping, unsigned int, long)

∁ ARDOUR:DSP:Biquad

C‡: ARDOUR::DSP::Biquad

@@ -938,6 +1061,45 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C voidrun (FloatArray, unsigned int)

process audio data

data
pointer to audio-data
n_samples
number of samples to process
+

∁ ARDOUR:DSP:Convolution

+

C‡: ARDOUR::DSP::Convolution

+
+ + + + + + + + + + + +
Constructor
ℂARDOUR.DSP.Convolution (Session&, unsigned int, unsigned int)
Methods
booladd_impdata (unsigned int, unsigned int, Readable, float, unsigned int, long, long, unsigned int)
unsigned intlatency ()
unsigned intn_inputs ()
unsigned intn_outputs ()
boolready ()
voidrestart ()
voidrun (BufferSet&, ChanMapping, ChanMapping, unsigned int, long)
+

∁ ARDOUR:DSP:Convolver

+

C‡: ARDOUR::DSP::Convolver

+

is-a: ARDOUR:DSP:Convolution

+
+ + + + + + +
Constructor
ℂARDOUR.DSP.Convolver (Session&, std::string, IRChannelConfig, IRSettings)
Methods
voidrun_mono (FloatArray, unsigned int)
voidrun_stereo (FloatArray, FloatArray, unsigned int)
+

Inherited from ARDOUR:DSP:Convolution

+ + + + + + + + + + + +
Constructor
ℂARDOUR.DSP.Convolution (Session&, unsigned int, unsigned int)
Methods
booladd_impdata (unsigned int, unsigned int, Readable, float, unsigned int, long, long, unsigned int)
unsigned intlatency ()
unsigned intn_inputs ()
unsigned intn_outputs ()
boolready ()
voidrestart ()
voidrun (BufferSet&, ChanMapping, ChanMapping, unsigned int, long)

∁ ARDOUR:DSP:DspShm

C‡: ARDOUR::DSP::DspShm

@@ -970,9 +1132,44 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C

process current data in buffer

floatfreq_at_bin (unsigned int) floatpower_at_bin (unsigned int, float) -

query

b
the frequency bin 0 .. window_size / 2
norm
gain factor (set equal to for 1/f normalization)

Returns signal power at given bin (in dBFS)

+

query

b
the frequency bin 0 .. window_size / 2
norm
gain factor (set equal to bin for 1/f normalization)

Returns signal power at given bin (in dBFS)

voidset_data_hann (FloatArray, unsigned int, unsigned int) +

∁ ARDOUR:DSP:Generator

+

C‡: ARDOUR::DSP::Generator

+
+ + + + + + +
Constructor
ℂARDOUR.DSP.Generator ()
Methods
voidrun (FloatArray, unsigned int)
voidset_type (Type)
+

∁ ARDOUR:DSP:IRSettings

+

C‡: ARDOUR::DSP::Convolver::IRSettings

+
+ + + + + + + + + + + +
Constructor
ℂARDOUR.DSP.IRSettings ()
Methods
unsigned intget_channel_delay (unsigned int)
floatget_channel_gain (unsigned int)
voidset_channel_delay (unsigned int, unsigned int)
voidset_channel_gain (unsigned int, float)
Data Members
floatgain
unsigned intpre_delay
+

∁ ARDOUR:DSP:LTCReader

+

C‡: ARDOUR::LTCReader

+
+ + + + + + +
Constructor
ℂARDOUR.DSP.LTCReader (int, LTC_TV_STANDARD)
Methods
LuaTable(long, ...)read (unsigned int&, unsigned int&, unsigned int&, unsigned int&)
voidwrite (FloatArray, long, long)

∁ ARDOUR:DSP:LowPass

C‡: ARDOUR::DSP::LowPass

@@ -983,7 +1180,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C

instantiate a LPF

samplerate
samplerate
freq
cut-off frequency
Methods voidctrl (FloatArray, float, unsigned int) -

filter control data

This is useful for parameter smoothing.

data
pointer to control-data array
val
target value
array
length
+

filter control data

This is useful for parameter smoothing.

data
pointer to control-data array
val
target value
n_samples
array length
voidproc (FloatArray, unsigned int)

process audio data

data
pointer to audio-data
n_samples
number of samples to process
voidreset () @@ -1008,11 +1205,63 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C char*to_string ()

Inverse of the from-string constructor

+

↠ ARDOUR:DelayLine

+

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
longdelay ()
boolisnil ()
+

Inherited from ARDOUR:Processor

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Methods
voidactivate ()
boolactive ()
longcapture_offset ()
voiddeactivate ()
std::stringdisplay_name ()
booldisplay_to_user ()
longinput_latency ()
ChanCountinput_streams ()
longoutput_latency ()
ChanCountoutput_streams ()
longplayback_offset ()
longsignal_latency ()
Cast
Ampto_amp ()
Automatableto_automatable ()
DelayLineto_delayline ()
DiskIOProcessorto_diskioprocessor ()
DiskReaderto_diskreader ()
DiskWriterto_diskwriter ()
PluginInsertto_insert ()
IOProcessorto_ioprocessor ()
Latentto_latent ()
PeakMeterto_meter ()
MonitorProcessorto_monitorprocessor ()
PeakMeterto_peakmeter ()
PluginInsertto_plugininsert ()
PolarityProcessorto_polarityprocessor ()
Sendto_send ()
SideChainto_sidechain ()
UnknownProcessorto_unknownprocessor ()
+

Inherited from ARDOUR:SessionObjectPtr

+ + + + + + +
Methods
std::stringname ()
Cast
Statefulto_stateful ()
StatefulDestructibleto_statefuldestructible ()

↠ ARDOUR:Delivery

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.

@@ -1031,20 +1280,32 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C + - - + + + + + + + + + + + + +
Methods
boolisnil ()
Methods
voidactivate ()
boolactive ()
longcapture_offset ()
voiddeactivate ()
std::stringdisplay_name ()
booldisplay_to_user ()
ChanCountinput_streams ()
ChanCountoutput_streams ()
longinput_latency ()
ChanCountinput_streams ()
longoutput_latency ()
ChanCountoutput_streams ()
longplayback_offset ()
longsignal_latency ()
Cast
Ampto_amp ()
Automatableto_automatable ()
DelayLineto_delayline ()
DiskIOProcessorto_diskioprocessor ()
DiskReaderto_diskreader ()
DiskWriterto_diskwriter ()
PluginInsertto_insert ()
IOProcessorto_ioprocessor ()
Latentto_latent ()
PeakMeterto_meter ()
MonitorProcessorto_monitorprocessor ()
PeakMeterto_peakmeter ()
PluginInsertto_plugininsert ()
PolarityProcessorto_polarityprocessor ()
Sendto_send ()
SideChainto_sidechain ()
UnknownProcessorto_unknownprocessor ()
@@ -1075,23 +1336,178 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C Methods LuaTableadd (LuaTable {DeviceStatus}) DeviceStatusat (unsigned long) + voidclear () boolempty () LuaIteriter () voidpush_back (DeviceStatus) unsigned longsize () LuaTabletable () + ...to_array (--lua--) + +

↠ ARDOUR:DiskIOProcessor

+

C‡: boost::shared_ptr< ARDOUR::DiskIOProcessor >, boost::weak_ptr< ARDOUR::DiskIOProcessor >

+

is-a: ARDOUR:Processor

+
+

A mixer strip element - plugin, send, meter, etc

+ + +
Methods
boolisnil ()
-

∁ ARDOUR:DoubleBeatsFramesConverter

-

C‡: ARDOUR::DoubleBeatsFramesConverter

+

Inherited from ARDOUR:Processor

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Methods
voidactivate ()
boolactive ()
longcapture_offset ()
voiddeactivate ()
std::stringdisplay_name ()
booldisplay_to_user ()
longinput_latency ()
ChanCountinput_streams ()
longoutput_latency ()
ChanCountoutput_streams ()
longplayback_offset ()
longsignal_latency ()
Cast
Ampto_amp ()
Automatableto_automatable ()
DelayLineto_delayline ()
DiskIOProcessorto_diskioprocessor ()
DiskReaderto_diskreader ()
DiskWriterto_diskwriter ()
PluginInsertto_insert ()
IOProcessorto_ioprocessor ()
Latentto_latent ()
PeakMeterto_meter ()
MonitorProcessorto_monitorprocessor ()
PeakMeterto_peakmeter ()
PluginInsertto_plugininsert ()
PolarityProcessorto_polarityprocessor ()
Sendto_send ()
SideChainto_sidechain ()
UnknownProcessorto_unknownprocessor ()
+

Inherited from ARDOUR:SessionObjectPtr

+ + + + + + +
Methods
std::stringname ()
Cast
Statefulto_stateful ()
StatefulDestructibleto_statefuldestructible ()
+

↠ ARDOUR:DiskReader

+

C‡: boost::shared_ptr< ARDOUR::DiskReader >, boost::weak_ptr< ARDOUR::DiskReader >

+

is-a: ARDOUR:DiskIOProcessor

-

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
boolisnil ()
+

Inherited from ARDOUR:Processor

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Methods
voidactivate ()
boolactive ()
longcapture_offset ()
voiddeactivate ()
std::stringdisplay_name ()
booldisplay_to_user ()
longinput_latency ()
ChanCountinput_streams ()
longoutput_latency ()
ChanCountoutput_streams ()
longplayback_offset ()
longsignal_latency ()
Cast
Ampto_amp ()
Automatableto_automatable ()
DelayLineto_delayline ()
DiskIOProcessorto_diskioprocessor ()
DiskReaderto_diskreader ()
DiskWriterto_diskwriter ()
PluginInsertto_insert ()
IOProcessorto_ioprocessor ()
Latentto_latent ()
PeakMeterto_meter ()
MonitorProcessorto_monitorprocessor ()
PeakMeterto_peakmeter ()
PluginInsertto_plugininsert ()
PolarityProcessorto_polarityprocessor ()
Sendto_send ()
SideChainto_sidechain ()
UnknownProcessorto_unknownprocessor ()
+

Inherited from ARDOUR:SessionObjectPtr

+ + + + + + +
Methods
std::stringname ()
Cast
Statefulto_stateful ()
StatefulDestructibleto_statefuldestructible ()
+

↠ ARDOUR:DiskWriter

+

C‡: boost::shared_ptr< ARDOUR::DiskWriter >, boost::weak_ptr< ARDOUR::DiskWriter >

+

is-a: ARDOUR:DiskIOProcessor

+
+

A mixer strip element - plugin, send, meter, etc

+ + + +
Methods
boolisnil ()
+

Inherited from ARDOUR:Processor

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Methods
voidactivate ()
boolactive ()
longcapture_offset ()
voiddeactivate ()
std::stringdisplay_name ()
booldisplay_to_user ()
longinput_latency ()
ChanCountinput_streams ()
longoutput_latency ()
ChanCountoutput_streams ()
longplayback_offset ()
longsignal_latency ()
Cast
Ampto_amp ()
Automatableto_automatable ()
DelayLineto_delayline ()
DiskIOProcessorto_diskioprocessor ()
DiskReaderto_diskreader ()
DiskWriterto_diskwriter ()
PluginInsertto_insert ()
IOProcessorto_ioprocessor ()
Latentto_latent ()
PeakMeterto_meter ()
MonitorProcessorto_monitorprocessor ()
PeakMeterto_peakmeter ()
PluginInsertto_plugininsert ()
PolarityProcessorto_polarityprocessor ()
Sendto_send ()
SideChainto_sidechain ()
UnknownProcessorto_unknownprocessor ()
+

Inherited from ARDOUR:SessionObjectPtr

+ + + + + + +
Methods
std::stringname ()
Cast
Statefulto_stateful ()
StatefulDestructibleto_statefuldestructible ()
+

∁ ARDOUR:DoubleBeatsSamplesConverter

+

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
doublefrom (long)
doublefrom (long)

Convert B time to A time (A from B)

longto (double)
longto (double)

Convert A time to B time (A to B)

∁ ARDOUR:EventList

@@ -1121,7 +1537,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C boolisnil () std::stringorigin () std::stringpath () - std::stringtake_id () + std::stringtake_id () boolwithin_session ()

Inherited from ARDOUR:Source

@@ -1129,7 +1545,6 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C Methods std::stringancestor_name () boolcan_be_analysed () - booldestructive () boolempty () boolhas_been_analysed () longlength (long) @@ -1158,7 +1573,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C - + @@ -1193,13 +1608,18 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C + - + + + - + + + @@ -1222,7 +1642,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C

C‡: boost::shared_ptr< ARDOUR::IO >, boost::weak_ptr< ARDOUR::IO >

is-a: ARDOUR:SessionObjectPtr

-

A collection of ports (all input or all output) with connections.

An IO can contain ports of varying types, making routes/inserts/etc with varied combinations of types (e.g. MIDI and audio) possible.

+

A collection of ports (all input or all output) with connections.

An IO can contain ports of varying types, making routes/inserts/etc with varied combinations of types (eg MIDI and audio) possible.

Constructor
ℂARDOUR.FluidSynth (float, int)

instantiate a Synth

samplerate
samplerate

instantiate a Synth

samplerate
samplerate
polyphony
polyphony
Methods
boolload_sf2 (std::string)
boolmidi_event (unsigned char*, unsigned long)
Methods
AutomationListalist ()
AutoStateautomation_state ()
ParameterDescriptordesc ()
doubleget_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

doublelower ()
doublenormal ()
voidset_automation_state (AutoState)
voidset_value (double, GroupControlDisposition)

Get and 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.

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.

value
raw numeric value to set
group_override
if and how to propagate value to grouped controls
voidstart_touch (double)
voidstop_touch (double)
booltoggled ()
doubleupper ()
boolwritable ()
Cast
Controlto_ctrl ()
@@ -1234,11 +1654,13 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C + +
Methods
boolactive ()
intdisconnect_all (void*)
boolhas_port (Port)
boolisnil ()
longlatency ()
MidiPortmidi (unsigned int)
ChanCountn_ports ()
Portnth (unsigned int)
boolphysically_connected ()
Portport_by_name (unsigned int)
longpublic_latency ()
intremove_port (Port, void*)

Inherited from ARDOUR:SessionObjectPtr

@@ -1253,7 +1675,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C

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.

@@ -1267,20 +1689,32 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C + - - + + + + + + + + + + + + +
Methods
IOinput ()
Methods
voidactivate ()
boolactive ()
longcapture_offset ()
voiddeactivate ()
std::stringdisplay_name ()
booldisplay_to_user ()
ChanCountinput_streams ()
ChanCountoutput_streams ()
longinput_latency ()
ChanCountinput_streams ()
longoutput_latency ()
ChanCountoutput_streams ()
longplayback_offset ()
longsignal_latency ()
Cast
Ampto_amp ()
Automatableto_automatable ()
DelayLineto_delayline ()
DiskIOProcessorto_diskioprocessor ()
DiskReaderto_diskreader ()
DiskWriterto_diskwriter ()
PluginInsertto_insert ()
IOProcessorto_ioprocessor ()
Latentto_latent ()
PeakMeterto_meter ()
MonitorProcessorto_monitorprocessor ()
PeakMeterto_peakmeter ()
PluginInsertto_plugininsert ()
PolarityProcessorto_polarityprocessor ()
Sendto_send ()
SideChainto_sidechain ()
UnknownProcessorto_unknownprocessor ()
@@ -1302,6 +1736,156 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C booldone floatprogress +

↠ ARDOUR:InternalReturn

+

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
boolisnil ()
+

Inherited from ARDOUR:IOProcessor

+ + + + + + +
Methods
IOinput ()
ChanCountnatural_input_streams ()
ChanCountnatural_output_streams ()
IOoutput ()
+

Inherited from ARDOUR:Processor

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Methods
voidactivate ()
boolactive ()
longcapture_offset ()
voiddeactivate ()
std::stringdisplay_name ()
booldisplay_to_user ()
longinput_latency ()
ChanCountinput_streams ()
longoutput_latency ()
ChanCountoutput_streams ()
longplayback_offset ()
longsignal_latency ()
Cast
Ampto_amp ()
Automatableto_automatable ()
DelayLineto_delayline ()
DiskIOProcessorto_diskioprocessor ()
DiskReaderto_diskreader ()
DiskWriterto_diskwriter ()
PluginInsertto_insert ()
IOProcessorto_ioprocessor ()
Latentto_latent ()
PeakMeterto_meter ()
MonitorProcessorto_monitorprocessor ()
PeakMeterto_peakmeter ()
PluginInsertto_plugininsert ()
PolarityProcessorto_polarityprocessor ()
Sendto_send ()
SideChainto_sidechain ()
UnknownProcessorto_unknownprocessor ()
+

Inherited from ARDOUR:SessionObjectPtr

+ + + + + + +
Methods
std::stringname ()
Cast
Statefulto_stateful ()
StatefulDestructibleto_statefuldestructible ()
+

↠ ARDOUR:InternalSend

+

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
boolisnil ()
+

Inherited from ARDOUR:Send

+ + + + +
Methods
longget_delay_in ()
longget_delay_out ()
+

Inherited from ARDOUR:Delivery

+ + + +
Methods
PannerShellpanner_shell ()
+

Inherited from ARDOUR:IOProcessor

+ + + + + + +
Methods
IOinput ()
ChanCountnatural_input_streams ()
ChanCountnatural_output_streams ()
IOoutput ()
+

Inherited from ARDOUR:Processor

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Methods
voidactivate ()
boolactive ()
longcapture_offset ()
voiddeactivate ()
std::stringdisplay_name ()
booldisplay_to_user ()
longinput_latency ()
ChanCountinput_streams ()
longoutput_latency ()
ChanCountoutput_streams ()
longplayback_offset ()
longsignal_latency ()
Cast
Ampto_amp ()
Automatableto_automatable ()
DelayLineto_delayline ()
DiskIOProcessorto_diskioprocessor ()
DiskReaderto_diskreader ()
DiskWriterto_diskwriter ()
PluginInsertto_insert ()
IOProcessorto_ioprocessor ()
Latentto_latent ()
PeakMeterto_meter ()
MonitorProcessorto_monitorprocessor ()
PeakMeterto_peakmeter ()
PluginInsertto_plugininsert ()
PolarityProcessorto_polarityprocessor ()
Sendto_send ()
SideChainto_sidechain ()
UnknownProcessorto_unknownprocessor ()
+

Inherited from ARDOUR:SessionObjectPtr

+ + + + + + +
Methods
std::stringname ()
Cast
Statefulto_stateful ()
StatefulDestructibleto_statefuldestructible ()
+

∁ ARDOUR:LatencyRange

+

C‡: ARDOUR::LatencyRange

+
+ + + + + + +
Constructor
ℂARDOUR.LatencyRange ()
Data Members
unsigned intmax
unsigned intmin
+

↠ ARDOUR:Latent

+

C‡: boost::shared_ptr< ARDOUR::Latent >, boost::weak_ptr< ARDOUR::Latent >

+
+ + + + + + + +
Methods
longeffective_latency ()
boolisnil ()
voidset_user_latency (long)
voidunset_user_latency ()
longuser_latency ()

∁ ARDOUR:Location

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 C boolmatches (Flags) intmove_to (long, unsigned int) std::stringname () + intset (long, long, bool, unsigned int) intset_end (long, bool, bool, unsigned int)

Set end position.

force
true to force setting, even if the given new end is before the current start.
allow_beat_recompute
True to recompute BEAT end time from the new given end time.
s
New end.
intset_length (long, long, bool, unsigned int) + voidset_name (std::string) +

Set location name

intset_start (long, bool, bool, unsigned int)

Set start position.

s
New start.
force
true to force setting, even if the given new start is after the current end.
allow_beat_recompute
True to recompute BEAT start time from the new given start time.
longstart () @@ -1369,8 +1956,9 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C Locationfirst_mark_at (long, long) longfirst_mark_before (long, bool) LocationListlist () + Locationmark_at (long, long) LuaTable(...)marks_either_side (long, long&, long&) -

Look for the `marks' (either locations which are marks, or start/end points of range markers) either side of a frame. Note that if frame is exactly on a `mark', that mark will not be considered for returning as before/after.

frame
Frame to look for.
before
Filled in with the position of the last `mark' before `frame' (or max_framepos if none exists)
after
Filled in with the position of the next `mark' after `frame' (or max_framepos if none exists)
+

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.

sample
Frame to look for.
before
Filled in with the position of the last `mark' before `sample' (or max_samplepos if none exists)
after
Filled in with the position of the next `mark' after `sample' (or max_samplepos if none exists)
voidremove (Location) Locationsession_range_location () @@ -1386,27 +1974,32 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
+ + + - + + + - + - + - + - + - +
Methods
std::stringascii_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::stringfile_get_contents (std::string)
boolfile_test (std::string, FileTest)
LuaTable(float, ...)get_plugin_insert_param (PluginInsert, unsigned int, bool&)

get a plugin control parameter value

which
control port to query (starting at 0, including ports of type input and output)
ok
boolean variable contains true or false after call returned. to be checked by caller before using value.
proc
Plugin-Insert

Returns value

get a plugin control parameter value

pi
Plugin-Insert
which
control port to query (starting at 0, including ports of type input and output)
ok
boolean variable contains true or false after call returned. to be checked by caller before using value.

Returns value

LuaTable(float, ...)get_processor_param (Processor, unsigned int, bool&)

get a plugin control parameter value

proc
Plugin-Processor
which
control port to set (starting at 0, including ports of type input and output))
ok
boolean variable contains true or false after call returned. to be checked by caller before using 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)

PluginInfoListlist_plugins ()

List all installed plugins

longmonotonic_time ()
Processornew_luaproc (Session, std::string)

create a new Lua Processor (Plugin)

s
Session Handle
p
Identifier or Name of the Processor

Returns Processor object (may be nil)

NotePtrnew_noteptr (unsigned char, Beats, Beats, unsigned char, unsigned char)
NotePtrnew_noteptr (unsigned char, Beats, Beats, unsigned char, unsigned char)
Processornew_plugin (Session, std::string, PluginType, std::string)

create a new Plugin Instance

s
Session Handle
id
Plugin Name, ID or URI
type
Plugin Type

Returns Processor or nil

create a new Plugin Instance

s
Session Handle
id
Plugin Name, ID or URI
type
Plugin Type
preset
name of plugin-preset to load, leave empty "" to not load any preset after instantiation

Returns Processor or nil

PluginInfonew_plugin_info (std::string, PluginType)

search a Plugin

id
Plugin Name, ID or URI
type
Plugin Type

Returns PluginInfo or nil if not found

Processornil_proc ()
NotePtrListnote_list (MidiModel)
NotePtrListnote_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
...sample_to_timecode (--lua--)

Generic conversion from audio sample count to timecode. (TimecodeType, sample-rate, sample-pos)

boolset_plugin_insert_param (PluginInsert, unsigned int, float)

set a plugin control-input parameter value

This is a wrapper around set_processor_param which looks up the Processor by plugin-insert.

which
control-input to set (starting at 0)
proc
Plugin-Insert
value
value to set

Returns true on success, false on error or out-of-bounds value

set a plugin control-input parameter value

This is a wrapper around set_processor_param which looks up the Processor by plugin-insert.

pi
Plugin-Insert
which
control-input to set (starting at 0)
value
value to set

Returns true on success, false on error or out-of-bounds value

boolset_processor_param (Processor, unsigned int, float)

set a plugin control-input parameter value

proc
Plugin-Processor
which
control-input to set (starting at 0)
value
value to set

Returns true on success, false on error or out-of-bounds value

set a plugin control-input parameter value

proc
Plugin-Processor
which
control-input to set (starting at 0)
value
value to set

Returns true on success, false on error or out-of-bounds value

...timecode_to_sample (--lua--)

Generic conversion from timecode to audio sample count. (TimecodeType, sample-rate, hh, mm, ss, ff)

voidusleep (unsigned long)
+

∁ ARDOUR:LuaAPI:Rubberband

+

C‡: ARDOUR::LuaAPI::Rubberband

+
+ + + + + + + + + + +
Constructor
ℂARDOUR.LuaAPI.Rubberband (AudioRegion, bool)
Methods
unsigned intn_channels ()
AudioRegionprocess (Lua-Function)
Readablereadable ()
longreadable_length ()
boolset_mapping (Lua-Function)
boolset_strech_and_pitch (double, double)

∁ ARDOUR:LuaAPI:Vamp

C‡: ARDOUR::LuaAPI::Vamp

@@ -1437,7 +2044,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C ℂARDOUR.LuaAPI.Vamp (std::string, float) Methods intanalyze (Readable, unsigned int, Lua-Function) -

high-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.

r
readable
channel
channel to process
fn
lua callback function

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.

r
readable
channel
channel to process
cb
lua callback function or nil

Returns 0 on success

boolinitialize ()

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
  doubledivisions_per_bar ()
- doubleframes_per_bar (Tempo, long)
- doubleframes_per_grid (Tempo, long)
  doublenote_divisor ()
+ doublesamples_per_bar (Tempo, long)
+ doublesamples_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 C
 
 A section of timeline with a certain Meter. 

 
+ 
+ 
- 

  
Methods
BBT_TIMEbbt ()
doublebeat ()

  
voidset_beat (double)
voidset_pulse (double)

  
Cast

  
Meterto_meter ()

  

 
Inherited from ARDOUR:MetricSection

 
+ 
+ 
+ 
+ 
+ 
+ 
+ 

  
Methods
boolinitial ()
boolis_tempo ()
doubleminute ()
doubleminute_at_sample (long)

  
doublepulse ()
longsample ()
longsample_at_minute (double)
voidset_pulse (double)

 

 
∁ ARDOUR:MetricSection

 
C‡: ARDOUR::MetricSection

@@ -1551,7 +2166,13 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
 
 A section of timeline with a certain Tempo or Meter. 

 
+ 
+ 
+ 
+ 
+ 
+ 

  
Methods
boolinitial ()
boolis_tempo ()
doubleminute ()
doubleminute_at_sample (long)

  
doublepulse ()
longsample ()
longsample_at_minute (double)

  
voidset_pulse (double)

  

 
∁ ARDOUR:MidiBuffer

@@ -1567,7 +2188,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
  voidresize (unsigned long)
 
 Reallocate the buffer used internally to handle at least size_t units of data.
 The buffer is not silent after this operation. the capacity argument passed to the constructor must have been non-zero.

  voidsilence (long, long)
-
 Clear (e.g. zero, or empty) buffer 

+
 Clear (eg zero, or empty) buffer 

  unsigned longsize ()
  ...table (--lua--)
  
@@ -1586,7 +2207,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
 
Inherited from ARDOUR:AutomatableSequence

 
- 
+ 

  
Cast
Sequenceto_sequence ()
Sequenceto_sequence ()

 

 
Inherited from ARDOUR:Automatable

 
@@ -1622,8 +2243,8 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
 
 Base class for Undo/Redo commands and changesets 

 

- 
- 
+ 
+ 

  
Methods
voidadd (NotePtr)
voidremove (NotePtr)
voidadd (NotePtr)
voidremove (NotePtr)

  

 
Inherited from PBD:Command

 
@@ -1662,10 +2283,13 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
 
-
+
+ 
+ 
+ 
@@ -1679,11 +2303,12 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
  
- 
- 
+ 
+ 
+ 
@@ -1706,6 +2331,8 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
  
+ 
+ 
gap
 from the beginning of the region to the next beginning 

  
voidduplicate_range (AudioRange&, float)

  
voidduplicate_until (Region, long, long, long)
gap
 from the beginning of the region to the next beginning 
end
 the first frame that does _not_ contain a duplicated frame 
gap
 from the beginning of the region to the next beginning 
end
 the first sample that does _not_ contain a duplicated sample 
boolempty ()

  
Regionfind_next_region (long, RegionPoint, int)

  
longfind_next_region_boundary (long, int)

  
longfind_next_transient (long, int)
IDget_orig_track_id ()
boolhidden ()

  
voidlower_region (Region)

  
voidlower_region_to_bottom (Region)

  
unsigned intn_regions ()
RegionListPtrregions_with_end_within (Range)

  
RegionListPtrregions_with_start_within (Range)

  
voidremove_region (Region)
voidsplit (long)
voidsplit_region (Region, MusicFrame)
boolshared ()
voidsplit_region (Region, MusicSample)

  
Regiontop_region_at (long)

  
Regiontop_unmuted_region_at (long)

  
voiduncombine (Region)
boolused ()

  
Cast

  
AudioPlaylistto_audioplaylist ()

  
MidiPlaylistto_midiplaylist ()
boolinput_active ()

  
boolisnil ()

  
voidset_input_active (bool)
Cast
AsyncMIDIPortto_asyncmidiport ()

  

 
Inherited from ARDOUR:Port

 
@@ -1717,15 +2344,20 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
 
+ 
+ 
+ 
+ 
+ 
o
 Port name 
Returns  true if this port is connected to o, otherwise false.

  
intdisconnect (std::string)

  
intdisconnect_all ()
LuaTable(...)get_connected_latency_range (LatencyRange&, bool)

  
std::stringname ()

 
Returns  Port short name 
boolphysically_connected ()

  
std::stringpretty_name (bool)

 
Returns  Port human readable name 
LatencyRangeprivate_latency_range (bool)
LatencyRangepublic_latency_range (bool)

  
boolreceives_input ()

 
Returns  true if this Port receives input, otherwise false 

  
boolsends_output ()

 
Returns  true if this Port sends output, otherwise false 

  
Cast
AsyncMIDIPortto_asyncmidiport ()

  
AudioPortto_audioport ()

  
MidiPortto_midiport ()

 

@@ -1775,18 +2407,21 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
  unsigned intn_channels ()
  voidnudge_position (long)
  boolopaque ()
+ Playlistplaylist ()
  longposition ()
-
 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

  boolposition_locked ()
  doublequarter_note ()
  voidraise ()
  voidraise_to_top ()
  voidset_hidden (bool)
  voidset_initial_position (long)
-
 A gui may need to create a region, then place it in an initial  position determined by the user.  When this takes place within one gui operation, we have to reset  _last_position to prevent an implied move.

+
 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.

  voidset_length (long, int)
  voidset_locked (bool)
  voidset_muted (bool)
+ boolset_name (std::string)
+
 Note: changing the name of a Region does not constitute an edit 

  voidset_opaque (bool)
  voidset_position (long, int)
  voidset_position_locked (bool)
@@ -1838,7 +2473,6 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
  Methods
  std::stringancestor_name ()
  boolcan_be_analysed ()
- booldestructive ()
  boolhas_been_analysed ()
  longnatural_position ()
  longtimeline_position ()
@@ -1863,7 +2497,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
 
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.

 
@@ -1878,8 +2512,12 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
  
+ 
+ 
+ 
+ 
@@ -1895,6 +2533,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
  
+ 
@@ -1908,6 +2547,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
  
+ 
@@ -1921,34 +2561,33 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
  
+ 
- 
- 

  
Methods

  
boolisnil ()
boolbounceable (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.
endpoint
 the processor to tap the signal off (or nil for the top) 
include_endpoint
 include the given processor in the bounced audio. 
Returns  true if the track can be bounced, or false otherwise.

  
boolcan_record ()
intfind_and_use_playlist (DataType, ID)

  
Playlistplaylist ()

  
boolset_name (std::string)
intuse_copy_playlist ()
intuse_new_playlist (DataType)
intuse_playlist (DataType, Playlist)

  
Cast

  
AudioTrackto_audio_track ()

  
MidiTrackto_midi_track ()
std::stringcomment ()

  
boolcustomize_plugin_insert (Processor, unsigned int, ChanCount, ChanCount)

 
 enable custom plugin-insert configuration 
proc
 Processor to customize 
count
 number of plugin instances to use (if zero, reset to default) 
outs
 output port customization 
sinks
 input pins for variable-I/O plugins 
Returns  true if successful
DataTypedata_type ()

  
IOinput ()

  
Deliverymain_outs ()

 
 the signal processorat at end of the processing chain which produces output 
PannerShellpanner_shell ()

  
PeakMeterpeak_meter ()

 
************************************************************* Pure interface begins here*************************************************************
longplayback_latency (bool)

  
intremove_processor (Processor, ProcessorStreams, bool)

 
 remove plugin/processor
proc
 processor to remove 
err
 error report (index where removal vailed, channel-count why it failed) may be nil 
need_process_lock
 if locking is required (set to true, unless called from RT context with lock) 
Returns  0 on success

  
intremove_processors (ProcessorList, ProcessorStreams)
voidset_comment (std::string, void*)

  
voidset_meter_point (MeterPoint, bool)

  
boolset_strict_io (bool)
longsignal_latency ()

  
boolsoloed ()

  
boolstrict_io ()

  
Processorthe_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.

  
Amptrim ()

  
Cast
Automatableto_automatable ()
Slavableto_slavable ()

  
Trackto_track ()

 

 
Inherited from ARDOUR:Stripable

 
- 
- 
- 
+ 
+ 
+ 
- 
- 
+ 
+ 
- 
+ 
- 
- 
- 
- 
- 
+ 
+ 
+ 
+ 
+ 
@@ -1957,8 +2596,9 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
  
+ 
- 
+ 
@@ -1970,16 +2610,22 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
  
- 
- 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 

  
Methods
AutomationControlcomp_enable_control ()
AutomationControlcomp_makeup_control ()
AutomationControlcomp_mode_control ()
AutomationControlcomp_enable_controllable ()
AutomationControlcomp_makeup_controllable ()
AutomationControlcomp_mode_controllable ()

  
std::stringcomp_mode_name (unsigned int)
ReadOnlyControlcomp_redux_control ()
AutomationControlcomp_speed_control ()
ReadOnlyControlcomp_redux_controllable ()
AutomationControlcomp_speed_controllable ()

  
std::stringcomp_speed_name (unsigned int)
AutomationControlcomp_threshold_control ()
AutomationControlcomp_threshold_controllable ()

  
unsigned inteq_band_cnt ()

  
std::stringeq_band_name (unsigned int)
AutomationControleq_enable_control ()
AutomationControleq_freq_control (unsigned int)
AutomationControleq_gain_control (unsigned int)
AutomationControleq_q_control (unsigned int)
AutomationControleq_shape_control (unsigned int)
AutomationControleq_enable_controllable ()
AutomationControleq_freq_controllable (unsigned int)
AutomationControleq_gain_controllable (unsigned int)
AutomationControleq_q_controllable (unsigned int)
AutomationControleq_shape_controllable (unsigned int)

  
AutomationControlfilter_enable_controllable (bool)

  
AutomationControlfilter_freq_controllable (bool)

  
AutomationControlfilter_slope_controllable (bool)
boolis_hidden ()

  
boolis_master ()

  
boolis_monitor ()
boolis_private_route ()

  
boolis_selected ()
AutomationControlmaster_send_enable_control ()
AutomationControlmaster_send_enable_controllable ()

  
MonitorProcessormonitor_control ()

  
MuteControlmute_control ()

  
AutomationControlpan_azimuth_control ()
PresentationInfopresentation_info_ptr ()

  
AutomationControlrec_enable_control ()

  
AutomationControlrec_safe_control ()
AutomationControlsend_enable_control (unsigned int)
AutomationControlsend_level_control (unsigned int)
AutomationControlsend_enable_controllable (unsigned int)
AutomationControlsend_level_controllable (unsigned int)

  
std::stringsend_name (unsigned int)
AutomationControlsend_pan_azimuth_controllable (unsigned int)
AutomationControlsend_pan_azimuth_enable_controllable (unsigned int)

  
voidset_presentation_order (unsigned int)
boolslaved ()
boolslaved_to (VCA)

  
SoloControlsolo_control ()

  
SoloIsolateControlsolo_isolate_control ()

  
SoloSafeControlsolo_safe_control ()

  
GainControltrim_control ()

  
Cast
Automatableto_automatable ()

  
Routeto_route ()
Slavableto_slavable ()

  
VCAto_vca ()

 

 
Inherited from ARDOUR:SessionObjectPtr

@@ -1998,9 +2644,9 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
  ℂARDOUR.MidiTrackList ()
  Methods
  LuaTableadd (LuaTable {MidiTrack})
- MidiTrackback ()
+ MidiTrackback ()
  boolempty ()
- MidiTrackfront ()
+ MidiTrackfront ()
  LuaIteriter ()
  voidpush_back (MidiTrack)
  voidreverse ()
@@ -2048,20 +2694,32 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
  Methods
  voidactivate ()
  boolactive ()
+ longcapture_offset ()
  voiddeactivate ()
  std::stringdisplay_name ()
  booldisplay_to_user ()
- ChanCountinput_streams ()
- ChanCountoutput_streams ()
+ longinput_latency ()
+ ChanCountinput_streams ()
+ longoutput_latency ()
+ ChanCountoutput_streams ()
+ longplayback_offset ()
+ longsignal_latency ()
  Cast
  Ampto_amp ()
  Automatableto_automatable ()
+ DelayLineto_delayline ()
+ DiskIOProcessorto_diskioprocessor ()
+ DiskReaderto_diskreader ()
+ DiskWriterto_diskwriter ()
  PluginInsertto_insert ()
  IOProcessorto_ioprocessor ()
+ Latentto_latent ()
  PeakMeterto_meter ()
  MonitorProcessorto_monitorprocessor ()
  PeakMeterto_peakmeter ()
  PluginInsertto_plugininsert ()
+ PolarityProcessorto_polarityprocessor ()
+ Sendto_send ()
  SideChainto_sidechain ()
  UnknownProcessorto_unknownprocessor ()
 
@@ -2073,17 +2731,17 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
  Statefulto_stateful ()
  StatefulDestructibleto_statefuldestructible ()
 
-
∁ ARDOUR:MusicFrame

-
C‡: ARDOUR::MusicFrame

+
∁ ARDOUR:MusicSample

+
C‡: ARDOUR::MusicSample

 

 
- 
+ 
- 
+ 
- 
+ 

  
Constructor
ℂARDOUR.MusicFrame (long, int)
ℂARDOUR.MusicSample (long, int)

  
Methods
voidset (long, int)
voidset (long, int)

  
Data Members

  
intdivision
longframe
longsample

  

 
↠ ARDOUR:MuteControl

 
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 C
  Methods
  AutomationListalist ()
  AutoStateautomation_state ()
+ ParameterDescriptordesc ()
  doubleget_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

+ doublelower ()
+ doublenormal ()
  voidset_automation_state (AutoState)
  voidset_value (double, GroupControlDisposition)
-
 Get and 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.

+
 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.
value
 raw numeric value to set 
group_override
 if and how to propagate value to grouped controls

  voidstart_touch (double)
  voidstop_touch (double)
+ booltoggled ()
+ doubleupper ()
  boolwritable ()
  Cast
  Controlto_ctrl ()
@@ -2138,22 +2801,22 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
  OwnedPropertyListproperties ()
 
 
∁ ARDOUR:NotePtrList

-
C‡: std::list<boost::shared_ptr<Evoral::Note<Evoral::Beats> > > >

+
C‡: std::list<boost::shared_ptr<Evoral::Note<Temporal::Beats> > > >

 

 
- 
- 
- 
+ 
+ 
+ 
- 
- 
- 
+ 
+ 
+ 
- 
+ 

  
Constructor

  
ℂARDOUR.NotePtrList ()

  
Methods

  
LuaTableadd (LuaTable {Beats})
NotePtrback ()
boolempty ()
NotePtrfront ()
NotePtrback ()
boolempty ()
NotePtrfront ()

  
LuaIteriter ()
voidpush_back (NotePtr)
voidreverse ()
unsigned longsize ()
voidpush_back (NotePtr)
voidreverse ()
unsigned longsize ()

  
LuaTabletable ()
voidunique ()
voidunique ()

  

 
∅ ARDOUR:OwnedPropertyList

 
C‡: PBD::OwnedPropertyList

@@ -2161,6 +2824,14 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
 

 
 Persistent Property List
 A variant of PropertyList that does not delete its property list in its destructor. Objects with their own Properties store them in an OwnedPropertyList to avoid having them deleted at the wrong time.

 
This class object is only used indirectly as return-value and function-parameter. It provides no methods by itself.

+
∁ ARDOUR:PDC

+
C‡: ARDOUR::Latent

+

+
+ 
+ 
+ 
+ 
Methods
voidforce_zero_latency (bool)
boolzero_latency ()

 
↠ ARDOUR:PannerShell

 
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
  boolisnil ()
  floatmeter_level (unsigned int, MeterType)
+ MeterTypemeter_type ()
  voidreset_max ()
- voidset_type (MeterType)
+ voidset_meter_type (MeterType)
  
 
Inherited from ARDOUR:Processor

 
+ 
- 
- 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 

  
Methods

  
voidactivate ()

  
boolactive ()
longcapture_offset ()

  
voiddeactivate ()

  
std::stringdisplay_name ()

  
booldisplay_to_user ()
ChanCountinput_streams ()
ChanCountoutput_streams ()
longinput_latency ()
ChanCountinput_streams ()
longoutput_latency ()
ChanCountoutput_streams ()
longplayback_offset ()
longsignal_latency ()

  
Cast

  
Ampto_amp ()

  
Automatableto_automatable ()
DelayLineto_delayline ()
DiskIOProcessorto_diskioprocessor ()
DiskReaderto_diskreader ()
DiskWriterto_diskwriter ()

  
PluginInsertto_insert ()

  
IOProcessorto_ioprocessor ()
Latentto_latent ()

  
PeakMeterto_meter ()

  
MonitorProcessorto_monitorprocessor ()

  
PeakMeterto_peakmeter ()

  
PluginInsertto_plugininsert ()
PolarityProcessorto_polarityprocessor ()
Sendto_send ()

  
SideChainto_sidechain ()

  
UnknownProcessorto_unknownprocessor ()

 

@@ -2268,13 +2952,18 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
  Methods
  AutomationListalist ()
  AutoStateautomation_state ()
+ ParameterDescriptordesc ()
  doubleget_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

+ doublelower ()
+ doublenormal ()
  voidset_automation_state (AutoState)
  voidset_value (double, GroupControlDisposition)
-
 Get and 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.

+
 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.
value
 raw numeric value to set 
group_override
 if and how to propagate value to grouped controls

  voidstart_touch (double)
  voidstop_touch (double)
+ booltoggled ()
+ doubleupper ()
  boolwritable ()
  Cast
  Controlto_ctrl ()
@@ -2310,10 +2999,13 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
 
gap
 from the beginning of the region to the next beginning 

  voidduplicate_range (AudioRange&, float)
  voidduplicate_until (Region, long, long, long)
-
gap
 from the beginning of the region to the next beginning 
end
 the first frame that does _not_ contain a duplicated frame 

+
gap
 from the beginning of the region to the next beginning 
end
 the first sample that does _not_ contain a duplicated sample 

+ boolempty ()
  Regionfind_next_region (long, RegionPoint, int)
  longfind_next_region_boundary (long, int)
  longfind_next_transient (long, int)
+ IDget_orig_track_id ()
+ boolhidden ()
  boolisnil ()
  voidlower_region (Region)
  voidlower_region_to_bottom (Region)
@@ -2328,11 +3020,12 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
  RegionListPtrregions_with_end_within (Range)
  RegionListPtrregions_with_start_within (Range)
  voidremove_region (Region)
- voidsplit (long)
- voidsplit_region (Region, MusicFrame)
+ boolshared ()
+ voidsplit_region (Region, MusicSample)
  Regiontop_region_at (long)
  Regiontop_unmuted_region_at (long)
  voiduncombine (Region)
+ boolused ()
  Cast
  AudioPlaylistto_audioplaylist ()
  MidiPlaylistto_midiplaylist ()
@@ -2345,6 +3038,24 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
  Statefulto_stateful ()
  StatefulDestructibleto_statefuldestructible ()
 
+
∁ ARDOUR:PlaylistList

+
C‡: std::vector<boost::shared_ptr<ARDOUR::Playlist> >

+

+
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
Constructor
ℂARDOUR.PlaylistList ()
ℂARDOUR.PlaylistList ()
Methods
LuaTableadd (LuaTable {Playlist})
Playlistat (unsigned long)
voidclear ()
boolempty ()
LuaIteriter ()
voidpush_back (Playlist)
unsigned longsize ()
LuaTabletable ()
...to_array (--lua--)

 
↠ ARDOUR:Plugin

 
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 C
  Methods
  AutomationListalist ()
  AutoStateautomation_state ()
+ ParameterDescriptordesc ()
  doubleget_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

+ doublelower ()
+ doublenormal ()
  voidset_automation_state (AutoState)
  voidset_value (double, GroupControlDisposition)
-
 Get and 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.

+
 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.
value
 raw numeric value to set 
group_override
 if and how to propagate value to grouped controls

  voidstart_touch (double)
  voidstop_touch (double)
+ booltoggled ()
+ doubleupper ()
  boolwritable ()
  Cast
  Controlto_ctrl ()
@@ -2453,6 +3169,24 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
  ARDOUR.PluginTypetype
  std::stringunique_id
  
+
∁ ARDOUR:PluginInfoList

+
C‡: std::list<boost::shared_ptr<ARDOUR::PluginInfo> >

+

+
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
Constructor
ℂARDOUR.PluginInfoList ()
Methods
LuaTableadd (LuaTable {PluginInfo})
PluginInfoback ()
boolempty ()
PluginInfofront ()
LuaIteriter ()
voidpush_back (PluginInfo)
voidreverse ()
unsigned longsize ()
LuaTabletable ()
voidunique ()

 
↠ ARDOUR:PluginInsert

 
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
 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
@@ -2471,25 +3213,89 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
  
+ 
+ 
+ 

  
Methods

  
voidactivate ()
voidclear_stats ()

  
voiddeactivate ()
voidenable (bool)
boolenabled ()
unsigned intget_count ()
LuaTable(bool, ...)get_stats (unsigned long&, unsigned long&, double&, double&)
boolhas_sidechain ()

  
ChanMappinginput_map (unsigned int)
boolis_channelstrip ()
boolis_instrument ()

  
boolisnil ()

  
ChanCountnatural_input_streams ()

  
ChanCountnatural_output_streams ()
boolreset_parameters_to_default ()

  
voidset_input_map (unsigned int, ChanMapping)

  
voidset_output_map (unsigned int, ChanMapping)
longsignal_latency ()

  
boolstrict_io_configured ()
PluginTypetype ()

+
Inherited from ARDOUR:Processor

+
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+
Methods
boolactive ()
longcapture_offset ()
std::stringdisplay_name ()
booldisplay_to_user ()
longinput_latency ()
ChanCountinput_streams ()
longoutput_latency ()
ChanCountoutput_streams ()
longplayback_offset ()
Cast
Ampto_amp ()
Automatableto_automatable ()
DelayLineto_delayline ()
DiskIOProcessorto_diskioprocessor ()
DiskReaderto_diskreader ()
DiskWriterto_diskwriter ()
PluginInsertto_insert ()
IOProcessorto_ioprocessor ()
Latentto_latent ()
PeakMeterto_meter ()
MonitorProcessorto_monitorprocessor ()
PeakMeterto_peakmeter ()
PluginInsertto_plugininsert ()
PolarityProcessorto_polarityprocessor ()
Sendto_send ()
SideChainto_sidechain ()
UnknownProcessorto_unknownprocessor ()

+
Inherited from ARDOUR:SessionObjectPtr

+
+ 
+ 
+ 
+ 
+ 
+
Methods
std::stringname ()
Cast
Statefulto_stateful ()
StatefulDestructibleto_statefuldestructible ()

+
↠ ARDOUR:PolarityProcessor

+
C‡: boost::shared_ptr< ARDOUR::PolarityProcessor >, boost::weak_ptr< ARDOUR::PolarityProcessor >

+ 
is-a: ARDOUR:Processor

+

+
 A mixer strip element - plugin, send, meter, etc 

+
+ 
+ 
Methods
boolisnil ()

  

 
Inherited from ARDOUR:Processor

 
+ 
+ 
+ 
- 
- 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 

  
Methods
voidactivate ()

  
boolactive ()
longcapture_offset ()
voiddeactivate ()

  
std::stringdisplay_name ()

  
booldisplay_to_user ()
ChanCountinput_streams ()
ChanCountoutput_streams ()
longinput_latency ()
ChanCountinput_streams ()
longoutput_latency ()
ChanCountoutput_streams ()
longplayback_offset ()
longsignal_latency ()

  
Cast

  
Ampto_amp ()

  
Automatableto_automatable ()
DelayLineto_delayline ()
DiskIOProcessorto_diskioprocessor ()
DiskReaderto_diskreader ()
DiskWriterto_diskwriter ()

  
PluginInsertto_insert ()

  
IOProcessorto_ioprocessor ()
Latentto_latent ()

  
PeakMeterto_meter ()

  
MonitorProcessorto_monitorprocessor ()

  
PeakMeterto_peakmeter ()

  
PluginInsertto_plugininsert ()
PolarityProcessorto_polarityprocessor ()
Sendto_send ()

  
SideChainto_sidechain ()

  
UnknownProcessorto_unknownprocessor ()

 

@@ -2513,16 +3319,21 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
 
o
 Port name 
Returns  true if this port is connected to o, otherwise false.

  intdisconnect (std::string)
  intdisconnect_all ()
+ LuaTable(...)get_connected_latency_range (LatencyRange&, bool)
  boolisnil ()
  std::stringname ()
 
Returns  Port short name 

+ boolphysically_connected ()
  std::stringpretty_name (bool)
 
Returns  Port human readable name 

+ LatencyRangeprivate_latency_range (bool)
+ LatencyRangepublic_latency_range (bool)
  boolreceives_input ()
 
Returns  true if this Port receives input, otherwise false 

  boolsends_output ()
 
Returns  true if this Port sends output, otherwise false 

  Cast
+ AsyncMIDIPortto_asyncmidiport ()
  AudioPortto_audioport ()
  MidiPortto_midiport ()
  
@@ -2538,9 +3349,9 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
  Constructor
  ℂARDOUR.PortList ()
  Methods
- Portback ()
+ Portback ()
  boolempty ()
- Portfront ()
+ Portfront ()
  LuaIteriter ()
  voidreverse ()
  unsigned longsize ()
@@ -2629,11 +3440,13 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
  Methods
  LuaTableadd (LuaTable {PresetRecord})
  PresetRecordat (unsigned long)
+ voidclear ()
  boolempty ()
  LuaIteriter ()
  voidpush_back (PresetRecord)
  unsigned longsize ()
  LuaTabletable ()
+ ...to_array (--lua--)
  
 
↠ ARDOUR:Processor

 
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 C
  Methods
  voidactivate ()
  boolactive ()
+ longcapture_offset ()
  voiddeactivate ()
  std::stringdisplay_name ()
  booldisplay_to_user ()
- ChanCountinput_streams ()
+ longinput_latency ()
+ ChanCountinput_streams ()
  boolisnil ()
- ChanCountoutput_streams ()
+ longoutput_latency ()
+ ChanCountoutput_streams ()
+ longplayback_offset ()
+ longsignal_latency ()
  Cast
  Ampto_amp ()
  Automatableto_automatable ()
+ DelayLineto_delayline ()
+ DiskIOProcessorto_diskioprocessor ()
+ DiskReaderto_diskreader ()
+ DiskWriterto_diskwriter ()
  PluginInsertto_insert ()
  IOProcessorto_ioprocessor ()
+ Latentto_latent ()
  PeakMeterto_meter ()
  MonitorProcessorto_monitorprocessor ()
  PeakMeterto_peakmeter ()
  PluginInsertto_plugininsert ()
+ PolarityProcessorto_polarityprocessor ()
+ Sendto_send ()
  SideChainto_sidechain ()
  UnknownProcessorto_unknownprocessor ()
  
@@ -2678,9 +3503,9 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
  ℂARDOUR.ProcessorList ()
  Methods
  LuaTableadd (LuaTable {Processor})
- Processorback ()
+ Processorback ()
  boolempty ()
- Processorfront ()
+ Processorfront ()
  LuaIteriter ()
  voidpush_back (Processor)
  voidreverse ()
@@ -2698,11 +3523,13 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
  Methods
  LuaTableadd (LuaTable {Processor})
  Processorat (unsigned long)
+ voidclear ()
  boolempty ()
  LuaIteriter ()
  voidpush_back (Processor)
  unsigned longsize ()
  LuaTabletable ()
+ ...to_array (--lua--)
  
 
∅ ARDOUR:Progress

 
C‡: ARDOUR::Progress

@@ -2717,7 +3544,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
 
C‡: PBD::PropertyDescriptor<float>

 

 
This class object is only used indirectly as return-value and function-parameter. It provides no methods by itself.

-
∅ ARDOUR:Properties:FrameposProperty

+
∅ ARDOUR:Properties:SampleposProperty

 
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 C
  Methods
  boolcontainsBool (BoolProperty)
  boolcontainsFloat (FloatProperty)
- boolcontainsFramePos (FrameposProperty)
+ boolcontainsSamplePos (SampleposProperty)
  
 
∅ ARDOUR:PropertyList

 
C‡: PBD::PropertyList

@@ -2754,6 +3581,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
  std::stringget_auditioner_output_right ()
  boolget_auto_analyse_audio ()
  boolget_auto_connect_standard_busses ()
+ boolget_auto_input_does_talkback ()
  AutoReturnTargetget_auto_return_target_list ()
  boolget_automation_follows_regions ()
  floatget_automation_interval_msecs ()
@@ -2764,6 +3592,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
  boolget_click_record_only ()
  std::stringget_click_sound ()
  boolget_clicking ()
+ boolget_conceal_lv1_if_lv2_exists ()
  boolget_copy_demo_sessions ()
  boolget_create_xrun_marker ()
  FadeShapeget_default_fade_shape ()
@@ -2787,29 +3616,31 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
  intget_history_depth ()
  intget_initial_program_change ()
  AutoConnectOptionget_input_auto_connect ()
- intget_inter_scene_gap_frames ()
+ intget_inter_scene_gap_samples ()
  boolget_latched_record_enable ()
  LayerModelget_layer_model ()
+ unsigned intget_limit_n_automatables ()
  boolget_link_send_and_route_panner ()
  std::stringget_linux_pingback_url ()
  ListenPositionget_listen_position ()
  boolget_locate_while_waiting_for_sync ()
+ --MISSING (ARDOUR::LoopFadeChoice)--get_loop_fade_choice ()
  boolget_loop_is_mode ()
  std::stringget_ltc_output_port ()
  floatget_ltc_output_volume ()
  boolget_ltc_send_continuously ()
- std::stringget_ltc_source_port ()
  floatget_max_gain ()
  unsigned intget_max_recent_sessions ()
  unsigned intget_max_recent_templates ()
+ floatget_max_transport_speed ()
  floatget_meter_falloff ()
  MeterTypeget_meter_type_bus ()
  MeterTypeget_meter_type_master ()
  MeterTypeget_meter_type_track ()
  std::stringget_midi_audition_synth_uri ()
+ boolget_midi_clock_sets_tempo ()
  boolget_midi_feedback ()
  boolget_midi_input_follows_selection ()
- floatget_midi_readahead ()
  floatget_midi_track_buffer_seconds ()
  unsigned intget_minimum_disk_read_bytes ()
  unsigned intget_minimum_disk_write_bytes ()
@@ -2839,15 +3670,16 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
  intget_processor_usage ()
  boolget_quieten_at_speed ()
  longget_range_location_minimum ()
+ RangeSelectionAfterSplitget_range_selection_after_split ()
  std::stringget_reference_manual_url ()
  boolget_region_boundaries_from_onscreen_tracks ()
  boolget_region_boundaries_from_selected_tracks ()
+ RegionEquivalenceget_region_equivalence ()
  RegionSelectionAfterSplitget_region_selection_after_split ()
  boolget_replicate_missing_region_channels ()
- floatget_rf_speed ()
+ boolget_run_all_transport_masters_always ()
  boolget_save_history ()
  intget_saved_history_depth ()
- boolget_seamless_loop ()
  boolget_send_ltc ()
  boolget_send_midi_clock ()
  boolget_send_mmc ()
@@ -2867,15 +3699,12 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
  boolget_stop_at_session_end ()
  boolget_stop_recording_on_xrun ()
  boolget_strict_io ()
- SyncSourceget_sync_source ()
- boolget_tape_machine_mode ()
- boolget_timecode_source_2997 ()
- boolget_timecode_source_is_synced ()
  boolget_timecode_sync_frame_rate ()
  boolget_trace_midi_input ()
  boolget_trace_midi_output ()
  TracksAutoNamingRuleget_tracks_auto_naming ()
  floatget_transient_sensitivity ()
+ boolget_transport_masters_just_roll_when_sync_lost ()
  boolget_try_autostart_engine ()
  std::stringget_tutorial_manual_url ()
  std::stringget_updates_url ()
@@ -2884,7 +3713,6 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
  boolget_use_macvst ()
  boolget_use_monitor_bus ()
  boolget_use_osc ()
- boolget_use_overlap_equivalency ()
  boolget_use_plugin_own_gui ()
  boolget_use_tranzport ()
  boolget_use_windows_vst ()
@@ -2895,6 +3723,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
  std::stringget_video_server_url ()
  intget_vst_scan_timeout ()
  std::stringget_windows_pingback_url ()
+ std::stringget_xjadeo_binary ()
  boolset_afl_position (AFLPosition)
  boolset_all_safe (bool)
  boolset_allow_special_bus_removal (bool)
@@ -2906,6 +3735,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
  boolset_auditioner_output_right (std::string)
  boolset_auto_analyse_audio (bool)
  boolset_auto_connect_standard_busses (bool)
+ boolset_auto_input_does_talkback (bool)
  boolset_auto_return_target_list (AutoReturnTarget)
  boolset_automation_follows_regions (bool)
  boolset_automation_interval_msecs (float)
@@ -2916,6 +3746,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
  boolset_click_record_only (bool)
  boolset_click_sound (std::string)
  boolset_clicking (bool)
+ boolset_conceal_lv1_if_lv2_exists (bool)
  boolset_copy_demo_sessions (bool)
  boolset_create_xrun_marker (bool)
  boolset_default_fade_shape (FadeShape)
@@ -2939,29 +3770,31 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
  boolset_history_depth (int)
  boolset_initial_program_change (int)
  boolset_input_auto_connect (AutoConnectOption)
- boolset_inter_scene_gap_frames (int)
+ boolset_inter_scene_gap_samples (int)
  boolset_latched_record_enable (bool)
  boolset_layer_model (LayerModel)
+ boolset_limit_n_automatables (unsigned int)
  boolset_link_send_and_route_panner (bool)
  boolset_linux_pingback_url (std::string)
  boolset_listen_position (ListenPosition)
  boolset_locate_while_waiting_for_sync (bool)
+ boolset_loop_fade_choice (--MISSING (ARDOUR::LoopFadeChoice)--)
  boolset_loop_is_mode (bool)
  boolset_ltc_output_port (std::string)
  boolset_ltc_output_volume (float)
  boolset_ltc_send_continuously (bool)
- boolset_ltc_source_port (std::string)
  boolset_max_gain (float)
  boolset_max_recent_sessions (unsigned int)
  boolset_max_recent_templates (unsigned int)
+ boolset_max_transport_speed (float)
  boolset_meter_falloff (float)
  boolset_meter_type_bus (MeterType)
  boolset_meter_type_master (MeterType)
  boolset_meter_type_track (MeterType)
  boolset_midi_audition_synth_uri (std::string)
+ boolset_midi_clock_sets_tempo (bool)
  boolset_midi_feedback (bool)
  boolset_midi_input_follows_selection (bool)
- boolset_midi_readahead (float)
  boolset_midi_track_buffer_seconds (float)
  boolset_minimum_disk_read_bytes (unsigned int)
  boolset_minimum_disk_write_bytes (unsigned int)
@@ -2991,15 +3824,16 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
  boolset_processor_usage (int)
  boolset_quieten_at_speed (bool)
  boolset_range_location_minimum (long)
+ boolset_range_selection_after_split (RangeSelectionAfterSplit)
  boolset_reference_manual_url (std::string)
  boolset_region_boundaries_from_onscreen_tracks (bool)
  boolset_region_boundaries_from_selected_tracks (bool)
+ boolset_region_equivalence (RegionEquivalence)
  boolset_region_selection_after_split (RegionSelectionAfterSplit)
  boolset_replicate_missing_region_channels (bool)
- boolset_rf_speed (float)
+ boolset_run_all_transport_masters_always (bool)
  boolset_save_history (bool)
  boolset_saved_history_depth (int)
- boolset_seamless_loop (bool)
  boolset_send_ltc (bool)
  boolset_send_midi_clock (bool)
  boolset_send_mmc (bool)
@@ -3019,15 +3853,12 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
  boolset_stop_at_session_end (bool)
  boolset_stop_recording_on_xrun (bool)
  boolset_strict_io (bool)
- boolset_sync_source (SyncSource)
- boolset_tape_machine_mode (bool)
- boolset_timecode_source_2997 (bool)
- boolset_timecode_source_is_synced (bool)
  boolset_timecode_sync_frame_rate (bool)
  boolset_trace_midi_input (bool)
  boolset_trace_midi_output (bool)
  boolset_tracks_auto_naming (TracksAutoNamingRule)
  boolset_transient_sensitivity (float)
+ boolset_transport_masters_just_roll_when_sync_lost (bool)
  boolset_try_autostart_engine (bool)
  boolset_tutorial_manual_url (std::string)
  boolset_updates_url (std::string)
@@ -3036,7 +3867,6 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
  boolset_use_macvst (bool)
  boolset_use_monitor_bus (bool)
  boolset_use_osc (bool)
- boolset_use_overlap_equivalency (bool)
  boolset_use_plugin_own_gui (bool)
  boolset_use_tranzport (bool)
  boolset_use_windows_vst (bool)
@@ -3047,6 +3877,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
  boolset_video_server_url (std::string)
  boolset_vst_scan_timeout (int)
  boolset_windows_pingback_url (std::string)
+ boolset_xjadeo_binary (std::string)
  Properties
  ARDOUR.AFLPositionafl_position
  boolall_safe
@@ -3059,6 +3890,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
  std::stringauditioner_output_right
  boolauto_analyse_audio
  boolauto_connect_standard_busses
+ boolauto_input_does_talkback
  ARDOUR.AutoReturnTargetauto_return_target_list
  boolautomation_follows_regions
  floatautomation_interval_msecs
@@ -3069,6 +3901,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
  boolclick_record_only
  std::stringclick_sound
  boolclicking
+ boolconceal_lv1_if_lv2_exists
  boolcopy_demo_sessions
  boolcreate_xrun_marker
  ARDOUR.FadeShapedefault_fade_shape
@@ -3092,29 +3925,31 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
  inthistory_depth
  intinitial_program_change
  ARDOUR.AutoConnectOptioninput_auto_connect
- intinter_scene_gap_frames
+ intinter_scene_gap_samples
  boollatched_record_enable
  ARDOUR.LayerModellayer_model
+ unsigned intlimit_n_automatables
  boollink_send_and_route_panner
  std::stringlinux_pingback_url
  ARDOUR.ListenPositionlisten_position
  boollocate_while_waiting_for_sync
+ --MISSING (ARDOUR::LoopFadeChoice)--loop_fade_choice
  boolloop_is_mode
  std::stringltc_output_port
  floatltc_output_volume
  boolltc_send_continuously
- std::stringltc_source_port
  floatmax_gain
  unsigned intmax_recent_sessions
  unsigned intmax_recent_templates
+ floatmax_transport_speed
  floatmeter_falloff
  ARDOUR.MeterTypemeter_type_bus
  ARDOUR.MeterTypemeter_type_master
  ARDOUR.MeterTypemeter_type_track
  std::stringmidi_audition_synth_uri
+ boolmidi_clock_sets_tempo
  boolmidi_feedback
  boolmidi_input_follows_selection
- floatmidi_readahead
  floatmidi_track_buffer_seconds
  unsigned intminimum_disk_read_bytes
  unsigned intminimum_disk_write_bytes
@@ -3144,15 +3979,16 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
  intprocessor_usage
  boolquieten_at_speed
  longrange_location_minimum
+ ARDOUR.RangeSelectionAfterSplitrange_selection_after_split
  std::stringreference_manual_url
  boolregion_boundaries_from_onscreen_tracks
  boolregion_boundaries_from_selected_tracks
+ ARDOUR.RegionEquivalenceregion_equivalence
  ARDOUR.RegionSelectionAfterSplitregion_selection_after_split
  boolreplicate_missing_region_channels
- floatrf_speed
+ boolrun_all_transport_masters_always
  boolsave_history
  intsaved_history_depth
- boolseamless_loop
  boolsend_ltc
  boolsend_midi_clock
  boolsend_mmc
@@ -3172,15 +4008,12 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
  boolstop_at_session_end
  boolstop_recording_on_xrun
  boolstrict_io
- ARDOUR.SyncSourcesync_source
- booltape_machine_mode
- booltimecode_source_2997
- booltimecode_source_is_synced
  booltimecode_sync_frame_rate
  booltrace_midi_input
  booltrace_midi_output
  ARDOUR.TracksAutoNamingRuletracks_auto_naming
  floattransient_sensitivity
+ booltransport_masters_just_roll_when_sync_lost
  booltry_autostart_engine
  std::stringtutorial_manual_url
  std::stringupdates_url
@@ -3189,7 +4022,6 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
  booluse_macvst
  booluse_monitor_bus
  booluse_osc
- booluse_overlap_equivalency
  booluse_plugin_own_gui
  booluse_tranzport
  booluse_windows_vst
@@ -3200,6 +4032,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
  std::stringvideo_server_url
  intvst_scan_timeout
  std::stringwindows_pingback_url
+ std::stringxjadeo_binary
  
 
Inherited from PBD:Stateful

 
@@ -3209,6 +4042,18 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
  
IDid ()

  
OwnedPropertyListproperties ()

 

+
∁ ARDOUR:RawMidiParser

+
C‡: ARDOUR::RawMidiParser

+

+
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
Constructor
ℂARDOUR.RawMidiParser ()
Methods
unsigned longbuffer_size ()
unsigned char*midi_buffer ()
boolprocess_byte (unsigned char)
voidreset ()

 
↠ ARDOUR:ReadOnlyControl

 
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

  
boolisnil ()
ReadableListload (Session&, std::string)

  
unsigned intn_channels ()

  
longread (FloatArray, long, long, int)

  
longreadable_length ()

  

+
∁ ARDOUR:ReadableList

+
C‡: std::vector<boost::shared_ptr<ARDOUR::Readable> >

+

+
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
Constructor
ℂARDOUR.ReadableList ()
ℂARDOUR.ReadableList ()
Methods
LuaTableadd (LuaTable {Readable})
Readableat (unsigned long)
voidclear ()
boolempty ()
LuaIteriter ()
voidpush_back (Readable)
unsigned longsize ()
LuaTabletable ()
...to_array (--lua--)

 
↠ ARDOUR:Region

 
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 C
  unsigned intn_channels ()
  voidnudge_position (long)
  boolopaque ()
+ Playlistplaylist ()
  longposition ()
-
 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

  boolposition_locked ()
  doublequarter_note ()
  voidraise ()
  voidraise_to_top ()
  voidset_hidden (bool)
  voidset_initial_position (long)
-
 A gui may need to create a region, then place it in an initial  position determined by the user.  When this takes place within one gui operation, we have to reset  _last_position to prevent an implied move.

+
 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.

  voidset_length (long, int)
  voidset_locked (bool)
  voidset_muted (bool)
+ boolset_name (std::string)
+
 Note: changing the name of a Region does not constitute an edit 

  voidset_opaque (bool)
  voidset_position (long, int)
  voidset_position_locked (bool)
@@ -3336,9 +4203,9 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
  Constructor
  ℂARDOUR.RegionList ()
  Methods
- Regionback ()
+ Regionback ()
  boolempty ()
- Regionfront ()
+ Regionfront ()
  LuaIteriter ()
  voidreverse ()
  unsigned longsize ()
@@ -3386,12 +4253,73 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
  Methods
  LuaTableadd (LuaTable {Region})
  Regionat (unsigned long)
+ voidclear ()
  boolempty ()
  LuaIteriter ()
  voidpush_back (Region)
  unsigned longsize ()
  LuaTabletable ()
+ ...to_array (--lua--)
+ 
+
↠ ARDOUR:Return

+
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
boolisnil ()

  

+
Inherited from ARDOUR:IOProcessor

+
+ 
+ 
+ 
+ 
+ 
+
Methods
IOinput ()
ChanCountnatural_input_streams ()
ChanCountnatural_output_streams ()
IOoutput ()

+
Inherited from ARDOUR:Processor

+
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+
Methods
voidactivate ()
boolactive ()
longcapture_offset ()
voiddeactivate ()
std::stringdisplay_name ()
booldisplay_to_user ()
longinput_latency ()
ChanCountinput_streams ()
longoutput_latency ()
ChanCountoutput_streams ()
longplayback_offset ()
longsignal_latency ()
Cast
Ampto_amp ()
Automatableto_automatable ()
DelayLineto_delayline ()
DiskIOProcessorto_diskioprocessor ()
DiskReaderto_diskreader ()
DiskWriterto_diskwriter ()
PluginInsertto_insert ()
IOProcessorto_ioprocessor ()
Latentto_latent ()
PeakMeterto_meter ()
MonitorProcessorto_monitorprocessor ()
PeakMeterto_peakmeter ()
PluginInsertto_plugininsert ()
PolarityProcessorto_polarityprocessor ()
Sendto_send ()
SideChainto_sidechain ()
UnknownProcessorto_unknownprocessor ()

+
Inherited from ARDOUR:SessionObjectPtr

+
+ 
+ 
+ 
+ 
+ 
+
Methods
std::stringname ()
Cast
Statefulto_stateful ()
StatefulDestructibleto_statefuldestructible ()

 
↠ ARDOUR:Route

 
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 C
  std::stringcomment ()
  boolcustomize_plugin_insert (Processor, unsigned int, ChanCount, ChanCount)
 
 enable custom plugin-insert configuration 
proc
 Processor to customize 
count
 number of plugin instances to use (if zero, reset to default) 
outs
 output port customization 
sinks
 input pins for variable-I/O plugins 
Returns  true if successful

+ DataTypedata_type ()
  IOinput ()
  boolisnil ()
  Deliverymain_outs ()
@@ -3421,6 +4350,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
  PannerShellpanner_shell ()
  PeakMeterpeak_meter ()
 
************************************************************* Pure interface begins here*************************************************************

+ longplayback_latency (bool)
  intremove_processor (Processor, ProcessorStreams, bool)
 
 remove plugin/processor
proc
 processor to remove 
err
 error report (index where removal vailed, channel-count why it failed) may be nil 
need_process_lock
 if locking is required (set to true, unless called from RT context with lock) 
Returns  0 on success

  intremove_processors (ProcessorList, ProcessorStreams)
@@ -3435,34 +4365,33 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
  voidset_meter_point (MeterPoint, bool)
  boolset_name (std::string)
  boolset_strict_io (bool)
+ longsignal_latency ()
  boolsoloed ()
  boolstrict_io ()
  Processorthe_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.

  Amptrim ()
  Cast
- Automatableto_automatable ()
- Slavableto_slavable ()
  Trackto_track ()
  
 
Inherited from ARDOUR:Stripable

 
- 
- 
- 
+ 
+ 
+ 
- 
- 
+ 
+ 
- 
+ 
- 
- 
- 
- 
- 
+ 
+ 
+ 
+ 
+ 
@@ -3471,8 +4400,9 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
  
+ 
- 
+ 
@@ -3484,16 +4414,22 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
  
- 
- 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 

  
Methods
AutomationControlcomp_enable_control ()
AutomationControlcomp_makeup_control ()
AutomationControlcomp_mode_control ()
AutomationControlcomp_enable_controllable ()
AutomationControlcomp_makeup_controllable ()
AutomationControlcomp_mode_controllable ()

  
std::stringcomp_mode_name (unsigned int)
ReadOnlyControlcomp_redux_control ()
AutomationControlcomp_speed_control ()
ReadOnlyControlcomp_redux_controllable ()
AutomationControlcomp_speed_controllable ()

  
std::stringcomp_speed_name (unsigned int)
AutomationControlcomp_threshold_control ()
AutomationControlcomp_threshold_controllable ()

  
unsigned inteq_band_cnt ()

  
std::stringeq_band_name (unsigned int)
AutomationControleq_enable_control ()
AutomationControleq_freq_control (unsigned int)
AutomationControleq_gain_control (unsigned int)
AutomationControleq_q_control (unsigned int)
AutomationControleq_shape_control (unsigned int)
AutomationControleq_enable_controllable ()
AutomationControleq_freq_controllable (unsigned int)
AutomationControleq_gain_controllable (unsigned int)
AutomationControleq_q_controllable (unsigned int)
AutomationControleq_shape_controllable (unsigned int)

  
AutomationControlfilter_enable_controllable (bool)

  
AutomationControlfilter_freq_controllable (bool)

  
AutomationControlfilter_slope_controllable (bool)
boolis_hidden ()

  
boolis_master ()

  
boolis_monitor ()
boolis_private_route ()

  
boolis_selected ()
AutomationControlmaster_send_enable_control ()
AutomationControlmaster_send_enable_controllable ()

  
MonitorProcessormonitor_control ()

  
MuteControlmute_control ()

  
AutomationControlpan_azimuth_control ()
PresentationInfopresentation_info_ptr ()

  
AutomationControlrec_enable_control ()

  
AutomationControlrec_safe_control ()
AutomationControlsend_enable_control (unsigned int)
AutomationControlsend_level_control (unsigned int)
AutomationControlsend_enable_controllable (unsigned int)
AutomationControlsend_level_controllable (unsigned int)

  
std::stringsend_name (unsigned int)
AutomationControlsend_pan_azimuth_controllable (unsigned int)
AutomationControlsend_pan_azimuth_enable_controllable (unsigned int)

  
voidset_presentation_order (unsigned int)
boolslaved ()
boolslaved_to (VCA)

  
SoloControlsolo_control ()

  
SoloIsolateControlsolo_isolate_control ()

  
SoloSafeControlsolo_safe_control ()

  
GainControltrim_control ()

  
Cast
Automatableto_automatable ()

  
Routeto_route ()
Slavableto_slavable ()

  
VCAto_vca ()

 

 
Inherited from ARDOUR:SessionObjectPtr

@@ -3585,9 +4521,9 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
  Constructor
  ℂARDOUR.RouteList ()
  Methods
- Routeback ()
+ Routeback ()
  boolempty ()
- Routefront ()
+ Routefront ()
  LuaIteriter ()
  voidreverse ()
  unsigned longsize ()
@@ -3609,6 +4545,72 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
  LuaTabletable ()
  voidunique ()
  
+
↠ ARDOUR:Send

+
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
longget_delay_in ()
longget_delay_out ()
boolisnil ()

+
Inherited from ARDOUR:Delivery

+
+ 
+ 
+
Methods
PannerShellpanner_shell ()

+
Inherited from ARDOUR:IOProcessor

+
+ 
+ 
+ 
+ 
+ 
+
Methods
IOinput ()
ChanCountnatural_input_streams ()
ChanCountnatural_output_streams ()
IOoutput ()

+
Inherited from ARDOUR:Processor

+
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+
Methods
voidactivate ()
boolactive ()
longcapture_offset ()
voiddeactivate ()
std::stringdisplay_name ()
booldisplay_to_user ()
longinput_latency ()
ChanCountinput_streams ()
longoutput_latency ()
ChanCountoutput_streams ()
longplayback_offset ()
longsignal_latency ()
Cast
Ampto_amp ()
Automatableto_automatable ()
DelayLineto_delayline ()
DiskIOProcessorto_diskioprocessor ()
DiskReaderto_diskreader ()
DiskWriterto_diskwriter ()
PluginInsertto_insert ()
IOProcessorto_ioprocessor ()
Latentto_latent ()
PeakMeterto_meter ()
MonitorProcessorto_monitorprocessor ()
PeakMeterto_peakmeter ()
PluginInsertto_plugininsert ()
PolarityProcessorto_polarityprocessor ()
Sendto_send ()
SideChainto_sidechain ()
UnknownProcessorto_unknownprocessor ()

+
Inherited from ARDOUR:SessionObjectPtr

+
+ 
+ 
+ 
+ 
+ 
+
Methods
std::stringname ()
Cast
Statefulto_stateful ()
StatefulDestructibleto_statefuldestructible ()

 
∁ ARDOUR:Session

 
C‡: ARDOUR::Session

 

@@ -3621,7 +4623,6 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
  voidadd_command (Command)
  voidadd_internal_sends (Route, Placement, RouteListPtr)
  intadd_master_bus (ChanCount)
- voidadd_monitor_section ()
  StatefulDiffCommandadd_stateful_diff_command (StatefulDestructiblePtr)
 
 create an StatefulDiffCommand from the given object and add it to the stack.
 This function must only be called after  begin_reversible_command. Failing to do so may lead to a crash.
sfd
 the object to diff 
Returns  the allocated StatefulDiffCommand (already added via add_command)

  voidbegin_reversible_command (std::string)
@@ -3632,23 +4633,22 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
  voidcommit_reversible_command (Command)
 
 finalize an undo command and commit pending transactions
 This must only be called after begin_reversible_command () 
cmd
 (additional) command to add

  Controllablecontrollable_by_id (ID)
- longcurrent_end_frame ()
- longcurrent_start_frame ()
+ longcurrent_end_sample ()
+ longcurrent_start_sample ()
  voiddisable_record (bool, bool)
- boolend_is_free ()
  AudioEngineengine ()
  boolexport_track_state (RouteListPtr, std::string)
- longframe_rate ()
-
 "actual" sample rate of session, set by current audioengine rate, pullup/down etc. 

  unsigned intget_block_size ()
  boolget_play_loop ()
  Routeget_remote_nth_route (unsigned int)
  Stripableget_remote_nth_stripable (unsigned int, Flag)
+ RouteListget_routelist (bool, Flag)
  RouteListPtrget_routes ()
  BufferSetget_scratch_buffers (ChanCount, bool)
  BufferSetget_silent_buffers (ChanCount)
  StripableListget_stripables ()
  RouteListPtrget_tracks ()
+ unsigned intget_xrun_count ()
  voidgoto_end ()
  voidgoto_start (bool)
  longlast_transport_start ()
@@ -3664,50 +4664,56 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
  MidiTrackListnew_midi_track (ChanCount, ChanCount, bool, PluginInfo, PresetRecord, RouteGroup, unsigned int, std::string, unsigned int, TrackMode)
  RouteListnew_route_from_template (unsigned int, unsigned int, std::string, std::string, PlaylistDisposition)
  RouteGroupnew_route_group (std::string)
- longnominal_frame_rate ()
+ longnominal_sample_rate ()
 
 "native" sample rate of session, regardless of current audioengine rate, pullup/down etc 

  std::stringpath ()
+ SessionPlaylistsplaylists ()
+ boolplot_process_graph (std::string)
  Processorprocessor_by_id (ID)
  RecordStaterecord_status ()
- voidremove_monitor_section ()
  voidremove_route_group (RouteGroup)
- voidrequest_locate (long, bool)
+ voidrequest_bounded_roll (long, long)
+ voidrequest_locate (long, LocateTransportDisposition, TransportRequestSource)
  voidrequest_play_loop (bool, bool)
- voidrequest_stop (bool, bool)
- voidrequest_transport_speed (double, bool)
+ voidrequest_stop (bool, bool, TransportRequestSource)
+ voidrequest_transport_speed (double, bool, TransportRequestSource)
+ voidreset_xrun_count ()
  Routeroute_by_id (ID)
  Routeroute_by_name (std::string)
  Routeroute_by_selected_count (unsigned int)
  RouteGroupListroute_groups ()
+ longsample_rate ()
+
 "actual" sample rate of session, set by current audioengine rate, pullup/down etc. 

  ...sample_to_timecode_lua (--lua--)
  doublesamples_per_timecode_frame ()
- intsave_state (std::string, bool, bool, bool)
-
 save session 
snapshot_name
 name of the session (use an empty string for the current name) 
pending
 save a 'recovery', not full state (default: false) 
switch_to_snapshot
 switch to given snapshot after saving (default: false) 
template_only
 save a session template (default: false) 
Returns  zero on success

+ intsave_state (std::string, bool, bool, bool, bool, bool)
+
 save session 
snapshot_name
 name of the session (use an empty string for the current name) 
pending
 save a 'recovery', not full state (default: false) 
switch_to_snapshot
 switch to given snapshot after saving (default: false) 
template_only
 save a session template (default: false) 
for_archive
 save only data relevant for session-archive 
only_used_assets
 skip Sources that are not used, mainly useful with for_archive 
Returns  zero on success

  voidscripts_changed ()
+ boolsession_range_is_free ()
  voidset_control (AutomationControl, double, GroupControlDisposition)
  voidset_controls (ControlListPtr, double, GroupControlDisposition)
  voidset_dirty ()
- voidset_end_is_free (bool)
  voidset_exclusive_input_active (RouteListPtr, bool, bool)
+ voidset_session_range_is_free (bool)
  std::stringsnap_name ()
  boolsolo_isolated ()
  boolsoloing ()
  Sourcesource_by_id (ID)
+ Stripablestripable_by_id (ID)
  TempoMaptempo_map ()
  booltimecode_drop_frames ()
  longtimecode_frames_per_hour ()
  doubletimecode_frames_per_second ()
  ...timecode_to_sample_lua (--lua--)
- Tracktrack_by_diskstream_id (ID)
- longtransport_frame ()
  booltransport_rolling ()
+ longtransport_sample ()
  doubletransport_speed ()
  StringListunknown_processors ()
  VCAManagervca_manager ()
  longworst_input_latency ()
+ longworst_latency_preroll ()
  longworst_output_latency ()
- longworst_playback_latency ()
- longworst_track_latency ()
+ longworst_route_latency ()
  
 
∁ ARDOUR:SessionConfiguration

 
C‡: ARDOUR::SessionConfiguration

@@ -3721,7 +4727,6 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
  boolget_auto_play ()
  boolget_auto_return ()
  boolget_count_in ()
- unsigned intget_destructive_xfade_msecs ()
  boolget_external_sync ()
  boolget_glue_new_markers_to_bars_and_beats ()
  boolget_glue_new_regions_to_bars_and_beats ()
@@ -3773,7 +4778,6 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
  boolset_auto_play (bool)
  boolset_auto_return (bool)
  boolset_count_in (bool)
- boolset_destructive_xfade_msecs (unsigned int)
  boolset_external_sync (bool)
  boolset_glue_new_markers_to_bars_and_beats (bool)
  boolset_glue_new_regions_to_bars_and_beats (bool)
@@ -3826,7 +4830,6 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
  boolauto_play
  boolauto_return
  boolcount_in
- unsigned intdestructive_xfade_msecs
  boolexternal_sync
  boolglue_new_markers_to_bars_and_beats
  boolglue_new_regions_to_bars_and_beats
@@ -3904,11 +4907,27 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
  Statefulto_stateful ()
  StatefulDestructibleto_statefuldestructible ()
  
+
↠ ARDOUR:SessionPlaylists

+
C‡: boost::shared_ptr< ARDOUR::SessionPlaylists >, boost::weak_ptr< ARDOUR::SessionPlaylists >

+

+
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+
+ 
+ 
+ 
Methods
Playlistby_id (ID)
Playlistby_name (std::string)
PlaylistListget_unused ()
PlaylistListget_used ()
boolisnil ()
unsigned intn_playlists ()
PlaylistListplaylists_for_track (Track)
Returns  list of Playlists that are associated with a track 
unsigned intregion_use_count (Region)
unsigned intsource_use_count (Source)

 
↠ ARDOUR:SideChain

 
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. 

 
@@ -3926,20 +4945,32 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
  
+ 
- 
- 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 

  
Methods

  
boolisnil ()
Methods

  
voidactivate ()

  
boolactive ()
longcapture_offset ()

  
voiddeactivate ()

  
std::stringdisplay_name ()

  
booldisplay_to_user ()
ChanCountinput_streams ()
ChanCountoutput_streams ()
longinput_latency ()
ChanCountinput_streams ()
longoutput_latency ()
ChanCountoutput_streams ()
longplayback_offset ()
longsignal_latency ()

  
Cast

  
Ampto_amp ()

  
Automatableto_automatable ()
DelayLineto_delayline ()
DiskIOProcessorto_diskioprocessor ()
DiskReaderto_diskreader ()
DiskWriterto_diskwriter ()

  
PluginInsertto_insert ()

  
IOProcessorto_ioprocessor ()
Latentto_latent ()

  
PeakMeterto_meter ()

  
MonitorProcessorto_monitorprocessor ()

  
PeakMeterto_peakmeter ()

  
PluginInsertto_plugininsert ()
PolarityProcessorto_polarityprocessor ()
Sendto_send ()

  
SideChainto_sidechain ()

  
UnknownProcessorto_unknownprocessor ()

 

@@ -3957,7 +4988,10 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
 
+ 
+
+ 

  
Methods

  
voidassign (VCA)
boolassigned_to (VCAManager, VCA)
 recursively test for master assignment to given VCA 

  
boolisnil ()
VCAVectormasters (VCAManager)

  
voidunassign (VCA)

  

 
↠ ARDOUR:SlavableAutomationControl

@@ -3981,13 +5015,18 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
  Methods
  AutomationListalist ()
  AutoStateautomation_state ()
+ ParameterDescriptordesc ()
  doubleget_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

+ doublelower ()
+ doublenormal ()
  voidset_automation_state (AutoState)
  voidset_value (double, GroupControlDisposition)
-
 Get and 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.

+
 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.
value
 raw numeric value to set 
group_override
 if and how to propagate value to grouped controls

  voidstart_touch (double)
  voidstop_touch (double)
+ booltoggled ()
+ doubleupper ()
  boolwritable ()
  Cast
  Controlto_ctrl ()
@@ -4034,13 +5073,18 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
  Methods
  AutomationListalist ()
  AutoStateautomation_state ()
+ ParameterDescriptordesc ()
  doubleget_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

+ doublelower ()
+ doublenormal ()
  voidset_automation_state (AutoState)
  voidset_value (double, GroupControlDisposition)
-
 Get and 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.

+
 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.
value
 raw numeric value to set 
group_override
 if and how to propagate value to grouped controls

  voidstart_touch (double)
  voidstop_touch (double)
+ booltoggled ()
+ doubleupper ()
  boolwritable ()
  Cast
  Controlto_ctrl ()
@@ -4086,13 +5130,18 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
  Methods
  AutomationListalist ()
  AutoStateautomation_state ()
+ ParameterDescriptordesc ()
  doubleget_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

+ doublelower ()
+ doublenormal ()
  voidset_automation_state (AutoState)
  voidset_value (double, GroupControlDisposition)
-
 Get and 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.

+
 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.
value
 raw numeric value to set 
group_override
 if and how to propagate value to grouped controls

  voidstart_touch (double)
  voidstop_touch (double)
+ booltoggled ()
+ doubleupper ()
  boolwritable ()
  Cast
  Controlto_ctrl ()
@@ -4137,13 +5186,18 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
  Methods
  AutomationListalist ()
  AutoStateautomation_state ()
+ ParameterDescriptordesc ()
  doubleget_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

+ doublelower ()
+ doublenormal ()
  voidset_automation_state (AutoState)
  voidset_value (double, GroupControlDisposition)
-
 Get and 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.

+
 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.
value
 raw numeric value to set 
group_override
 if and how to propagate value to grouped controls

  voidstart_touch (double)
  voidstop_touch (double)
+ booltoggled ()
+ doubleupper ()
  boolwritable ()
  Cast
  Controlto_ctrl ()
@@ -4171,7 +5225,6 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
  Methods
  std::stringancestor_name ()
  boolcan_be_analysed ()
- booldestructive ()
  boolempty ()
  boolhas_been_analysed ()
  boolisnil ()
@@ -4205,11 +5258,13 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
  Methods
  LuaTableadd (LuaTable {Source})
  Sourceat (unsigned long)
+ voidclear ()
  boolempty ()
  LuaIteriter ()
  voidpush_back (Source)
  unsigned longsize ()
  LuaTabletable ()
+ ...to_array (--lua--)
  
 
↠ ARDOUR:Stripable

 
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 C
 
 A named object associated with a Session. Objects derived from this class are    expected to be destroyed before the session calls drop_references().

 
- 
- 
- 
+ 
+ 
+ 
- 
- 
+ 
+ 
- 
+ 
- 
- 
- 
- 
- 
+ 
+ 
+ 
+ 
+ 
@@ -4241,9 +5296,10 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
  
+ 
- 
+ 
@@ -4255,16 +5311,22 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
  
- 
- 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 

  
Methods
AutomationControlcomp_enable_control ()
AutomationControlcomp_makeup_control ()
AutomationControlcomp_mode_control ()
AutomationControlcomp_enable_controllable ()
AutomationControlcomp_makeup_controllable ()
AutomationControlcomp_mode_controllable ()

  
std::stringcomp_mode_name (unsigned int)
ReadOnlyControlcomp_redux_control ()
AutomationControlcomp_speed_control ()
ReadOnlyControlcomp_redux_controllable ()
AutomationControlcomp_speed_controllable ()

  
std::stringcomp_speed_name (unsigned int)
AutomationControlcomp_threshold_control ()
AutomationControlcomp_threshold_controllable ()

  
unsigned inteq_band_cnt ()

  
std::stringeq_band_name (unsigned int)
AutomationControleq_enable_control ()
AutomationControleq_freq_control (unsigned int)
AutomationControleq_gain_control (unsigned int)
AutomationControleq_q_control (unsigned int)
AutomationControleq_shape_control (unsigned int)
AutomationControleq_enable_controllable ()
AutomationControleq_freq_controllable (unsigned int)
AutomationControleq_gain_controllable (unsigned int)
AutomationControleq_q_controllable (unsigned int)
AutomationControleq_shape_controllable (unsigned int)

  
AutomationControlfilter_enable_controllable (bool)

  
AutomationControlfilter_freq_controllable (bool)

  
AutomationControlfilter_slope_controllable (bool)
boolis_hidden ()

  
boolis_master ()

  
boolis_monitor ()
boolis_private_route ()

  
boolis_selected ()

  
boolisnil ()
AutomationControlmaster_send_enable_control ()
AutomationControlmaster_send_enable_controllable ()

  
MonitorProcessormonitor_control ()

  
MuteControlmute_control ()

  
AutomationControlpan_azimuth_control ()
PresentationInfopresentation_info_ptr ()

  
AutomationControlrec_enable_control ()

  
AutomationControlrec_safe_control ()
AutomationControlsend_enable_control (unsigned int)
AutomationControlsend_level_control (unsigned int)
AutomationControlsend_enable_controllable (unsigned int)
AutomationControlsend_level_controllable (unsigned int)

  
std::stringsend_name (unsigned int)
AutomationControlsend_pan_azimuth_controllable (unsigned int)
AutomationControlsend_pan_azimuth_enable_controllable (unsigned int)

  
voidset_presentation_order (unsigned int)
boolslaved ()
boolslaved_to (VCA)

  
SoloControlsolo_control ()

  
SoloIsolateControlsolo_isolate_control ()

  
SoloSafeControlsolo_safe_control ()

  
GainControltrim_control ()

  
Cast
Automatableto_automatable ()

  
Routeto_route ()
Slavableto_slavable ()

  
VCAto_vca ()

  

 
Inherited from ARDOUR:SessionObjectPtr

@@ -4282,9 +5344,9 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
  Constructor
  ℂARDOUR.StripableList ()
  Methods
- Stripableback ()
+ Stripableback ()
  boolempty ()
- Stripablefront ()
+ Stripablefront ()
  LuaIteriter ()
  voidreverse ()
  unsigned longsize ()
@@ -4298,13 +5360,14 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
  Constructor
  ℂARDOUR.Tempo (double, double, double)
  Methods
- doubleframes_per_note_type (long)
-
 audio samples per note type. if you want an instantaneous value for this, use TempoMap::frames_per_quarter_note_at() instead. 
sr
 samplerate

- doubleframes_per_quarter_note (long)
-
 audio samples per quarter note. if you want an instantaneous value for this, use TempoMap::frames_per_quarter_note_at() instead. 
sr
 samplerate

+ doubleend_note_types_per_minute ()
  doublenote_type ()
  doublenote_types_per_minute ()
  doublequarter_notes_per_minute ()
+ doublesamples_per_note_type (long)
+
 audio samples per note type. if you want an instantaneous value for this, use TempoMap::samples_per_quarter_note_at() instead. 
sr
 samplerate

+ doublesamples_per_quarter_note (long)
+
 audio samples per quarter note. if you want an instantaneous value for this, use TempoMap::samples_per_quarter_note_at() instead. 
sr
 samplerate

  
 
∁ ARDOUR:TempoMap

 
C‡: ARDOUR::TempoMap

@@ -4314,18 +5377,19 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
  Methods
  MeterSectionadd_meter (Meter, BBT_TIME, long, PositionLockStyle)
  TempoSectionadd_tempo (Tempo, double, long, PositionLockStyle)
- BBT_TIMEbbt_at_frame (long)
-
 Returns the BBT time corresponding to the supplied frame position. 
frame
 the position in audio samples. 
Returns  the BBT time at the frame position .

- doubleexact_beat_at_frame (long, int)
- doubleexact_qn_at_frame (long, int)
- longframepos_plus_qn (long, Beats)
-
 Add some (fractional) Beats to a session frame position, and return the result in frames.  pos can be -ve, if required.

- Beatsframewalk_to_qn (long, long)
-
 Count the number of beats that are equivalent to distance when going forward,    starting at pos.

+ BBT_TIMEbbt_at_sample (long)
+
 Returns the BBT time corresponding to the supplied sample position. 
sample
 the position in audio samples. 
Returns  the BBT time at the sample position .

+ doubleexact_beat_at_sample (long, int)
+ doubleexact_qn_at_sample (long, int)
+ Beatsframewalk_to_qn (long, long)
+
 Count the number of beats that are equivalent to distance when going forward, starting at pos.

  MeterSectionmeter_section_at_beat (double)
- MeterSectionmeter_section_at_frame (long)
- TempoSectiontempo_section_at_frame (long)
- TempoSectiontempo_section_at_frame (long)
+ MeterSectionmeter_section_at_sample (long)
+ TempoSectionnext_tempo_section (TempoSection)
+ TempoSectionprevious_tempo_section (TempoSection)
+ longsamplepos_plus_qn (long, Beats)
+
 Add some (fractional) Beats to a session sample position, and return the result in samples.  pos can be -ve, if required.

+ TempoSectiontempo_section_at_sample (long)
  
 
∁ ARDOUR:TempoSection

 
C‡: ARDOUR::TempoSection

@@ -4334,19 +5398,30 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
 
 A section of timeline with a certain Tempo. 

 
+ 
+ 
+ 
+ 
+ 

  
Methods
boolactive ()

  
doublec ()
boolclamped ()
boollocked_to_meter ()
Cast
Tempoto_tempo ()

  

 
Inherited from ARDOUR:MetricSection

 
+ 
+ 
+ 
+ 
+ 
+ 

  
Methods
boolinitial ()
boolis_tempo ()
doubleminute ()
doubleminute_at_sample (long)

  
doublepulse ()
longsample ()
longsample_at_minute (double)

  
voidset_pulse (double)

 

 
↠ ARDOUR:Track

 
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.

 
@@ -4356,9 +5431,13 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
  
+ 
+ 
+ 
+ 
@@ -4374,6 +5453,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
  
+ 
@@ -4387,6 +5467,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
  
+ 
@@ -4400,34 +5481,33 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
  
+ 
- 
- 

  
Methods

  
Regionbounce (InterThreadInfo&)
boolbounceable (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.
endpoint
 the processor to tap the signal off (or nil for the top) 
include_endpoint
 include the given processor in the bounced audio. 
Returns  true if the track can be bounced, or false otherwise.

  
boolcan_record ()
intfind_and_use_playlist (DataType, ID)

  
boolisnil ()

  
Playlistplaylist ()

  
boolset_name (std::string)
intuse_copy_playlist ()
intuse_new_playlist (DataType)
intuse_playlist (DataType, Playlist)

  
Cast

  
AudioTrackto_audio_track ()

  
MidiTrackto_midi_track ()
std::stringcomment ()

  
boolcustomize_plugin_insert (Processor, unsigned int, ChanCount, ChanCount)

 
 enable custom plugin-insert configuration 
proc
 Processor to customize 
count
 number of plugin instances to use (if zero, reset to default) 
outs
 output port customization 
sinks
 input pins for variable-I/O plugins 
Returns  true if successful
DataTypedata_type ()

  
IOinput ()

  
Deliverymain_outs ()

 
 the signal processorat at end of the processing chain which produces output 
PannerShellpanner_shell ()

  
PeakMeterpeak_meter ()

 
************************************************************* Pure interface begins here*************************************************************
longplayback_latency (bool)

  
intremove_processor (Processor, ProcessorStreams, bool)

 
 remove plugin/processor
proc
 processor to remove 
err
 error report (index where removal vailed, channel-count why it failed) may be nil 
need_process_lock
 if locking is required (set to true, unless called from RT context with lock) 
Returns  0 on success

  
intremove_processors (ProcessorList, ProcessorStreams)
voidset_comment (std::string, void*)

  
voidset_meter_point (MeterPoint, bool)

  
boolset_strict_io (bool)
longsignal_latency ()

  
boolsoloed ()

  
boolstrict_io ()

  
Processorthe_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.

  
Amptrim ()

  
Cast
Automatableto_automatable ()
Slavableto_slavable ()

  
Trackto_track ()

 

 
Inherited from ARDOUR:Stripable

 
- 
- 
- 
+ 
+ 
+ 
- 
- 
+ 
+ 
- 
+ 
- 
- 
- 
- 
- 
+ 
+ 
+ 
+ 
+ 
@@ -4436,8 +5516,9 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
  
+ 
- 
+ 
@@ -4449,16 +5530,22 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
  
- 
- 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 

  
Methods
AutomationControlcomp_enable_control ()
AutomationControlcomp_makeup_control ()
AutomationControlcomp_mode_control ()
AutomationControlcomp_enable_controllable ()
AutomationControlcomp_makeup_controllable ()
AutomationControlcomp_mode_controllable ()

  
std::stringcomp_mode_name (unsigned int)
ReadOnlyControlcomp_redux_control ()
AutomationControlcomp_speed_control ()
ReadOnlyControlcomp_redux_controllable ()
AutomationControlcomp_speed_controllable ()

  
std::stringcomp_speed_name (unsigned int)
AutomationControlcomp_threshold_control ()
AutomationControlcomp_threshold_controllable ()

  
unsigned inteq_band_cnt ()

  
std::stringeq_band_name (unsigned int)
AutomationControleq_enable_control ()
AutomationControleq_freq_control (unsigned int)
AutomationControleq_gain_control (unsigned int)
AutomationControleq_q_control (unsigned int)
AutomationControleq_shape_control (unsigned int)
AutomationControleq_enable_controllable ()
AutomationControleq_freq_controllable (unsigned int)
AutomationControleq_gain_controllable (unsigned int)
AutomationControleq_q_controllable (unsigned int)
AutomationControleq_shape_controllable (unsigned int)

  
AutomationControlfilter_enable_controllable (bool)

  
AutomationControlfilter_freq_controllable (bool)

  
AutomationControlfilter_slope_controllable (bool)
boolis_hidden ()

  
boolis_master ()

  
boolis_monitor ()
boolis_private_route ()

  
boolis_selected ()
AutomationControlmaster_send_enable_control ()
AutomationControlmaster_send_enable_controllable ()

  
MonitorProcessormonitor_control ()

  
MuteControlmute_control ()

  
AutomationControlpan_azimuth_control ()
PresentationInfopresentation_info_ptr ()

  
AutomationControlrec_enable_control ()

  
AutomationControlrec_safe_control ()
AutomationControlsend_enable_control (unsigned int)
AutomationControlsend_level_control (unsigned int)
AutomationControlsend_enable_controllable (unsigned int)
AutomationControlsend_level_controllable (unsigned int)

  
std::stringsend_name (unsigned int)
AutomationControlsend_pan_azimuth_controllable (unsigned int)
AutomationControlsend_pan_azimuth_enable_controllable (unsigned int)

  
voidset_presentation_order (unsigned int)
boolslaved ()
boolslaved_to (VCA)

  
SoloControlsolo_control ()

  
SoloIsolateControlsolo_isolate_control ()

  
SoloSafeControlsolo_safe_control ()

  
GainControltrim_control ()

  
Cast
Automatableto_automatable ()

  
Routeto_route ()
Slavableto_slavable ()

  
VCAto_vca ()

 

 
Inherited from ARDOUR:SessionObjectPtr

@@ -4483,20 +5570,32 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
  Methods
  voidactivate ()
  boolactive ()
+ longcapture_offset ()
  voiddeactivate ()
  std::stringdisplay_name ()
  booldisplay_to_user ()
- ChanCountinput_streams ()
- ChanCountoutput_streams ()
+ longinput_latency ()
+ ChanCountinput_streams ()
+ longoutput_latency ()
+ ChanCountoutput_streams ()
+ longplayback_offset ()
+ longsignal_latency ()
  Cast
  Ampto_amp ()
  Automatableto_automatable ()
+ DelayLineto_delayline ()
+ DiskIOProcessorto_diskioprocessor ()
+ DiskReaderto_diskreader ()
+ DiskWriterto_diskwriter ()
  PluginInsertto_insert ()
  IOProcessorto_ioprocessor ()
+ Latentto_latent ()
  PeakMeterto_meter ()
  MonitorProcessorto_monitorprocessor ()
  PeakMeterto_peakmeter ()
  PluginInsertto_plugininsert ()
+ PolarityProcessorto_polarityprocessor ()
+ Sendto_send ()
  SideChainto_sidechain ()
  UnknownProcessorto_unknownprocessor ()
 
@@ -4525,21 +5624,21 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
 
Inherited from ARDOUR:Stripable

 
- 
- 
- 
+ 
+ 
+ 
- 
- 
+ 
+ 
- 
+ 
- 
- 
- 
- 
- 
+ 
+ 
+ 
+ 
+ 
@@ -4547,8 +5646,9 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
  
+ 
- 
+ 
@@ -4559,15 +5659,21 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
  
- 
- 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 

  
Methods
AutomationControlcomp_enable_control ()
AutomationControlcomp_makeup_control ()
AutomationControlcomp_mode_control ()
AutomationControlcomp_enable_controllable ()
AutomationControlcomp_makeup_controllable ()
AutomationControlcomp_mode_controllable ()

  
std::stringcomp_mode_name (unsigned int)
ReadOnlyControlcomp_redux_control ()
AutomationControlcomp_speed_control ()
ReadOnlyControlcomp_redux_controllable ()
AutomationControlcomp_speed_controllable ()

  
std::stringcomp_speed_name (unsigned int)
AutomationControlcomp_threshold_control ()
AutomationControlcomp_threshold_controllable ()

  
unsigned inteq_band_cnt ()

  
std::stringeq_band_name (unsigned int)
AutomationControleq_enable_control ()
AutomationControleq_freq_control (unsigned int)
AutomationControleq_gain_control (unsigned int)
AutomationControleq_q_control (unsigned int)
AutomationControleq_shape_control (unsigned int)
AutomationControleq_enable_controllable ()
AutomationControleq_freq_controllable (unsigned int)
AutomationControleq_gain_controllable (unsigned int)
AutomationControleq_q_controllable (unsigned int)
AutomationControleq_shape_controllable (unsigned int)

  
AutomationControlfilter_enable_controllable (bool)

  
AutomationControlfilter_freq_controllable (bool)

  
AutomationControlfilter_slope_controllable (bool)
boolis_hidden ()

  
boolis_master ()

  
boolis_monitor ()
boolis_private_route ()

  
boolis_selected ()
AutomationControlmaster_send_enable_control ()
AutomationControlmaster_send_enable_controllable ()

  
MonitorProcessormonitor_control ()

  
AutomationControlpan_azimuth_control ()

  
AutomationControlpan_elevation_control ()
PresentationInfopresentation_info_ptr ()

  
AutomationControlrec_enable_control ()

  
AutomationControlrec_safe_control ()
AutomationControlsend_enable_control (unsigned int)
AutomationControlsend_level_control (unsigned int)
AutomationControlsend_enable_controllable (unsigned int)
AutomationControlsend_level_controllable (unsigned int)

  
std::stringsend_name (unsigned int)
AutomationControlsend_pan_azimuth_controllable (unsigned int)
AutomationControlsend_pan_azimuth_enable_controllable (unsigned int)

  
voidset_presentation_order (unsigned int)
boolslaved ()
boolslaved_to (VCA)

  
SoloIsolateControlsolo_isolate_control ()

  
SoloSafeControlsolo_safe_control ()

  
GainControltrim_control ()

  
Cast
Automatableto_automatable ()

  
Routeto_route ()
Slavableto_slavable ()

  
VCAto_vca ()

 

 
Inherited from ARDOUR:SessionObjectPtr

@@ -4585,9 +5691,9 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
  Constructor
  ℂARDOUR.VCAList ()
  Methods
- VCAback ()
+ VCAback ()
  boolempty ()
- VCAfront ()
+ VCAfront ()
  LuaIteriter ()
  voidreverse ()
  unsigned longsize ()
@@ -4600,7 +5706,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
 
 Base class for objects with saveable and undoable state with destruction notification 

 
- 
+ 
@@ -4615,6 +5721,19 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
  

  
Methods
intcreate_vca (unsigned int, std::string)
VCAListcreate_vca (unsigned int, std::string)

  
unsigned longn_vcas ()

  
voidremove_vca (VCA)

  
VCAvca_by_name (std::string)
IDid ()

  
OwnedPropertyListproperties ()

 

+
∁ ARDOUR:VCAVector

+
C‡: std::vector<boost::shared_ptr<ARDOUR::VCA> >

+

+
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
Constructor
ℂARDOUR.VCAVector ()
Methods
VCAat (unsigned long)
boolempty ()
LuaIteriter ()
unsigned longsize ()
LuaTabletable ()

 
∁ ARDOUR:WeakAudioSourceList

 
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
  Constructor
  ℂARDOUR.WeakAudioSourceList ()
  Methods
- AudioSourceback ()
+ AudioSourceback ()
  boolempty ()
- AudioSourcefront ()
+ AudioSourcefront ()
  LuaIteriter ()
  voidreverse ()
  unsigned longsize ()
@@ -4637,9 +5756,9 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
  Constructor
  ℂARDOUR.WeakRouteList ()
  Methods
- Routeback ()
+ Routeback ()
  boolempty ()
- Routefront ()
+ Routefront ()
  LuaIteriter ()
  voidreverse ()
  unsigned longsize ()
@@ -4652,9 +5771,9 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
  Constructor
  ℂARDOUR.WeakSourceList ()
  Methods
- Sourceback ()
+ Sourceback ()
  boolempty ()
- Sourcefront ()
+ Sourcefront ()
  LuaIteriter ()
  voidreverse ()
  unsigned longsize ()
@@ -4664,7 +5783,10 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
 

 
+ 
+ 
+ 

  
Methods
LuaTableactionlist ()
UIConfigurationconfig ()

  
std::stringhttp_get (std::string)
voidmixer_screenshot (std::string)

  
ProcessorVectorprocessor_selection ()

  
unsigned inttranslate_order (InsertAt)

  

@@ -4685,12 +5807,11 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
  Constructor
  ℂArdourUI.ArdourMarkerList ()
  Methods
- LuaTableadd (ArdourMarker* )
  ArdourMarkerback ()
  boolempty ()
  ArdourMarkerfront ()
  LuaIteriter ()
- voidpush_back (ArdourMarker)
+ ...push_back (--lua--)
  voidreverse ()
  unsigned longsize ()
  LuaTabletable ()
@@ -4714,7 +5835,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
  voidclear_playlist (Playlist)
  voidclear_playlists (TimeAxisView)
  voidconsider_auditioning (Region)
-
 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
 will start. 
r
 Region to consider.
r,
 the audition will be cancelled.  Otherwise an audition of 

+
 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.
r
 Region to consider auditioning

  voidcopy_playlists (TimeAxisView)
  MouseModecurrent_mouse_mode ()
 
Returns  The current mouse mode (gain, object, range, timefx etc.) (defined in editing_syms.h)

@@ -4740,7 +5861,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
  longget_current_zoom ()
  Selectionget_cut_buffer ()
  unsigned intget_grid_beat_divisions (long)
- LuaTable(Beats, ...)get_grid_type_as_beats (bool&, long)
+ LuaTable(Beats, ...)get_grid_type_as_beats (bool&, long)
  LuaTable(long, ...)get_nudge_distance (long, long&)
  longget_paste_offset (long, unsigned int, long)
  LuaTable(...)get_pointer_position (double&, double&)
@@ -4753,6 +5874,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
  doubleget_y_origin ()
  ZoomFocusget_zoom_focus ()
  voidgoto_nth_marker (int)
+ GridTypegrid_type ()
  voidhide_track_in_display (TimeAxisView, bool)
  longleftmost_sample ()
  voidmaximise_editing_space ()
@@ -4781,6 +5903,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
  voidscroll_tracks_up_line ()
  boolscroll_up_one_track (bool)
  voidselect_all_tracks ()
+ voidselect_all_visible_lanes ()
  voidseparate_region_from_selection ()
  voidset_follow_playhead (bool, bool)
 
 Set whether the editor should follow the playhead. 
yn
 true to follow playhead, otherwise false. 
catch_up
 true to reset the editor view to show the playhead (if yn == true), otherwise false.

@@ -4789,20 +5912,15 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
 
 Set the mouse mode (gain, object, range, timefx etc.) 
m
 Mouse mode (defined in editing_syms.h) 
force
 Perform the effects of the change even if no change is required (ie even if the current mouse mode is equal to 

  voidset_punch_range (long, long, std::string)
  voidset_selection (SelectionList, Operation)
- voidset_show_measures (bool)
  voidset_snap_mode (SnapMode)
 
 Set the snap mode. 
m
 Snap mode (defined in editing_syms.h)

- voidset_snap_threshold (double)
-
 Set the snap threshold. 
t
 Snap threshold in `units'.

  voidset_stationary_playhead (bool)
  voidset_toggleaction (std::string, std::string, bool)
  voidset_video_timeline_height (int)
  voidset_visible_track_count (int)
  voidset_zoom_focus (ZoomFocus)
- boolshow_measures ()
  voidshow_track_in_display (TimeAxisView, bool)
  SnapModesnap_mode ()
- SnapTypesnap_type ()
  boolstationary_playhead ()
  voidstem_export ()
 
 Open stem export dialog 

@@ -4812,6 +5930,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
  voidtoggle_xjadeo_proc (int)
  voidundo (unsigned int)
 
 Undo some transactions. 
n
 Number of transactions to undo.

+ voidupdate_grid ()
  doublevisible_canvas_height ()
  
 
∅ ArdourUI:MarkerSelection

@@ -4824,12 +5943,11 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
  Constructor
  ℂArdourUI.ArdourMarkerList ()
  Methods
- LuaTableadd (ArdourMarker* )
  ArdourMarkerback ()
  boolempty ()
  ArdourMarkerfront ()
  LuaIteriter ()
- voidpush_back (ArdourMarker)
+ ...push_back (--lua--)
  voidreverse ()
  unsigned longsize ()
  LuaTabletable ()
@@ -4841,7 +5959,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
 
 Class to represent list of selected regions.

 
- 
+ 
@@ -4901,7 +6019,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
  
- 
+ 
@@ -4913,12 +6031,34 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
 
 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.

-
∅ ArdourUI:TimeAxisView

+
Inherited from ArdourUI:TimeAxisView

+

  
Methods
longend_frame ()
longend_sample ()

  
unsigned longn_midi_regions ()

  
RegionListregionlist ()

  
longstart ()
boolempty ()

  
Selectablefront ()

  
LuaIteriter ()
voidpush_back (Selectable)
...push_back (--lua--)

  
voidreverse ()

  
unsigned longsize ()

  
LuaTabletable ()

 
 

+ 
+ 
+ 
+
+ 
+
+ 
+ 
+
+
Methods
unsigned intcurrent_height ()
unsigned inteffective_height ()
Returns  effective height (taking children into account) in canvas units, or		0 if this TimeAxisView has not yet been shown 
intorder ()
Returns  index of this TimeAxisView within its parent 
voidset_height (unsigned int, TrackHeightMode)
doubley_position ()
Returns  y position, or -1 if hidden 

+
∁ ArdourUI:TimeAxisView

 
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 intcurrent_height ()
unsigned inteffective_height ()
Returns  effective height (taking children into account) in canvas units, or		0 if this TimeAxisView has not yet been shown 
intorder ()
Returns  index of this TimeAxisView within its parent 
voidset_height (unsigned int, TrackHeightMode)
doubley_position ()
Returns  y position, or -1 if hidden 

 
∅ ArdourUI:TimeAxisViewItem

 
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
longend_frame ()
longend_sample ()

  
longlength ()

  
longstart ()

  

@@ -4940,9 +6080,9 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
  Constructor
  ℂARDOUR.AudioRangeList ()
  Methods
- AudioRangeback ()
+ AudioRangeback ()
  boolempty ()
- AudioRangefront ()
+ AudioRangefront ()
  LuaIteriter ()
  voidreverse ()
  unsigned longsize ()
@@ -4958,46 +6098,19 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
  Methods
  boolcontains (TimeAxisView)
  RouteListroutelist ()
-
-
Inherited from ArdourUI:TrackViewStdList

-
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
+ 
+ 
Constructor
ℂArdourUI.TrackViewStdList ()
Methods
TimeAxisViewback ()
boolempty ()
TimeAxisViewfront ()
LuaIteriter ()
voidpush_back (TimeAxisView)
voidreverse ()
unsigned longsize ()
LuaTabletable ()
voidunique ()
Cast
TrackViewStdListto_tav_list ()

 

 
∁ ArdourUI:TrackViewList

 
C‡: TrackViewList

- 
is-a: ArdourUI:TrackViewStdList

 

 
+ 
+ 

  
Methods

  
boolcontains (TimeAxisView)

  
RouteListroutelist ()
Cast
TrackViewStdListto_tav_list ()

  

-
Inherited from ArdourUI:TrackViewStdList

-
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
-
Constructor
ℂArdourUI.TrackViewStdList ()
Methods
TimeAxisViewback ()
boolempty ()
TimeAxisViewfront ()
LuaIteriter ()
voidpush_back (TimeAxisView)
voidreverse ()
unsigned longsize ()
LuaTabletable ()
voidunique ()

 
∁ ArdourUI:TrackViewStdList

 
C‡: std::list<TimeAxisView* >

 

@@ -5009,11 +6122,323 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
  boolempty ()
  TimeAxisViewfront ()
  LuaIteriter ()
- voidpush_back (TimeAxisView)
  voidreverse ()
  unsigned longsize ()
  LuaTabletable ()
- voidunique ()
+ 
+
∁ ArdourUI:UIConfiguration

+
C‡: UIConfiguration

+

+
 Base class for objects with saveable and undoable state 

+
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
Methods
unsigned intget_action_table_columns ()
boolget_all_floating_windows_are_dialogs ()
boolget_allow_non_quarter_pulse ()
boolget_autoplay_files ()
boolget_autoscroll_editor ()
boolget_blink_alert_indicators ()
boolget_blink_rec_arm ()
boolget_boxy_buttons ()
boolget_buggy_gradients ()
boolget_cairo_image_surface ()
unsigned longget_clock_display_limit ()
std::stringget_color_file ()
boolget_color_regions_using_track_color ()
std::stringget_default_bindings ()
boolget_default_narrow_ms ()
boolget_draggable_playhead ()
floatget_draggable_playhead_speed ()
boolget_editor_stereo_only_meters ()
floatget_extra_ui_extents_time ()
boolget_flat_buttons ()
boolget_floating_monitor_section ()
boolget_follow_edits ()
intget_font_scale ()
boolget_grid_follows_internal ()
boolget_hiding_groups_deactivates_groups ()
std::stringget_icon_set ()
std::stringget_keyboard_layout ()
std::stringget_keyboard_layout_name ()
boolget_link_region_and_track_selection ()
unsigned intget_lock_gui_after_seconds ()
unsigned intget_max_inline_controls ()
floatget_meter_hold ()
--MISSING (ARDOUR::MeterLineUp)--get_meter_line_up_din ()
--MISSING (ARDOUR::MeterLineUp)--get_meter_line_up_level ()
floatget_meter_peak ()
boolget_meter_style_led ()
--MISSING (ARDOUR::VUMeterStandard)--get_meter_vu_standard ()
std::stringget_mixer_strip_visibility ()
boolget_name_new_markers ()
boolget_never_display_periodic_midi ()
boolget_new_automation_points_on_lane ()
boolget_no_new_session_dialog ()
boolget_only_copy_imported_files ()
boolget_open_gui_after_adding_plugin ()
boolget_prefer_inline_over_gui ()
boolget_preview_video_frame_on_drag ()
--MISSING (ARDOUR::ClockDeltaMode)--get_primary_clock_delta_mode ()
intget_recent_session_sort ()
boolget_rubberbanding_snaps_to_grid ()
boolget_rulers_follow_grid ()
boolget_save_export_analysis_image ()
boolget_save_export_mixer_screenshot ()
--MISSING (ARDOUR::ScreenSaverMode)--get_screen_saver_mode ()
--MISSING (ARDOUR::ClockDeltaMode)--get_secondary_clock_delta_mode ()
boolget_show_editor_meter ()
boolget_show_grids_ruler ()
boolget_show_inline_display_by_default ()
boolget_show_mini_timeline ()
boolget_show_name_highlight ()
boolget_show_plugin_scan_window ()
boolget_show_region_gain ()
boolget_show_region_name ()
boolget_show_secondary_clock ()
boolget_show_snapped_cursor ()
boolget_show_toolbar_latency ()
boolget_show_toolbar_monitoring ()
boolget_show_toolbar_recpunch ()
boolget_show_toolbar_selclock ()
boolget_show_track_meters ()
boolget_show_waveform_clipping ()
boolget_show_waveforms ()
boolget_show_waveforms_while_recording ()
boolget_show_zoom_tools ()
unsigned intget_snap_threshold ()
boolget_snap_to_grid ()
boolget_snap_to_marks ()
boolget_snap_to_region_end ()
boolget_snap_to_region_start ()
boolget_snap_to_region_sync ()
boolget_sound_midi_notes ()
std::stringget_stripable_color_palette ()
boolget_super_rapid_clock_update ()
floatget_timeline_item_gradient_depth ()
boolget_transients_follow_front ()
std::stringget_ui_font_family ()
std::stringget_ui_rc_file ()
boolget_update_editor_during_summary_drag ()
boolget_use_double_click_to_zoom_to_selection ()
boolget_use_mouse_position_as_zoom_focus_on_scroll ()
boolget_use_note_bars_for_velocity ()
boolget_use_note_color_for_velocity ()
boolget_use_time_rulers_to_zoom_with_vertical_drag ()
boolget_use_tooltips ()
boolget_use_wm_visibility ()
unsigned intget_vertical_region_gap ()
std::stringget_vkeybd_layout ()
unsigned longget_waveform_cache_size ()
doubleget_waveform_clip_level ()
floatget_waveform_gradient_depth ()
--MISSING (ARDOUR::WaveformScale)--get_waveform_scale ()
--MISSING (ARDOUR::WaveformShape)--get_waveform_shape ()
boolget_widget_prelight ()
boolset_action_table_columns (unsigned int)
boolset_all_floating_windows_are_dialogs (bool)
boolset_allow_non_quarter_pulse (bool)
boolset_autoplay_files (bool)
boolset_autoscroll_editor (bool)
boolset_blink_alert_indicators (bool)
boolset_blink_rec_arm (bool)
boolset_boxy_buttons (bool)
boolset_buggy_gradients (bool)
boolset_cairo_image_surface (bool)
boolset_clock_display_limit (unsigned long)
boolset_color_file (std::string)
boolset_color_regions_using_track_color (bool)
boolset_default_bindings (std::string)
boolset_default_narrow_ms (bool)
boolset_draggable_playhead (bool)
boolset_draggable_playhead_speed (float)
boolset_editor_stereo_only_meters (bool)
boolset_extra_ui_extents_time (float)
boolset_flat_buttons (bool)
boolset_floating_monitor_section (bool)
boolset_follow_edits (bool)
boolset_font_scale (int)
boolset_grid_follows_internal (bool)
boolset_hiding_groups_deactivates_groups (bool)
boolset_icon_set (std::string)
boolset_keyboard_layout (std::string)
boolset_keyboard_layout_name (std::string)
boolset_link_region_and_track_selection (bool)
boolset_lock_gui_after_seconds (unsigned int)
boolset_max_inline_controls (unsigned int)
boolset_meter_hold (float)
boolset_meter_line_up_din (--MISSING (ARDOUR::MeterLineUp)--)
boolset_meter_line_up_level (--MISSING (ARDOUR::MeterLineUp)--)
boolset_meter_peak (float)
boolset_meter_style_led (bool)
boolset_meter_vu_standard (--MISSING (ARDOUR::VUMeterStandard)--)
boolset_mixer_strip_visibility (std::string)
boolset_name_new_markers (bool)
boolset_never_display_periodic_midi (bool)
boolset_new_automation_points_on_lane (bool)
boolset_no_new_session_dialog (bool)
boolset_only_copy_imported_files (bool)
boolset_open_gui_after_adding_plugin (bool)
boolset_prefer_inline_over_gui (bool)
boolset_preview_video_frame_on_drag (bool)
boolset_primary_clock_delta_mode (--MISSING (ARDOUR::ClockDeltaMode)--)
boolset_recent_session_sort (int)
boolset_rubberbanding_snaps_to_grid (bool)
boolset_rulers_follow_grid (bool)
boolset_save_export_analysis_image (bool)
boolset_save_export_mixer_screenshot (bool)
boolset_screen_saver_mode (--MISSING (ARDOUR::ScreenSaverMode)--)
boolset_secondary_clock_delta_mode (--MISSING (ARDOUR::ClockDeltaMode)--)
boolset_show_editor_meter (bool)
boolset_show_grids_ruler (bool)
boolset_show_inline_display_by_default (bool)
boolset_show_mini_timeline (bool)
boolset_show_name_highlight (bool)
boolset_show_plugin_scan_window (bool)
boolset_show_region_gain (bool)
boolset_show_region_name (bool)
boolset_show_secondary_clock (bool)
boolset_show_snapped_cursor (bool)
boolset_show_toolbar_latency (bool)
boolset_show_toolbar_monitoring (bool)
boolset_show_toolbar_recpunch (bool)
boolset_show_toolbar_selclock (bool)
boolset_show_track_meters (bool)
boolset_show_waveform_clipping (bool)
boolset_show_waveforms (bool)
boolset_show_waveforms_while_recording (bool)
boolset_show_zoom_tools (bool)
boolset_snap_threshold (unsigned int)
boolset_snap_to_grid (bool)
boolset_snap_to_marks (bool)
boolset_snap_to_region_end (bool)
boolset_snap_to_region_start (bool)
boolset_snap_to_region_sync (bool)
boolset_sound_midi_notes (bool)
boolset_stripable_color_palette (std::string)
boolset_super_rapid_clock_update (bool)
boolset_timeline_item_gradient_depth (float)
boolset_transients_follow_front (bool)
boolset_ui_font_family (std::string)
boolset_ui_rc_file (std::string)
boolset_update_editor_during_summary_drag (bool)
boolset_use_double_click_to_zoom_to_selection (bool)
boolset_use_mouse_position_as_zoom_focus_on_scroll (bool)
boolset_use_note_bars_for_velocity (bool)
boolset_use_note_color_for_velocity (bool)
boolset_use_time_rulers_to_zoom_with_vertical_drag (bool)
boolset_use_tooltips (bool)
boolset_use_wm_visibility (bool)
boolset_vertical_region_gap (unsigned int)
boolset_vkeybd_layout (std::string)
boolset_waveform_cache_size (unsigned long)
boolset_waveform_clip_level (double)
boolset_waveform_gradient_depth (float)
boolset_waveform_scale (--MISSING (ARDOUR::WaveformScale)--)
boolset_waveform_shape (--MISSING (ARDOUR::WaveformShape)--)
boolset_widget_prelight (bool)
Properties
unsigned intaction_table_columns
boolall_floating_windows_are_dialogs
boolallow_non_quarter_pulse
boolautoplay_files
boolautoscroll_editor
boolblink_alert_indicators
boolblink_rec_arm
boolboxy_buttons
boolbuggy_gradients
boolcairo_image_surface
unsigned longclock_display_limit
std::stringcolor_file
boolcolor_regions_using_track_color
std::stringdefault_bindings
booldefault_narrow_ms
booldraggable_playhead
floatdraggable_playhead_speed
booleditor_stereo_only_meters
floatextra_ui_extents_time
boolflat_buttons
boolfloating_monitor_section
boolfollow_edits
intfont_scale
boolgrid_follows_internal
boolhiding_groups_deactivates_groups
std::stringicon_set
std::stringkeyboard_layout
std::stringkeyboard_layout_name
boollink_region_and_track_selection
unsigned intlock_gui_after_seconds
unsigned intmax_inline_controls
floatmeter_hold
--MISSING (ARDOUR::MeterLineUp)--meter_line_up_din
--MISSING (ARDOUR::MeterLineUp)--meter_line_up_level
floatmeter_peak
boolmeter_style_led
--MISSING (ARDOUR::VUMeterStandard)--meter_vu_standard
std::stringmixer_strip_visibility
boolname_new_markers
boolnever_display_periodic_midi
boolnew_automation_points_on_lane
boolno_new_session_dialog
boolonly_copy_imported_files
boolopen_gui_after_adding_plugin
boolprefer_inline_over_gui
boolpreview_video_frame_on_drag
--MISSING (ARDOUR::ClockDeltaMode)--primary_clock_delta_mode
intrecent_session_sort
boolrubberbanding_snaps_to_grid
boolrulers_follow_grid
boolsave_export_analysis_image
boolsave_export_mixer_screenshot
--MISSING (ARDOUR::ScreenSaverMode)--screen_saver_mode
--MISSING (ARDOUR::ClockDeltaMode)--secondary_clock_delta_mode
boolshow_editor_meter
boolshow_grids_ruler
boolshow_inline_display_by_default
boolshow_mini_timeline
boolshow_name_highlight
boolshow_plugin_scan_window
boolshow_region_gain
boolshow_region_name
boolshow_secondary_clock
boolshow_snapped_cursor
boolshow_toolbar_latency
boolshow_toolbar_monitoring
boolshow_toolbar_recpunch
boolshow_toolbar_selclock
boolshow_track_meters
boolshow_waveform_clipping
boolshow_waveforms
boolshow_waveforms_while_recording
boolshow_zoom_tools
unsigned intsnap_threshold
boolsnap_to_grid
boolsnap_to_marks
boolsnap_to_region_end
boolsnap_to_region_start
boolsnap_to_region_sync
boolsound_midi_notes
std::stringstripable_color_palette
boolsuper_rapid_clock_update
floattimeline_item_gradient_depth
booltransients_follow_front
std::stringui_font_family
std::stringui_rc_file
boolupdate_editor_during_summary_drag
booluse_double_click_to_zoom_to_selection
booluse_mouse_position_as_zoom_focus_on_scroll
booluse_note_bars_for_velocity
booluse_note_color_for_velocity
booluse_time_rulers_to_zoom_with_vertical_drag
booluse_tooltips
booluse_wm_visibility
unsigned intvertical_region_gap
std::stringvkeybd_layout
unsigned longwaveform_cache_size
doublewaveform_clip_level
floatwaveform_gradient_depth
--MISSING (ARDOUR::WaveformScale)--waveform_scale
--MISSING (ARDOUR::WaveformShape)--waveform_shape
boolwidget_prelight

  

 
⋯ C:ByteArray

 
C‡: unsigned char*

@@ -5025,6 +6450,34 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
  unsigned char*offset (unsigned int)
  voidset_table (LuaTable {unsigned char})
  
+
∁ C:ByteVector

+
C‡: std::vector<unsigned char >

+

+
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
Constructor
ℂC.ByteVector ()
ℂC.ByteVector ()
Methods
LuaTableadd (LuaTable {unsigned char})
unsigned charat (unsigned long)
voidclear ()
boolempty ()
LuaIteriter ()
voidpush_back (unsigned char)
unsigned longsize ()
LuaTabletable ()
...to_array (--lua--)

+
⋯ C:DoubleArray

+
C‡: double*

+

+
+ 
+ 
+ 
+ 
+ 
+ 
Methods
LuaMetaTablearray ()
LuaTableget_table ()
DoubleArrayoffset (unsigned int)
voidset_table (LuaTable {double})

 
∁ C:DoubleVector

 
C‡: std::vector<double >

 

@@ -5035,11 +6488,13 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
  Methods
  LuaTableadd (LuaTable {double})
  doubleat (unsigned long)
+ voidclear ()
  boolempty ()
  LuaIteriter ()
  voidpush_back (double)
  unsigned longsize ()
  LuaTabletable ()
+ ...to_array (--lua--)
  
 
⋯ C:FloatArray

 
C‡: float*

@@ -5061,11 +6516,13 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
  Methods
  LuaTableadd (LuaTable {FloatArray})
  FloatArrayat (unsigned long)
+ voidclear ()
  boolempty ()
  LuaIteriter ()
  voidpush_back (FloatArray)
  unsigned longsize ()
  LuaTabletable ()
+ ...to_array (--lua--)
  
 
∁ C:FloatVector

 
C‡: std::vector<float >

@@ -5077,11 +6534,13 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
  Methods
  LuaTableadd (LuaTable {float})
  floatat (unsigned long)
+ voidclear ()
  boolempty ()
  LuaIteriter ()
  voidpush_back (float)
  unsigned longsize ()
  LuaTabletable ()
+ ...to_array (--lua--)
  
 
∁ C:Int64List

 
C‡: std::list<long >

@@ -5091,9 +6550,9 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
  ℂC.Int64List ()
  Methods
  LuaTableadd (LuaTable {long})
- longback ()
+ longback ()
  boolempty ()
- longfront ()
+ longfront ()
  LuaIteriter ()
  voidpush_back (long)
  voidreverse ()
@@ -5119,9 +6578,9 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
  ℂC.StringList ()
  Methods
  LuaTableadd (LuaTable {std::string})
- std::stringback ()
+ std::stringback ()
  boolempty ()
- std::stringfront ()
+ std::stringfront ()
  LuaIteriter ()
  voidpush_back (std::string)
  voidreverse ()
@@ -5139,11 +6598,13 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
  Methods
  LuaTableadd (LuaTable {std::string})
  std::stringat (unsigned long)
+ voidclear ()
  boolempty ()
  LuaIteriter ()
  voidpush_back (std::string)
  unsigned longsize ()
  LuaTabletable ()
+ ...to_array (--lua--)
  
 
∁ Cairo:Context

 
C‡: Cairo::Context

@@ -5249,6 +6710,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
  intget_width ()
 
 Gets the width of the ImageSurface in pixels 

  voidset_as_source (Context, int, int)
+
 Set this surface as source for another context. This allows to draw this surface

  
 
∁ Cairo:PangoLayout

 
C‡: LuaCairo::PangoLayout

@@ -5257,6 +6719,8 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
  Constructor
  ℂCairo.PangoLayout (Context, std::string)
  Methods
+ Alignmentget_alignment ()
+
 Gets the alignment for the layout: how partial lines are positioned within the horizontal space available. 
Returns  The alignment.

  EllipsizeModeget_ellipsize ()
 
 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.

  ...get_pixel_size (--lua--)
@@ -5270,28 +6734,30 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
  boolis_wrapped ()
 
 Queries whether the layout had to wrap any paragraphs.
 This returns true if a positive width is set on layout, ellipsization mode of layout is set to Pango::ELLIPSIZE_NONE, and there are paragraphs exceeding the layout width that have to be wrapped.
Returns  true if any paragraphs had to be wrapped, false otherwise.

  voidlayout_cairo_path (Context)
+ voidset_alignment (Alignment)
+
 Sets the alignment for the layout: how partial lines are positioned within the horizontal space available. 
alignment
 The alignment.

  voidset_ellipsize (EllipsizeMode)
 
 Sets the type of ellipsization being performed for layout. Depending on the ellipsization mode ellipsize text is removed from the start, middle, or end of text so they fit within the width and height of layout set with set_width() and set_height().
 If the layout contains characters such as newlines that force it to be layed out in multiple paragraphs, then whether each paragraph is ellipsized separately or the entire layout is ellipsized as a whole depends on the set height of the layout. See set_height() for details.
ellipsize
 The new ellipsization mode for layout.		 

  voidset_markup (std::string)
 
 Sets the layout text and attribute list from marked-up text (see markup format). Replaces the current text and attribute list. 
markup
 Some marked-up text.

  voidset_text (std::string)
 
 Set the text of the layout. 
text
 The text for the layout.

- voidset_width (int)
+ voidset_width (float)
 
 Sets the width to which the lines of the Pango::Layout should wrap or ellipsized.  The default value is -1: no width set.
width
 The desired width in Pango units, or -1 to indicate that no wrapping or ellipsization should be performed.

  voidset_wrap (WrapMode)
 
 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.
wrap
 The wrap mode.

  voidshow_in_cairo_context (Context)
+
 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.
context
 A Cairo context.

  
 
∁ Evoral:Beats

-
C‡: Evoral::Beats

+
C‡: Temporal::Beats

 

 
 Musical time in beats. 

 
-
- 
+ 

  
Constructor

  
ℂEvoral.Beats (double)
 Create from a real number of beats. 

  
Methods
doubleto_double ()
doubleto_double ()

  

 
↠ Evoral:Control

 
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 C
  voidclear (double, double)
 
 remove all automation events between the given time range 
start
 start of range (inclusive) in audio samples 
end
 end of range (inclusive) in audio samples

  voidclear_list ()
+ booleditor_add (double, double, bool)
  doubleeval (double)
 
 query value at given time (takes a read-lock, not safe while writing automation) 
where
 absolute time in samples 
Returns  parameter value

  EventListevents ()
@@ -5363,17 +6830,17 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
  unsigned chartype ()
  
 
↠ Evoral:NotePtr

-
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 charchannel ()
unsigned charchannel ()

  
boolisnil ()
Beatslength ()
unsigned charnote ()
unsigned charoff_velocity ()
Beatstime ()
unsigned charvelocity ()
Beatslength ()
unsigned charnote ()
unsigned charoff_velocity ()
Beatstime ()
unsigned charvelocity ()

  

 
∁ Evoral:Parameter

 
C‡: Evoral::Parameter

@@ -5417,7 +6884,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
  longto
  
 
↠ Evoral:Sequence

-
C‡: 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

 

 
@@ -5442,22 +6909,36 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
  
Methods

  
intrun ()

  

+
∁ LuaDialog:ProgressWindow

+
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
boolcanceled ()
voiddone ()
 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.
boolprogress (float, std::string)
 Report progress and update GUI. 
prog
 progress in range 0..1 show a bar, values outside this range show a pulsing dialog. 
text
 optional text to show on the progress-bar 
Returns  true if cancel was clicked, false otherwise

 
∁ LuaSignal:Set

-
C‡: std::bitset<48ul>

+
C‡: std::bitset<49ul>

 

 
- 
- 
- 
- 
- 
- 
- 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
- 
+ 

  
Constructor

  
ℂLuaSignal.Set ()

  
Methods
LuaTableadd (48ul)
boolany ()
unsigned longcount ()
boolnone ()
Setreset ()
Setset (unsigned long, bool)
unsigned longsize ()
LuaTableadd (49ul)
boolany ()
unsigned longcount ()
boolnone ()
Setreset ()
Setset (unsigned long, bool)
unsigned longsize ()

  
LuaTabletable ()
booltest (unsigned long)
booltest (unsigned long)

  

 
ℕ PBD

 

@@ -5502,10 +6983,11 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
 
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

  
doubleget_value ()
 Get `internal' value 
Returns  raw value as used for the plugin/processor control port

  
boolisnil ()

  
std::stringname ()

  

@@ -5537,11 +7019,13 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
  Methods
  LuaTableadd (LuaTable {ID})
  IDat (unsigned long)
+ voidclear ()
  boolempty ()
  LuaIteriter ()
  voidpush_back (ID)
  unsigned longsize ()
  LuaTabletable ()
+ ...to_array (--lua--)
  
 
∁ PBD:RingBuffer8

 
C‡: PBD::RingBufferNPT<unsigned char>

@@ -5684,9 +7168,9 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
  Constructor
  ℂTimecode.BBT_TIME (unsigned int, unsigned int, unsigned int)
  Data Members
- unsigned intbars
- unsigned intbeats
- unsigned intticks
+ intbars
+ intbeats
+ intticks
  
 
∁ Timecode:Time

 
C‡: Timecode::Time

@@ -5698,7 +7182,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
  booldrop
 
 Whether this Time uses dropframe Timecode

  unsigned intframes
-
 Timecode frames (not audio samples)

+
 Timecode frames (not audio frames)

  unsigned inthours
  unsigned intminutes
  boolnegative
@@ -5792,11 +7276,13 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
  Methods
  LuaTableadd (LuaTable {Feature})
  Featureat (unsigned long)
+ voidclear ()
  boolempty ()
  LuaIteriter ()
  voidpush_back (Feature)
  unsigned longsize ()
  LuaTabletable ()
+ ...to_array (--lua--)
  
 
∁ Vamp:Plugin:FeatureSet

 
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 C
  Methods
  LuaTableadd (LuaTable {OutputDescriptor})
  OutputDescriptorat (unsigned long)
+ voidclear ()
  boolempty ()
  LuaIteriter ()
  voidpush_back (OutputDescriptor)
  unsigned longsize ()
  LuaTabletable ()
+ ...to_array (--lua--)
  
 
∁ Vamp:PluginBase

 
C‡: Vamp::PluginBase

@@ -5933,11 +7421,13 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
  Methods
  LuaTableadd (LuaTable {ParameterDescriptor})
  ParameterDescriptorat (unsigned long)
+ voidclear ()
  boolempty ()
  LuaIteriter ()
  voidpush_back (ParameterDescriptor)
  unsigned longsize ()
  LuaTabletable ()
+ ...to_array (--lua--)
  
 
∁ Vamp:RealTime

 
C‡: Vamp::RealTime

@@ -6023,6 +7513,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
 
  • ARDOUR.PluginType.LV2
    • 
 
  • ARDOUR.PluginType.Windows_VST
    • 
 
  • ARDOUR.PluginType.LXVST
    • 
+
  • ARDOUR.PluginType.MacVST
    • 
 
  • ARDOUR.PluginType.Lua
    • 
 
 
    ∈ ARDOUR.PresentationInfo.Flag
    
@@ -6045,10 +7536,12 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
 
  • ARDOUR.AutoState.Write
    • 
 
  • ARDOUR.AutoState.Touch
    • 
 
  • ARDOUR.AutoState.Play
    • 
+
  • ARDOUR.AutoState.Latch
    • 
 
 
    ∈ ARDOUR.AutomationType
    
 
      
 
    • ARDOUR.AutomationType.GainAutomation
      • 
+
    • ARDOUR.AutomationType.BusSendLevel
      • 
 
    • ARDOUR.AutomationType.PluginAutomation
      • 
 
    • ARDOUR.AutomationType.SoloAutomation
      • 
 
    • ARDOUR.AutomationType.SoloIsolateAutomation
      • 
@@ -6143,6 +7636,13 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
 
    • ARDOUR.MidiTempoMapDisposition.SMFTempoIgnore
      • 
 
    • ARDOUR.MidiTempoMapDisposition.SMFTempoUse
      • 
 
    
+
    ∈ ARDOUR.RegionEquivalence
    
+
      
+
    • ARDOUR.RegionEquivalence.Exact
      • 
+
    • ARDOUR.RegionEquivalence.Enclosed
      • 
+
    • ARDOUR.RegionEquivalence.Overlap
      • 
+
    • ARDOUR.RegionEquivalence.LayerTime
      • 
+
    
 
    ∈ ARDOUR.RegionPoint
    -
    Ardour 5.12  -  Sat, 16 Sep 2017 16:18:16 +0200
    +
    Ardour 6.0-pre1  -  Thu, 26 Mar 2020 17:53:58 +0100