From fd1ad5d44650630a40b1afa2bd6c5278737346b9 Mon Sep 17 00:00:00 2001 From: Robin Gareus Date: Tue, 31 May 2016 03:24:59 +0200 Subject: [PATCH] update lua class doc --- .../24_lua-scripting/02_class_reference.html | 91 +++++++++++++++++-- 1 file changed, 82 insertions(+), 9 deletions(-) diff --git a/_manual/24_lua-scripting/02_class_reference.html b/_manual/24_lua-scripting/02_class_reference.html index 5eda475..503e877 100644 --- a/_manual/24_lua-scripting/02_class_reference.html +++ b/_manual/24_lua-scripting/02_class_reference.html @@ -146,10 +146,12 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C voiddeactivate () std::stringdisplay_name () Cast + Ampto_amp () Automatableto_automatable () PluginInsertto_insert () IOProcessorto_ioprocessor () SideChainto_sidechain () + UnknownProcessorto_unknownprocessor ()

Inherited from ARDOUR:SessionObject

@@ -263,7 +265,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C - +
ChanCountn_physical_inputs ()
ChanCountn_physical_outputs ()
boolphysically_connected (std::string)
--MISSING (ARDOUR::PortEngine&)--port_engine ()
PortEngineport_engine ()
boolport_is_physical (std::string)

↠ ARDOUR:AudioPort

@@ -294,6 +296,9 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C

Returns true if this Port receives input, otherwise false

boolsends_output ()

Returns true if this Port sends output, otherwise false

+ Cast + AudioPortto_audioport () + MidiPortto_midiport ()

∁ ARDOUR:AudioRange

C‡: ARDOUR::AudioRange

@@ -379,6 +384,8 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C ChanCountn_inputs () ChanCountn_outputs () Processornth_plugin (unsigned int) + Processornth_processor (unsigned int) + Processornth_send (unsigned int) intremove_processor (Processor, ProcessorStreams, bool)

remove plugin/processor

proc
processor to remove
err
error report (index where removal vailed, channel-count why it failed) may be nil
need_process_lock
if locking is required (set to true, unless called from RT context with lock)

Returns 0 on success

boolremove_sidechain (Processor) @@ -664,10 +671,12 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C voiddeactivate () std::stringdisplay_name () Cast + Ampto_amp () Automatableto_automatable () PluginInsertto_insert () IOProcessorto_ioprocessor () SideChainto_sidechain () + UnknownProcessorto_unknownprocessor ()

Inherited from ARDOUR:SessionObject

@@ -794,10 +803,12 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C + +
voiddeactivate ()
std::stringdisplay_name ()
Cast
Ampto_amp ()
Automatableto_automatable ()
PluginInsertto_insert ()
IOProcessorto_ioprocessor ()
SideChainto_sidechain ()
UnknownProcessorto_unknownprocessor ()

Inherited from ARDOUR:SessionObject

@@ -940,10 +951,12 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C

Buffer containing 8-bit unsigned char (MIDI) data.

- + + +
Methods
boolempty ()
boolpush_back (long, unsigned long, unsigned char*)
boolpush_event (MidiEvent)
boolsameinstance (MidiBuffer)
voidsilence (long, long)

Clear (eg zero, or empty) buffer

...table (--lua--)

↠ ARDOUR:MidiPort

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

@@ -951,6 +964,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
+ @@ -975,6 +989,9 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C + + +
Methods
MidiBufferget_midi_buffer (unsigned int)
boolinput_active ()
boolisnil ()
voidset_input_active (bool)

Returns true if this Port receives input, otherwise false

boolsends_output ()

Returns true if this Port sends output, otherwise false

Cast
AudioPortto_audioport ()
MidiPortto_midiport ()

↠ ARDOUR:MidiTrack

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

@@ -1022,6 +1039,8 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C ChanCountn_inputs () ChanCountn_outputs () Processornth_plugin (unsigned int) + Processornth_processor (unsigned int) + Processornth_send (unsigned int) intremove_processor (Processor, ProcessorStreams, bool)

remove plugin/processor

proc
processor to remove
err
error report (index where removal vailed, channel-count why it failed) may be nil
need_process_lock
if locking is required (set to true, unless called from RT context with lock)

Returns 0 on success

boolremove_sidechain (Processor) @@ -1242,10 +1261,12 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C Controlcontrol (Parameter, bool) std::stringdisplay_name () Cast + Ampto_amp () Automatableto_automatable () PluginInsertto_insert () IOProcessorto_ioprocessor () SideChainto_sidechain () + UnknownProcessorto_unknownprocessor ()

Inherited from ARDOUR:SessionObject

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

Returns true if this Port receives input, otherwise false

boolsends_output ()

Returns true if this Port sends output, otherwise false

Cast
AudioPortto_audioport ()
MidiPortto_midiport ()
+

∅ ARDOUR:PortEngine

+

C‡: ARDOUR::PortEngine

+
+

PortEngine is an abstract base class that defines the functionality required by Ardour.

A Port is basically an endpoint for a datastream (which can either be continuous, like audio, or event-based, like MIDI). Ports have buffers associated with them into which data can be written (if they are output ports) and from which data can be read (if they input ports). Ports can be connected together so that data written to an output port can be read from an input port. These connections can be 1:1, 1:N OR N:1.

Ports may be associated with software only, or with hardware. Hardware related ports are often referred to as physical, and correspond to some relevant physical entity on a hardware device, such as an audio jack or a MIDI connector. Physical ports may be potentially asked to monitor their inputs, though some implementations may not support this.

Most physical ports will also be considered "terminal", which means that data delivered there or read from there will go to or comes from a system outside of the PortEngine implementation's control (e.g. the analog domain for audio, or external MIDI devices for MIDI). Non-physical ports can also be considered "terminal". For example, the output port of a software synthesizer is a terminal port, because the data contained in its buffer does not and cannot be considered to come from any other port - it is synthesized by its owner.

Ports also have latency associated with them. Each port has a playback latency and a capture latency:

capture latency: how long since the data read from the buffer of a port arrived at at a terminal port. The data will have come from the "outside world" if the terminal port is also physical, or will have been synthesized by the entity that owns the terminal port.

playback latency: how long until the data written to the buffer of port will reach a terminal port.

For more detailed questions about the PortEngine API, consult the JACK API documentation, on which this entire object is based.

+

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

∁ ARDOUR:PortList

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

@@ -1312,7 +1341,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C ChanCountn_physical_inputs () ChanCountn_physical_outputs () boolphysically_connected (std::string) - --MISSING (ARDOUR::PortEngine&)--port_engine () + PortEngineport_engine () boolport_is_physical (std::string)

↠ ARDOUR:PortSet

@@ -1359,10 +1388,12 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C std::stringdisplay_name () boolisnil () Cast + Ampto_amp () Automatableto_automatable () PluginInsertto_insert () IOProcessorto_ioprocessor () SideChainto_sidechain () + UnknownProcessorto_unknownprocessor ()

Inherited from ARDOUR:SessionObject

@@ -1528,6 +1559,8 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C + + @@ -1708,10 +1741,12 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C + +
ChanCountn_inputs ()
ChanCountn_outputs ()
Processornth_plugin (unsigned int)
Processornth_processor (unsigned int)
Processornth_send (unsigned int)
intremove_processor (Processor, ProcessorStreams, bool)

remove plugin/processor

proc
processor to remove
err
error report (index where removal vailed, channel-count why it failed) may be nil
need_process_lock
if locking is required (set to true, unless called from RT context with lock)

Returns 0 on success

boolremove_sidechain (Processor)
voiddeactivate ()
std::stringdisplay_name ()
Cast
Ampto_amp ()
Automatableto_automatable ()
PluginInsertto_insert ()
IOProcessorto_ioprocessor ()
SideChainto_sidechain ()
UnknownProcessorto_unknownprocessor ()

Inherited from ARDOUR:SessionObject

@@ -1749,8 +1784,8 @@ 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
voidadd_meter (Meter, BBT_TIME)
voidadd_tempo (Tempo, BBT_TIME)
--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)--)

↠ ARDOUR:Track

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

@@ -1794,6 +1829,8 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C ChanCountn_inputs () ChanCountn_outputs () Processornth_plugin (unsigned int) + Processornth_processor (unsigned int) + Processornth_send (unsigned int) intremove_processor (Processor, ProcessorStreams, bool)

remove plugin/processor

proc
processor to remove
err
error report (index where removal vailed, channel-count why it failed) may be nil
need_process_lock
if locking is required (set to true, unless called from RT context with lock)

Returns 0 on success

boolremove_sidechain (Processor) @@ -1818,6 +1855,40 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C Statefulto_stateful () StatefulDestructibleto_statefuldestructible () +

↠ ARDOUR:UnknownProcessor

+

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

+

is-a: ARDOUR:Processor

+
+

A stub Processor that can be used in place of a `real' one that cannot be created for some reason; usually because it requires a plugin which is not present. UnknownProcessors are special-cased in a few places, notably in route configuration and signal processing, so that on encountering them configuration or processing stops.

When a Processor is missing from a Route, the following processors cannot be configured, as the missing Processor's output port configuration is unknown.

The main utility of the UnknownProcessor is that it allows state to be preserved, so that, for example, loading and re-saving a session on a machine without a particular plugin will not corrupt the session.

+ + + +
Methods
boolisnil ()
+

Inherited from ARDOUR:Processor

+ + + + + + + + + + + + + + + +
Methods
voidactivate ()
boolactive ()
AutomationControlautomation_control (Parameter, bool)
Controlcontrol (Parameter, bool)
voiddeactivate ()
std::stringdisplay_name ()
Cast
Ampto_amp ()
Automatableto_automatable ()
PluginInsertto_insert ()
IOProcessorto_ioprocessor ()
SideChainto_sidechain ()
UnknownProcessorto_unknownprocessor ()
+

Inherited from ARDOUR:SessionObject

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

∁ ARDOUR:WeakAudioSourceList

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

@@ -2289,8 +2360,8 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C - - + +
Methods
unsigned charchannel ()
unsigned charset_channel ()
unsigned charset_type ()
voidset_channel (unsigned char)
voidset_type (unsigned char)
unsigned chartype ()

Inherited from Evoral:Event

@@ -2822,6 +2893,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
  • ARDOUR:PluginInfo
  • ARDOUR:PluginInsert
  • ARDOUR:Port
    • +
  • ARDOUR:PortEngine
  • ARDOUR:PortList
  • ARDOUR:PortManager
  • ARDOUR:PortSet
    • @@ -2848,6 +2920,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
  • ARDOUR:Tempo
  • ARDOUR:TempoMap
  • ARDOUR:Track
    • +
  • ARDOUR:UnknownProcessor
  • ARDOUR:WeakAudioSourceList
  • ARDOUR:WeakRouteList
  • ARDOUR:WeakSourceList
    • @@ -2887,6 +2960,6 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
  • PBD:XMLNode
  • Timecode:BBT_TIME
    • - + -
    Ardour 4.7-1065-ge63c2c3  -  Sat, 21 May 2016 16:17:54 +0200
    +
    Ardour 4.7-1385-gca8ac05  -  Tue, 31 May 2016 03:23:16 +0200
    -- 2.37.2