X-Git-Url: http://shamusworld.gotdns.org/cgi-bin/gitweb.cgi?a=blobdiff_plain;f=_manual%2F24_lua-scripting%2F02_class_reference.html;h=0cde811307e3f3f5e2602011f8c4f3a2755ba1a8;hb=9bca305233a422a852d093538be53ce3ad50d308;hp=66aa47212cf01c0578ca504d4802ac2ee10093cb;hpb=6e1d335671e9affda395ca068541291fc112eb74;p=ardour-manual diff --git a/_manual/24_lua-scripting/02_class_reference.html b/_manual/24_lua-scripting/02_class_reference.html index 66aa472..0cde811 100644 --- a/_manual/24_lua-scripting/02_class_reference.html +++ b/_manual/24_lua-scripting/02_class_reference.html @@ -8,6 +8,7 @@ title: Class Reference This documention is far from complete may be inaccurate and subject to change.

+
@@ -36,6 +37,12 @@ Operations are performed on objects. One gets a reference to an object and then e.g obj = Session:route_by_name("Audio") obj:set_name("Guitar").

+Lua automatically follows C++ class inheritance. e.g one can directly call all SessionObject and Route methods on Track object. However lua does not automatically promote objects. A Route object which just happens to be a Track needs to be explicily cast to a Track. Methods for casts are provided with each class. Note that the cast may fail and return a nil reference. +

+

+Likewise multiple inheritance is a non-trivial issue in lua. To avoid performance penalties involved with lookups, explicit casts are required in this case. One example is ARDOUR:SessionObject which is-a StatefulDestructible which inhertis from both Stateful and Destructible. +

+

Object lifetimes are managed by the Session. Most Objects cannot be directly created, but one asks the Session to create or destroy them. This is mainly due to realtime constrains: you cannot simply remove a track that is currently processing audio. There are various factory methods for object creation or removal.

@@ -119,6 +126,38 @@ 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 ()
Cast
Automatableto_automatable ()
PluginInsertto_insert ()
IOProcessorto_ioprocessor ()
SideChainto_sidechain ()
+

Inherited from ARDOUR:SessionObject

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

↠ ARDOUR:AudioBackend

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

@@ -178,9 +217,12 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C + + + - +
Methods
voidapply_gain (float, long)
boolcheck_silence (unsigned int, unsigned int&)

check buffer for silence

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

Returns true if all samples are zero

FloatArraydata (long)
voidread_from (FloatArray, long, long, long)
voidsilence (long, long)

Clear (eg zero, or empty) buffer

silence buffer

len
number of samples to clear
offset
start offset

∁ ARDOUR:AudioEngine

C‡: ARDOUR::AudioEngine

@@ -199,6 +241,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

@@ -220,40 +318,55 @@ 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)
Cast
AudioTrackto_audio_track ()
MidiTrackto_midi_track ()

Inherited from ARDOUR:Route

+ + + + + + + + + +
Methods
boolactive ()
intadd_processor_by_index (Processor, int, ProcessorStreams, bool)
booladd_sidechain (Processor)
Ampamp ()
std::stringcomment ()
boolcustomize_plugin_insert (Processor, unsigned int, ChanCount)
Deliverymain_outs ()

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

boolmuted ()
ChanCountn_inputs ()
ChanCountn_outputs ()
Processornth_plugin (unsigned int)
intremove_processor (Processor, ProcessorStreams, bool)
boolremove_sidechain (Processor)
intreplace_processor (Processor, Processor, ProcessorStreams)
boolreset_plugin_insert (Processor)
voidset_active (bool, void*)
voidset_comment (std::string, void*)
boolset_strict_io (bool)
boolsoloed ()
boolstrict_io ()
Amptrim ()
Cast
Trackto_track ()

Inherited from ARDOUR:SessionObject

-
Methods
std::stringname ()
-

Inherited from PBD:StatefulPtr

- - - + + +
Methods
OwnedPropertyListproperties ()
Cast
Statefulto_stateful ()
StatefulDestructibleto_statefuldestructible ()

∁ ARDOUR:AudioTrackList

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

@@ -282,26 +395,54 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C

↠ ARDOUR:AutomationControl

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

-

is-a: Evoral:Control

+

is-a: PBD:Controllable

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

Inherited from Evoral:Control

+

Inherited from PBD:Controllable

- + +
Methods
ControlListlist ()
std::stringname ()
+

Inherited from PBD:StatefulPtr

+ + + + +
Methods
voidclear_changes ()

Forget about any changes to this object's properties

OwnedPropertyListproperties ()
+

↠ ARDOUR:AutomationList

+

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

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

∁ ARDOUR:BackendVector

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

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

∁ ARDOUR:ChanMapping

C‡: ARDOUR::ChanMapping

-

A mapping from one set of channels to another (e.g. how to 'connect' two BufferSets).

for plugins the form is "pin" -> "buffer"

+

A mapping from one set of channels to another. The general form is 1 source (from), many sinks (to). numeric IDs are used to identify sources and sinks.

for plugins this is used to map "plugin-pin" to "audio-buffer"

- + - +
Constructor
ℂARDOUR.ChanMapping ()
Methods
unsigned intget (DataType, unsigned int)

get buffer mapping for given data type and pin

from
pin
type
data type

Returns mapped buffer number (or ChanMapping::Invalid)

get buffer mapping for given data type and pin

from
numeric source id
type
data type

Returns mapped buffer number (or ChanMapping::Invalid)

voidset (DataType, unsigned int, unsigned int)

set buffer mapping for given data type

from
pin
to
buffer
type
data type

set buffer mapping for given data type

from
numeric source id
to
buffer
type
data type

ℕ ARDOUR.DSP

@@ -394,7 +535,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C ℂARDOUR.DSP.Biquad (double) Methods voidcompute (Type, double, double, double) -

setup filter, compute coefficients

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

setup filter, compute coefficients

type
filter type (LowPass, HighPass, etc)
freq
filter frequency
Q
filter quality
gain
filter gain
voidreset ()

reset filter state

voidrun (FloatArray, unsigned int) @@ -444,7 +585,55 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C + + + + + + + + + +
Constructor
ℂARDOUR.DataType (std::string)
Methods
DataTypeaudio ()

convenience contructor for DataType::AUDIO

Returns DataType::AUDIO

DataTypemidi ()

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 ()
Cast
Automatableto_automatable ()
PluginInsertto_insert ()
IOProcessorto_ioprocessor ()
SideChainto_sidechain ()
+

Inherited from ARDOUR:SessionObject

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

∁ ARDOUR:DeviceStatus

C‡: ARDOUR::AudioBackend::DeviceStatus

@@ -469,18 +658,136 @@ 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)
boolwritable ()
Cast
Controlto_ctrl ()
+

Inherited from PBD:Controllable

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

Inherited from PBD:StatefulPtr

+ + + + + +
Methods
voidclear_changes ()

Forget about any changes to this object's properties

OwnedPropertyListproperties ()
+

↠ ARDOUR:IO

+

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

+

is-a: ARDOUR:SessionObject

+
+ + + + + + + + + + + + + + + + +
Methods
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.
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 ()
Portport_by_name (unsigned int)
intremove_port (Port, void*)
+

Inherited from ARDOUR:SessionObject

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

↠ ARDOUR:IOProcessor

+

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

+

is-a: ARDOUR:Processor

+
+ + + + + + + +
Methods
IOinput ()
boolisnil ()
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 ()
Cast
Automatableto_automatable ()
PluginInsertto_insert ()
IOProcessorto_ioprocessor ()
SideChainto_sidechain ()
+

Inherited from ARDOUR:SessionObject

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

∁ ARDOUR:InterThreadInfo

+

C‡: ARDOUR::InterThreadInfo

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

+ + + + + @@ -491,8 +798,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

@@ -503,10 +825,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 the third 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

@@ -543,6 +877,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

@@ -554,40 +919,55 @@ 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)
Cast
AudioTrackto_audio_track ()
MidiTrackto_midi_track ()

Inherited from ARDOUR:Route

+ + + + + + + + + +
Methods
boolactive ()
intadd_processor_by_index (Processor, int, ProcessorStreams, bool)
booladd_sidechain (Processor)
Ampamp ()
std::stringcomment ()
boolcustomize_plugin_insert (Processor, unsigned int, ChanCount)
Deliverymain_outs ()

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

boolmuted ()
ChanCountn_inputs ()
ChanCountn_outputs ()
Processornth_plugin (unsigned int)
intremove_processor (Processor, ProcessorStreams, bool)
boolremove_sidechain (Processor)
intreplace_processor (Processor, Processor, ProcessorStreams)
boolreset_plugin_insert (Processor)
voidset_active (bool, void*)
voidset_comment (std::string, void*)
boolset_strict_io (bool)
boolsoloed ()
boolstrict_io ()
Amptrim ()
Cast
Trackto_track ()

Inherited from ARDOUR:SessionObject

-
Methods
std::stringname ()
-

Inherited from PBD:StatefulPtr

- - - + + +
Methods
OwnedPropertyListproperties ()
Cast
Statefulto_stateful ()
StatefulDestructibleto_statefuldestructible ()

∁ ARDOUR:MidiTrackList

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

@@ -633,6 +1013,49 @@ 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 ()
Cast
Statefulto_stateful ()
StatefulDestructibleto_statefuldestructible ()

↠ ARDOUR:Plugin

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

is-a: PBD:StatefulDestructiblePtr

@@ -657,6 +1080,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

@@ -670,20 +1095,32 @@ 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)
boolwritable ()
Cast
Controlto_ctrl ()
-

Inherited from Evoral:Control

+

Inherited from PBD:Controllable

- + +
Methods
ControlListlist ()
std::stringname ()
+

Inherited from PBD:StatefulPtr

+ + + + +
Methods
voidclear_changes ()

Forget about any changes to this object's properties

OwnedPropertyListproperties ()

↠ ARDOUR:PluginInfo

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

@@ -704,11 +1141,9 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C voiddeactivate () ChanMappinginput_map (unsigned int) boolisnil () - boolno_inplace () ChanMappingoutput_map (unsigned int) Pluginplugin (unsigned int) voidset_input_map (unsigned int, ChanMapping) - voidset_no_inplace (bool) voidset_output_map (unsigned int, ChanMapping) boolstrict_io_configured () @@ -719,18 +1154,60 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C AutomationControlautomation_control (Parameter, bool) Controlcontrol (Parameter, bool) std::stringdisplay_name () + Cast + Automatableto_automatable () PluginInsertto_insert () + IOProcessorto_ioprocessor () + SideChainto_sidechain ()

Inherited from ARDOUR:SessionObject

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

Inherited from PBD:StatefulPtr

+

↠ ARDOUR:Port

+

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

+
- -
Methods
OwnedPropertyListproperties ()
+ 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
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

@@ -743,7 +1220,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:SessionObject

@@ -754,18 +1231,19 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C - + + + +
Methods
voiddeactivate ()
std::stringdisplay_name ()
boolisnil ()
boolisnil ()
Cast
Automatableto_automatable ()
PluginInsertto_insert ()
IOProcessorto_ioprocessor ()
SideChainto_sidechain ()

Inherited from ARDOUR:SessionObject

-
Methods
std::stringname ()
-

Inherited from PBD:StatefulPtr

- - - + + +
Methods
OwnedPropertyListproperties ()
Cast
Statefulto_stateful ()
StatefulDestructibleto_statefuldestructible ()

∅ ARDOUR:Properties:BoolProperty

C‡: PBD::PropertyDescriptor<bool>

@@ -861,11 +1339,9 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C -
Methods
std::stringname ()
-

Inherited from PBD:StatefulPtr

- - - + + +
Methods
OwnedPropertyListproperties ()
Cast
Statefulto_stateful ()
StatefulDestructibleto_statefuldestructible ()

∁ ARDOUR:RegionFactory

C‡: ARDOUR::RegionFactory

@@ -874,6 +1350,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

@@ -882,30 +1387,38 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C Methods 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 () +

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

+ boolmuted () ChanCountn_inputs () ChanCountn_outputs () Processornth_plugin (unsigned int) intremove_processor (Processor, ProcessorStreams, bool) + boolremove_sidechain (Processor) intreplace_processor (Processor, Processor, ProcessorStreams) boolreset_plugin_insert (Processor) voidset_active (bool, void*) voidset_comment (std::string, void*) boolset_name (std::string) boolset_strict_io (bool) + boolsoloed () boolstrict_io () + Amptrim () + Cast + Trackto_track ()

Inherited from ARDOUR:SessionObject

-
Methods
std::stringname ()
-

Inherited from PBD:StatefulPtr

- - - + + +
Methods
OwnedPropertyListproperties ()
Cast
Statefulto_stateful ()
StatefulDestructibleto_statefuldestructible ()

∁ ARDOUR:Route:ProcessorStreams

C‡: ARDOUR::Route::ProcessorStreams

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

Ardour Session

+ + + + + @@ -964,8 +1482,10 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C + + @@ -978,7 +1498,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C - + @@ -995,17 +1515,53 @@ 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)

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

longnominal_frame_rate ()

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

std::stringpath ()
Routeroute_by_name (std::string)
Routeroute_by_remote_id (unsigned int)
intsave_state (std::string, bool, bool, bool)
snapshot_name
Name to save under, without .ardour / .pending prefix

save session

snapshot_name
name of the session (use an empty string for the current name)
pending
save a 'recovery', not full state (default: false)
switch_to_snapshot
switch to given snapshot after saving (default: false)
template_only
save a session template (default: false)

Returns zero on success

voidscripts_changed ()
voidset_dirty ()
std::stringsnap_name ()

↠ ARDOUR:SessionObject

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

-

is-a: PBD:StatefulDestructiblePtr

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

Inherited from PBD:StatefulPtr

+

↠ ARDOUR:SideChain

+

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

+

is-a: ARDOUR:IOProcessor

+
- + +
Methods
OwnedPropertyListproperties ()
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 ()
Cast
Automatableto_automatable ()
PluginInsertto_insert ()
IOProcessorto_ioprocessor ()
SideChainto_sidechain ()
+

Inherited from ARDOUR:SessionObject

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

↠ ARDOUR:Source

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

@@ -1043,41 +1599,56 @@ 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)
Cast
AudioTrackto_audio_track ()
MidiTrackto_midi_track ()

Inherited from ARDOUR:Route

+ + + + + + + + + +
Methods
boolactive ()
intadd_processor_by_index (Processor, int, ProcessorStreams, bool)
booladd_sidechain (Processor)
Ampamp ()
std::stringcomment ()
boolcustomize_plugin_insert (Processor, unsigned int, ChanCount)
Deliverymain_outs ()

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

boolmuted ()
ChanCountn_inputs ()
ChanCountn_outputs ()
Processornth_plugin (unsigned int)
intremove_processor (Processor, ProcessorStreams, bool)
boolremove_sidechain (Processor)
intreplace_processor (Processor, Processor, ProcessorStreams)
boolreset_plugin_insert (Processor)
voidset_active (bool, void*)
voidset_comment (std::string, void*)
boolset_strict_io (bool)
boolsoloed ()
boolstrict_io ()
Amptrim ()
Cast
Trackto_track ()

Inherited from ARDOUR:SessionObject

-
Methods
std::stringname ()
-

Inherited from PBD:StatefulPtr

- - - + + +
Methods
OwnedPropertyListproperties ()
Cast
Statefulto_stateful ()
StatefulDestructibleto_statefuldestructible ()

∁ ARDOUR:WeakAudioSourceList

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

@@ -1092,20 +1663,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> >

@@ -1132,11 +1689,32 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C unsigned longsize () LuaTabletable () -

∅ ArdourUI:ArdourMarker

+

∁ ArdourUI:ArdourMarker

C‡: ArdourMarker

Location Marker

Editor ruler representation of a location marker or range on the timeline.

-

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

+ + + + + +
Methods
std::stringname ()
longposition ()
Typetype ()
+

∁ ArdourUI:ArdourMarkerList

+

C‡: std::list<ArdourMarker* >

+
+ + + + + + + + + + + + +
Constructor
ℂArdourUI.ArdourMarkerList ()
Methods
LuaTableadd (LuaTable {ArdourMarker* })
boolempty ()
LuaIteriter ()
voidpush_back (ArdourMarker)
voidreverse ()
unsigned longsize ()
LuaTabletable ()
voidunique ()

∁ ArdourUI:Editor

C‡: PublicEditor

@@ -1168,11 +1746,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 () @@ -1205,8 +1786,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)
@@ -1229,6 +1812,25 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C

Undo some transactions.

n
Number of transactions to undo.
doublevisible_canvas_height () +

∅ ArdourUI:MarkerSelection

+

C‡: MarkerSelection

+

is-a: ArdourUI:ArdourMarkerList

+
+

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

+

Inherited from ArdourUI:ArdourMarkerList

+ + + + + + + + + + + + +
Constructor
ℂArdourUI.ArdourMarkerList ()
Methods
LuaTableadd (LuaTable {ArdourMarker* })
boolempty ()
LuaIteriter ()
voidpush_back (ArdourMarker)
voidreverse ()
unsigned longsize ()
LuaTabletable ()
voidunique ()

∁ ArdourUI:RegionSelection

C‡: RegionSelection

@@ -1239,8 +1841,64 @@ 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 ()
boolempty (bool)

check if all selections are empty

internal_selection
also check object internals (e.g midi notes, automation points), when false only check objects.

Returns true if nothing is selected.

Data Members
ArdourUI:MarkerSelectionmarkers
ArdourUI:RegionSelectionregions
ArdourUI:TimeSelectiontime
ArdourUI:TrackSelectiontracks
+

∁ ArdourUI:TimeSelection

+

C‡: TimeSelection

+

is-a: ARDOUR:AudioRangeList

+
+ + + + + +
Methods
longend_frame ()
longlength ()
longstart ()
+

Inherited from ARDOUR:AudioRangeList

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

∅ 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 >

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

Makes a copy of the current state of the Context and saves it on an internal stack of saved states. When restore() is called, it will be restored to the saved state. Multiple calls to save() and restore() can be nested; each call to restore() restores the state from the matching paired save().

It isn't necessary to clear all saved states before a cairo_t is freed. Any saved states will be freed when the Context is destroyed.

restore()

voidscale (double, double)

Modifies the current transformation matrix (CTM) by scaling the X and Y user-space axes by sx and sy respectively. The scaling of the axes takes place after any existing transformation of user space.

sx
scale factor for the X dimension
sy
scale factor for the Y dimension
- voidset_dash (DoubleVector&, double) + voidset_dash (DoubleVector, double) voidset_font_size (double)

Sets the current font matrix to a scale by a factor of size, replacing any font matrix previously set with set_font_size() or set_font_matrix(). This results in a font size of size user space units. (More precisely, this matrix will result in the font's em-square being a by size square in user space.)

If text is drawn without a call to set_font_size(), (nor set_font_matrix() nor set_scaled_font()), the default font size is 10.0.

size
the new font size, in user space units)
voidset_line_cap (LineCap) @@ -1413,7 +2071,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 >

@@ -1476,6 +2152,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>

@@ -1493,6 +2179,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

@@ -1501,10 +2204,13 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C Methods doubleget_value () boolisnil () + std::stringname ()

Inherited from PBD:StatefulPtr

+ +
Methods
voidclear_changes ()

Forget about any changes to this object's properties

OwnedPropertyListproperties ()

∁ PBD:ID

@@ -1522,6 +2228,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

@@ -1533,6 +2241,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

@@ -1546,6 +2256,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

@@ -1553,9 +2288,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

@@ -1571,6 +2315,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

    -
    Ardour 4.7-535-g0818257  -  Thu, 31 Mar 2016 01:17:33 +0200
    +
    Ardour 4.7-687-gdd57b33  -  Tue, 12 Apr 2016 14:06:18 +0200