From 37f29da1a6d74ad6544e5c94ed6b01fd26c9a4b7 Mon Sep 17 00:00:00 2001 From: Robin Gareus Date: Thu, 10 Nov 2016 02:01:58 +0100 Subject: [PATCH] update lua class doc --- .../24_lua-scripting/02_class_reference.html | 290 ++++++++++++++++-- 1 file changed, 265 insertions(+), 25 deletions(-) diff --git a/_manual/24_lua-scripting/02_class_reference.html b/_manual/24_lua-scripting/02_class_reference.html index 2833668..2465fb5 100644 --- a/_manual/24_lua-scripting/02_class_reference.html +++ b/_manual/24_lua-scripting/02_class_reference.html @@ -144,11 +144,14 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C boolactive () voiddeactivate () std::stringdisplay_name () + ChanCountinput_streams () + ChanCountoutput_streams () Cast Ampto_amp () Automatableto_automatable () PluginInsertto_insert () IOProcessorto_ioprocessor () + PeakMeterto_meter () MonitorProcessorto_monitorprocessor () PeakMeterto_peakmeter () SideChainto_sidechain () @@ -258,8 +261,8 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C intdisconnect_port (Port) LuaTable(int, ...)get_backend_ports (std::string, DataType, PortFlags, StringVector&) LuaTable(int, ...)get_connections (std::string, StringVector&) - voidget_physical_inputs (DataType, StringVector&) - voidget_physical_outputs (DataType, StringVector&) + voidget_physical_inputs (DataType, StringVector&, --MISSING (ARDOUR::MidiPortFlags)--, --MISSING (ARDOUR::MidiPortFlags)--) + voidget_physical_outputs (DataType, StringVector&, --MISSING (ARDOUR::MidiPortFlags)--, --MISSING (ARDOUR::MidiPortFlags)--) Portget_port_by_name (std::string)
name
Full or short name of port

Returns Corresponding Port or 0.

LuaTable(int, ...)get_ports (DataType, PortList&) @@ -338,15 +341,13 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C

Inherited from ARDOUR:Port

- - + - - - + + + - @@ -393,11 +394,47 @@ 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().

Methods
intconnect (Port)
intconnect_by_name (std::string)
intconnect (std::string)
boolconnected ()

Returns true if this port is connected to anything

boolconnected_to (Port)
boolconnected_to_name (std::string)
intdisconnect (Port)
boolconnected_to (std::string)
o
Port name

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

intdisconnect (std::string)
intdisconnect_all ()
intdisconnect_by_name (std::string)
std::stringname ()

Returns Port short name

std::stringpretty_name (bool)
+ + + + + + + + + + +
Methods
std::stringcaptured_for ()
boolempty ()
boolisnil ()
boolisnil ()
longlength (long)
unsigned intn_channels ()
unsigned intn_channels ()
longread (FloatArray, long, long, int)
longreadable_length ()
longreadable_length ()
boolsameinstance (AudioSource)
boolsameinstance (AudioSource)
floatsample_rate ()
Cast
Readableto_readable ()
+

Inherited from ARDOUR:Source

+ + + + + + + + + + + + + + + +
Methods
std::stringancestor_name ()
boolcan_be_analysed ()
booldestructive ()
boolhas_been_analysed ()
longnatural_position ()
longtimeline_position ()
longtimestamp ()
intuse_count ()
boolused ()
boolwritable ()
Cast
AudioSourceto_audiosource ()
MidiSourceto_midisource ()
+

Inherited from ARDOUR:SessionObject

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

↠ ARDOUR:AudioTrack

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

is-a: ARDOUR:Track

@@ -435,6 +472,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C std::stringcomment () boolcustomize_plugin_insert (Processor, unsigned int, ChanCount, ChanCount)

enable custom plugin-insert configuration

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

Returns true if successful

+ IOinput () Deliverymain_outs ()

the signal processorat at end of the processing chain which produces output

boolmuted () @@ -443,6 +481,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) + IOoutput () + PannerShellpanner_shell () PeakMeterpeak_meter ()

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

intremove_processor (Processor, ProcessorStreams, bool) @@ -458,6 +498,8 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C boolset_strict_io (bool) boolsoloed () boolstrict_io () + Processorthe_instrument () +

Return the first processor that accepts has at least one MIDI input and at least one audio output. In the vast majority of cases, this will be "the instrument". This does not preclude other MIDI->audio processors later in the processing chain, but that would be a special case not covered by this utility function.

Amptrim () Cast Trackto_track () @@ -802,6 +844,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C +
Methods
boolisnil ()
PannerShellpanner_shell ()
boolsameinstance (Delivery)

Inherited from ARDOUR:IOProcessor

@@ -819,11 +862,14 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C boolactive () voiddeactivate () std::stringdisplay_name () + ChanCountinput_streams () + ChanCountoutput_streams () Cast Ampto_amp () Automatableto_automatable () PluginInsertto_insert () IOProcessorto_ioprocessor () + PeakMeterto_meter () MonitorProcessorto_monitorprocessor () PeakMeterto_peakmeter () SideChainto_sidechain () @@ -942,6 +988,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C AudioPortaudio (unsigned int) intconnect (Port, std::string, void*) intdisconnect (Port, std::string, void*) + intdisconnect_all (void*) boolhas_port (Port) boolisnil () MidiPortmidi (unsigned int) @@ -981,11 +1028,14 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C boolactive () voiddeactivate () std::stringdisplay_name () + ChanCountinput_streams () + ChanCountoutput_streams () Cast Ampto_amp () Automatableto_automatable () PluginInsertto_insert () IOProcessorto_ioprocessor () + PeakMeterto_meter () MonitorProcessorto_monitorprocessor () PeakMeterto_peakmeter () SideChainto_sidechain () @@ -1155,6 +1205,48 @@ 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:LuaProc

+

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

+

is-a: ARDOUR:Plugin

+
+

A plugin is an external module (usually 3rd party provided) loaded into Ardour for the purpose of digital signal processing.

This class provides an abstraction for methords provided by all supported plugin standards such as presets, name, parameters etc.

Plugins are not used directly in Ardour but always wrapped by a PluginInsert.

+ + + + + + +
Methods
boolisnil ()
boolsameinstance (LuaProc)
DspShmshmem ()
LuaTableReftable ()
+

Inherited from ARDOUR:Plugin

+ + + + + + + + + + + + + + + + + + + + +
Methods
IOPortDescriptiondescribe_io_port (DataType, bool, unsigned int)
std::stringget_docs ()
PluginInfoget_info ()
LuaTable(int, ...)get_parameter_descriptor (unsigned int, ParameterDescriptor&)
std::stringget_parameter_docs (unsigned int)
char*label ()
boolload_preset (PresetRecord)

Set parameters using a preset

char*maker ()
char*name ()
LuaTable(unsigned int, ...)nth_parameter (unsigned int, bool&)
unsigned intparameter_count ()
boolparameter_is_input (unsigned int)
PresetRecordpreset_by_label (std::string)
PresetRecordpreset_by_uri (std::string)
std::stringunique_id ()
Cast
LuaProcto_luaproc ()
+

Inherited from PBD:StatefulPtr

+ + + + + + +
Methods
voidclear_changes ()

Forget about any changes to this object's properties

IDid ()
OwnedPropertyListproperties ()

∁ ARDOUR:LuaTableRef

C‡: ARDOUR::LuaTableRef

@@ -1358,15 +1450,13 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C

Inherited from ARDOUR:Port

- - + - - - + + + - @@ -1389,9 +1479,11 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C + +
Methods
intconnect (Port)
intconnect_by_name (std::string)
intconnect (std::string)
boolconnected ()

Returns true if this port is connected to anything

boolconnected_to (Port)
boolconnected_to_name (std::string)
intdisconnect (Port)
boolconnected_to (std::string)
o
Port name

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

intdisconnect (std::string)
intdisconnect_all ()
intdisconnect_by_name (std::string)
std::stringname ()

Returns Port short name

std::stringpretty_name (bool)
booldo_export (std::string)

Export the MIDI data of the MidiRegion to a new MIDI file (SMF).

boolisnil ()
doublelength_beats ()
MidiSourcemidi_source (unsigned int)
MidiModelmodel ()
boolsameinstance (MidiRegion)
doublestart_beats ()

Inherited from ARDOUR:Region

@@ -1414,14 +1506,18 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C + + + + @@ -1438,6 +1534,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C + @@ -1474,6 +1571,31 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
boollocked ()
voidlower ()
voidlower_to_bottom ()
StringVectormaster_source_names ()
SourceListmaster_sources ()
voidmove_start (long, int)
voidmove_to_natural_position ()
boolmuted ()
unsigned intn_channels ()
voidnudge_position (long)
boolopaque ()
longposition ()

How the region parameters play together:

POSITION: first frame of the region along the timeline START: first frame of the region within its source(s) LENGTH: number of frames the region represents

boolposition_locked ()
doublepulse ()
voidraise ()
voidraise_to_top ()
voidset_hidden (bool)

Set the region's sync point.

absolute_pos
Session time.
voidset_video_locked (bool)
floatshift ()
Sourcesource (unsigned int)
longstart ()
floatstretch ()
boolsync_marked ()
MidiModelmodel ()
boolsameinstance (MidiSource)
+

Inherited from ARDOUR:Source

+ + + + + + + + + + + + + + + +
Methods
std::stringancestor_name ()
boolcan_be_analysed ()
booldestructive ()
boolhas_been_analysed ()
longnatural_position ()
longtimeline_position ()
longtimestamp ()
intuse_count ()
boolused ()
boolwritable ()
Cast
AudioSourceto_audiosource ()
MidiSourceto_midisource ()
+

Inherited from ARDOUR:SessionObject

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

↠ ARDOUR:MidiTrack

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

is-a: ARDOUR:Track

@@ -1511,6 +1633,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C std::stringcomment () boolcustomize_plugin_insert (Processor, unsigned int, ChanCount, ChanCount)

enable custom plugin-insert configuration

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

Returns true if successful

+ IOinput () Deliverymain_outs ()

the signal processorat at end of the processing chain which produces output

boolmuted () @@ -1519,6 +1642,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) + IOoutput () + PannerShellpanner_shell () PeakMeterpeak_meter ()

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

intremove_processor (Processor, ProcessorStreams, bool) @@ -1534,6 +1659,8 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C boolset_strict_io (bool) boolsoloed () boolstrict_io () + Processorthe_instrument () +

Return the first processor that accepts has at least one MIDI input and at least one audio output. In the vast majority of cases, this will be "the instrument". This does not preclude other MIDI->audio processors later in the processing chain, but that would be a special case not covered by this utility function.

Amptrim () Cast Trackto_track () @@ -1653,11 +1780,14 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C boolactive () voiddeactivate () std::stringdisplay_name () + ChanCountinput_streams () + ChanCountoutput_streams () Cast Ampto_amp () Automatableto_automatable () PluginInsertto_insert () IOProcessorto_ioprocessor () + PeakMeterto_meter () MonitorProcessorto_monitorprocessor () PeakMeterto_peakmeter () SideChainto_sidechain () @@ -1731,6 +1861,26 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C

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

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

+

↠ ARDOUR:PannerShell

+

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

+

is-a: ARDOUR:SessionObject

+
+

Class to manage panning by instantiating and controlling an appropriate Panner object for a given in/out configuration.

+ + + + + + +
Methods
boolbypassed ()
boolisnil ()
boolsameinstance (PannerShell)
voidset_bypassed (bool)
+

Inherited from ARDOUR:SessionObject

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

∁ ARDOUR:ParameterDescriptor

C‡: ARDOUR::ParameterDescriptor

is-a: Evoral:ParameterDescriptor

@@ -1779,11 +1929,14 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C boolactive () voiddeactivate () std::stringdisplay_name () + ChanCountinput_streams () + ChanCountoutput_streams () Cast Ampto_amp () Automatableto_automatable () PluginInsertto_insert () IOProcessorto_ioprocessor () + PeakMeterto_meter () MonitorProcessorto_monitorprocessor () PeakMeterto_peakmeter () SideChainto_sidechain () @@ -1899,6 +2052,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C

A plugin is an external module (usually 3rd party provided) loaded into Ardour for the purpose of digital signal processing.

This class provides an abstraction for methords provided by all supported plugin standards such as presets, name, parameters etc.

Plugins are not used directly in Ardour but always wrapped by a PluginInsert.

+ @@ -1915,6 +2069,9 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C + + +
Methods
IOPortDescriptiondescribe_io_port (DataType, bool, unsigned int)
std::stringget_docs ()
PluginInfoget_info ()
LuaTable(int, ...)get_parameter_descriptor (unsigned int, ParameterDescriptor&)
PresetRecordpreset_by_label (std::string)
PresetRecordpreset_by_uri (std::string)
boolsameinstance (Plugin)
std::stringunique_id ()
Cast
LuaProcto_luaproc ()

Inherited from PBD:StatefulPtr

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

∁ ARDOUR:Plugin:IOPortDescription

+

C‡: ARDOUR::Plugin::IOPortDescription

+
+ + + + + + +
Data Members
unsigned intgroup_channel
std::stringgroup_name
boolis_sidechain
std::stringname

↠ ARDOUR:PluginControl

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

is-a: ARDOUR:AutomationControl

@@ -1997,12 +2164,13 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C voiddeactivate () ChanMappinginput_map (unsigned int) boolisnil () + ChanCountnatural_input_streams () + ChanCountnatural_output_streams () ChanMappingoutput_map (unsigned int) Pluginplugin (unsigned int) boolsameinstance (PluginInsert) voidset_input_map (unsigned int, ChanMapping) voidset_output_map (unsigned int, ChanMapping) - IOsidechain_input () boolstrict_io_configured ()

Inherited from ARDOUR:Processor

@@ -2010,11 +2178,14 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C Methods boolactive () std::stringdisplay_name () + ChanCountinput_streams () + ChanCountoutput_streams () Cast Ampto_amp () Automatableto_automatable () PluginInsertto_insert () IOProcessorto_ioprocessor () + PeakMeterto_meter () MonitorProcessorto_monitorprocessor () PeakMeterto_peakmeter () SideChainto_sidechain () @@ -2033,15 +2204,13 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
- - + - - - + + + - @@ -2085,8 +2254,8 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C - - + + @@ -2172,13 +2341,16 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C + + + @@ -2271,14 +2443,18 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C + + + + @@ -2296,6 +2472,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C + @@ -2370,6 +2547,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C + @@ -2379,6 +2557,8 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C + + @@ -2396,6 +2576,8 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C + + @@ -2775,11 +2957,14 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C + + + @@ -3005,12 +3190,51 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
Methods
intconnect (Port)
intconnect_by_name (std::string)
intconnect (std::string)
boolconnected ()

Returns true if this port is connected to anything

boolconnected_to (Port)
boolconnected_to_name (std::string)
intdisconnect (Port)
boolconnected_to (std::string)
o
Port name

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

intdisconnect (std::string)
intdisconnect_all ()
intdisconnect_by_name (std::string)
boolisnil ()
std::stringname ()

Returns Port short name

intdisconnect_port (Port)
LuaTable(int, ...)get_backend_ports (std::string, DataType, PortFlags, StringVector&)
LuaTable(int, ...)get_connections (std::string, StringVector&)
voidget_physical_inputs (DataType, StringVector&)
voidget_physical_outputs (DataType, StringVector&)
voidget_physical_inputs (DataType, StringVector&, --MISSING (ARDOUR::MidiPortFlags)--, --MISSING (ARDOUR::MidiPortFlags)--)
voidget_physical_outputs (DataType, StringVector&, --MISSING (ARDOUR::MidiPortFlags)--, --MISSING (ARDOUR::MidiPortFlags)--)
Portget_port_by_name (std::string)
name
Full or short name of port

Returns Corresponding Port or 0.

LuaTable(int, ...)get_ports (DataType, PortList&)
boolactive ()
voiddeactivate ()
std::stringdisplay_name ()
ChanCountinput_streams ()
boolisnil ()
ChanCountoutput_streams ()
boolsameinstance (Processor)
Cast
Ampto_amp ()
Automatableto_automatable ()
PluginInsertto_insert ()
IOProcessorto_ioprocessor ()
PeakMeterto_meter ()
MonitorProcessorto_monitorprocessor ()
PeakMeterto_peakmeter ()
SideChainto_sidechain ()
boollocked ()
voidlower ()
voidlower_to_bottom ()
StringVectormaster_source_names ()
SourceListmaster_sources ()
voidmove_start (long, int)
voidmove_to_natural_position ()
boolmuted ()
unsigned intn_channels ()
voidnudge_position (long)
boolopaque ()
longposition ()

How the region parameters play together:

POSITION: first frame of the region along the timeline START: first frame of the region within its source(s) LENGTH: number of frames the region represents

boolposition_locked ()
doublepulse ()
voidraise ()
voidraise_to_top ()
boolsameinstance (Region)

Set the region's sync point.

absolute_pos
Session time.
voidset_video_locked (bool)
floatshift ()
Sourcesource (unsigned int)
longstart ()
floatstretch ()
boolsync_marked ()
std::stringcomment ()
boolcustomize_plugin_insert (Processor, unsigned int, ChanCount, ChanCount)

enable custom plugin-insert configuration

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

Returns true if successful

IOinput ()
boolisnil ()
Deliverymain_outs ()

the signal processorat at end of the processing chain which produces output

Processornth_plugin (unsigned int)
Processornth_processor (unsigned int)
Processornth_send (unsigned int)
IOoutput ()
PannerShellpanner_shell ()
PeakMeterpeak_meter ()

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

intremove_processor (Processor, ProcessorStreams, bool)
boolset_strict_io (bool)
boolsoloed ()
boolstrict_io ()
Processorthe_instrument ()

Return the first processor that accepts has at least one MIDI input and at least one audio output. In the vast majority of cases, this will be "the instrument". This does not preclude other MIDI->audio processors later in the processing chain, but that would be a special case not covered by this utility function.

Amptrim ()
Cast
Trackto_track ()
boolactive ()
voiddeactivate ()
std::stringdisplay_name ()
ChanCountinput_streams ()
ChanCountoutput_streams ()
Cast
Ampto_amp ()
Automatableto_automatable ()
PluginInsertto_insert ()
IOProcessorto_ioprocessor ()
PeakMeterto_meter ()
MonitorProcessorto_monitorprocessor ()
PeakMeterto_peakmeter ()
SideChainto_sidechain ()

↠ ARDOUR:Source

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

+

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
std::stringancestor_name ()
boolcan_be_analysed ()
booldestructive ()
boolempty ()
boolhas_been_analysed ()
boolisnil ()
longlength (long)
longnatural_position ()
boolsameinstance (Source)
longtimeline_position ()
longtimestamp ()
intuse_count ()
boolused ()
boolwritable ()
Cast
AudioSourceto_audiosource ()
MidiSourceto_midisource ()
+

Inherited from ARDOUR:SessionObject

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

∁ ARDOUR:SourceList

+

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

+
+ + + + + + + + + + +
Constructor
ℂARDOUR.SourceList ()
Methods
LuaTableadd (LuaTable {Source})
Sourceat (unsigned long)
boolempty ()
LuaIteriter ()
voidpush_back (Source)
unsigned longsize ()
LuaTabletable ()

↠ ARDOUR:Stripable

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

@@ -3151,6 +3375,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C std::stringcomment () boolcustomize_plugin_insert (Processor, unsigned int, ChanCount, ChanCount)

enable custom plugin-insert configuration

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

Returns true if successful

+ IOinput () Deliverymain_outs ()

the signal processorat at end of the processing chain which produces output

boolmuted () @@ -3159,6 +3384,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) + IOoutput () + PannerShellpanner_shell () PeakMeterpeak_meter ()

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

intremove_processor (Processor, ProcessorStreams, bool) @@ -3174,6 +3401,8 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C boolset_strict_io (bool) boolsoloed () boolstrict_io () + Processorthe_instrument () +

Return the first processor that accepts has at least one MIDI input and at least one audio output. In the vast majority of cases, this will be "the instrument". This does not preclude other MIDI->audio processors later in the processing chain, but that would be a special case not covered by this utility function.

Amptrim () Cast Trackto_track () @@ -3251,11 +3480,14 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C boolactive () voiddeactivate () std::stringdisplay_name () + ChanCountinput_streams () + ChanCountoutput_streams () Cast Ampto_amp () Automatableto_automatable () PluginInsertto_insert () IOProcessorto_ioprocessor () + PeakMeterto_meter () MonitorProcessorto_monitorprocessor () PeakMeterto_peakmeter () SideChainto_sidechain () @@ -4463,6 +4695,10 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
  • ARDOUR.Properties.Length
  • ARDOUR.Properties.Position
    • +

    ∈ ARDOUR.PresentationInfo

    +

    ∈ ARDOUR.PluginType

    - + -
    Ardour 5.4-66-g40a57f2  -  Sat, 08 Oct 2016 01:49:55 +0200
    +
    Ardour 5.4-270-gd253d49  -  Thu, 10 Nov 2016 02:00:45 +0100
    -- 2.37.2