From: Robin Gareus Date: Sun, 10 Apr 2016 21:35:52 +0000 (+0200) Subject: update lua class reference, yet again. X-Git-Url: http://shamusworld.gotdns.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=804840431d3e10912cbe652a4a64f4aadcb6ef90;p=ardour-manual-diverged update lua class reference, yet again. --- diff --git a/_manual/24_lua-scripting/02_class_reference.html b/_manual/24_lua-scripting/02_class_reference.html index 67803b5..b3e99b3 100644 --- a/_manual/24_lua-scripting/02_class_reference.html +++ b/_manual/24_lua-scripting/02_class_reference.html @@ -120,6 +120,29 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C

Class Documentation

+

↠ ARDOUR:Amp

+

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

+

is-a: ARDOUR:Processor

+
+ + + + +
Methods
GainControlgain_control ()
boolisnil ()
+

Inherited from ARDOUR:Processor

+ + + + + + + + + + + + +
Methods
voidactivate ()
boolactive ()
AutomationControlautomation_control (Parameter, bool)
Controlcontrol (Parameter, bool)
voiddeactivate ()
std::stringdisplay_name ()
PluginInsertto_insert ()
IOProcessorto_ioprocessor ()
SessionObjectto_sessionobject ()
SideChainto_sidechain ()

↠ ARDOUR:AudioBackend

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

@@ -203,6 +226,62 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C intstart (bool) intstop (bool) +

↠ ARDOUR:AudioPort

+

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

+

is-a: ARDOUR:Port

+
+ + + +
Methods
boolisnil ()
+

Inherited from ARDOUR:Port

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

Returns true if this port is connected to anything

boolconnected_to (Port)
boolconnected_to_name (std::string)
intdisconnect (Port)
intdisconnect_all ()
intdisconnect_by_name (std::string)
std::stringname ()

Returns Port short name

std::stringpretty_name (bool)

Returns Port human readable name

boolreceives_input ()

Returns true if this Port receives input, otherwise false

boolsends_output ()

Returns true if this Port sends output, otherwise false

+

∁ ARDOUR:AudioRange

+

C‡: ARDOUR::AudioRange

+
+ + + + + + + + + + +
Constructor
ℂARDOUR.AudioRange (long, long, unsigned int)
Methods
boolequal (AudioRange)
longlength ()
Data Members
longend
unsigned intid
longstart
+

∁ ARDOUR:AudioRangeList

+

C‡: std::list<ARDOUR::AudioRange >

+
+ + + + + + + + + +
Constructor
ℂARDOUR.AudioRangeList ()
Methods
boolempty ()
LuaIteriter ()
voidreverse ()
unsigned longsize ()
LuaTabletable ()

↠ ARDOUR:AudioSource

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

is-a: ARDOUR:Source

@@ -224,12 +303,18 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C

Inherited from ARDOUR:Track

+ + + + + +
Methods
Regionbounce (long, long, InterThreadInfo&, Processor, bool)
Regionbounce_range (long, long, InterThreadInfo&, Processor, bool)
boolbounceable (Processor, bool)
boolcan_record ()
Playlistplaylist ()
boolrecord_enabled ()
boolrecord_safe ()
boolset_name (std::string)
voidset_record_enabled (bool, GroupControlDisposition)
voidset_record_safe (bool, GroupControlDisposition)
AudioTrackto_audio_track ()
MidiTrackto_midi_track ()

Inherited from ARDOUR:Route

@@ -237,8 +322,11 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C + + + @@ -249,16 +337,23 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C + + +
boolactive ()
intadd_processor_by_index (Processor, int, ProcessorStreams, bool)
booladd_sidechain (Processor)
Ampamp ()
std::stringcomment ()
boolcustomize_plugin_insert (Processor, unsigned int, ChanCount)
Deliverymain_outs ()
boolmuted ()
ChanCountn_inputs ()
ChanCountn_outputs ()
Processornth_plugin (unsigned int)
voidset_active (bool, void*)
voidset_comment (std::string, void*)
boolset_strict_io (bool)
boolsoloed ()
boolstrict_io ()
Trackto_track ()
Amptrim ()

Inherited from ARDOUR:SessionObject

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

Inherited from PBD:StatefulPtr

+ +
Methods
voidclear_changes ()

Forget about any changes to this object's properties

OwnedPropertyListproperties ()

∁ ARDOUR:AudioTrackList

@@ -292,15 +387,19 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
+ + + +
Methods
AutomationListalist ()
AutoStateautomation_state ()
AutoStyleautomation_style ()
doubleget_value ()

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

boolisnil ()
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)
Controlto_ctrl ()
boolwritable ()

Inherited from Evoral:Control

@@ -308,6 +407,21 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C Methods ControlListlist () +

↠ ARDOUR:AutomationList

+

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

+
+ + + + + + + + + + + +
Methods
XMLNodeget_state ()
boolisnil ()
ControlListlist ()
Commandmemento_command (XMLNode, XMLNode)
Statefulto_stateful ()
StatefulDestructibleto_statefuldestructible ()
booltouch_enabled ()
booltouching ()
boolwriting ()

∁ ARDOUR:BackendVector

C‡: std::vector<ARDOUR::AudioBackendInfo const* >

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

convenience contructor for DataType::MIDI

Returns DataType::MIDI

DataTypenull ()

convenience contructor for DataType::NIL

Returns DataType::NIL

+ char*to_string () +

Inverse of the from-string constructor

+ +

↠ ARDOUR:Delivery

+

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

+

is-a: ARDOUR:IOProcessor

+
+ + +
Methods
boolisnil ()
+

Inherited from ARDOUR:IOProcessor

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

Inherited from ARDOUR:Processor

+ + + + + + + + + + + + +
Methods
voidactivate ()
boolactive ()
AutomationControlautomation_control (Parameter, bool)
Controlcontrol (Parameter, bool)
voiddeactivate ()
std::stringdisplay_name ()
PluginInsertto_insert ()
IOProcessorto_ioprocessor ()
SessionObjectto_sessionobject ()
SideChainto_sidechain ()

∁ ARDOUR:DeviceStatus

C‡: ARDOUR::AudioBackend::DeviceStatus

@@ -482,6 +628,36 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C unsigned longsize () LuaTabletable () +

↠ ARDOUR:GainControl

+

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

+

is-a: ARDOUR:AutomationControl

+
+ + + +
Methods
boolisnil ()
+

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)
Controlto_ctrl ()
boolwritable ()
+

Inherited from Evoral:Control

+ + + +
Methods
ControlListlist ()

↠ ARDOUR:IO

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

is-a: ARDOUR:SessionObject

@@ -491,20 +667,30 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C boolactive () intadd_port (std::string, void*, DataType)

Add a port.

destination
Name of port to connect new port to.
src
Source for emitted ConfigurationChanged signal.
type
Data type of port. Default value (NIL) will use this IO's default type.
- intconnect (--MISSING (boost::shared_ptr<ARDOUR::Port>)--, std::string, void*) - intdisconnect (--MISSING (boost::shared_ptr<ARDOUR::Port>)--, std::string, void*) + AudioPortaudio (unsigned int) + intconnect (Port, std::string, void*) + intdisconnect (Port, std::string, void*) + boolhas_port (Port) boolisnil () + MidiPortmidi (unsigned int) + ChanCountn_ports () + Portnth (unsigned int) boolphysically_connected () - intremove_port (--MISSING (boost::shared_ptr<ARDOUR::Port>)--, void*) + Portport_by_name (unsigned int) + intremove_port (Port, void*)

Inherited from ARDOUR:SessionObject

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

Inherited from PBD:StatefulPtr

+ +
Methods
voidclear_changes ()

Forget about any changes to this object's properties

OwnedPropertyListproperties ()

↠ ARDOUR:IOProcessor

@@ -530,30 +716,37 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C std::stringdisplay_name () PluginInsertto_insert () IOProcessorto_ioprocessor () + SessionObjectto_sessionobject () SideChainto_sidechain () -

Inherited from ARDOUR:SessionObject

- - - -
Methods
std::stringname ()
-

Inherited from PBD:StatefulPtr

+

∁ ARDOUR:InterThreadInfo

+

C‡: ARDOUR::InterThreadInfo

+
- - -
Methods
OwnedPropertyListproperties ()
+ Constructor + ℂARDOUR.InterThreadInfo () + Data Members + boolcancel + booldone + floatprogress +

∁ ARDOUR:Location

-

C‡: ARDOUR::Location

+

C‡: ARDOUR::Locations

is-a: PBD:StatefulDestructible

-

Location on Timeline - abstract representation for Markers, Loop/Punch Ranges, CD-Markers etc.

+

Base class for objects with saveable and undoable state with destruction notification

+ + + + + @@ -564,8 +757,23 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C

Inherited from PBD:Stateful

Methods
Locationauto_loop_location ()
Locationauto_punch_location ()
longend ()
longfirst_mark_after (long, bool)
longfirst_mark_after (long, bool)
longlength ()
voidlock ()
boollocked ()
intmove_to (long)
Locationsession_range_location ()
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)
+ +
Methods
voidclear_changes ()

Forget about any changes to this object's properties

OwnedPropertyListproperties ()
+

∁ ARDOUR:LocationList

+

C‡: std::list<ARDOUR::Location* >

+
+ + + + + + + + + +
Constructor
ℂARDOUR.LocationList ()
Methods
boolempty ()
LuaIteriter ()
voidreverse ()
unsigned longsize ()
LuaTabletable ()

ℕ ARDOUR.LuaAPI

@@ -576,10 +784,22 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C + + + +

create a new Plugin Instance

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

Returns Processor or nil

PluginInfonew_plugin_info (std::string, PluginType)

search a Plugin

id
Plugin Name, ID or URI
type
Plugin Type

Returns PluginInfo or nil if not found

Processornil_proc ()
LuaTableplugin_automation ()

A convenience function to get a Automation Lists and ParamaterDescriptor for a given plugin control.

This is equivalent to the following lua code 

 function (processor, param_id)
+ 	local plugininsert = processor:to_insert ()
+ 	local plugin = plugininsert:plugin(0)
+  local _, t = plugin:get_parameter_descriptor(param_id, ARDOUR.ParameterDescriptor ())
+  local ctrl = Evoral.Parameter (ARDOUR.AutomationType.PluginAutomation, 0, param_id)
+  local ac = pi:automation_control (ctrl, false)
+  local acl = ac:alist()
+  return ac:alist(), ac:to_ctrl():list(), t[2]
+ end

Example usage: get 3rd input parameter of first plugin on the given route (Ardour starts counting at zero). 

 local al, cl, pd = ARDOUR.LuaAPI.plugin_automation (route:nth_plugin (0), 3)

Returns 3 parameters: AutomationList, ControlList, ParamaterDescriptor

boolset_plugin_insert_param (PluginInsert, unsigned int, float)

set a plugin control-input parameter value

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

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

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

boolset_processor_param (Processor, unsigned int, float)

set a plugin control-input parameter value

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

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

voidusleep (unsigned long)

∁ ARDOUR:LuaOSC:Address

C‡: ARDOUR::LuaOSC::Address

@@ -616,6 +836,37 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C voidsilence (long, long)

Clear (eg zero, or empty) buffer

+

↠ ARDOUR:MidiPort

+

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

+

is-a: ARDOUR:Port

+
+ + + + + +
Methods
boolinput_active ()
boolisnil ()
voidset_input_active (bool)
+

Inherited from ARDOUR:Port

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

Returns true if this port is connected to anything

boolconnected_to (Port)
boolconnected_to_name (std::string)
intdisconnect (Port)
intdisconnect_all ()
intdisconnect_by_name (std::string)
std::stringname ()

Returns Port short name

std::stringpretty_name (bool)

Returns Port human readable name

boolreceives_input ()

Returns true if this Port receives input, otherwise false

boolsends_output ()

Returns true if this Port sends output, otherwise false

↠ ARDOUR:MidiTrack

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

is-a: ARDOUR:Track

@@ -627,12 +878,18 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C

Inherited from ARDOUR:Track

+ + + + + +
Methods
Regionbounce (long, long, InterThreadInfo&, Processor, bool)
Regionbounce_range (long, long, InterThreadInfo&, Processor, bool)
boolbounceable (Processor, bool)
boolcan_record ()
Playlistplaylist ()
boolrecord_enabled ()
boolrecord_safe ()
boolset_name (std::string)
voidset_record_enabled (bool, GroupControlDisposition)
voidset_record_safe (bool, GroupControlDisposition)
AudioTrackto_audio_track ()
MidiTrackto_midi_track ()

Inherited from ARDOUR:Route

@@ -640,8 +897,11 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C + + + @@ -652,16 +912,23 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C + + +
boolactive ()
intadd_processor_by_index (Processor, int, ProcessorStreams, bool)
booladd_sidechain (Processor)
Ampamp ()
std::stringcomment ()
boolcustomize_plugin_insert (Processor, unsigned int, ChanCount)
Deliverymain_outs ()
boolmuted ()
ChanCountn_inputs ()
ChanCountn_outputs ()
Processornth_plugin (unsigned int)
voidset_active (bool, void*)
voidset_comment (std::string, void*)
boolset_strict_io (bool)
boolsoloed ()
boolstrict_io ()
Trackto_track ()
Amptrim ()

Inherited from ARDOUR:SessionObject

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

Inherited from PBD:StatefulPtr

+ +
Methods
voidclear_changes ()

Forget about any changes to this object's properties

OwnedPropertyListproperties ()

∁ ARDOUR:MidiTrackList

@@ -708,6 +975,55 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C booltoggled floatupper +

↠ ARDOUR:Playlist

+

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

+

is-a: ARDOUR:SessionObject

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Methods
voidadd_region (Region, long, float, bool)
Regioncombine (RegionList)
unsigned intcount_regions_at (long)
Playlistcut (AudioRangeList&, bool)
DataTypedata_type ()
voidduplicate (Region, long, long, float)
voidduplicate_range (AudioRange&, float)
voidduplicate_until (Region, long, long, long)
Regionfind_next_region (long, RegionPoint, int)
longfind_next_region_boundary (long, int)
boolisnil ()
voidlower_region (Region)
voidlower_region_to_bottom (Region)
unsigned intn_regions ()
voidraise_region (Region)
voidraise_region_to_top (Region)
Regionregion_by_id (ID)
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)
Regiontop_region_at (long)
Regiontop_unmuted_region_at (long)
voiduncombine (Region)
+

Inherited from ARDOUR:SessionObject

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

Inherited from PBD:StatefulPtr

+ + + + + +
Methods
voidclear_changes ()

Forget about any changes to this object's properties

OwnedPropertyListproperties ()

↠ ARDOUR:Plugin

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

is-a: PBD:StatefulDestructiblePtr

@@ -732,6 +1048,8 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C

Inherited from PBD:StatefulPtr

+ +
Methods
voidclear_changes ()

Forget about any changes to this object's properties

OwnedPropertyListproperties ()

↠ ARDOUR:PluginControl

@@ -745,14 +1063,18 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C

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

Inherited from Evoral:Control

@@ -794,18 +1116,49 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C std::stringdisplay_name () PluginInsertto_insert () IOProcessorto_ioprocessor () + SessionObjectto_sessionobject () SideChainto_sidechain () -

Inherited from ARDOUR:SessionObject

+

↠ ARDOUR:Port

+

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

+
- -
Methods
std::stringname ()
-

Inherited from PBD:StatefulPtr

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

Returns true if this port is connected to anything

+ boolconnected_to (Port) + boolconnected_to_name (std::string) + intdisconnect (Port) + intdisconnect_all () + intdisconnect_by_name (std::string) + boolisnil () + std::stringname () +

Returns Port short name

+ std::stringpretty_name (bool) +

Returns Port human readable name

+ boolreceives_input () +

Returns true if this Port receives input, otherwise false

+ boolsends_output () +

Returns true if this Port sends output, otherwise false

+ +

↠ ARDOUR:PortSet

+

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

+
- -
Methods
OwnedPropertyListproperties ()
+ voidadd (Port) + voidclear () +

Remove all ports from the PortSet. Ports are not deregistered with the engine, it's the caller's responsibility to not leak here!

+ boolcontains (Port) + boolempty () + boolisnil () + unsigned longnum_ports (DataType) + Portport (DataType, unsigned long) +

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

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

∁ ARDOUR:PresetRecord

C‡: ARDOUR::Plugin::PresetRecord

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

↠ ARDOUR:Processor

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

-

is-a: ARDOUR:Automatable, ARDOUR:SessionObject

+

is-a: ARDOUR:Automatable

@@ -829,21 +1182,11 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C - +
Methods
voiddeactivate ()
std::stringdisplay_name ()
boolisnil ()
boolisnil ()
PluginInsertto_insert ()
IOProcessorto_ioprocessor ()
SessionObjectto_sessionobject ()
SideChainto_sidechain ()
-

Inherited from ARDOUR:SessionObject

- - - -
Methods
std::stringname ()
-

Inherited from PBD:StatefulPtr

- - - -
Methods
OwnedPropertyListproperties ()

∅ ARDOUR:Properties:BoolProperty

C‡: PBD::PropertyDescriptor<bool>

@@ -938,10 +1281,14 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C + +
Methods
std::stringname ()
Statefulto_stateful ()
StatefulDestructibleto_statefuldestructible ()

Inherited from PBD:StatefulPtr

+ +
Methods
voidclear_changes ()

Forget about any changes to this object's properties

OwnedPropertyListproperties ()

∁ ARDOUR:RegionFactory

@@ -951,6 +1298,35 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C Methods Regionregion_by_id (ID) +

∁ ARDOUR:RegionList

+

C‡: std::list<boost::shared_ptr<ARDOUR::Region> >

+
+ + + + + + + + + +
Constructor
ℂARDOUR.RegionList ()
Methods
boolempty ()
LuaIteriter ()
voidreverse ()
unsigned longsize ()
LuaTabletable ()
+

∁ ARDOUR:RegionListPtr

+

C‡: boost::shared_ptr<std::list<boost::shared_ptr<ARDOUR::Region> > >

+
+ + + + + + + + + + + + +
Constructor
ℂARDOUR.RegionListPtr ()
Methods
LuaTableadd (LuaTable {Region})
boolempty ()
LuaIteriter ()
voidpush_back (Region)
voidreverse ()
unsigned longsize ()
LuaTabletable ()
voidunique ()

↠ ARDOUR:Route

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

is-a: ARDOUR:SessionObject

@@ -960,9 +1336,12 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C boolactive () intadd_processor_by_index (Processor, int, ProcessorStreams, bool) booladd_sidechain (Processor) + Ampamp () std::stringcomment () boolcustomize_plugin_insert (Processor, unsigned int, ChanCount) boolisnil () + Deliverymain_outs () + boolmuted () ChanCountn_inputs () ChanCountn_outputs () Processornth_plugin (unsigned int) @@ -974,16 +1353,23 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C voidset_comment (std::string, void*) boolset_name (std::string) boolset_strict_io (bool) + boolsoloed () boolstrict_io () + Trackto_track () + Amptrim ()

Inherited from ARDOUR:SessionObject

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

Inherited from PBD:StatefulPtr

+ +
Methods
voidclear_changes ()

Forget about any changes to this object's properties

OwnedPropertyListproperties ()

∁ ARDOUR:Route:ProcessorStreams

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

Ardour Session

+ + + + + @@ -1043,6 +1434,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C + @@ -1080,10 +1472,14 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C + +
Methods
voidabort_reversible_command ()
boolactively_recording ()
voidadd_command (Command)
StatefulDiffCommandadd_stateful_diff_command (StatefulDestructiblePtr)
voidbegin_reversible_command (std::string)
voidcommit_reversible_command (Command)
Controllablecontrollable_by_id (ID)
longcurrent_end_frame ()
longcurrent_start_frame ()
voidgoto_end ()
voidgoto_start ()
longlast_transport_start ()
Locationlocations ()
std::stringname ()
RouteListnew_route_from_template (unsigned int, std::string, std::string, PlaylistDisposition)
longnominal_frame_rate ()
Methods
boolisnil ()
std::stringname ()
Statefulto_stateful ()
StatefulDestructibleto_statefuldestructible ()

Inherited from PBD:StatefulPtr

+ +
Methods
voidclear_changes ()

Forget about any changes to this object's properties

OwnedPropertyListproperties ()

↠ ARDOUR:SideChain

@@ -1113,18 +1509,9 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C std::stringdisplay_name () PluginInsertto_insert () IOProcessorto_ioprocessor () + SessionObjectto_sessionobject () SideChainto_sidechain () -

Inherited from ARDOUR:SessionObject

- - - -
Methods
std::stringname ()
-

Inherited from PBD:StatefulPtr

- - - -
Methods
OwnedPropertyListproperties ()

↠ ARDOUR:Source

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

@@ -1161,13 +1548,19 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
+ + + + + +
Methods
Regionbounce (long, long, InterThreadInfo&, Processor, bool)
Regionbounce_range (long, long, InterThreadInfo&, Processor, bool)
boolbounceable (Processor, bool)
boolcan_record ()
boolisnil ()
Playlistplaylist ()
boolrecord_enabled ()
boolrecord_safe ()
boolset_name (std::string)
voidset_record_enabled (bool, GroupControlDisposition)
voidset_record_safe (bool, GroupControlDisposition)
AudioTrackto_audio_track ()
MidiTrackto_midi_track ()

Inherited from ARDOUR:Route

@@ -1175,8 +1568,11 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C + + + @@ -1187,16 +1583,23 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C + + +
boolactive ()
intadd_processor_by_index (Processor, int, ProcessorStreams, bool)
booladd_sidechain (Processor)
Ampamp ()
std::stringcomment ()
boolcustomize_plugin_insert (Processor, unsigned int, ChanCount)
Deliverymain_outs ()
boolmuted ()
ChanCountn_inputs ()
ChanCountn_outputs ()
Processornth_plugin (unsigned int)
voidset_active (bool, void*)
voidset_comment (std::string, void*)
boolset_strict_io (bool)
boolsoloed ()
boolstrict_io ()
Trackto_track ()
Amptrim ()

Inherited from ARDOUR:SessionObject

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

Inherited from PBD:StatefulPtr

+ +
Methods
voidclear_changes ()

Forget about any changes to this object's properties

OwnedPropertyListproperties ()

∁ ARDOUR:WeakAudioSourceList

@@ -1212,20 +1615,6 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C unsigned longsize () LuaTabletable () -

∁ ARDOUR:WeakPortSet

-

C‡: std::set<boost::weak_ptr<ARDOUR::AudioPort> > >

-
- - - - - - - - - - -
Constructor
ℂARDOUR.WeakPortSet ()
Methods
LuaTableadd (LuaTable {ARDOUR::AudioPort})
voidclear ()
boolempty ()
LuaIteriter ()
unsigned longsize ()
LuaTabletable ()

∁ ARDOUR:WeakRouteList

C‡: std::list<boost::weak_ptr<ARDOUR::Route> >

@@ -1288,11 +1677,14 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C boolfollow_playhead ()

Returns true if the editor is following the playhead

longget_current_zoom () + Selectionget_cut_buffer () unsigned intget_grid_beat_divisions (long) LuaTable(Beats, ...)get_grid_type_as_beats (bool&, long) LuaTable(long, ...)get_nudge_distance (long, long&) longget_paste_offset (long, unsigned int, long) LuaTable(...)get_pointer_position (double&, double&) + Selectionget_selection () + LuaTable(bool, ...)get_selection_extents (long&, long&) boolget_smart_mode () intget_videotl_bar_height () doubleget_y_origin () @@ -1325,8 +1717,10 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C voidseparate_region_from_selection () voidset_follow_playhead (bool, bool)

Set whether the editor should follow the playhead.

yn
true to follow playhead, otherwise false.
catch_up
true to reset the editor view to show the playhead (if yn == true), otherwise false.
+ voidset_loop_range (long, long, std::string) voidset_mouse_mode (MouseMode, bool)

Set the mouse mode (gain, object, range, timefx etc.)

m
Mouse mode (defined in editing_syms.h)
force
Perform the effects of the change even if no change is required (ie even if the current mouse mode is equal to
+ voidset_punch_range (long, long, std::string) voidset_show_measures (bool) voidset_snap_mode (SnapMode)

Set the snap mode.

m
Snap mode (defined in editing_syms.h)
@@ -1359,8 +1753,39 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C

Empty this RegionSelection.

longend_frame () unsigned longn_midi_regions () + RegionListregionlist () longstart () +

∁ ArdourUI:Selection

+

C‡: Selection

+
+

The Selection class holds lists of selected items (tracks, regions, etc. etc.).

+ + + + + + + + +
Methods
voidclear ()

Clear everything from the Selection

voidclear_all ()
Data Members
ArdourUI:RegionSelectionregions
ArdourUI:TrackSelectiontracks
+

∅ ArdourUI:TrackSelection

+

C‡: TrackSelection

+

is-a: ArdourUI:TrackViewList

+
+

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

+

Inherited from ArdourUI:TrackViewList

+ + + +
Methods
RouteListroutelist ()
+

∁ ArdourUI:TrackViewList

+

C‡: TrackViewList

+
+ + + +
Methods
RouteListroutelist ()

∁ C:DoubleVector

C‡: std::vector<double >

@@ -1533,7 +1958,25 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C + + + + + + + + + + + + + + + + + +
Methods
voidadd (double, double, bool, bool)

add automation events

when
absolute time in samples
value
parameter value
with_guards
if true, add guard-points
with_initial
if true, add an initial point if the list is empty
voidclear (double, double)

remove all automation events between the given time range

start
start of range (inclusive) in audio samples
end
end of range (inclusive) in audio samples
doubleeval (double)

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

where
absolute time in samples

Returns parameter value

boolin_write_pass ()
InterpolationStyleinterpolation ()

query interpolation style of the automation data

Returns Interpolation Style

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

voidset_interpolation (InterpolationStyle)

set the interpolation style of the automation data

is
interpolation style
voidthin (double)

Thin the number of events in this list.

The thinning factor corresponds to the area of a triangle computed between three points in the list (time-difference * value-difference). If the area is large, it indicates significant non-linearity between the points.

Time is measured in samples, value is usually normalized to 0..1.

During automation recording we thin the recorded points using this value. If a point is sufficiently co-linear with its neighbours (as defined by the area of the triangle formed by three of them), we will not include it in the list. The larger the value, the more points are excluded, so this effectively measures the amount of thinning to be done.

thinning_factor
area-size (default: 20)
voidtruncate_end (double)

truncate the event list after the given time

last_coordinate
last event to include
voidtruncate_start (double)

truncate the event list to the given time

overall_length
overall length

↠ Evoral:ControlSet

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

@@ -1596,6 +2039,16 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C booltoggled floatupper +

∁ Evoral:Range

+

C‡: Evoral::Range<long>

+
+ + + + + + +
Constructor
ℂEvoral.Range (long, long)
Data Members
longfrom
longto

∁ LuaSignal:Set

C‡: std::bitset<47ul>

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

∁ PBD:Command

+

C‡: Command

+

is-a: PBD:StatefulDestructible

+
+

Base class for objects with saveable and undoable state with destruction notification

+ + + + +
Methods
std::stringname ()
voidset_name (std::string)
+

Inherited from PBD:Stateful

+ + + + + +
Methods
voidclear_changes ()

Forget about any changes to this object's properties

OwnedPropertyListproperties ()

↠ PBD:Controllable

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

is-a: PBD:StatefulDestructiblePtr

@@ -1625,6 +2095,8 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C

Inherited from PBD:StatefulPtr

+ +
Methods
voidclear_changes ()

Forget about any changes to this object's properties

OwnedPropertyListproperties ()

∁ PBD:ID

@@ -1642,6 +2114,8 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C

Base class for objects with saveable and undoable state

+ +
Methods
voidclear_changes ()

Forget about any changes to this object's properties

OwnedPropertyListproperties ()

∅ PBD:StatefulDestructible

@@ -1653,6 +2127,8 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C

Inherited from PBD:Stateful

+ +
Methods
voidclear_changes ()

Forget about any changes to this object's properties

OwnedPropertyListproperties ()

↠ PBD:StatefulDestructiblePtr

@@ -1666,6 +2142,31 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C

Inherited from PBD:StatefulPtr

+ + + +
Methods
voidclear_changes ()

Forget about any changes to this object's properties

OwnedPropertyListproperties ()
+

∁ PBD:StatefulDiffCommand

+

C‡: PBD::StatefulDiffCommand

+

is-a: PBD:Command

+
+

A Command which stores its action as the differences between the before and after state of a Stateful object.

+ + + + +
Methods
boolempty ()
voidundo ()
+

Inherited from PBD:Command

+ + + + +
Methods
std::stringname ()
voidset_name (std::string)
+

Inherited from PBD:Stateful

+ + + +
Methods
voidclear_changes ()

Forget about any changes to this object's properties

OwnedPropertyListproperties ()

↠ PBD:StatefulPtr

@@ -1673,9 +2174,18 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
+ +
Methods
voidclear_changes ()

Forget about any changes to this object's properties

boolisnil ()
OwnedPropertyListproperties ()
+

∁ PBD:XMLNode

+

C‡: XMLNode

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

∁ Timecode:BBT_TIME

C‡: Timecode::BBT_Time

@@ -1691,6 +2201,12 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
  • PBD.GroupControlDisposition.NoGroup
  • PBD.GroupControlDisposition.UseGroup
    • +

    ∈ Evoral.ControlList.InterpolationStyle

    +

    ∈ ARDOUR.ChanMapping