X-Git-Url: http://shamusworld.gotdns.org/cgi-bin/gitweb.cgi?a=blobdiff_plain;f=_manual%2F24_lua-scripting%2F02_class_reference.html;h=d5f530c5cc1d3a0c9beaff5f803196402431aa78;hb=7460a6641c2c3b4a51e3578492b3d73d6345305c;hp=503e8774823dab3f07dd8ab589f2625ac0992a1c;hpb=fd1ad5d44650630a40b1afa2bd6c5278737346b9;p=ardour-manual diff --git a/_manual/24_lua-scripting/02_class_reference.html b/_manual/24_lua-scripting/02_class_reference.html index 503e877..d5f530c 100644 --- a/_manual/24_lua-scripting/02_class_reference.html +++ b/_manual/24_lua-scripting/02_class_reference.html @@ -135,14 +135,13 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C Methods GainControlgain_control () boolisnil () + boolsameinstance (Amp)

Inherited from ARDOUR:Processor

- - @@ -150,6 +149,8 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C + +
Methods
voidactivate ()
boolactive ()
AutomationControlautomation_control (Parameter, bool)
Controlcontrol (Parameter, bool)
voiddeactivate ()
std::stringdisplay_name ()
Cast
Automatableto_automatable ()
PluginInsertto_insert ()
IOProcessorto_ioprocessor ()
MonitorProcessorto_monitorprocessor ()
PeakMeterto_peakmeter ()
SideChainto_sidechain ()
UnknownProcessorto_unknownprocessor ()
@@ -189,6 +190,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C unsigned intoutput_channels () std::stringoutput_device_name () unsigned intperiod_size () + boolsameinstance (AudioBackend) floatsample_rate () 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).

@@ -268,6 +270,61 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C PortEngineport_engine () boolport_is_physical (std::string) +

 ARDOUR:AudioPlaylist

+

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

+

is-a: ARDOUR:Playlist

+
+

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

+ + + + + +
Methods
boolisnil ()
longread (FloatArray, FloatArray, FloatArray, long, long, unsigned int)
boolsameinstance (AudioPlaylist)
+

Inherited from ARDOUR:Playlist

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Methods
voidadd_region (Region, long, float, bool, int)
Regioncombine (RegionList)
unsigned intcount_regions_at (long)
Playlistcut (AudioRangeList&, bool)
DataTypedata_type ()
voidduplicate (Region, long, long, float)
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
Regionfind_next_region (long, RegionPoint, int)
longfind_next_region_boundary (long, int)
voidlower_region (Region)
voidlower_region_to_bottom (Region)
unsigned intn_regions ()
voidraise_region (Region)
voidraise_region_to_top (Region)
Regionregion_by_id (ID)
RegionListPtrregion_list ()
RegionListPtrregions_at (long)
RegionListPtrregions_touched (long, long)
start
Range start.
end
Range end.

Returns regions which have some part within this range.

RegionListPtrregions_with_end_within (Range)
RegionListPtrregions_with_start_within (Range)
voidremove_region (Region)
voidsplit (long)
voidsplit_region (Region, long, int)
Regiontop_region_at (long)
Regiontop_unmuted_region_at (long)
voiduncombine (Region)
Cast
AudioPlaylistto_audioplaylist ()
+

Inherited from ARDOUR:SessionObject

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

 ARDOUR:AudioPort

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

is-a: ARDOUR:Port

@@ -275,6 +332,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C +
Methods
boolisnil ()
boolsameinstance (AudioPort)

Inherited from ARDOUR:Port

@@ -337,6 +395,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C +
boolisnil ()
unsigned intn_channels ()
longreadable_length ()
boolsameinstance (AudioSource)

 ARDOUR:AudioTrack

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

@@ -346,6 +405,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C +
Methods
boolisnil ()
boolsameinstance (AudioTrack)

Inherited from ARDOUR:Track

@@ -358,11 +418,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C - - - - @@ -386,6 +442,8 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C + + @@ -395,6 +453,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C + @@ -402,6 +461,54 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C

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 ()
Playlistplaylist ()
boolrecord_enabled ()
boolrecord_safe ()
boolset_name (std::string)
voidset_record_enabled (bool, GroupControlDisposition)
voidset_record_safe (bool, GroupControlDisposition)
Cast
AudioTrackto_audio_track ()
MidiTrackto_midi_track ()
Processornth_plugin (unsigned int)
Processornth_processor (unsigned int)
Processornth_send (unsigned int)
PeakMeterpeak_meter ()

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

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

boolremove_sidechain (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)
boolsoloed ()
boolstrict_io ()
Cast
Trackto_track ()
+

Inherited from ARDOUR:Stripable

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Methods
AutomationControlcomp_enable_control ()
AutomationControlcomp_makeup_control ()
AutomationControlcomp_mode_control ()
std::stringcomp_mode_name (unsigned int)
AutomationControlcomp_redux_control ()
AutomationControlcomp_speed_control ()
std::stringcomp_speed_name (unsigned int)
AutomationControlcomp_threshold_control ()
unsigned inteq_band_cnt ()
std::stringeq_band_name (unsigned int)
AutomationControleq_enable_control ()
AutomationControleq_freq_control (unsigned int)
AutomationControleq_gain_control (unsigned int)
AutomationControleq_hpf_control ()
AutomationControleq_q_control (unsigned int)
AutomationControleq_shape_control (unsigned int)
GainControlgain_control ()
boolis_auditioner ()
boolis_hidden ()
boolis_master ()
boolis_monitor ()
boolis_selected ()
AutomationControlmaster_send_enable_control ()
MonitorProcessormonitor_control ()
MuteControlmute_control ()
AutomationControlpan_azimuth_control ()
AutomationControlpan_elevation_control ()
AutomationControlpan_frontback_control ()
AutomationControlpan_lfe_control ()
AutomationControlpan_width_control ()
PhaseControlphase_control ()
PresentationInfopresentation_info_ptr ()
AutomationControlrec_enable_control ()
AutomationControlrec_safe_control ()
AutomationControlsend_enable_control (unsigned int)
AutomationControlsend_level_control (unsigned int)
std::stringsend_name (unsigned int)
voidset_presentation_order (unsigned int, bool)
SoloControlsolo_control ()
SoloIsolateControlsolo_isolate_control ()
SoloSafeControlsolo_safe_control ()
GainControltrim_control ()
Cast
Routeto_route ()

Inherited from ARDOUR:SessionObject

@@ -434,6 +541,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C +
Methods
Methods
AutomationControlautomation_control (Parameter, bool)
boolisnil ()
boolsameinstance (Automatable)

 ARDOUR:AutomationControl

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

@@ -448,6 +556,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C doubleget_value ()

Get the current effective `user' value based on automation state

boolisnil () + boolsameinstance (AutomationControl) voidset_automation_state (AutoState) voidset_automation_style (AutoStyle) voidset_value (double, GroupControlDisposition) @@ -480,6 +589,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C XMLNodeget_state () boolisnil () Commandmemento_command (XMLNode, XMLNode) + boolsameinstance (AutomationList) booltouch_enabled () booltouching () boolwriting () @@ -511,6 +621,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C Methods ChanCountcount () AudioBufferget_audio (unsigned long) + MidiBufferget_midi (unsigned long) boolsameinstance (BufferSet)

 ARDOUR:ChanCount

@@ -543,8 +654,12 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C Constructor ℂARDOUR.ChanMapping () 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)

+ 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
@@ -569,8 +684,8 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C voidmix_buffers_with_gain (FloatArray, FloatArray, unsigned int, float) 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) -

calculate peaks

data
data to analyze
min
result, minimum value found in range
max
result, max value found in range
n_samples
number of samples to analyze
+ LuaTable(...)peaks (FloatArray, float&, float&, unsigned int) + voidprocess_map (BufferSet, ChanMapping, ChanMapping, unsigned int, long, DataType)

 ARDOUR:DSP:Biquad

C‡: ARDOUR::DSP::Biquad

@@ -583,6 +698,8 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C Methods voidcompute (Type, double, double, double)

setup filter, compute coefficients

type
filter type (LowPass, HighPass, etc)
freq
filter frequency
Q
filter quality
gain
filter gain
+ voidconfigure (double, double, double, double, double) +

setup filter, set coefficients directly

floatdB_at_freq (float)

filter transfer function (filter response for spectrum visualization)

freq
frequency

Returns gain at given frequency in dB (clamped to -120..+120)

voidreset () @@ -595,6 +712,8 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C

C/C++ Shared Memory

A convenience class representing a C array of float[] or int32_t[] data values. This is useful for lua scripts to perform DSP operations directly using C/C++ with CPU Hardware acceleration.

Access to this memory area is always 4 byte aligned. The data is interpreted either as float or as int.

This memory area can also be shared between different instances or the same lua plugin (DSP, GUI).

Since memory allocation is not realtime safe it should be allocated during dsp_init() or dsp_configure(). The memory is free()ed automatically when the lua instance is destroyed.

+ + @@ -609,6 +728,20 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
Constructor
ARDOUR.DSP.DspShm (unsigned long)
Methods
voidallocate (unsigned long)

[re] allocate memory in host's memory space

s
size, total number of float or integer elements to store.
IntArrayto_int (unsigned long)

access memory as integer array

off
offset in shared memory region

Returns int_32_t[]

+

 ARDOUR:DSP:FFTSpectrum

+

C‡: ARDOUR::DSP::FFTSpectrum

+
+ + + + + + + + + + +
Constructor
ARDOUR.DSP.FFTSpectrum (unsigned int, double)
Methods
voidexecute ()

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)

voidset_data_hann (FloatArray, unsigned int, unsigned int)

 ARDOUR:DSP:LowPass

C‡: ARDOUR::DSP::LowPass

@@ -652,6 +785,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C +
Methods
boolisnil ()
boolsameinstance (Delivery)

Inherited from ARDOUR:IOProcessor

@@ -666,8 +800,6 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C - - @@ -675,6 +807,8 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C + +
Methods
voidactivate ()
boolactive ()
AutomationControlautomation_control (Parameter, bool)
Controlcontrol (Parameter, bool)
voiddeactivate ()
std::stringdisplay_name ()
Cast
Automatableto_automatable ()
PluginInsertto_insert ()
IOProcessorto_ioprocessor ()
MonitorProcessorto_monitorprocessor ()
PeakMeterto_peakmeter ()
SideChainto_sidechain ()
UnknownProcessorto_unknownprocessor ()
@@ -710,15 +844,43 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C unsigned longsize () LuaTabletable () +

 ARDOUR:FluidSynth

+

C‡: ARDOUR::FluidSynth

+
+ + + + + + + + + + + + +
Constructor
ARDOUR.FluidSynth (float, int)

instantiate a Synth

samplerate
samplerate
Methods
boolload_sf2 (std::string)
boolmidi_event (unsigned char*, unsigned long)
voidpanic ()
unsigned intprogram_count ()
std::stringprogram_name (unsigned int)
boolselect_program (unsigned int, unsigned char)
boolsynth (FloatArray, FloatArray, unsigned int)

 ARDOUR:GainControl

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

-

is-a: ARDOUR:AutomationControl

+

is-a: ARDOUR:SlavableAutomationControl,

A PBD::Controllable with associated automation data (AutomationList)

+
Methods
boolisnil ()
boolsameinstance (GainControl)
+

Inherited from ARDOUR:SlavableAutomationControl,

+ + + + + + + + + +
Methods
voidadd_master (AutomationControl)
voidclear_masters ()
intget_boolean_masters ()
doubleget_masters_value ()
voidremove_master (AutomationControl)
boolslaved ()
boolslaved_to (AutomationControl)

Inherited from ARDOUR:AutomationControl

@@ -771,6 +933,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C +
Methods
boolphysically_connected ()
Portport_by_name (unsigned int)
intremove_port (Port, void*)
boolsameinstance (IO)

Inherited from ARDOUR:SessionObject

@@ -792,14 +955,13 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C +
ChanCountnatural_input_streams ()
ChanCountnatural_output_streams ()
IOoutput ()
boolsameinstance (IOProcessor)

Inherited from ARDOUR:Processor

- - @@ -807,6 +969,8 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C + +
Methods
voidactivate ()
boolactive ()
AutomationControlautomation_control (Parameter, bool)
Controlcontrol (Parameter, bool)
voiddeactivate ()
std::stringdisplay_name ()
Cast
Automatableto_automatable ()
PluginInsertto_insert ()
IOProcessorto_ioprocessor ()
MonitorProcessorto_monitorprocessor ()
PeakMeterto_peakmeter ()
SideChainto_sidechain ()
UnknownProcessorto_unknownprocessor ()
@@ -836,16 +1000,27 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C + + + + + + + + + + +
Methods
longend ()
Flagsflags ()
boolis_auto_loop ()
boolis_auto_punch ()
boolis_cd_marker ()
boolis_hidden ()
boolis_mark ()
boolis_range_marker ()
boolis_session_range ()
longlength ()
voidlock ()
boollocked ()
boolmatches (Flags)
intmove_to (long)
std::stringname ()
intset_end (long, bool, bool)

Set end position.

force
true to force setting, even if the given new end is before the current start.
allow_bbt_recompute
True to recompute BBT end time from the new given end time.
s
New end.
intset_length (long, long, bool)
intset_start (long, bool, bool)

Set start position.

s
New start.
force
true to force setting, even if the given new start is after the current end.
allow_bbt_recompute
True to recompute BBT start time from the new given start time.
longstart ()
voidunlock ()

Inherited from PBD:Stateful

@@ -881,8 +1056,10 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C + +
longfirst_mark_after (long, bool)
Locationfirst_mark_at (long, long)
longfirst_mark_before (long, bool)
LocationListlist ()
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)
voidremove (Location)
Locationsession_range_location ()

Inherited from PBD:Stateful

@@ -897,6 +1074,13 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
+ + + + + + + @@ -920,6 +1104,23 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
Methods
LuaTablebuild_filename ()
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

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

LuaTablehsla_to_rgba ()

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)

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)

Processornew_plugin (Session, std::string, PluginType, std::string)

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

voidusleep (unsigned long)
+

 ARDOUR:LuaAPI:Vamp

+

C‡: ARDOUR::LuaAPI::Vamp

+
+ + + + + + + + + + +
Constructor
ARDOUR.LuaAPI.Vamp (std::string, float)
Methods
intanalyze (Readable, unsigned int, --MISSING (luabridge::LuaRef)--)
boolinitialize ()

initialize the plugin for use with analyze().

This is equivalent to plugin():initialise (1, 8192, 8192) and prepares a plugin for analyze.

Manual initialization is only required to set plugin-parameters which depend on prior initialization of the plugin.

 vamp:reset ()
+ vamp:initialize ()
+ vamp:plugin():setParameter (0, 1.5)
+ vamp:analyze (r, 0)
Pluginplugin ()
voidreset ()

call plugin():reset() and clear intialization flag

 ARDOUR:LuaOSC:Address

C‡: ARDOUR::LuaOSC::Address

@@ -932,6 +1133,14 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C ...send (--lua--)

Transmit an OSC message

Path (string) and type (string) must always be given. The number of following args must match the type. Supported types are:

'i': integer (lua number)

'f': float (lua number)

'd': double (lua number)

'h': 64bit integer (lua number)

's': string (lua string)

'c': character (lua string)

'T': boolean (lua bool) -- this is not implicily True, a lua true/false must be given

'F': boolean (lua bool) -- this is not implicily False, a lua true/false must be given

lua:
lua arguments: path, types, ...

Returns boolean true if successful, false on error.

+

 ARDOUR:LuaTableRef

+

C‡: ARDOUR::LuaTableRef

+
+ + + + +
Methods
...get (--lua--)
...set (--lua--)

 ARDOUR:Meter

C‡: ARDOUR::Meter

@@ -945,17 +1154,48 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C doubleframes_per_grid (Tempo, long) doublenote_divisor () +

 ARDOUR:MeterSection

+

C‡: ARDOUR::MeterSection

+

is-a: ARDOUR:MetricSection

+
+

A section of timeline with a certain Meter.

+ + + + + + +
Methods
voidset_beat (double)
voidset_pulse (double)
Cast
Meterto_meter ()
+

Inherited from ARDOUR:MetricSection

+ + + +
Methods
doublepulse ()
+

 ARDOUR:MetricSection

+

C‡: ARDOUR::MetricSection

+
+

A section of timeline with a certain Tempo or Meter.

+ + + + +
Methods
doublepulse ()
voidset_pulse (double)

 ARDOUR:MidiBuffer

C‡: ARDOUR::MidiBuffer

Buffer containing 8-bit unsigned char (MIDI) data.

+ + + + +
Methods
voidcopy (MidiBuffer)
boolempty ()
boolpush_back (long, unsigned long, unsigned char*)
boolpush_event (MidiEvent)
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.

boolsameinstance (MidiBuffer)
voidsilence (long, long)

Clear (eg zero, or empty) buffer

unsigned longsize ()
...table (--lua--)

 ARDOUR:MidiPort

@@ -967,6 +1207,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C MidiBufferget_midi_buffer (unsigned int) boolinput_active () boolisnil () + boolsameinstance (MidiPort) voidset_input_active (bool)

Inherited from ARDOUR:Port

@@ -1001,6 +1242,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C +
Methods
boolisnil ()
boolsameinstance (MidiTrack)

Inherited from ARDOUR:Track

@@ -1013,11 +1255,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C - - - - @@ -1041,6 +1279,8 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C + + @@ -1050,6 +1290,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C + @@ -1057,6 +1298,54 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C

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 ()
Playlistplaylist ()
boolrecord_enabled ()
boolrecord_safe ()
boolset_name (std::string)
voidset_record_enabled (bool, GroupControlDisposition)
voidset_record_safe (bool, GroupControlDisposition)
Cast
AudioTrackto_audio_track ()
MidiTrackto_midi_track ()
Processornth_plugin (unsigned int)
Processornth_processor (unsigned int)
Processornth_send (unsigned int)
PeakMeterpeak_meter ()

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

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

boolremove_sidechain (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)
boolsoloed ()
boolstrict_io ()
Cast
Trackto_track ()
+

Inherited from ARDOUR:Stripable

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Methods
AutomationControlcomp_enable_control ()
AutomationControlcomp_makeup_control ()
AutomationControlcomp_mode_control ()
std::stringcomp_mode_name (unsigned int)
AutomationControlcomp_redux_control ()
AutomationControlcomp_speed_control ()
std::stringcomp_speed_name (unsigned int)
AutomationControlcomp_threshold_control ()
unsigned inteq_band_cnt ()
std::stringeq_band_name (unsigned int)
AutomationControleq_enable_control ()
AutomationControleq_freq_control (unsigned int)
AutomationControleq_gain_control (unsigned int)
AutomationControleq_hpf_control ()
AutomationControleq_q_control (unsigned int)
AutomationControleq_shape_control (unsigned int)
GainControlgain_control ()
boolis_auditioner ()
boolis_hidden ()
boolis_master ()
boolis_monitor ()
boolis_selected ()
AutomationControlmaster_send_enable_control ()
MonitorProcessormonitor_control ()
MuteControlmute_control ()
AutomationControlpan_azimuth_control ()
AutomationControlpan_elevation_control ()
AutomationControlpan_frontback_control ()
AutomationControlpan_lfe_control ()
AutomationControlpan_width_control ()
PhaseControlphase_control ()
PresentationInfopresentation_info_ptr ()
AutomationControlrec_enable_control ()
AutomationControlrec_safe_control ()
AutomationControlsend_enable_control (unsigned int)
AutomationControlsend_level_control (unsigned int)
std::stringsend_name (unsigned int)
voidset_presentation_order (unsigned int, bool)
SoloControlsolo_control ()
SoloIsolateControlsolo_isolate_control ()
SoloSafeControlsolo_safe_control ()
GainControltrim_control ()
Cast
Routeto_route ()

Inherited from ARDOUR:SessionObject

@@ -1081,6 +1370,121 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
Methods
LuaTabletable ()
voidunique ()
+

 ARDOUR:MonitorProcessor

+

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

+

is-a: ARDOUR:Processor

+
+

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

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Methods
Controllablechannel_cut_control (unsigned int)
Controllablechannel_dim_control (unsigned int)
Controllablechannel_polarity_control (unsigned int)
Controllablechannel_solo_control (unsigned int)
boolcut (unsigned int)
boolcut_all ()
Controllablecut_control ()
booldim_all ()
Controllabledim_control ()
floatdim_level ()
Controllabledim_level_control ()
booldimmed (unsigned int)
boolinverted (unsigned int)
boolisnil ()
boolmonitor_active ()
boolmono ()
Controllablemono_control ()
boolsameinstance (MonitorProcessor)
voidset_cut (unsigned int, bool)
voidset_cut_all (bool)
voidset_dim (unsigned int, bool)
voidset_dim_all (bool)
voidset_mono (bool)
voidset_polarity (unsigned int, bool)
voidset_solo (unsigned int, bool)
Controllablesolo_boost_control ()
floatsolo_boost_level ()
boolsoloed (unsigned int)
+

Inherited from ARDOUR:Processor

+ + + + + + + + + + + + + + + +
Methods
voidactivate ()
boolactive ()
voiddeactivate ()
std::stringdisplay_name ()
Cast
Ampto_amp ()
Automatableto_automatable ()
PluginInsertto_insert ()
IOProcessorto_ioprocessor ()
MonitorProcessorto_monitorprocessor ()
PeakMeterto_peakmeter ()
SideChainto_sidechain ()
UnknownProcessorto_unknownprocessor ()
+

Inherited from ARDOUR:SessionObject

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

 ARDOUR:MuteControl

+

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

+

is-a: ARDOUR:SlavableAutomationControl,

+
+

A PBD::Controllable with associated automation data (AutomationList)

+ + + + + + +
Methods
boolisnil ()
boolmuted ()
boolmuted_by_self ()
boolsameinstance (MuteControl)
+

Inherited from ARDOUR:SlavableAutomationControl,

+ + + + + + + + + +
Methods
voidadd_master (AutomationControl)
voidclear_masters ()
intget_boolean_masters ()
doubleget_masters_value ()
voidremove_master (AutomationControl)
boolslaved ()
boolslaved_to (AutomationControl)
+

Inherited from ARDOUR:AutomationControl

+ + + + + + + + + + + + + + + + +
Methods
AutomationListalist ()
AutoStateautomation_state ()
AutoStyleautomation_style ()
doubleget_value ()

Get the current effective `user' value based on automation state

voidset_automation_state (AutoState)
voidset_automation_style (AutoStyle)
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.
voidstart_touch (double)
voidstop_touch (bool, double)
boolwritable ()
Cast
Controlto_ctrl ()
+

Inherited from PBD:Controllable

+ + + +
Methods
std::stringname ()
+

Inherited from PBD:StatefulPtr

+ + + + + + +
Methods
voidclear_changes ()

Forget about any changes to this object's properties

IDid ()
OwnedPropertyListproperties ()

 ARDOUR:OwnedPropertyList

C‡: PBD::OwnedPropertyList

is-a: ARDOUR:PropertyList

@@ -1095,6 +1499,8 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C + + @@ -1109,6 +1515,88 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
Constructor
ARDOUR.ParameterDescriptor ()
Methods
std::stringmidi_note_name (unsigned char)
Data Members
std::stringlabel
boollogarithmic
booltoggled
floatupper
+

 ARDOUR:PeakMeter

+

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

+

is-a: ARDOUR:Processor

+
+

Meters peaks on the input and stores them for access.

+ + + + + + + +
Methods
boolisnil ()
floatmeter_level (unsigned int, MeterType)
voidreset_max ()
boolsameinstance (PeakMeter)
voidset_type (MeterType)
+

Inherited from ARDOUR:Processor

+ + + + + + + + + + + + + + + +
Methods
voidactivate ()
boolactive ()
voiddeactivate ()
std::stringdisplay_name ()
Cast
Ampto_amp ()
Automatableto_automatable ()
PluginInsertto_insert ()
IOProcessorto_ioprocessor ()
MonitorProcessorto_monitorprocessor ()
PeakMeterto_peakmeter ()
SideChainto_sidechain ()
UnknownProcessorto_unknownprocessor ()
+

Inherited from ARDOUR:SessionObject

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

 ARDOUR:PhaseControl

+

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

+

is-a: ARDOUR:AutomationControl

+
+

A PBD::Controllable with associated automation data (AutomationList)

+ + + + + + + +
Methods
boolinverted (unsigned int)
boolisnil ()
boolsameinstance (PhaseControl)
voidset_phase_invert (unsigned int, bool)
c
Audio channel index.
yn
true to invert phase, otherwise false.
+

Inherited from ARDOUR:AutomationControl

+ + + + + + + + + + + + + + + + +
Methods
AutomationListalist ()
AutoStateautomation_state ()
AutoStyleautomation_style ()
doubleget_value ()

Get the current effective `user' value based on automation state

voidset_automation_state (AutoState)
voidset_automation_style (AutoStyle)
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.
voidstart_touch (double)
voidstop_touch (bool, double)
boolwritable ()
Cast
Controlto_ctrl ()
+

Inherited from PBD:Controllable

+ + + +
Methods
std::stringname ()
+

Inherited from PBD:StatefulPtr

+ + + + + + +
Methods
voidclear_changes ()

Forget about any changes to this object's properties

IDid ()
OwnedPropertyListproperties ()

 ARDOUR:Playlist

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

is-a: ARDOUR:SessionObject

@@ -1116,8 +1604,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().

- - + @@ -1136,17 +1623,21 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C + + - + + +
Methods
voidadd_region (Region, long, float, bool)

Note: this calls set_layer (..., DBL_MAX) so it will reset the layering index of region

voidadd_region (Region, long, float, bool, int)
Regioncombine (RegionList)
unsigned intcount_regions_at (long)
Playlistcut (AudioRangeList&, bool)
voidraise_region (Region)
voidraise_region_to_top (Region)
Regionregion_by_id (ID)
RegionListPtrregion_list ()
RegionListPtrregions_at (long)
RegionListPtrregions_touched (long, long)
start
Range start.
end
Range end.

Returns regions which have some part within this range.

RegionListPtrregions_with_end_within (Range)
RegionListPtrregions_with_start_within (Range)
voidremove_region (Region)
boolsameinstance (Playlist)
voidsplit (long)
voidsplit_region (Region, long)
voidsplit_region (Region, long, int)
Regiontop_region_at (long)
Regiontop_unmuted_region_at (long)
voiduncombine (Region)
Cast
AudioPlaylistto_audioplaylist ()

Inherited from ARDOUR:SessionObject

@@ -1164,6 +1655,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
+ @@ -1177,6 +1669,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C +
Methods
std::stringget_docs ()
PluginInfoget_info ()
LuaTable(int, ...)get_parameter_descriptor (unsigned int, ParameterDescriptor&)
std::stringget_parameter_docs (unsigned int)
boolisnil ()
boolparameter_is_input (unsigned int)
PresetRecordpreset_by_label (std::string)
PresetRecordpreset_by_uri (std::string)
boolsameinstance (Plugin)

Inherited from PBD:StatefulPtr

@@ -1194,6 +1687,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
+
Methods
boolisnil ()
boolsameinstance (PluginControl)

Inherited from ARDOUR:AutomationControl

@@ -1233,7 +1727,19 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C + + + + + + + + + + + +
Constructor
ARDOUR.PluginInfo ()
Methods
PresetVectorget_presets (bool)
boolis_instrument ()
boolisnil ()
boolsameinstance (PluginInfo)
Data Members
std::stringcategory
std::stringcreator
ARDOUR:ChanCountn_inputs
ARDOUR:ChanCountn_outputs
std::stringname
std::stringpath
ARDOUR.PluginTypetype
std::stringunique_id

 ARDOUR:PluginInsert

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

@@ -1248,6 +1754,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C boolisnil () ChanMappingoutput_map (unsigned int) Pluginplugin (unsigned int) + boolsameinstance (PluginInsert) voidset_input_map (unsigned int, ChanMapping) voidset_output_map (unsigned int, ChanMapping) IOsidechain_input () @@ -1257,14 +1764,14 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C - - + +
Methods
boolactive ()
AutomationControlautomation_control (Parameter, bool)
Controlcontrol (Parameter, bool)
std::stringdisplay_name ()
Cast
Ampto_amp ()
Automatableto_automatable ()
PluginInsertto_insert ()
IOProcessorto_ioprocessor ()
MonitorProcessorto_monitorprocessor ()
PeakMeterto_peakmeter ()
SideChainto_sidechain ()
UnknownProcessorto_unknownprocessor ()
@@ -1297,6 +1804,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C

Returns Port human readable name

boolreceives_input ()

Returns true if this Port receives input, otherwise false

+ boolsameinstance (Port) boolsends_output ()

Returns true if this Port sends output, otherwise false

Cast @@ -1360,7 +1868,27 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C Portport (DataType, unsigned long)

nth port of type t, or nth port if t = NIL

t
data type
index
port index
boolremove (Port) + boolsameinstance (PortSet) + +

 ARDOUR:PresentationInfo

+

C‡: ARDOUR::PresentationInfo

+

is-a: PBD:Stateful

+
+

Base class for objects with saveable and undoable state

+ + + + +
Methods
unsigned intcolor ()
unsigned intorder ()
voidset_color (unsigned int)
+

Inherited from PBD:Stateful

+ + + + + + +
Methods
voidclear_changes ()

Forget about any changes to this object's properties

IDid ()
OwnedPropertyListproperties ()

 ARDOUR:PresetRecord

C‡: ARDOUR::Plugin::PresetRecord

@@ -1373,6 +1901,21 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C booluser boolvalid +

 ARDOUR:PresetVector

+

C‡: std::vector<ARDOUR::Plugin::PresetRecord >

+
+ + + + + + + + + + + +
Constructor
ARDOUR.PresetVector ()
Methods
LuaTableadd (LuaTable {PresetRecord})
PresetRecordat (unsigned long)
boolempty ()
LuaIteriter ()
voidpush_back (PresetRecord)
unsigned longsize ()
LuaTabletable ()

 ARDOUR:Processor

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

is-a: ARDOUR:SessionObject

@@ -1382,16 +1925,17 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C Methods voidactivate () boolactive () - AutomationControlautomation_control (Parameter, bool) - Controlcontrol (Parameter, bool) voiddeactivate () std::stringdisplay_name () boolisnil () + boolsameinstance (Processor) Cast Ampto_amp () Automatableto_automatable () PluginInsertto_insert () IOProcessorto_ioprocessor () + MonitorProcessorto_monitorprocessor () + PeakMeterto_peakmeter () SideChainto_sidechain () UnknownProcessorto_unknownprocessor () @@ -1403,6 +1947,21 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C Statefulto_stateful () StatefulDestructibleto_statefuldestructible () +

 ARDOUR:ProcessorVector

+

C‡: std::vector<boost::shared_ptr<ARDOUR::Processor> >

+
+ + + + + + + + + + + +
Constructor
ARDOUR.ProcessorVector ()
Methods
LuaTableadd (LuaTable {Processor})
Processorat (unsigned long)
boolempty ()
LuaIteriter ()
voidpush_back (Processor)
unsigned longsize ()
LuaTabletable ()

 ARDOUR:Properties:BoolProperty

C‡: PBD::PropertyDescriptor<bool>

@@ -1430,6 +1989,17 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C

A list of properties, mapped using their ID

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

+

 ARDOUR:Readable

+

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

+
+ + + + + + + +
Methods
boolisnil ()
unsigned intn_channels ()
longread (FloatArray, long, long, int)
longreadable_length ()
boolsameinstance (Readable)

 ARDOUR:Region

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

is-a: ARDOUR:SessionObject

@@ -1443,8 +2013,8 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C boolcaptured () voidclear_sync_position () boolcovers (long) - voidcut_end (long) - voidcut_front (long) + voidcut_end (long, int) + voidcut_front (long, int) DataTypedata_type () boolexternal () boolhidden () @@ -1456,7 +2026,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C boollocked () voidlower () voidlower_to_bottom () - voidmove_start (long) + voidmove_start (long, int) voidmove_to_natural_position () boolmuted () voidnudge_position (long) @@ -1466,14 +2036,15 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C boolposition_locked () voidraise () voidraise_to_top () + boolsameinstance (Region) 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.

- voidset_length (long) + voidset_length (long, int) voidset_locked (bool) voidset_muted (bool) voidset_opaque (bool) - voidset_position (long) + voidset_position (long, int) voidset_position_locked (bool) voidset_start (long) voidset_sync_position (long) @@ -1486,12 +2057,13 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C LuaTable(long, ...)sync_offset (int&) longsync_position ()

Returns Sync position in session time

- voidtrim_end (long) -
new_endpoint
New region end point, such that, for example, a region at 0 of length 10 has an endpoint of 9.
- voidtrim_front (long) - voidtrim_to (long, long) + voidtrim_end (long, int) + voidtrim_front (long, int) + voidtrim_to (long, long, int) boolvideo_locked () boolwhole_file () + Cast + Readableto_readable ()

Inherited from ARDOUR:SessionObject

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

 ARDOUR:Route

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

-

is-a: ARDOUR:SessionObject

+

is-a: ARDOUR:Stripable

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

@@ -1561,6 +2133,8 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C + + @@ -1568,8 +2142,10 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C + + @@ -1578,6 +2154,54 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
Processornth_plugin (unsigned int)
Processornth_processor (unsigned int)
Processornth_send (unsigned int)
PeakMeterpeak_meter ()

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

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

boolremove_sidechain (Processor)

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

boolsameinstance (Route)
voidset_active (bool, void*)
voidset_comment (std::string, void*)
voidset_meter_point (MeterPoint, bool)
boolset_name (std::string)
boolset_strict_io (bool)
boolsoloed ()
Cast
Trackto_track ()
+

Inherited from ARDOUR:Stripable

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Methods
AutomationControlcomp_enable_control ()
AutomationControlcomp_makeup_control ()
AutomationControlcomp_mode_control ()
std::stringcomp_mode_name (unsigned int)
AutomationControlcomp_redux_control ()
AutomationControlcomp_speed_control ()
std::stringcomp_speed_name (unsigned int)
AutomationControlcomp_threshold_control ()
unsigned inteq_band_cnt ()
std::stringeq_band_name (unsigned int)
AutomationControleq_enable_control ()
AutomationControleq_freq_control (unsigned int)
AutomationControleq_gain_control (unsigned int)
AutomationControleq_hpf_control ()
AutomationControleq_q_control (unsigned int)
AutomationControleq_shape_control (unsigned int)
GainControlgain_control ()
boolis_auditioner ()
boolis_hidden ()
boolis_master ()
boolis_monitor ()
boolis_selected ()
AutomationControlmaster_send_enable_control ()
MonitorProcessormonitor_control ()
MuteControlmute_control ()
AutomationControlpan_azimuth_control ()
AutomationControlpan_elevation_control ()
AutomationControlpan_frontback_control ()
AutomationControlpan_lfe_control ()
AutomationControlpan_width_control ()
PhaseControlphase_control ()
PresentationInfopresentation_info_ptr ()
AutomationControlrec_enable_control ()
AutomationControlrec_safe_control ()
AutomationControlsend_enable_control (unsigned int)
AutomationControlsend_level_control (unsigned int)
std::stringsend_name (unsigned int)
voidset_presentation_order (unsigned int, bool)
SoloControlsolo_control ()
SoloIsolateControlsolo_isolate_control ()
SoloSafeControlsolo_safe_control ()
GainControltrim_control ()
Cast
Routeto_route ()

Inherited from ARDOUR:SessionObject

@@ -1642,46 +2266,50 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C + + + + + - + + - - - - - - - - + + + + + + - - - + + + @@ -1692,7 +2320,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C - + @@ -1702,6 +2330,167 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
Methods

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)

begin collecting undo information

This call must always be followed by either begin_reversible_command() or commit_reversible_command()

cmd_name
human readable name for the undo operation
SessionConfigurationcfg ()
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 ()
voiddisable_record (bool, bool)
AudioEngineengine ()
longframe_rate ()

"actual" sample rate of session, set by current audioengine rate, pullup/down etc.

doubleframes_per_timecode_frame ()
unsigned intget_block_size ()
boolget_play_loop ()
Routeget_remote_nth_route (unsigned int)
Stripableget_remote_nth_stripable (unsigned int, Flag)
RouteListPtrget_routes ()
BufferSetget_scratch_buffers (ChanCount, bool)
BufferSetget_silent_buffers (ChanCount)
RouteListPtrget_tracks ()
voidgoto_end ()
voidgoto_start ()
voidgoto_start (bool)
longlast_transport_start ()
Locationslocations ()
Routemaster_out ()
voidmaybe_enable_record ()
Routemonitor_out ()
std::stringname ()
RouteListnew_audio_route (int, int, RouteGroup, unsigned int, std::string)

Caller must not hold process lock.

name_template
string to use for the start of the name, or "" to use "Bus".
AudioTrackListnew_audio_track (int, int, TrackMode, RouteGroup, unsigned int, std::string)

Caller must not hold process lock

name_template
string to use for the start of the name, or "" to use "Audio".
RouteListnew_midi_route (RouteGroup, unsigned int, std::string, PluginInfo, PresetRecord)
MidiTrackListnew_midi_track (ChanCount, ChanCount, PluginInfo, TrackMode, RouteGroup, unsigned int, std::string, PresetRecord)
RouteListnew_route_from_template (unsigned int, std::string, std::string, PlaylistDisposition)

create a new track or bus from a template (XML path)

how_many
how many tracks or busses to create
template_path
path to xml template file
name
name (prefix) of the route to create
pd
Playlist disposition

Returns list of newly created routes

RouteListnew_audio_route (int, int, RouteGroup, unsigned int, std::string, Flag, unsigned int)
AudioTrackListnew_audio_track (int, int, RouteGroup, unsigned int, std::string, unsigned int, TrackMode)
RouteListnew_midi_route (RouteGroup, unsigned int, std::string, PluginInfo, PresetRecord, Flag, unsigned int)
MidiTrackListnew_midi_track (ChanCount, ChanCount, PluginInfo, PresetRecord, RouteGroup, unsigned int, std::string, unsigned int, TrackMode)
RouteListnew_route_from_template (unsigned int, unsigned int, std::string, std::string, PlaylistDisposition)
longnominal_frame_rate ()

"native" sample rate of session, regardless of current audioengine rate, pullup/down etc

std::stringpath ()
Processorprocessor_by_id (ID)
RecordStaterecord_status ()
voidrequest_locate (long, bool)
voidrequest_play_loop (bool, bool)
voidrequest_stop (bool, bool)
voidrequest_transport_speed (double, bool)
Routeroute_by_id (ID)
Routeroute_by_name (std::string)
Routeroute_by_remote_id (unsigned int)
Routeroute_by_id (ID)
Routeroute_by_name (std::string)
Routeroute_by_selected_count (unsigned int)
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

voidscripts_changed ()
booltimecode_drop_frames ()
longtimecode_frames_per_hour ()
doubletimecode_frames_per_second ()
Tracktrack_by_diskstream_id (ID)
Tracktrack_by_diskstream_id (ID)
longtransport_frame ()
booltransport_rolling ()
doubletransport_speed ()
longworst_playback_latency ()
longworst_track_latency ()
+

 ARDOUR:SessionConfiguration

+

C‡: ARDOUR::SessionConfiguration

+

is-a: PBD:Configuration

+
+

Base class for objects with saveable and undoable state

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Methods
std::stringget_audio_search_path ()
boolget_auto_input ()
boolget_auto_play ()
boolget_auto_return ()
unsigned intget_destructive_xfade_msecs ()
boolget_external_sync ()
boolget_glue_new_markers_to_bars_and_beats ()
boolget_glue_new_regions_to_bars_and_beats ()
InsertMergePolicyget_insert_merge_policy ()
boolget_jack_time_master ()
unsigned intget_meterbridge_label_height ()
boolget_midi_copy_is_fork ()
std::stringget_midi_search_path ()
SampleFormatget_native_file_data_format ()
HeaderFormatget_native_file_header_format ()
boolget_punch_in ()
boolget_punch_out ()
std::stringget_raid_path ()
boolget_realtime_export ()
boolget_show_busses_on_meterbridge ()
boolget_show_group_tabs ()
boolget_show_master_on_meterbridge ()
boolget_show_midi_on_meterbridge ()
boolget_show_monitor_on_meterbridge ()
boolget_show_mute_on_meterbridge ()
boolget_show_name_on_meterbridge ()
boolget_show_rec_on_meterbridge ()
boolget_show_region_fades ()
boolget_show_solo_on_meterbridge ()
boolget_show_summary ()
std::stringget_slave_timecode_offset ()
unsigned intget_subframes_per_frame ()
std::stringget_take_name ()
TimecodeFormatget_timecode_format ()
std::stringget_timecode_generator_offset ()
longget_timecode_offset ()
boolget_timecode_offset_negative ()
boolget_track_name_number ()
boolget_track_name_take ()
boolget_use_monitor_fades ()
boolget_use_region_fades ()
boolget_use_transport_fades ()
boolget_use_video_file_fps ()
boolget_use_video_sync ()
floatget_video_pullup ()
boolget_videotimeline_pullup ()
doubleget_wave_amplitude_zoom ()
unsigned shortget_wave_zoom_factor ()
boolset_audio_search_path (std::string)
boolset_auto_input (bool)
boolset_auto_play (bool)
boolset_auto_return (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)
boolset_insert_merge_policy (InsertMergePolicy)
boolset_jack_time_master (bool)
boolset_meterbridge_label_height (unsigned int)
boolset_midi_copy_is_fork (bool)
boolset_midi_search_path (std::string)
boolset_native_file_data_format (SampleFormat)
boolset_native_file_header_format (HeaderFormat)
boolset_punch_in (bool)
boolset_punch_out (bool)
boolset_raid_path (std::string)
boolset_realtime_export (bool)
boolset_show_busses_on_meterbridge (bool)
boolset_show_group_tabs (bool)
boolset_show_master_on_meterbridge (bool)
boolset_show_midi_on_meterbridge (bool)
boolset_show_monitor_on_meterbridge (bool)
boolset_show_mute_on_meterbridge (bool)
boolset_show_name_on_meterbridge (bool)
boolset_show_rec_on_meterbridge (bool)
boolset_show_region_fades (bool)
boolset_show_solo_on_meterbridge (bool)
boolset_show_summary (bool)
boolset_slave_timecode_offset (std::string)
boolset_subframes_per_frame (unsigned int)
boolset_take_name (std::string)
boolset_timecode_format (TimecodeFormat)
boolset_timecode_generator_offset (std::string)
boolset_timecode_offset (long)
boolset_timecode_offset_negative (bool)
boolset_track_name_number (bool)
boolset_track_name_take (bool)
boolset_use_monitor_fades (bool)
boolset_use_region_fades (bool)
boolset_use_transport_fades (bool)
boolset_use_video_file_fps (bool)
boolset_use_video_sync (bool)
boolset_video_pullup (float)
boolset_videotimeline_pullup (bool)
boolset_wave_amplitude_zoom (double)
boolset_wave_zoom_factor (unsigned short)
Properties
std::stringaudio_search_path
boolauto_input
boolauto_play
boolauto_return
unsigned intdestructive_xfade_msecs
boolexternal_sync
boolglue_new_markers_to_bars_and_beats
boolglue_new_regions_to_bars_and_beats
ARDOUR.InsertMergePolicyinsert_merge_policy
booljack_time_master
unsigned intmeterbridge_label_height
boolmidi_copy_is_fork
std::stringmidi_search_path
ARDOUR.SampleFormatnative_file_data_format
ARDOUR.HeaderFormatnative_file_header_format
boolpunch_in
boolpunch_out
std::stringraid_path
boolrealtime_export
boolshow_busses_on_meterbridge
boolshow_group_tabs
boolshow_master_on_meterbridge
boolshow_midi_on_meterbridge
boolshow_monitor_on_meterbridge
boolshow_mute_on_meterbridge
boolshow_name_on_meterbridge
boolshow_rec_on_meterbridge
boolshow_region_fades
boolshow_solo_on_meterbridge
boolshow_summary
std::stringslave_timecode_offset
unsigned intsubframes_per_frame
std::stringtake_name
Timecode.TimecodeFormattimecode_format
std::stringtimecode_generator_offset
longtimecode_offset
booltimecode_offset_negative
booltrack_name_number
booltrack_name_take
booluse_monitor_fades
booluse_region_fades
booluse_transport_fades
booluse_video_file_fps
booluse_video_sync
floatvideo_pullup
boolvideotimeline_pullup
doublewave_amplitude_zoom
unsigned shortwave_zoom_factor
+

Inherited from PBD:Stateful

+ + + + + + +
Methods
voidclear_changes ()

Forget about any changes to this object's properties

IDid ()
OwnedPropertyListproperties ()

 ARDOUR:SessionObject

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

@@ -1710,6 +2499,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C Methods boolisnil () std::stringname () + boolsameinstance (SessionObject) Cast Statefulto_stateful () StatefulDestructibleto_statefuldestructible () @@ -1722,6 +2512,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C +
Methods
boolisnil ()
boolsameinstance (SideChain)

Inherited from ARDOUR:IOProcessor

@@ -1736,8 +2527,6 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C - - @@ -1745,6 +2534,8 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C + +
Methods
voidactivate ()
boolactive ()
AutomationControlautomation_control (Parameter, bool)
Controlcontrol (Parameter, bool)
voiddeactivate ()
std::stringdisplay_name ()
Cast
Automatableto_automatable ()
PluginInsertto_insert ()
IOProcessorto_ioprocessor ()
MonitorProcessorto_monitorprocessor ()
PeakMeterto_peakmeter ()
SideChainto_sidechain ()
UnknownProcessorto_unknownprocessor ()
@@ -1756,6 +2547,216 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C Statefulto_stateful () StatefulDestructibleto_statefuldestructible () +

 ARDOUR:SlavableAutomationControl,

+

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

+

is-a: ARDOUR:AutomationControl

+
+

A PBD::Controllable with associated automation data (AutomationList)

+ + + + + + + + + + + +
Methods
voidadd_master (AutomationControl)
voidclear_masters ()
intget_boolean_masters ()
doubleget_masters_value ()
boolisnil ()
voidremove_master (AutomationControl)
boolsameinstance (SlavableAutomationControl,)
boolslaved ()
boolslaved_to (AutomationControl)
+

Inherited from ARDOUR:AutomationControl

+ + + + + + + + + + + + + + + + +
Methods
AutomationListalist ()
AutoStateautomation_state ()
AutoStyleautomation_style ()
doubleget_value ()

Get the current effective `user' value based on automation state

voidset_automation_state (AutoState)
voidset_automation_style (AutoStyle)
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.
voidstart_touch (double)
voidstop_touch (bool, double)
boolwritable ()
Cast
Controlto_ctrl ()
+

Inherited from PBD:Controllable

+ + + +
Methods
std::stringname ()
+

Inherited from PBD:StatefulPtr

+ + + + + + +
Methods
voidclear_changes ()

Forget about any changes to this object's properties

IDid ()
OwnedPropertyListproperties ()
+

 ARDOUR:SoloControl

+

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

+

is-a: ARDOUR:SlavableAutomationControl,

+
+

A PBD::Controllable with associated automation data (AutomationList)

+ + + + + + + +
Methods
boolcan_solo ()
boolisnil ()
boolsameinstance (SoloControl)
boolself_soloed ()
boolsoloed ()
+

Inherited from ARDOUR:SlavableAutomationControl,

+ + + + + + + + + +
Methods
voidadd_master (AutomationControl)
voidclear_masters ()
intget_boolean_masters ()
doubleget_masters_value ()
voidremove_master (AutomationControl)
boolslaved ()
boolslaved_to (AutomationControl)
+

Inherited from ARDOUR:AutomationControl

+ + + + + + + + + + + + + + + + +
Methods
AutomationListalist ()
AutoStateautomation_state ()
AutoStyleautomation_style ()
doubleget_value ()

Get the current effective `user' value based on automation state

voidset_automation_state (AutoState)
voidset_automation_style (AutoStyle)
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.
voidstart_touch (double)
voidstop_touch (bool, double)
boolwritable ()
Cast
Controlto_ctrl ()
+

Inherited from PBD:Controllable

+ + + +
Methods
std::stringname ()
+

Inherited from PBD:StatefulPtr

+ + + + + + +
Methods
voidclear_changes ()

Forget about any changes to this object's properties

IDid ()
OwnedPropertyListproperties ()
+

 ARDOUR:SoloIsolateControl

+

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

+

is-a: ARDOUR:SlavableAutomationControl,

+
+

A PBD::Controllable with associated automation data (AutomationList)

+ + + + + + +
Methods
boolisnil ()
boolsameinstance (SoloIsolateControl)
boolself_solo_isolated ()
boolsolo_isolated ()
+

Inherited from ARDOUR:SlavableAutomationControl,

+ + + + + + + + + +
Methods
voidadd_master (AutomationControl)
voidclear_masters ()
intget_boolean_masters ()
doubleget_masters_value ()
voidremove_master (AutomationControl)
boolslaved ()
boolslaved_to (AutomationControl)
+

Inherited from ARDOUR:AutomationControl

+ + + + + + + + + + + + + + + + +
Methods
AutomationListalist ()
AutoStateautomation_state ()
AutoStyleautomation_style ()
doubleget_value ()

Get the current effective `user' value based on automation state

voidset_automation_state (AutoState)
voidset_automation_style (AutoStyle)
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.
voidstart_touch (double)
voidstop_touch (bool, double)
boolwritable ()
Cast
Controlto_ctrl ()
+

Inherited from PBD:Controllable

+ + + +
Methods
std::stringname ()
+

Inherited from PBD:StatefulPtr

+ + + + + + +
Methods
voidclear_changes ()

Forget about any changes to this object's properties

IDid ()
OwnedPropertyListproperties ()
+

 ARDOUR:SoloSafeControl

+

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

+

is-a: ARDOUR:SlavableAutomationControl,

+
+

A PBD::Controllable with associated automation data (AutomationList)

+ + + + + +
Methods
boolisnil ()
boolsameinstance (SoloSafeControl)
boolsolo_safe ()
+

Inherited from ARDOUR:SlavableAutomationControl,

+ + + + + + + + + +
Methods
voidadd_master (AutomationControl)
voidclear_masters ()
intget_boolean_masters ()
doubleget_masters_value ()
voidremove_master (AutomationControl)
boolslaved ()
boolslaved_to (AutomationControl)
+

Inherited from ARDOUR:AutomationControl

+ + + + + + + + + + + + + + + + +
Methods
AutomationListalist ()
AutoStateautomation_state ()
AutoStyleautomation_style ()
doubleget_value ()

Get the current effective `user' value based on automation state

voidset_automation_state (AutoState)
voidset_automation_style (AutoStyle)
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.
voidstart_touch (double)
voidstop_touch (bool, double)
boolwritable ()
Cast
Controlto_ctrl ()
+

Inherited from PBD:Controllable

+ + + +
Methods
std::stringname ()
+

Inherited from PBD:StatefulPtr

+ + + + + + +
Methods
voidclear_changes ()

Forget about any changes to this object's properties

IDid ()
OwnedPropertyListproperties ()

 ARDOUR:Source

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

@@ -1763,7 +2764,70 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C + +
Methods
boolisnil ()
boolsameinstance (Source)
+

 ARDOUR:Stripable

+

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

+

is-a: ARDOUR:SessionObject

+
+

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

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Methods
AutomationControlcomp_enable_control ()
AutomationControlcomp_makeup_control ()
AutomationControlcomp_mode_control ()
std::stringcomp_mode_name (unsigned int)
AutomationControlcomp_redux_control ()
AutomationControlcomp_speed_control ()
std::stringcomp_speed_name (unsigned int)
AutomationControlcomp_threshold_control ()
unsigned inteq_band_cnt ()
std::stringeq_band_name (unsigned int)
AutomationControleq_enable_control ()
AutomationControleq_freq_control (unsigned int)
AutomationControleq_gain_control (unsigned int)
AutomationControleq_hpf_control ()
AutomationControleq_q_control (unsigned int)
AutomationControleq_shape_control (unsigned int)
GainControlgain_control ()
boolis_auditioner ()
boolis_hidden ()
boolis_master ()
boolis_monitor ()
boolis_selected ()
boolisnil ()
AutomationControlmaster_send_enable_control ()
MonitorProcessormonitor_control ()
MuteControlmute_control ()
AutomationControlpan_azimuth_control ()
AutomationControlpan_elevation_control ()
AutomationControlpan_frontback_control ()
AutomationControlpan_lfe_control ()
AutomationControlpan_width_control ()
PhaseControlphase_control ()
PresentationInfopresentation_info_ptr ()
AutomationControlrec_enable_control ()
AutomationControlrec_safe_control ()
boolsameinstance (Stripable)
AutomationControlsend_enable_control (unsigned int)
AutomationControlsend_level_control (unsigned int)
std::stringsend_name (unsigned int)
voidset_presentation_order (unsigned int, bool)
SoloControlsolo_control ()
SoloIsolateControlsolo_isolate_control ()
SoloSafeControlsolo_safe_control ()
GainControltrim_control ()
Cast
Routeto_route ()
+

Inherited from ARDOUR:SessionObject

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

 ARDOUR:Tempo

C‡: ARDOUR::Tempo

@@ -1784,9 +2848,27 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C

Tempo Map - mapping of timecode to musical time. convert audio-samples, sample-rate to Bar/Beat/Tick, Meter/Tempo

- - + + + + + +
Methods
--MISSING (ARDOUR::MeterSection*)--add_meter (Meter, double, BBT_TIME, long, --MISSING (ARDOUR::PositionLockStyle)--)
--MISSING (ARDOUR::TempoSection*)--add_tempo (Tempo, double, long, --MISSING (ARDOUR::TempoSection::Type)--, --MISSING (ARDOUR::PositionLockStyle)--)
MeterSectionadd_meter (Meter, double, BBT_TIME, long, PositionLockStyle)
TempoSectionadd_tempo (Tempo, double, long, Type, PositionLockStyle)
MeterSectionmeter_section_at_beat (double)
MeterSectionmeter_section_at_frame (long)
TempoSectiontempo_section_at_frame (long)
+

 ARDOUR:TempoSection

+

C‡: ARDOUR::TempoSection

+

is-a: ARDOUR:MetricSection

+
+

A section of timeline with a certain Tempo.

+ + +
Methods
doublec_func ()
+

Inherited from ARDOUR:MetricSection

+ + + + +
Methods
doublepulse ()
voidset_pulse (double)

 ARDOUR:Track

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

is-a: ARDOUR:Route

@@ -1803,11 +2885,8 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C boolcan_record () boolisnil () Playlistplaylist () - boolrecord_enabled () - boolrecord_safe () + boolsameinstance (Track) boolset_name (std::string) - voidset_record_enabled (bool, GroupControlDisposition) - voidset_record_safe (bool, GroupControlDisposition) Cast AudioTrackto_audio_track () MidiTrackto_midi_track () @@ -1831,6 +2910,8 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C Processornth_plugin (unsigned int) Processornth_processor (unsigned int) Processornth_send (unsigned int) + PeakMeterpeak_meter () +

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

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

boolremove_sidechain (Processor) @@ -1840,6 +2921,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C

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) boolsoloed () boolstrict_io () @@ -1847,6 +2929,54 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C Cast Trackto_track () +

Inherited from ARDOUR:Stripable

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Methods
AutomationControlcomp_enable_control ()
AutomationControlcomp_makeup_control ()
AutomationControlcomp_mode_control ()
std::stringcomp_mode_name (unsigned int)
AutomationControlcomp_redux_control ()
AutomationControlcomp_speed_control ()
std::stringcomp_speed_name (unsigned int)
AutomationControlcomp_threshold_control ()
unsigned inteq_band_cnt ()
std::stringeq_band_name (unsigned int)
AutomationControleq_enable_control ()
AutomationControleq_freq_control (unsigned int)
AutomationControleq_gain_control (unsigned int)
AutomationControleq_hpf_control ()
AutomationControleq_q_control (unsigned int)
AutomationControleq_shape_control (unsigned int)
GainControlgain_control ()
boolis_auditioner ()
boolis_hidden ()
boolis_master ()
boolis_monitor ()
boolis_selected ()
AutomationControlmaster_send_enable_control ()
MonitorProcessormonitor_control ()
MuteControlmute_control ()
AutomationControlpan_azimuth_control ()
AutomationControlpan_elevation_control ()
AutomationControlpan_frontback_control ()
AutomationControlpan_lfe_control ()
AutomationControlpan_width_control ()
PhaseControlphase_control ()
PresentationInfopresentation_info_ptr ()
AutomationControlrec_enable_control ()
AutomationControlrec_safe_control ()
AutomationControlsend_enable_control (unsigned int)
AutomationControlsend_level_control (unsigned int)
std::stringsend_name (unsigned int)
voidset_presentation_order (unsigned int, bool)
SoloControlsolo_control ()
SoloIsolateControlsolo_isolate_control ()
SoloSafeControlsolo_safe_control ()
GainControltrim_control ()
Cast
Routeto_route ()

Inherited from ARDOUR:SessionObject

@@ -1863,14 +2993,13 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
Methods
+
Methods
boolisnil ()
boolsameinstance (UnknownProcessor)

Inherited from ARDOUR:Processor

- - @@ -1878,6 +3007,8 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C + +
Methods
voidactivate ()
boolactive ()
AutomationControlautomation_control (Parameter, bool)
Controlcontrol (Parameter, bool)
voiddeactivate ()
std::stringdisplay_name ()
Cast
Automatableto_automatable ()
PluginInsertto_insert ()
IOProcessorto_ioprocessor ()
MonitorProcessorto_monitorprocessor ()
PeakMeterto_peakmeter ()
SideChainto_sidechain ()
UnknownProcessorto_unknownprocessor ()
@@ -1928,6 +3059,13 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C unsigned longsize () LuaTabletable () +

 ArdourUI

+
+ + + + +
Methods
std::stringhttp_get (std::string)
ProcessorVectorprocessor_selection (--MISSING (lua_State*)--)

 ArdourUI:ArdourMarker

C‡: ArdourMarker

@@ -2138,6 +3276,17 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C Methods RouteListroutelist () +

 C:ByteArray

+

C‡: unsigned char*

+
+ + + + + + + +
Methods
LuaMetaTablearray ()
LuaTableget_table ()
unsigned char*offset (unsigned int)
boolsameinstance (unsigned char*)
voidset_table (LuaTable {unsigned char})

 C:DoubleVector

C‡: std::vector<double >

@@ -2164,6 +3313,21 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C boolsameinstance (FloatArray) voidset_table (LuaTable {float}) +

 C:FloatVector

+

C‡: std::vector<float >

+
+ + + + + + + + + + + +
Constructor
C.FloatVector ()
Methods
LuaTableadd (LuaTable {float})
floatat (unsigned long)
boolempty ()
LuaIteriter ()
voidpush_back (float)
unsigned longsize ()
LuaTabletable ()

 C:IntArray

C‡: int*

@@ -2292,6 +3456,55 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C voidunset_dash ()

This function disables a dash pattern that was set with set_dash()

+

 Cairo:ImageSurface

+

C‡: LuaCairo::ImageSurface

+
+

wrap RefPtr< Cairo::ImageSurface >

Image surfaces provide the ability to render to memory buffers either allocated by cairo or by the calling code. The supported image formats are those defined in Cairo::Format.

+ + + + + + + + + + + + + +
Constructor
Cairo.ImageSurface (Format, int, int)
Methods
Contextcontext ()

Returns a context object to perform operations on the surface

intget_height ()

Gets the height of the ImageSurface in pixels

intget_stride ()

Returns the stride of the image surface in bytes (or 0 if surface is not an image surface). The stride is the distance in bytes from the beginning of one row of the image data to the beginning of the next row.

intget_width ()

Gets the width of the ImageSurface in pixels

voidset_as_source (Context, int, int)
+

 Cairo:PangoLayout

+

C‡: LuaCairo::PangoLayout

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
Constructor
Cairo.PangoLayout (Context, std::string)
Methods
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--)

Determines the logical width and height of a Pango::Layout in device units.

std::stringget_text ()

Gets the text in the layout. The returned text should not be freed or modified.

Returns The text in the layout.

WrapModeget_wrap ()

Gets the wrap mode for the layout.

Use is_wrapped() to query whether any paragraphs were actually wrapped.

Returns Active wrap mode.

boolis_ellipsized ()

Queries whether the layout had to ellipsize any paragraphs.

This returns true if the ellipsization mode for layout is not Pango::ELLIPSIZE_NONE, a positive width is set on layout, and there are paragraphs exceeding that width that have to be ellipsized.

Returns true if any paragraphs had to be ellipsized, false otherwise.

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.

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)

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)

 Evoral:Beats

C‡: Evoral::Beats

@@ -2308,6 +3521,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C Methods boolisnil () ControlListlist () + boolsameinstance (Control)

 Evoral:ControlList

C‡: boost::shared_ptr< Evoral::ControlList >, boost::weak_ptr< Evoral::ControlList >

@@ -2327,6 +3541,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C boolisnil () LuaTable(double, ...)rt_safe_eval (double, bool&)

realtime safe version of eval, may fail if read-lock cannot be taken

where
absolute time in samples
ok
boolean reference if returned value is valid

Returns parameter value

+ boolsameinstance (ControlList) voidset_interpolation (InterpolationStyle)

set the interpolation style of the automation data

is
interpolation style
voidthin (double) @@ -2342,6 +3557,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C +
Methods
boolisnil ()
boolsameinstance (ControlSet)

 Evoral:Event

C‡: Evoral::Event<long>

@@ -2352,6 +3568,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C voidclear () voidset_buffer (unsigned int, unsigned char*, bool) unsigned intsize () + longtime ()

 Evoral:MidiEvent

C‡: Evoral::MIDIEvent<long>

@@ -2371,6 +3588,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C voidclear () voidset_buffer (unsigned int, unsigned char*, bool) unsigned intsize () + longtime ()

 Evoral:Parameter

C‡: Evoral::Parameter

@@ -2424,6 +3642,13 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C LuaTabletable () booltest (unsigned long) +

 PBD

+
+ + + + +
Methods
boolopen_uri (std::string)
boolopen_uri (std::string)

 PBD:Command

C‡: Command

is-a: PBD:StatefulDestructible

@@ -2442,6 +3667,20 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C IDid () OwnedPropertyListproperties () +

 PBD:Configuration

+

C‡: PBD::Configuration

+

is-a: PBD:Stateful

+
+

Base class for objects with saveable and undoable state

+

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

+

Inherited from PBD:Stateful

+ + + + + + +
Methods
voidclear_changes ()

Forget about any changes to this object's properties

IDid ()
OwnedPropertyListproperties ()

 PBD:Controllable

C‡: boost::shared_ptr< PBD::Controllable >, boost::weak_ptr< PBD::Controllable >

is-a: PBD:StatefulDestructiblePtr

@@ -2452,6 +3691,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C doubleget_value () boolisnil () std::stringname () + boolsameinstance (Controllable)

Inherited from PBD:StatefulPtr

@@ -2471,6 +3711,69 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
Methods
std::stringto_s ()
+

 PBD:IdVector

+

C‡: std::vector<PBD::ID >

+
+ + + + + + + + + + + +
Constructor
PBD.IdVector ()
Methods
LuaTableadd (LuaTable {ID})
IDat (unsigned long)
boolempty ()
LuaIteriter ()
voidpush_back (ID)
unsigned longsize ()
LuaTabletable ()
+

 PBD:RingBuffer8

+

C‡: PBD::RingBufferNPT<unsigned char>

+
+ + + + + + + + + + + + +
Constructor
PBD.RingBuffer8 (unsigned long)
Methods
voidincrement_read_ptr (unsigned long)
voidincrement_write_ptr (unsigned long)
unsigned longread (unsigned char*, unsigned long)
unsigned longread_space ()
voidreset ()
unsigned longwrite (unsigned char*, unsigned long)
unsigned longwrite_one (unsigned char)
unsigned longwrite_space ()
+

 PBD:RingBufferF

+

C‡: PBD::RingBufferNPT<float>

+
+ + + + + + + + + + + + +
Constructor
PBD.RingBufferF (unsigned long)
Methods
voidincrement_read_ptr (unsigned long)
voidincrement_write_ptr (unsigned long)
unsigned longread (FloatArray, unsigned long)
unsigned longread_space ()
voidreset ()
unsigned longwrite (FloatArray, unsigned long)
unsigned longwrite_one (float)
unsigned longwrite_space ()
+

 PBD:RingBufferI

+

C‡: PBD::RingBufferNPT<int>

+
+ + + + + + + + + + + + +
Constructor
PBD.RingBufferI (unsigned long)
Methods
voidincrement_read_ptr (unsigned long)
voidincrement_write_ptr (unsigned long)
unsigned longread (IntArray, unsigned long)
unsigned longread_space ()
voidreset ()
unsigned longwrite (IntArray, unsigned long)
unsigned longwrite_one (int)
unsigned longwrite_space ()

 PBD:Stateful

C‡: PBD::Stateful

@@ -2504,6 +3807,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C +
Methods
boolisnil ()
boolsameinstance (StatefulDestructible)

Inherited from PBD:StatefulPtr

@@ -2548,6 +3852,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C +
IDid ()
boolisnil ()
OwnedPropertyListproperties ()
boolsameinstance (Stateful)

 PBD:XMLNode

C‡: XMLNode

@@ -2564,6 +3869,170 @@ 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) +

 Vamp:Plugin

+

C‡: _VampPlugin::Vamp::Plugin

+

is-a: Vamp:PluginBase

+
+ + + + +
Methods
FeatureSetgetRemainingFeatures ()
FeatureSetprocess (--MISSING (float**)--, RealTime)
+

Inherited from Vamp:PluginBase

+ + + + + + + + + + + + + + + +
Methods
std::stringgetCopyright ()
std::stringgetCurrentProgram ()
std::stringgetDescription ()
std::stringgetIdentifier ()
std::stringgetMaker ()
std::stringgetName ()
floatgetParameter (std::string)
ParameterListgetParameterDescriptors ()
intgetPluginVersion ()
StringVectorgetPrograms ()
std::stringgetType ()
voidselectProgram (std::string)
voidsetParameter (std::string, float)
+

 Vamp:Plugin:Feature

+

C‡: _VampPlugin::Vamp::Plugin::Feature

+
+ + + + + + + + +
Data Members
Vamp:RealTimeduration
boolhasDuration
boolhasTimestamp
std::stringlabel
Vamp:RealTimetimestamp
C:FloatVectorvalues
+

 Vamp:Plugin:FeatureList

+

C‡: std::vector<_VampPlugin::Vamp::Plugin::Feature >

+
+ + + + + + + + + + + +
Constructor
Vamp.Plugin.FeatureList ()
Methods
LuaTableadd (LuaTable {Feature})
Featureat (unsigned long)
boolempty ()
LuaIteriter ()
voidpush_back (Feature)
unsigned longsize ()
LuaTabletable ()
+

 Vamp:Plugin:FeatureSet

+

C‡: std::map<int, std::vector<_VampPlugin::Vamp::Plugin::Feature > > > >

+
+ + + + + + + + + + + +
Constructor
Vamp.Plugin.FeatureSet ()
Methods
LuaTableadd (LuaTable {Feature})
voidclear ()
unsigned longcount (int)
boolempty ()
LuaIteriter ()
unsigned longsize ()
LuaTabletable ()
+

 Vamp:Plugin:OutputDescriptor

+

C‡: _VampPlugin::Vamp::Plugin::OutputDescriptor

+
+ + + + + + + + + + + + + + + + +
Data Members
unsigned longbinCount
C:StringVectorbinNames
std::stringdescription
boolhasDuration
boolhasFixedBinCount
boolhasKnownExtents
std::stringidentifier
boolisQuantized
floatmaxValue
floatminValue
floatquantizeStep
floatsampleRate
_VampPlugin.Vamp.Plugin.OutputDescriptor.SampleTypesampleType
std::stringunit
+

 Vamp:Plugin:OutputList

+

C‡: std::vector<_VampPlugin::Vamp::Plugin::OutputDescriptor >

+
+ + + + + + + + + + + +
Constructor
Vamp.Plugin.OutputList ()
Methods
LuaTableadd (LuaTable {OutputDescriptor})
OutputDescriptorat (unsigned long)
boolempty ()
LuaIteriter ()
voidpush_back (OutputDescriptor)
unsigned longsize ()
LuaTabletable ()
+

 Vamp:PluginBase

+

C‡: _VampPlugin::Vamp::PluginBase

+
+ + + + + + + + + + + + + + + +
Methods
std::stringgetCopyright ()
std::stringgetCurrentProgram ()
std::stringgetDescription ()
std::stringgetIdentifier ()
std::stringgetMaker ()
std::stringgetName ()
floatgetParameter (std::string)
ParameterListgetParameterDescriptors ()
intgetPluginVersion ()
StringVectorgetPrograms ()
std::stringgetType ()
voidselectProgram (std::string)
voidsetParameter (std::string, float)
+

 Vamp:PluginBase:ParameterDescriptor

+

C‡: _VampPlugin::Vamp::PluginBase::ParameterDescriptor

+
+ + + + + + + + + + + + +
Data Members
floatdefaultValue
std::stringdescription
std::stringidentifier
boolisQuantized
floatmaxValue
floatminValue
std::stringname
floatquantizeStep
std::stringunit
C:StringVectorvalueNames
+

 Vamp:PluginBase:ParameterList

+

C‡: std::vector<_VampPlugin::Vamp::PluginBase::ParameterDescriptor >

+
+ + + + + + + + + + + +
Constructor
Vamp.PluginBase.ParameterList ()
Methods
LuaTableadd (LuaTable {ParameterDescriptor})
ParameterDescriptorat (unsigned long)
boolempty ()
LuaIteriter ()
voidpush_back (ParameterDescriptor)
unsigned longsize ()
LuaTabletable ()
+

 Vamp:RealTime

+

C‡: _VampPlugin::Vamp::RealTime

+
+ + + + + + + +
Constructor
Vamp.RealTime (int, int)
Methods
intmsec ()
std::stringtoString ()
intusec ()

Enum/Constants

 PBD.Controllable.GroupControlDisposition

+

 Timecode.TimecodeFormat

+

 Evoral.ControlList.InterpolationStyle

+

 _VampPlugin.Vamp.Plugin.OutputDescriptor.SampleType

+

 ARDOUR.ChanMapping

+

 ARDOUR.PresentationInfo.Flag

+

 ARDOUR.AutoStyle

 ARDOUR.AutomationType

 ARDOUR.SrcQuality

+

 ARDOUR.MeterType

+ +

 ARDOUR.MeterPoint

+

 ARDOUR.PortFlags

+

 ARDOUR.PositionLockStyle

+ +

 ARDOUR.TempoSection.Type

+

 ARDOUR.TrackMode

+

 ARDOUR.SampleFormat

+ +

 ARDOUR.HeaderFormat

+ +

 ARDOUR.InsertMergePolicy

+

 ARDOUR.Session.RecordState

+

 Cairo.Format

+ +

 Pango.EllipsizeMode

+ +

 Pango.WrapMode

+

 LuaSignal.LuaSignal

 ArdourMarker.Type

- + -
Ardour 4.7-1385-gca8ac05  -  Tue, 31 May 2016 03:23:16 +0200
+
Ardour 5.4-3-g2607e15  -  Mon, 03 Oct 2016 04:29:09 +0200