From 552e7036364fdafc7c5fde41b7a03e385f3b0ecb Mon Sep 17 00:00:00 2001 From: Robin Gareus Date: Wed, 1 Jun 2016 19:09:06 +0200 Subject: [PATCH] update lua class doc --- .../24_lua-scripting/02_class_reference.html | 613 ++++++++++++++++-- 1 file changed, 558 insertions(+), 55 deletions(-) diff --git a/_manual/24_lua-scripting/02_class_reference.html b/_manual/24_lua-scripting/02_class_reference.html index 503e877..0153bf4 100644 --- a/_manual/24_lua-scripting/02_class_reference.html +++ b/_manual/24_lua-scripting/02_class_reference.html @@ -141,8 +141,6 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C Methods voidactivate () boolactive () - AutomationControlautomation_control (Parameter, bool) - Controlcontrol (Parameter, bool) voiddeactivate () std::stringdisplay_name () Cast @@ -358,11 +356,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C

Test if the track can be bounced with the given settings. If sends/inserts/returns are present in the signal path or the given track has no audio outputs bouncing is not possible.

endpoint
the processor to tap the signal off (or nil for the top)
include_endpoint
include the given processor in the bounced audio.

Returns true if the track can be bounced, or false otherwise.

boolcan_record () Playlistplaylist () - boolrecord_enabled () - boolrecord_safe () boolset_name (std::string) - voidset_record_enabled (bool, GroupControlDisposition) - voidset_record_safe (bool, GroupControlDisposition) Cast AudioTrackto_audio_track () MidiTrackto_midi_track () @@ -402,6 +396,26 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C Cast Trackto_track () +

Inherited from ARDOUR:Stripable

+ + + + + + + + + + + + + + + + + + +
Methods
GainControlgain_control ()
boolis_auditioner ()
boolis_hidden ()
boolis_master ()
boolis_monitor ()
boolis_selected ()
MuteControlmute_control ()
PhaseControlphase_control ()
AutomationControlrec_enable_control ()
AutomationControlrec_safe_control ()
SoloControlsolo_control ()
SoloIsolateControlsolo_isolate_control ()
SoloSafeControlsolo_safe_control ()
GainControltrim_control ()
Cast
Routeto_route ()

Inherited from ARDOUR:SessionObject

@@ -666,8 +680,6 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C - - @@ -712,13 +724,24 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
Methods
Methods
voidactivate ()
boolactive ()
AutomationControlautomation_control (Parameter, bool)
Controlcontrol (Parameter, bool)
voiddeactivate ()
std::stringdisplay_name ()
Cast

↠ ARDOUR:GainControl

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

-

is-a: ARDOUR:AutomationControl

+

is-a: ARDOUR:SlavableAutomationControl,

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

Methods
boolisnil ()
+

Inherited from ARDOUR:SlavableAutomationControl,

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

Inherited from ARDOUR:AutomationControl

@@ -798,8 +821,6 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C - - @@ -945,6 +966,32 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
Methods
Methods
voidactivate ()
boolactive ()
AutomationControlautomation_control (Parameter, bool)
Controlcontrol (Parameter, bool)
voiddeactivate ()
std::stringdisplay_name ()
Cast
doubleframes_per_grid (Tempo, long)
doublenote_divisor ()
+

∁ ARDOUR:MeterSection

+

C‡: ARDOUR::MeterSection

+

is-a: ARDOUR:MetricSection

+
+

A section of timeline with a certain Meter.

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

Inherited from ARDOUR:MetricSection

+ + + +
Methods
doublepulse ()
+

∁ ARDOUR:MetricSection

+

C‡: ARDOUR::MetricSection

+
+

A section of timeline with a certain Tempo or Meter.

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

∁ ARDOUR:MidiBuffer

C‡: ARDOUR::MidiBuffer

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

Test if the track can be bounced with the given settings. If sends/inserts/returns are present in the signal path or the given track has no audio outputs bouncing is not possible.

endpoint
the processor to tap the signal off (or nil for the top)
include_endpoint
include the given processor in the bounced audio.

Returns true if the track can be bounced, or false otherwise.

boolcan_record () Playlistplaylist () - boolrecord_enabled () - boolrecord_safe () boolset_name (std::string) - voidset_record_enabled (bool, GroupControlDisposition) - voidset_record_safe (bool, GroupControlDisposition) Cast AudioTrackto_audio_track () MidiTrackto_midi_track () @@ -1057,6 +1100,26 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C Cast Trackto_track () +

Inherited from ARDOUR:Stripable

+ + + + + + + + + + + + + + + + + + +
Methods
GainControlgain_control ()
boolis_auditioner ()
boolis_hidden ()
boolis_master ()
boolis_monitor ()
boolis_selected ()
MuteControlmute_control ()
PhaseControlphase_control ()
AutomationControlrec_enable_control ()
AutomationControlrec_safe_control ()
SoloControlsolo_control ()
SoloIsolateControlsolo_isolate_control ()
SoloSafeControlsolo_safe_control ()
GainControltrim_control ()
Cast
Routeto_route ()

Inherited from ARDOUR:SessionObject

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

↠ ARDOUR:MuteControl

+

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

+

is-a: ARDOUR:SlavableAutomationControl,

+
+

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

+ + + + + +
Methods
boolisnil ()
boolmuted ()
boolmuted_by_self ()
+

Inherited from ARDOUR:SlavableAutomationControl,

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

Inherited from ARDOUR:AutomationControl

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

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

voidset_automation_state (AutoState)
voidset_automation_style (AutoStyle)
voidset_value (double, GroupControlDisposition)

Get and Set `internal' value

All derived classes must implement this.

Basic derived classes will ignore

group_override,
but more sophisticated children, notably those that proxy the value setting logic via an object that is aware of group relationships between this control and others, will find it useful.
voidstart_touch (double)
voidstop_touch (bool, double)
boolwritable ()
Cast
Controlto_ctrl ()
+

Inherited from PBD:Controllable

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

Inherited from PBD:StatefulPtr

+ + + + + + +
Methods
voidclear_changes ()

Forget about any changes to this object's properties

IDid ()
OwnedPropertyListproperties ()

∅ ARDOUR:OwnedPropertyList

C‡: PBD::OwnedPropertyList

is-a: ARDOUR:PropertyList

@@ -1109,6 +1225,49 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C booltoggled floatupper +

↠ ARDOUR:PhaseControl

+

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

+

is-a: ARDOUR:AutomationControl

+
+

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

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

Inherited from ARDOUR:AutomationControl

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

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

voidset_automation_state (AutoState)
voidset_automation_style (AutoStyle)
voidset_value (double, GroupControlDisposition)

Get and Set `internal' value

All derived classes must implement this.

Basic derived classes will ignore

group_override,
but more sophisticated children, notably those that proxy the value setting logic via an object that is aware of group relationships between this control and others, will find it useful.
voidstart_touch (double)
voidstop_touch (bool, double)
boolwritable ()
Cast
Controlto_ctrl ()
+

Inherited from PBD:Controllable

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

Inherited from PBD:StatefulPtr

+ + + + + + +
Methods
voidclear_changes ()

Forget about any changes to this object's properties

IDid ()
OwnedPropertyListproperties ()

↠ ARDOUR:Playlist

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

is-a: ARDOUR:SessionObject

@@ -1257,8 +1416,6 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C - - @@ -1382,8 +1539,6 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C - - @@ -1539,7 +1694,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
Methods
boolactive ()
AutomationControlautomation_control (Parameter, bool)
Controlcontrol (Parameter, bool)
std::stringdisplay_name ()
Cast
Ampto_amp ()
Methods
voidactivate ()
boolactive ()
AutomationControlautomation_control (Parameter, bool)
Controlcontrol (Parameter, bool)
voiddeactivate ()
std::stringdisplay_name ()
boolisnil ()

↠ ARDOUR:Route

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

-

is-a: ARDOUR:SessionObject

+

is-a: ARDOUR:Stripable

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

@@ -1578,6 +1733,26 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
Cast
Trackto_track ()
+

Inherited from ARDOUR:Stripable

+ + + + + + + + + + + + + + + + + + +
Methods
GainControlgain_control ()
boolis_auditioner ()
boolis_hidden ()
boolis_master ()
boolis_monitor ()
boolis_selected ()
MuteControlmute_control ()
PhaseControlphase_control ()
AutomationControlrec_enable_control ()
AutomationControlrec_safe_control ()
SoloControlsolo_control ()
SoloIsolateControlsolo_isolate_control ()
SoloSafeControlsolo_safe_control ()
GainControltrim_control ()
Cast
Routeto_route ()

Inherited from ARDOUR:SessionObject

@@ -1652,6 +1827,8 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C + + @@ -1663,12 +1840,10 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C - - - - - - + + + + @@ -1679,9 +1854,9 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C - - - + + + @@ -1692,7 +1867,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C - + @@ -1736,8 +1911,6 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C - - @@ -1756,6 +1929,212 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
Methods

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

doubleframes_per_timecode_frame ()
unsigned intget_block_size ()
Routeget_remote_nth_route (unsigned int)
Stripableget_remote_nth_stripable (unsigned int, Flag)
RouteListPtrget_routes ()
BufferSetget_scratch_buffers (ChanCount, bool)
BufferSetget_silent_buffers (ChanCount)
Routemaster_out ()
Routemonitor_out ()
std::stringname ()
RouteListnew_audio_route (int, int, RouteGroup, unsigned int, std::string)

Caller must not hold process lock.

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

Caller must not hold process lock

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

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

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

Returns list of newly created routes

longnominal_frame_rate ()
voidrequest_locate (long, bool)
voidrequest_stop (bool, bool)
voidrequest_transport_speed (double, bool)
Routeroute_by_id (ID)
Routeroute_by_name (std::string)
Routeroute_by_remote_id (unsigned int)
Routeroute_by_id (ID)
Routeroute_by_name (std::string)
Routeroute_by_selected_count (unsigned int)
intsave_state (std::string, bool, bool, bool)

save session

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

Returns zero on success

voidscripts_changed ()
booltimecode_drop_frames ()
longtimecode_frames_per_hour ()
doubletimecode_frames_per_second ()
Tracktrack_by_diskstream_id (ID)
Tracktrack_by_diskstream_id (ID)
longtransport_frame ()
booltransport_rolling ()
doubletransport_speed ()
Methods
voidactivate ()
boolactive ()
AutomationControlautomation_control (Parameter, bool)
Controlcontrol (Parameter, bool)
voiddeactivate ()
std::stringdisplay_name ()
Cast
Statefulto_stateful ()
StatefulDestructibleto_statefuldestructible ()
+

↠ ARDOUR:SlavableAutomationControl,

+

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

+

is-a: ARDOUR:AutomationControl

+
+

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

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

Inherited from ARDOUR:AutomationControl

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

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

voidset_automation_state (AutoState)
voidset_automation_style (AutoStyle)
voidset_value (double, GroupControlDisposition)

Get and Set `internal' value

All derived classes must implement this.

Basic derived classes will ignore

group_override,
but more sophisticated children, notably those that proxy the value setting logic via an object that is aware of group relationships between this control and others, will find it useful.
voidstart_touch (double)
voidstop_touch (bool, double)
boolwritable ()
Cast
Controlto_ctrl ()
+

Inherited from PBD:Controllable

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

Inherited from PBD:StatefulPtr

+ + + + + + +
Methods
voidclear_changes ()

Forget about any changes to this object's properties

IDid ()
OwnedPropertyListproperties ()
+

↠ ARDOUR:SoloControl

+

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

+

is-a: ARDOUR:SlavableAutomationControl,

+
+

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

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

Inherited from ARDOUR:SlavableAutomationControl,

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

Inherited from ARDOUR:AutomationControl

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

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

voidset_automation_state (AutoState)
voidset_automation_style (AutoStyle)
voidset_value (double, GroupControlDisposition)

Get and Set `internal' value

All derived classes must implement this.

Basic derived classes will ignore

group_override,
but more sophisticated children, notably those that proxy the value setting logic via an object that is aware of group relationships between this control and others, will find it useful.
voidstart_touch (double)
voidstop_touch (bool, double)
boolwritable ()
Cast
Controlto_ctrl ()
+

Inherited from PBD:Controllable

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

Inherited from PBD:StatefulPtr

+ + + + + + +
Methods
voidclear_changes ()

Forget about any changes to this object's properties

IDid ()
OwnedPropertyListproperties ()
+

↠ ARDOUR:SoloIsolateControl

+

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

+

is-a: ARDOUR:SlavableAutomationControl,

+
+

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

+ + + + + +
Methods
boolisnil ()
boolself_solo_isolated ()
boolsolo_isolated ()
+

Inherited from ARDOUR:SlavableAutomationControl,

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

Inherited from ARDOUR:AutomationControl

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

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

voidset_automation_state (AutoState)
voidset_automation_style (AutoStyle)
voidset_value (double, GroupControlDisposition)

Get and Set `internal' value

All derived classes must implement this.

Basic derived classes will ignore

group_override,
but more sophisticated children, notably those that proxy the value setting logic via an object that is aware of group relationships between this control and others, will find it useful.
voidstart_touch (double)
voidstop_touch (bool, double)
boolwritable ()
Cast
Controlto_ctrl ()
+

Inherited from PBD:Controllable

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

Inherited from PBD:StatefulPtr

+ + + + + + +
Methods
voidclear_changes ()

Forget about any changes to this object's properties

IDid ()
OwnedPropertyListproperties ()
+

↠ ARDOUR:SoloSafeControl

+

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

+

is-a: ARDOUR:SlavableAutomationControl,

+
+

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

+ + + + +
Methods
boolisnil ()
boolsolo_safe ()
+

Inherited from ARDOUR:SlavableAutomationControl,

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

Inherited from ARDOUR:AutomationControl

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

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

voidset_automation_state (AutoState)
voidset_automation_style (AutoStyle)
voidset_value (double, GroupControlDisposition)

Get and Set `internal' value

All derived classes must implement this.

Basic derived classes will ignore

group_override,
but more sophisticated children, notably those that proxy the value setting logic via an object that is aware of group relationships between this control and others, will find it useful.
voidstart_touch (double)
voidstop_touch (bool, double)
boolwritable ()
Cast
Controlto_ctrl ()
+

Inherited from PBD:Controllable

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

Inherited from PBD:StatefulPtr

+ + + + + + +
Methods
voidclear_changes ()

Forget about any changes to this object's properties

IDid ()
OwnedPropertyListproperties ()

↠ ARDOUR:Source

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

@@ -1764,6 +2143,39 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C Methods boolisnil () +

↠ ARDOUR:Stripable

+

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

+

is-a: ARDOUR:SessionObject

+
+

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

+ + + + + + + + + + + + + + + + + + + +
Methods
GainControlgain_control ()
boolis_auditioner ()
boolis_hidden ()
boolis_master ()
boolis_monitor ()
boolis_selected ()
boolisnil ()
MuteControlmute_control ()
PhaseControlphase_control ()
AutomationControlrec_enable_control ()
AutomationControlrec_safe_control ()
SoloControlsolo_control ()
SoloIsolateControlsolo_isolate_control ()
SoloSafeControlsolo_safe_control ()
GainControltrim_control ()
Cast
Routeto_route ()
+

Inherited from ARDOUR:SessionObject

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

∁ ARDOUR:Tempo

C‡: ARDOUR::Tempo

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

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

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

∁ ARDOUR:TempoSection

+

C‡: ARDOUR::TempoSection

+

is-a: ARDOUR:MetricSection

+
+

A section of timeline with a certain Tempo.

+ + + +
Methods
doublec_func ()
+

Inherited from ARDOUR:MetricSection

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

↠ ARDOUR:Track

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

is-a: ARDOUR:Route

@@ -1803,11 +2233,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C 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 () @@ -1847,6 +2273,26 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C Cast Trackto_track () +

Inherited from ARDOUR:Stripable

+ + + + + + + + + + + + + + + + + + +
Methods
GainControlgain_control ()
boolis_auditioner ()
boolis_hidden ()
boolis_master ()
boolis_monitor ()
boolis_selected ()
MuteControlmute_control ()
PhaseControlphase_control ()
AutomationControlrec_enable_control ()
AutomationControlrec_safe_control ()
SoloControlsolo_control ()
SoloIsolateControlsolo_isolate_control ()
SoloSafeControlsolo_safe_control ()
GainControltrim_control ()
Cast
Routeto_route ()

Inherited from ARDOUR:SessionObject

@@ -1869,8 +2315,6 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C - - @@ -2408,21 +2852,21 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
Methods
Methods
voidactivate ()
boolactive ()
AutomationControlautomation_control (Parameter, bool)
Controlcontrol (Parameter, bool)
voiddeactivate ()
std::stringdisplay_name ()
Cast
longto

∁ LuaSignal:Set

-

C‡: std::bitset<47ul>

+

C‡: std::bitset<46ul>

- - - - - - - + + + + + + + - +
Constructor
ℂLuaSignal.Set ()
Methods
LuaTableadd (LuaTable {47ul})
boolany ()
unsigned longcount ()
boolnone ()
Setreset ()
Setset (unsigned long, bool)
unsigned longsize ()
LuaTableadd (LuaTable {46ul})
boolany ()
unsigned longcount ()
boolnone ()
Setreset ()
Setset (unsigned long, bool)
unsigned longsize ()
LuaTabletable ()
booltest (unsigned long)
booltest (unsigned long)

∁ PBD:Command

C‡: Command

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

∁ PBD:IdVector

+

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

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

∁ PBD:Stateful

C‡: PBD::Stateful

@@ -2596,6 +3055,23 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
  • ARDOUR.PluginType.LXVST
  • ARDOUR.PluginType.Lua
    • +

    ∈ ARDOUR.PresentationInfo.Flag

    +

    ∈ ARDOUR.AutoStyle

    ∈ ARDOUR.AutomationType

    ∈ ARDOUR.SrcQuality

    +

    ∈ ARDOUR.PositionLockStyle

    + +

    ∈ ARDOUR.TempoSection.Type

    +

    ∈ ARDOUR.TrackMode

    - + -
    Ardour 4.7-1385-gca8ac05  -  Tue, 31 May 2016 03:23:16 +0200
    +
    Ardour 5.0-pre0-25-g46ae5aa  -  Wed, 01 Jun 2016 16:01:28 +0200
    -- 2.37.2