X-Git-Url: http://shamusworld.gotdns.org/cgi-bin/gitweb.cgi?a=blobdiff_plain;f=_manual%2F24_lua-scripting%2F02_class_reference.html;h=f21f6aea82c427a6e30c9fc1d10b210755b1b0b7;hb=a3167e17b75f9430c13e48f7c26c2c235aec24ec;hp=3ddfbf0066c6ac19cd86bd8112adf96de7cbc508;hpb=840272838fb1914dfa5103e22bd481dad7251cd7;p=ardour-manual
diff --git a/_manual/24_lua-scripting/02_class_reference.html b/_manual/24_lua-scripting/02_class_reference.html
index 3ddfbf0..f21f6ae 100644
--- a/_manual/24_lua-scripting/02_class_reference.html
+++ b/_manual/24_lua-scripting/02_class_reference.html
@@ -261,8 +261,8 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
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&, --MISSING (ARDOUR::MidiPortFlags)--, --MISSING (ARDOUR::MidiPortFlags)--) | |
- void | get_physical_outputs (DataType, StringVector&, --MISSING (ARDOUR::MidiPortFlags)--, --MISSING (ARDOUR::MidiPortFlags)--) | |
+ void | get_physical_inputs (DataType, StringVector&, MidiPortFlags, MidiPortFlags) | |
+ void | get_physical_outputs (DataType, StringVector&, MidiPortFlags, MidiPortFlags) | |
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&) | |
@@ -589,6 +589,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
| Return the first processor that accepts has at least one MIDI input and at least one audio output. In the vast majority of cases, this will be "the instrument". This does not preclude other MIDI->audio processors later in the processing chain, but that would be a special case not covered by this utility function. |
Amp | trim () | |
Cast |
+ Automatable | to_automatable () | |
Track | to_track () | |
Inherited from ARDOUR:Stripable
@@ -1228,12 +1229,13 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
Methods |
- LuaTable | build_filename () | |
+ ... | build_filename (--lua--) | |
+ | Creates a filename from a series of elements using the correct separator for filenames. No attempt is made to force the resulting filename to be an absolute path. If the first element is a relative path, the result will be a relative path. |
LuaTable(float, ...) | get_plugin_insert_param (PluginInsert, unsigned int, bool&) | |
| get a plugin control parameter value - which
- control port to query (starting at 0, including ports of type input and output)
- ok
- boolean variable contains true or false after call returned. to be checked by caller before using value.
- proc
- Plugin-Insert
|
LuaTable(float, ...) | get_processor_param (Processor, unsigned int, bool&) | |
| get a plugin control parameter value - proc
- Plugin-Processor
- which
- control port to set (starting at 0, including ports of type input and output))
- ok
- boolean variable contains true or false after call returned. to be checked by caller before using value.
|
- LuaTable | hsla_to_rgba () | |
+ ... | hsla_to_rgba (--lua--) | |
| A convenience function for colorspace HSL to RGB conversion. All ranges are 0..1 Example: local r, g, b, a = ARDOUR.LuaAPI.hsla_to_rgba (hue, saturation, luminosity, alpha) Returns 4 parameters: red, green, blue, alpha (in range 0..1) |
Processor | new_luaproc (Session, std::string) | |
| create a new Lua Processor (Plugin) - s
- Session Handle
- p
- Identifier or Name of the Processor
Returns Processor object (may be nil) |
@@ -1243,7 +1245,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
PluginInfo | new_plugin_info (std::string, PluginType) | |
| search a Plugin - id
- Plugin Name, ID or URI
- type
- Plugin Type
Returns PluginInfo or nil if not found |
Processor | nil_proc () | |
- LuaTable | plugin_automation () | |
+ ... | plugin_automation (--lua--) | |
| 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)
@@ -1253,10 +1255,14 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
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 |
+ ... | sample_to_timecode (--lua--) | |
+ | Generic conversion from audio sample count to timecode. (TimecodeType, sample-rate, sample-pos) |
bool | set_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 |
bool | set_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 |
+ ... | timecode_to_sample (--lua--) | |
+ | Generic conversion from timecode to audio sample count. (TimecodeType, sample-rate, hh, mm, ss, ff) |
void | usleep (unsigned long) | |
∁ ARDOUR:LuaAPI:Vamp
@@ -1390,7 +1396,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
void | copy (MidiBuffer) | |
bool | empty () | |
bool | push_back (long, unsigned long, unsigned char*) | |
- bool | push_event (MidiEvent) | |
+ bool | push_event (Event) | |
void | resize (unsigned long) | |
| Reallocate the buffer used internally to handle at least size_t units of data. The buffer is not silent after this operation. the capacity argument passed to the constructor must have been non-zero. |
bool | sameinstance (MidiBuffer) | |
@@ -1751,6 +1757,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
| Return the first processor that accepts has at least one MIDI input and at least one audio output. In the vast majority of cases, this will be "the instrument". This does not preclude other MIDI->audio processors later in the processing chain, but that would be a special case not covered by this utility function. |
Amp | trim () | |
Cast |
+ Automatable | to_automatable () | |
Track | to_track () | |
Inherited from ARDOUR:Stripable
@@ -2256,6 +2263,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
ChanCount | natural_output_streams () | |
ChanMapping | output_map (unsigned int) | |
Plugin | plugin (unsigned int) | |
+ bool | reset_parameters_to_default () | |
bool | sameinstance (PluginInsert) | |
void | set_input_map (unsigned int, ChanMapping) | |
void | set_output_map (unsigned int, ChanMapping) | |
@@ -2342,8 +2350,8 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
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&, --MISSING (ARDOUR::MidiPortFlags)--, --MISSING (ARDOUR::MidiPortFlags)--) | |
- void | get_physical_outputs (DataType, StringVector&, --MISSING (ARDOUR::MidiPortFlags)--, --MISSING (ARDOUR::MidiPortFlags)--) | |
+ void | get_physical_inputs (DataType, StringVector&, MidiPortFlags, MidiPortFlags) | |
+ void | get_physical_outputs (DataType, StringVector&, MidiPortFlags, MidiPortFlags) | |
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&) | |
@@ -2669,6 +2677,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
| Return the first processor that accepts has at least one MIDI input and at least one audio output. In the vast majority of cases, this will be "the instrument". This does not preclude other MIDI->audio processors later in the processing chain, but that would be a special case not covered by this utility function. |
Amp | trim () | |
Cast |
+ Automatable | to_automatable () | |
Track | to_track () | |
Inherited from ARDOUR:Stripable
@@ -2735,11 +2744,59 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
Constructor |
ℂ | ARDOUR.Route.ProcessorStreams () | |
-∅ ARDOUR:RouteGroup
+∁ ARDOUR:RouteGroup
C‡: ARDOUR::RouteGroup
A group identifier for routes.
RouteGroups permit to define properties which are shared among all Routes that use the given identifier.
A route can at most be in one group.
-This class object is only used indirectly as return-value and function-parameter. It provides no methods by itself.
+
+ Methods |
+ int | add (Route) | |
+ | Add a route to a group. Adding a route which is already in the group is allowed; nothing will happen. - r
- Route to add.
|
+ void | clear () | |
+ void | destroy_subgroup () | |
+ bool | empty () | |
+ int | group_master_number () | |
+ bool | has_subgroup () | |
+ bool | is_active () | |
+ bool | is_color () | |
+ bool | is_gain () | |
+ bool | is_hidden () | |
+ bool | is_monitoring () | |
+ bool | is_mute () | |
+ bool | is_recenable () | |
+ bool | is_relative () | |
+ bool | is_route_active () | |
+ bool | is_select () | |
+ bool | is_solo () | |
+ void | make_subgroup (bool, Placement) | |
+ int | remove (Route) | |
+ RouteListPtr | route_list () | |
+ void | set_active (bool, void*) | |
+ void | set_color (bool) | |
+ void | set_gain (bool) | |
+ void | set_hidden (bool, void*) | |
+ void | set_monitoring (bool) | |
+ void | set_mute (bool) | |
+ void | set_recenable (bool) | |
+ void | set_relative (bool, void*) | |
+ void | set_route_active (bool) | |
+ void | set_select (bool) | |
+ void | set_solo (bool) | |
+ unsigned long | size () | |
+
+∁ ARDOUR:RouteGroupList
+C‡: std::list<ARDOUR::RouteGroup* >
+
+
+ Constructor |
+ ℂ | ARDOUR.RouteGroupList () | |
+ Methods |
+ bool | empty () | |
+ LuaIter | iter () | |
+ void | reverse () | |
+ unsigned long | size () | |
+ LuaTable | table () | |
+
∁ ARDOUR:RouteList
C‡: std::list<boost::shared_ptr<ARDOUR::Route> >
@@ -2793,7 +2850,6 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
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 () | |
bool | get_play_loop () | |
Route | get_remote_nth_route (unsigned int) | |
@@ -2815,11 +2871,13 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
RouteList | new_midi_route (RouteGroup, unsigned int, std::string, PluginInfo, PresetRecord, Flag, unsigned int) | |
MidiTrackList | new_midi_track (ChanCount, ChanCount, PluginInfo, PresetRecord, RouteGroup, unsigned int, std::string, unsigned int, TrackMode) | |
RouteList | new_route_from_template (unsigned int, unsigned int, std::string, std::string, PlaylistDisposition) | |
+ RouteGroup | new_route_group (std::string) | |
long | nominal_frame_rate () | |
| "native" sample rate of session, regardless of current audioengine rate, pullup/down etc |
std::string | path () | |
Processor | processor_by_id (ID) | |
RecordState | record_status () | |
+ void | remove_route_group (RouteGroup) | |
void | request_locate (long, bool) | |
void | request_play_loop (bool, bool) | |
void | request_stop (bool, bool) | |
@@ -2827,6 +2885,9 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
Route | route_by_id (ID) | |
Route | route_by_name (std::string) | |
Route | route_by_selected_count (unsigned int) | |
+ RouteGroupList | route_groups () | |
+ ... | sample_to_timecode_lua (--lua--) | |
+ double | samples_per_timecode_frame () | |
int | save_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)
|
void | scripts_changed () | |
@@ -2835,8 +2896,12 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
Source | source_by_id (ID) | |
TempoMap | tempo_map () | |
bool | timecode_drop_frames () | |
+ bool | timecode_drop_frames () | |
long | timecode_frames_per_hour () | |
+ long | timecode_frames_per_hour () | |
+ double | timecode_frames_per_second () | |
double | timecode_frames_per_second () | |
+ ... | timecode_to_sample_lua (--lua--) | |
Track | track_by_diskstream_id (ID) | |
long | transport_frame () | |
bool | transport_rolling () | |
@@ -3414,8 +3479,8 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
TempoSection | add_tempo (Tempo, double, long, Type, PositionLockStyle) | |
BBT_TIME | bbt_at_frame (long) | |
| Returns the BBT time corresponding to the supplied frame position. - frame
- the position in audio samples.
Returns the BBT time at the frame position . |
- double | exact_beat_at_frame (long, int) | |
- double | exact_qn_at_frame (long, int) | |
+ double | exact_beat_at_frame (long, int) | |
+ double | exact_qn_at_frame (long, int) | |
MeterSection | meter_section_at_beat (double) | |
MeterSection | meter_section_at_frame (long) | |
TempoSection | tempo_section_at_frame (long) | |
@@ -3498,6 +3563,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
| Return the first processor that accepts has at least one MIDI input and at least one audio output. In the vast majority of cases, this will be "the instrument". This does not preclude other MIDI->audio processors later in the processing chain, but that would be a special case not covered by this utility function. |
Amp | trim () | |
Cast |
+ Automatable | to_automatable () | |
Track | to_track () | |
Inherited from ARDOUR:Stripable
@@ -4159,31 +4225,15 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
Methods |
unsigned char* | buffer () | |
+ unsigned char | channel () | |
void | clear () | |
void | set_buffer (unsigned int, unsigned char*, bool) | |
+ void | set_channel (unsigned char) | |
+ void | set_type (unsigned char) | |
unsigned int | size () | |
long | time () | |
+ unsigned char | type () | |
-∁ Evoral:MidiEvent
-C‡: Evoral::MIDIEvent<long>
- is-a: Evoral:Event
-
-
- Methods |
- unsigned char | channel () | |
- void | set_channel (unsigned char) | |
- void | set_type (unsigned char) | |
- unsigned char | type () | |
-
-Inherited from Evoral:Event
-
- Methods |
- unsigned char* | buffer () | |
- void | clear () | |
- void | set_buffer (unsigned int, unsigned char*, bool) | |
- unsigned int | size () | |
- long | time () | |
-
↠ Evoral:NotePtr
C‡: boost::shared_ptr< Evoral::Note<Evoral::Beats> >, boost::weak_ptr< Evoral::Note<Evoral::Beats> >
@@ -4494,6 +4544,26 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
unsigned int | beats | |
unsigned int | ticks | |
+∁ Timecode:Time
+C‡: Timecode::Time
+
+
+ Constructor |
+ ℂ | Timecode.Time (double) | |
+ Data Members |
+ bool | drop | |
+ | Whether this Time uses dropframe Timecode |
+ unsigned int | frames | |
+ | Timecode frames (not audio samples) |
+ unsigned int | hours | |
+ unsigned int | minutes | |
+ bool | negative | |
+ double | rate | |
+ | |
+ unsigned int | seconds | |
+ unsigned int | subframes | |
+ | |
+
∁ Vamp:Plugin
C‡: Vamp::Plugin
is-a: Vamp:PluginBase
@@ -4840,6 +4910,12 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
ARDOUR.AutomationType.RecSafeAutomation
ARDOUR.AutomationType.TrimAutomation
ARDOUR.AutomationType.PhaseAutomation
+ARDOUR.AutomationType.MidiCCAutomation
+ARDOUR.AutomationType.MidiPgmChangeAutomation
+ARDOUR.AutomationType.MidiPitchBenderAutomation
+ARDOUR.AutomationType.MidiChannelPressureAutomation
+ARDOUR.AutomationType.MidiNotePressureAutomation
+ARDOUR.AutomationType.MidiSystemExclusiveAutomation
∈ ARDOUR.SrcQuality
@@ -4870,6 +4946,11 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
- ARDOUR.MeterPoint.MeterOutput
- ARDOUR.MeterPoint.MeterCustom
+∈ ARDOUR.Placement
+
+- ARDOUR.Placement.PreFader
+- ARDOUR.Placement.PostFader
+
∈ ARDOUR.NoteMode
- ARDOUR.NoteMode.Sustained
@@ -4883,6 +4964,13 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
- ARDOUR.PortFlags.CanMonitor
- ARDOUR.PortFlags.IsTerminal
+∈ ARDOUR.MidiPortFlags
+
+- ARDOUR.MidiPortFlags.MidiPortMusic
+- ARDOUR.MidiPortFlags.MidiPortControl
+- ARDOUR.MidiPortFlags.MidiPortSelection
+- ARDOUR.MidiPortFlags.MidiPortVirtual
+
∈ ARDOUR.PlaylistDisposition
-
+
-
+