X-Git-Url: http://shamusworld.gotdns.org/cgi-bin/gitweb.cgi?a=blobdiff_plain;ds=sidebyside;f=_manual%2F24_lua-scripting%2F02_class_reference.html;h=d5f530c5cc1d3a0c9beaff5f803196402431aa78;hb=7460a6641c2c3b4a51e3578492b3d73d6345305c;hp=e1df373ecd0124da23de5b77a4ed27e2520e5c06;hpb=440459fffa7b0c625c8150fb7fe7e550fd11deb2;p=ardour-manual diff --git a/_manual/24_lua-scripting/02_class_reference.html b/_manual/24_lua-scripting/02_class_reference.html index e1df373..d5f530c 100644 --- a/_manual/24_lua-scripting/02_class_reference.html +++ b/_manual/24_lua-scripting/02_class_reference.html @@ -135,6 +135,7 @@ 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

@@ -149,6 +150,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C +
PluginInsertto_insert ()
IOProcessorto_ioprocessor ()
MonitorProcessorto_monitorprocessor ()
PeakMeterto_peakmeter ()
SideChainto_sidechain ()
UnknownProcessorto_unknownprocessor ()
@@ -188,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).

@@ -267,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

@@ -274,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

@@ -336,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 >

@@ -345,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

@@ -381,6 +442,8 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C + + @@ -390,6 +453,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C + @@ -477,6 +541,7 @@ 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)

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 ()
Methods
AutomationControlautomation_control (Parameter, bool)
boolisnil ()
boolsameinstance (Automatable)

↠ ARDOUR:AutomationControl

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

@@ -491,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) @@ -523,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 () @@ -718,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

@@ -740,6 +808,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C +
PluginInsertto_insert ()
IOProcessorto_ioprocessor ()
MonitorProcessorto_monitorprocessor ()
PeakMeterto_peakmeter ()
SideChainto_sidechain ()
UnknownProcessorto_unknownprocessor ()
@@ -775,6 +844,22 @@ 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:SlavableAutomationControl,

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

Inherited from ARDOUR:SlavableAutomationControl,

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

Inherited from ARDOUR:SessionObject

@@ -868,6 +955,7 @@ 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

@@ -882,6 +970,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C +
PluginInsertto_insert ()
IOProcessorto_ioprocessor ()
MonitorProcessorto_monitorprocessor ()
PeakMeterto_peakmeter ()
SideChainto_sidechain ()
UnknownProcessorto_unknownprocessor ()
@@ -924,6 +1013,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C 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) @@ -969,6 +1059,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C 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

@@ -983,6 +1074,11 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
+ + + + + @@ -1008,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)

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

@@ -1094,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

@@ -1128,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

@@ -1164,6 +1279,8 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C + + @@ -1173,6 +1290,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C + @@ -1276,6 +1394,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C + @@ -1300,6 +1419,7 @@ 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)

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 ()
boolmonitor_active ()
boolmono ()
Controllablemono_control ()
boolsameinstance (MonitorProcessor)
voidset_cut (unsigned int, bool)
voidset_cut_all (bool)
voidset_dim (unsigned int, bool)
PluginInsertto_insert ()
IOProcessorto_ioprocessor ()
MonitorProcessorto_monitorprocessor ()
PeakMeterto_peakmeter ()
SideChainto_sidechain ()
UnknownProcessorto_unknownprocessor ()
@@ -1321,6 +1441,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C boolisnil () boolmuted () boolmuted_by_self () + boolsameinstance (MuteControl)

Inherited from ARDOUR:SlavableAutomationControl,

@@ -1394,6 +1515,44 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
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

@@ -1403,6 +1562,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C Methods boolinverted (unsigned int) boolisnil () + boolsameinstance (PhaseControl) voidset_phase_invert (unsigned int, bool)
c
Audio channel index.
yn
true to invert phase, otherwise false.
@@ -1470,11 +1630,14 @@ 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) + boolsameinstance (Playlist) 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

@@ -1492,6 +1655,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
+ @@ -1505,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

@@ -1522,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

@@ -1561,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 >

@@ -1576,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 () @@ -1592,6 +1771,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C PluginInsertto_insert () IOProcessorto_ioprocessor () MonitorProcessorto_monitorprocessor () + PeakMeterto_peakmeter () SideChainto_sidechain () UnknownProcessorto_unknownprocessor () @@ -1624,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 @@ -1687,6 +1868,7 @@ 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

@@ -1719,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

@@ -1731,12 +1928,14 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C voiddeactivate () std::stringdisplay_name () boolisnil () + boolsameinstance (Processor) Cast Ampto_amp () Automatableto_automatable () PluginInsertto_insert () IOProcessorto_ioprocessor () MonitorProcessorto_monitorprocessor () + PeakMeterto_peakmeter () SideChainto_sidechain () UnknownProcessorto_unknownprocessor () @@ -1748,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>

@@ -1775,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

@@ -1811,6 +2036,7 @@ 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.

@@ -1836,6 +2062,8 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C voidtrim_to (long, long, int) boolvideo_locked () boolwhole_file () + Cast + Readableto_readable ()

Inherited from ARDOUR:SessionObject

@@ -1905,6 +2133,8 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C + + @@ -1912,8 +2142,10 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C + + @@ -2040,11 +2272,13 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C + + @@ -2052,24 +2286,25 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C - + + - - + + @@ -2264,6 +2499,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C + @@ -2276,6 +2512,7 @@ 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 ()
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_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, 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, 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_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)
Methods
boolisnil ()
std::stringname ()
boolsameinstance (SessionObject)
Cast
Statefulto_stateful ()
StatefulDestructibleto_statefuldestructible ()
+
Methods
boolisnil ()
boolsameinstance (SideChain)

Inherited from ARDOUR:IOProcessor

@@ -2298,6 +2535,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C +
PluginInsertto_insert ()
IOProcessorto_ioprocessor ()
MonitorProcessorto_monitorprocessor ()
PeakMeterto_peakmeter ()
SideChainto_sidechain ()
UnknownProcessorto_unknownprocessor ()
@@ -2322,6 +2560,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C doubleget_masters_value () boolisnil () voidremove_master (AutomationControl) + boolsameinstance (SlavableAutomationControl,) boolslaved () boolslaved_to (AutomationControl) @@ -2365,6 +2604,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C Methods boolcan_solo () boolisnil () + boolsameinstance (SoloControl) boolself_soloed () boolsoloed () @@ -2418,6 +2658,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C +
Methods
boolisnil ()
boolsameinstance (SoloIsolateControl)
boolself_solo_isolated ()
boolsolo_isolated ()
@@ -2471,6 +2712,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C +
Methods
boolisnil ()
boolsameinstance (SoloSafeControl)
boolsolo_safe ()

Inherited from ARDOUR:SlavableAutomationControl,

@@ -2522,6 +2764,7 @@ 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 >

@@ -2565,6 +2808,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C 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) @@ -2641,6 +2885,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C boolcan_record () boolisnil () Playlistplaylist () + boolsameinstance (Track) boolset_name (std::string) Cast AudioTrackto_audio_track () @@ -2665,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) @@ -2674,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 () @@ -2745,6 +2993,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C +
Methods
boolisnil ()
boolsameinstance (UnknownProcessor)

Inherited from ARDOUR:Processor

@@ -2759,6 +3008,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C +
PluginInsertto_insert ()
IOProcessorto_ioprocessor ()
MonitorProcessorto_monitorprocessor ()
PeakMeterto_peakmeter ()
SideChainto_sidechain ()
UnknownProcessorto_unknownprocessor ()
@@ -2814,6 +3064,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C +
Methods
std::stringhttp_get (std::string)
ProcessorVectorprocessor_selection (--MISSING (lua_State*)--)

∁ ArdourUI:ArdourMarker

C‡: ArdourMarker

@@ -3062,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*

@@ -3255,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 >

@@ -3274,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) @@ -3289,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>

@@ -3422,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

@@ -3537,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

@@ -3581,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

@@ -3597,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

+

∈ _VampPlugin.Vamp.Plugin.OutputDescriptor.SampleType

+

∈ ARDOUR.ChanMapping