X-Git-Url: http://shamusworld.gotdns.org/cgi-bin/gitweb.cgi?a=blobdiff_plain;f=_manual%2F24_lua-scripting%2F02_class_reference.html;h=0351e24d43531c5cc47eb3f2784925a84d6079ba;hb=ffeed640b94a64f139d1525c84feadf5a8effe5e;hp=9ab6accedc0488935eb04f4a4de9dd64e8080e1c;hpb=cb0a24a80389463079f1932e7878a266071def04;p=ardour-manual-diverged
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
Methods |
@@ -244,6 +245,27 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
int | start (bool) | |
int | stop (bool) | |
+Inherited from ARDOUR:PortManager
+
+ Methods |
+ int | connect (std::string, std::string) | |
+ bool | connected (std::string) | |
+ int | disconnect (std::string, std::string) | |
+ int | disconnect_port (Port) | |
+ LuaTable(int, ...) | get_backend_ports (std::string, DataType, PortFlags, StringVector&) | |
+ LuaTable(int, ...) | get_connections (std::string, StringVector&) | |
+ void | get_physical_inputs (DataType, StringVector&) | |
+ void | get_physical_outputs (DataType, StringVector&) | |
+ Port | get_port_by_name (std::string) | |
+ | - name
- Full or short name of port
Returns Corresponding Port or 0. |
+ LuaTable(int, ...) | get_ports (DataType, PortList&) | |
+ std::string | get_pretty_name_by_name (std::string) | |
+ ChanCount | n_physical_inputs () | |
+ ChanCount | n_physical_outputs () | |
+ bool | physically_connected (std::string) | |
+ --MISSING (ARDOUR::PortEngine&)-- | port_engine () | |
+ bool | port_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
bool | add_sidechain (Processor) | |
Amp | amp () | |
std::string | comment () | |
- bool | customize_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 |
+ bool | customize_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 |
Delivery | main_outs () | |
| the signal processorat at end of the processing chain which produces output |
bool | muted () | |
@@ -439,6 +461,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
Methods |
void | clear_changes () | |
| Forget about any changes to this object's properties |
+ ID | id () | |
OwnedPropertyList | properties () | |
↠ ARDOUR:AutomationList
@@ -712,6 +735,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
Methods |
void | clear_changes () | |
| Forget about any changes to this object's properties |
+ ID | id () | |
OwnedPropertyList | properties () | |
↠ ARDOUR:IO
@@ -814,6 +838,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
Methods |
void | clear_changes () | |
| Forget about any changes to this object's properties |
+ ID | id () | |
OwnedPropertyList | properties () | |
∁ ARDOUR:LocationList
@@ -838,8 +863,12 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
Methods |
Location | auto_loop_location () | |
Location | auto_punch_location () | |
+ LuaTable(...) | find_all_between (long, long, LocationList&, Flags) | |
long | first_mark_after (long, bool) | |
- long | first_mark_after (long, bool) | |
+ Location | first_mark_at (long, long) | |
+ long | first_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)
|
Location | session_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 |
void | clear_changes () | |
| Forget about any changes to this object's properties |
+ ID | id () | |
OwnedPropertyList | properties () | |
ℕ ARDOUR.LuaAPI
@@ -981,8 +1011,8 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
bool | add_sidechain (Processor) | |
Amp | amp () | |
std::string | comment () | |
- bool | customize_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 |
+ bool | customize_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 |
Delivery | main_outs () | |
| the signal processorat at end of the processing chain which produces output |
bool | muted () | |
@@ -1131,6 +1161,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
Methods |
void | clear_changes () | |
| Forget about any changes to this object's properties |
+ ID | id () | |
OwnedPropertyList | properties () | |
↠ ARDOUR:PluginControl
@@ -1170,6 +1201,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
Methods |
void | clear_changes () | |
| Forget about any changes to this object's properties |
+ ID | id () | |
OwnedPropertyList | properties () | |
↠ ARDOUR:PluginInfo
@@ -1244,6 +1276,42 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
bool | sends_output () | |
| Returns true if this Port sends output, otherwise false |
+∁ ARDOUR:PortList
+C‡: std::list<boost::shared_ptr<ARDOUR::Port> >
+
+
+ Constructor |
+ ℂ | ARDOUR.PortList () | |
+ Methods |
+ bool | empty () | |
+ LuaIter | iter () | |
+ void | reverse () | |
+ unsigned long | size () | |
+ LuaTable | table () | |
+
+∁ ARDOUR:PortManager
+C‡: ARDOUR::PortManager
+
+
+ Methods |
+ int | connect (std::string, std::string) | |
+ bool | connected (std::string) | |
+ int | disconnect (std::string, std::string) | |
+ int | disconnect_port (Port) | |
+ LuaTable(int, ...) | get_backend_ports (std::string, DataType, PortFlags, StringVector&) | |
+ LuaTable(int, ...) | get_connections (std::string, StringVector&) | |
+ void | get_physical_inputs (DataType, StringVector&) | |
+ void | get_physical_outputs (DataType, StringVector&) | |
+ Port | get_port_by_name (std::string) | |
+ | - name
- Full or short name of port
Returns Corresponding Port or 0. |
+ LuaTable(int, ...) | get_ports (DataType, PortList&) | |
+ std::string | get_pretty_name_by_name (std::string) | |
+ ChanCount | n_physical_inputs () | |
+ ChanCount | n_physical_outputs () | |
+ bool | physically_connected (std::string) | |
+ --MISSING (ARDOUR::PortEngine&)-- | port_engine () | |
+ bool | port_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
+ Constructor |
+ ℂ | ARDOUR.PresetRecord () | |
Data Members |
std::string | label | |
std::string | uri | |
@@ -1386,7 +1456,6 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
| - new_endpoint
- New region end point, such that, for example, a region at 0 of length 10 has an endpoint of 9.
|
void | trim_front (long) | |
void | trim_to (long, long) | |
- bool | valid_transients () | |
bool | video_locked () | |
bool | whole_file () | |
@@ -1447,8 +1516,8 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
bool | add_sidechain (Processor) | |
Amp | amp () | |
std::string | comment () | |
- bool | customize_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 |
+ bool | customize_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 |
bool | isnil () | |
Delivery | main_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
Controllable | controllable_by_id (ID) | |
long | current_end_frame () | |
long | current_start_frame () | |
+ AudioEngine | engine () | |
long | frame_rate () | |
| "actual" sample rate of session, set by current audioengine rate, pullup/down etc. |
double | frames_per_timecode_frame () | |
+ unsigned int | get_block_size () | |
RouteListPtr | get_routes () | |
BufferSet | get_scratch_buffers (ChanCount, bool) | |
BufferSet | get_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".
|
AudioTrackList | new_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".
|
- RouteList | new_midi_route (RouteGroup, unsigned int, std::string, PluginInfo) | |
- MidiTrackList | new_midi_track (ChanCount, ChanCount, PluginInfo, TrackMode, RouteGroup, unsigned int, std::string) | |
+ RouteList | new_midi_route (RouteGroup, unsigned int, std::string, PluginInfo, PresetRecord) | |
+ MidiTrackList | new_midi_track (ChanCount, ChanCount, PluginInfo, TrackMode, RouteGroup, unsigned int, std::string, PresetRecord) | |
RouteList | new_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 |
long | nominal_frame_rate () | |
@@ -1590,6 +1661,10 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
bool | transport_rolling () | |
double | transport_speed () | |
StringList | unknown_processors () | |
+ long | worst_input_latency () | |
+ long | worst_output_latency () | |
+ long | worst_playback_latency () | |
+ long | worst_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
bool | add_sidechain (Processor) | |
Amp | amp () | |
std::string | comment () | |
- bool | customize_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 |
+ bool | customize_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 |
Delivery | main_outs () | |
| the signal processorat at end of the processing chain which produces output |
bool | muted () | |
@@ -2288,6 +2363,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
Methods |
void | clear_changes () | |
| Forget about any changes to this object's properties |
+ ID | id () | |
OwnedPropertyList | properties () | |
↠ PBD:Controllable
@@ -2306,6 +2382,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
Methods |
void | clear_changes () | |
| Forget about any changes to this object's properties |
+ ID | id () | |
OwnedPropertyList | properties () | |
∁ PBD:ID
@@ -2326,6 +2403,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
Methods |
void | clear_changes () | |
| Forget about any changes to this object's properties |
+ ID | id () | |
OwnedPropertyList | properties () | |
∅ PBD:StatefulDestructible
@@ -2339,6 +2417,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
Methods |
void | clear_changes () | |
| Forget about any changes to this object's properties |
+ ID | id () | |
OwnedPropertyList | properties () | |
↠ PBD:StatefulDestructiblePtr
@@ -2355,6 +2434,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
Methods |
void | clear_changes () | |
| Forget about any changes to this object's properties |
+ ID | id () | |
OwnedPropertyList | properties () | |
∁ PBD:StatefulDiffCommand
@@ -2378,6 +2458,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
Methods |
void | clear_changes () | |
| Forget about any changes to this object's properties |
+ ID | id () | |
OwnedPropertyList | properties () | |
↠ PBD:StatefulPtr
@@ -2388,6 +2469,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
Methods |
void | clear_changes () | |
| Forget about any changes to this object's properties |
+ ID | id () | |
bool | isnil () | |
OwnedPropertyList | properties () | |
@@ -2460,6 +2542,14 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
- ARDOUR.SrcQuality.SrcBest
+∈ ARDOUR.PortFlags
+
+- ARDOUR.PortFlags.IsInput
+- ARDOUR.PortFlags.IsOutput
+- ARDOUR.PortFlags.IsPhysical
+- ARDOUR.PortFlags.CanMonitor
+- ARDOUR.PortFlags.IsTerminal
+
∈ ARDOUR.PlaylistDisposition
- ARDOUR.PlaylistDisposition.CopyPlaylist
@@ -2484,6 +2574,18 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
- ARDOUR.Session.RecordState.Enabled
- ARDOUR.Session.RecordState.Recording
+∈ ARDOUR.Location.Flags
+
+- ARDOUR.LocationFlags.IsMark
+- ARDOUR.LocationFlags.IsAutoPunch
+- ARDOUR.LocationFlags.IsAutoLoop
+- ARDOUR.LocationFlags.IsHidden
+- ARDOUR.LocationFlags.IsCDMarker
+- ARDOUR.LocationFlags.IsRangeMarker
+- ARDOUR.LocationFlags.IsSessionRange
+- ARDOUR.LocationFlags.IsSkip
+- ARDOUR.LocationFlags.IsSkipping
+
∈ Cairo.LineCap
-
+
-
+