From: Robin Gareus Date: Sun, 15 May 2016 12:00:06 +0000 (+0200) Subject: update lua class doc X-Git-Url: http://shamusworld.gotdns.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=ffeed640b94a64f139d1525c84feadf5a8effe5e;p=ardour-manual update lua class doc --- diff --git a/_manual/24_lua-scripting/02_class_reference.html b/_manual/24_lua-scripting/02_class_reference.html index 9ab6acc..0351e24 100644 --- a/_manual/24_lua-scripting/02_class_reference.html +++ b/_manual/24_lua-scripting/02_class_reference.html @@ -229,6 +229,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C

∁ ARDOUR:AudioEngine

C‡: ARDOUR::AudioEngine

+

is-a: ARDOUR:PortManager

@@ -244,6 +245,27 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
Methods
intstart (bool)
intstop (bool)
+

Inherited from ARDOUR:PortManager

+ + + + + + + + + + + + + + + + + + + +
Methods
intconnect (std::string, std::string)
boolconnected (std::string)
intdisconnect (std::string, std::string)
intdisconnect_port (Port)
LuaTable(int, ...)get_backend_ports (std::string, DataType, PortFlags, StringVector&)
LuaTable(int, ...)get_connections (std::string, StringVector&)
voidget_physical_inputs (DataType, StringVector&)
voidget_physical_outputs (DataType, StringVector&)
Portget_port_by_name (std::string)
name
Full or short name of port

Returns Corresponding Port or 0.

LuaTable(int, ...)get_ports (DataType, PortList&)
std::stringget_pretty_name_by_name (std::string)
ChanCountn_physical_inputs ()
ChanCountn_physical_outputs ()
boolphysically_connected (std::string)
--MISSING (ARDOUR::PortEngine&)--port_engine ()
boolport_is_physical (std::string)

↠ ARDOUR:AudioPort

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

is-a: ARDOUR:Port

@@ -349,8 +371,8 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C booladd_sidechain (Processor) Ampamp () std::stringcomment () - boolcustomize_plugin_insert (Processor, unsigned int, ChanCount) -

enable custom plugin-insert configuration

proc
Processor to customize
count
number of plugin instances to use (if zero, reset to default)
outs
output port customization

Returns true if successful

+ boolcustomize_plugin_insert (Processor, unsigned int, ChanCount, ChanCount) +

enable custom plugin-insert configuration

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

Returns true if successful

Deliverymain_outs ()

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

boolmuted () @@ -439,6 +461,7 @@ 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

+ IDid () OwnedPropertyListproperties ()

↠ ARDOUR:AutomationList

@@ -712,6 +735,7 @@ 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

+ IDid () OwnedPropertyListproperties ()

↠ ARDOUR:IO

@@ -814,6 +838,7 @@ 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

+ IDid () OwnedPropertyListproperties ()

∁ ARDOUR:LocationList

@@ -838,8 +863,12 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C Methods Locationauto_loop_location () Locationauto_punch_location () + LuaTable(...)find_all_between (long, long, LocationList&, Flags) longfirst_mark_after (long, bool) - longfirst_mark_after (long, bool) + Locationfirst_mark_at (long, long) + longfirst_mark_before (long, bool) + LuaTable(...)marks_either_side (long, long&, long&) +

Look for the `marks' (either locations which are marks, or start/end points of range markers) either side of a frame. Note that if frame is exactly on a `mark', that mark will not be considered for returning as before/after.

frame
Frame to look for.
before
Filled in with the position of the last `mark' before `frame' (or max_framepos if none exists)
after
Filled in with the position of the next `mark' after `frame' (or max_framepos if none exists)
Locationsession_range_location ()

Inherited from PBD:Stateful

@@ -847,6 +876,7 @@ 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

+ IDid () OwnedPropertyListproperties ()

ℕ ARDOUR.LuaAPI

@@ -981,8 +1011,8 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C booladd_sidechain (Processor) Ampamp () std::stringcomment () - boolcustomize_plugin_insert (Processor, unsigned int, ChanCount) -

enable custom plugin-insert configuration

proc
Processor to customize
count
number of plugin instances to use (if zero, reset to default)
outs
output port customization

Returns true if successful

+ boolcustomize_plugin_insert (Processor, unsigned int, ChanCount, ChanCount) +

enable custom plugin-insert configuration

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

Returns true if successful

Deliverymain_outs ()

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

boolmuted () @@ -1131,6 +1161,7 @@ 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

+ IDid () OwnedPropertyListproperties ()

↠ ARDOUR:PluginControl

@@ -1170,6 +1201,7 @@ 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

+ IDid () OwnedPropertyListproperties ()

↠ ARDOUR:PluginInfo

@@ -1244,6 +1276,42 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C boolsends_output ()

Returns true if this Port sends output, otherwise false

+

∁ ARDOUR:PortList

+

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

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

∁ ARDOUR:PortManager

+

C‡: ARDOUR::PortManager

+
+ + + + + + + + + + + + + + + + + + + +
Methods
intconnect (std::string, std::string)
boolconnected (std::string)
intdisconnect (std::string, std::string)
intdisconnect_port (Port)
LuaTable(int, ...)get_backend_ports (std::string, DataType, PortFlags, StringVector&)
LuaTable(int, ...)get_connections (std::string, StringVector&)
voidget_physical_inputs (DataType, StringVector&)
voidget_physical_outputs (DataType, StringVector&)
Portget_port_by_name (std::string)
name
Full or short name of port

Returns Corresponding Port or 0.

LuaTable(int, ...)get_ports (DataType, PortList&)
std::stringget_pretty_name_by_name (std::string)
ChanCountn_physical_inputs ()
ChanCountn_physical_outputs ()
boolphysically_connected (std::string)
--MISSING (ARDOUR::PortEngine&)--port_engine ()
boolport_is_physical (std::string)

↠ ARDOUR:PortSet

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

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

C‡: ARDOUR::Plugin::PresetRecord

+ + @@ -1386,7 +1456,6 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C -
Constructor
ℂARDOUR.PresetRecord ()
Data Members
std::stringlabel
std::stringuri
new_endpoint
New region end point, such that, for example, a region at 0 of length 10 has an endpoint of 9.
voidtrim_front (long)
voidtrim_to (long, long)
boolvalid_transients ()
boolvideo_locked ()
boolwhole_file ()
@@ -1447,8 +1516,8 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C booladd_sidechain (Processor) Ampamp () std::stringcomment () - boolcustomize_plugin_insert (Processor, unsigned int, ChanCount) -

enable custom plugin-insert configuration

proc
Processor to customize
count
number of plugin instances to use (if zero, reset to default)
outs
output port customization

Returns true if successful

+ boolcustomize_plugin_insert (Processor, unsigned int, ChanCount, ChanCount) +

enable custom plugin-insert configuration

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

Returns true if successful

boolisnil () Deliverymain_outs ()

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

@@ -1542,9 +1611,11 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C Controllablecontrollable_by_id (ID) longcurrent_end_frame () longcurrent_start_frame () + AudioEngineengine () longframe_rate ()

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

doubleframes_per_timecode_frame () + unsigned intget_block_size () RouteListPtrget_routes () BufferSetget_scratch_buffers (ChanCount, bool) BufferSetget_silent_buffers (ChanCount) @@ -1560,8 +1631,8 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C

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) - MidiTrackListnew_midi_track (ChanCount, ChanCount, PluginInfo, TrackMode, RouteGroup, unsigned int, std::string) + RouteListnew_midi_route (RouteGroup, unsigned int, std::string, PluginInfo, PresetRecord) + MidiTrackListnew_midi_track (ChanCount, ChanCount, PluginInfo, TrackMode, RouteGroup, unsigned int, std::string, PresetRecord) 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 () @@ -1590,6 +1661,10 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C booltransport_rolling () doubletransport_speed () StringListunknown_processors () + longworst_input_latency () + longworst_output_latency () + longworst_playback_latency () + longworst_track_latency ()

↠ ARDOUR:SessionObject

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

@@ -1708,8 +1783,8 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C booladd_sidechain (Processor) Ampamp () std::stringcomment () - boolcustomize_plugin_insert (Processor, unsigned int, ChanCount) -

enable custom plugin-insert configuration

proc
Processor to customize
count
number of plugin instances to use (if zero, reset to default)
outs
output port customization

Returns true if successful

+ boolcustomize_plugin_insert (Processor, unsigned int, ChanCount, ChanCount) +

enable custom plugin-insert configuration

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

Returns true if successful

Deliverymain_outs ()

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

boolmuted () @@ -2288,6 +2363,7 @@ 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

+ IDid () OwnedPropertyListproperties ()

↠ PBD:Controllable

@@ -2306,6 +2382,7 @@ 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

+ IDid () OwnedPropertyListproperties ()

∁ PBD:ID

@@ -2326,6 +2403,7 @@ 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

+ IDid () OwnedPropertyListproperties ()

∅ PBD:StatefulDestructible

@@ -2339,6 +2417,7 @@ 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

+ IDid () OwnedPropertyListproperties ()

↠ PBD:StatefulDestructiblePtr

@@ -2355,6 +2434,7 @@ 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

+ IDid () OwnedPropertyListproperties ()

∁ PBD:StatefulDiffCommand

@@ -2378,6 +2458,7 @@ 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

+ IDid () OwnedPropertyListproperties ()

↠ PBD:StatefulPtr

@@ -2388,6 +2469,7 @@ 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

+ IDid () boolisnil () OwnedPropertyListproperties () @@ -2460,6 +2542,14 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C +

∈ ARDOUR.PortFlags

+

∈ ARDOUR.PlaylistDisposition

+

∈ ARDOUR.Location.Flags

+

∈ Cairo.LineCap

- + -
Ardour 4.7-853-g4f3f966  -  Mon, 25 Apr 2016 13:49:00 +0200
+
Ardour 4.7-1011-g1968f94  -  Sun, 15 May 2016 13:59:13 +0200