From bf1456c4ad9f8a782611a22225dda130a8a45e5e Mon Sep 17 00:00:00 2001 From: Robin Gareus Date: Fri, 8 Apr 2016 03:02:05 +0200 Subject: [PATCH] update lua class reference (once again) --- .../24_lua-scripting/02_class_reference.html | 139 +++++++++++++++++- 1 file changed, 131 insertions(+), 8 deletions(-) diff --git a/_manual/24_lua-scripting/02_class_reference.html b/_manual/24_lua-scripting/02_class_reference.html index 66aa472..67803b5 100644 --- a/_manual/24_lua-scripting/02_class_reference.html +++ b/_manual/24_lua-scripting/02_class_reference.html @@ -8,6 +8,7 @@ title: Class Reference This documention is far from complete may be inaccurate and subject to change.

+
@@ -178,9 +179,12 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C + + + - +
Methods
voidapply_gain (float, long)
boolcheck_silence (unsigned int, unsigned int&)

check buffer for silence

nframes
number of frames to check
n
first non zero sample (if any)

Returns true if all samples are zero

FloatArraydata (long)
voidread_from (FloatArray, long, long, long)
voidsilence (long, long)

Clear (eg zero, or empty) buffer

silence buffer

len
number of samples to clear
offset
start offset

∁ ARDOUR:AudioEngine

C‡: ARDOUR::AudioEngine

@@ -232,12 +236,14 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C Methods boolactive () intadd_processor_by_index (Processor, int, ProcessorStreams, bool) + booladd_sidechain (Processor) std::stringcomment () boolcustomize_plugin_insert (Processor, unsigned int, ChanCount) ChanCountn_inputs () ChanCountn_outputs () Processornth_plugin (unsigned int) intremove_processor (Processor, ProcessorStreams, bool) + boolremove_sidechain (Processor) intreplace_processor (Processor, Processor, ProcessorStreams) boolreset_plugin_insert (Processor) voidset_active (bool, void*) @@ -351,15 +357,15 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C

∁ ARDOUR:ChanMapping

C‡: ARDOUR::ChanMapping

-

A mapping from one set of channels to another (e.g. how to 'connect' two BufferSets).

for plugins the form is "pin" -> "buffer"

+

A mapping from one set of channels to another. The general form is 1 source (from), many sinks (to). numeric IDs are used to identify sources and sinks.

for plugins this is used to map "plugin-pin" to "audio-buffer"

- + - +
Constructor
ℂARDOUR.ChanMapping ()
Methods
unsigned intget (DataType, unsigned int)

get buffer mapping for given data type and pin

from
pin
type
data type

Returns mapped buffer number (or ChanMapping::Invalid)

get buffer mapping for given data type and pin

from
numeric source id
type
data type

Returns mapped buffer number (or ChanMapping::Invalid)

voidset (DataType, unsigned int, unsigned int)

set buffer mapping for given data type

from
pin
to
buffer
type
data type

set buffer mapping for given data type

from
numeric source id
to
buffer
type
data type

ℕ ARDOUR.DSP

@@ -444,6 +450,13 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C + + + + + + +
Constructor
ℂARDOUR.DataType (std::string)
Methods
DataTypeaudio ()

convenience contructor for DataType::AUDIO

Returns DataType::AUDIO

DataTypemidi ()

convenience contructor for DataType::MIDI

Returns DataType::MIDI

DataTypenull ()

convenience contructor for DataType::NIL

Returns DataType::NIL

∁ ARDOUR:DeviceStatus

C‡: ARDOUR::AudioBackend::DeviceStatus

@@ -469,6 +482,66 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C unsigned longsize () LuaTabletable () +

↠ ARDOUR:IO

+

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

+

is-a: ARDOUR:SessionObject

+
+ + + + + + + + + + +
Methods
boolactive ()
intadd_port (std::string, void*, DataType)

Add a port.

destination
Name of port to connect new port to.
src
Source for emitted ConfigurationChanged signal.
type
Data type of port. Default value (NIL) will use this IO's default type.
intconnect (--MISSING (boost::shared_ptr<ARDOUR::Port>)--, std::string, void*)
intdisconnect (--MISSING (boost::shared_ptr<ARDOUR::Port>)--, std::string, void*)
boolisnil ()
boolphysically_connected ()
intremove_port (--MISSING (boost::shared_ptr<ARDOUR::Port>)--, void*)
+

Inherited from ARDOUR:SessionObject

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

Inherited from PBD:StatefulPtr

+ + + +
Methods
OwnedPropertyListproperties ()
+

↠ ARDOUR:IOProcessor

+

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

+

is-a: ARDOUR:Processor

+
+ + + + + + + +
Methods
IOinput ()
boolisnil ()
ChanCountnatural_input_streams ()
ChanCountnatural_output_streams ()
IOoutput ()
+

Inherited from ARDOUR:Processor

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

Inherited from ARDOUR:SessionObject

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

Inherited from PBD:StatefulPtr

+ + + +
Methods
OwnedPropertyListproperties ()

∁ ARDOUR:Location

C‡: ARDOUR::Location

is-a: PBD:StatefulDestructible

@@ -566,12 +639,14 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C Methods boolactive () intadd_processor_by_index (Processor, int, ProcessorStreams, bool) + booladd_sidechain (Processor) std::stringcomment () boolcustomize_plugin_insert (Processor, unsigned int, ChanCount) ChanCountn_inputs () ChanCountn_outputs () Processornth_plugin (unsigned int) intremove_processor (Processor, ProcessorStreams, bool) + boolremove_sidechain (Processor) intreplace_processor (Processor, Processor, ProcessorStreams) boolreset_plugin_insert (Processor) voidset_active (bool, void*) @@ -704,11 +779,9 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C voiddeactivate () ChanMappinginput_map (unsigned int) boolisnil () - boolno_inplace () ChanMappingoutput_map (unsigned int) Pluginplugin (unsigned int) voidset_input_map (unsigned int, ChanMapping) - voidset_no_inplace (bool) voidset_output_map (unsigned int, ChanMapping) boolstrict_io_configured () @@ -720,6 +793,8 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C Controlcontrol (Parameter, bool) std::stringdisplay_name () PluginInsertto_insert () + IOProcessorto_ioprocessor () + SideChainto_sidechain ()

Inherited from ARDOUR:SessionObject

@@ -756,6 +831,8 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C + +
boolisnil ()
boolisnil ()
PluginInsertto_insert ()
IOProcessorto_ioprocessor ()
SideChainto_sidechain ()

Inherited from ARDOUR:SessionObject

@@ -882,6 +959,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C + @@ -889,6 +967,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C + @@ -1007,6 +1086,45 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
Methods
boolactive ()
intadd_processor_by_index (Processor, int, ProcessorStreams, bool)
booladd_sidechain (Processor)
std::stringcomment ()
boolcustomize_plugin_insert (Processor, unsigned int, ChanCount)
boolisnil ()
ChanCountn_outputs ()
Processornth_plugin (unsigned int)
intremove_processor (Processor, ProcessorStreams, bool)
boolremove_sidechain (Processor)
intreplace_processor (Processor, Processor, ProcessorStreams)
boolreset_plugin_insert (Processor)
voidset_active (bool, void*)
Methods
OwnedPropertyListproperties ()
+

↠ ARDOUR:SideChain

+

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

+

is-a: ARDOUR:IOProcessor

+
+ + + +
Methods
boolisnil ()
+

Inherited from ARDOUR:IOProcessor

+ + + + + + +
Methods
IOinput ()
ChanCountnatural_input_streams ()
ChanCountnatural_output_streams ()
IOoutput ()
+

Inherited from ARDOUR:Processor

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

Inherited from ARDOUR:SessionObject

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

Inherited from PBD:StatefulPtr

+ + + +
Methods
OwnedPropertyListproperties ()

↠ ARDOUR:Source

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

@@ -1056,12 +1174,14 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C Methods boolactive () intadd_processor_by_index (Processor, int, ProcessorStreams, bool) + booladd_sidechain (Processor) std::stringcomment () boolcustomize_plugin_insert (Processor, unsigned int, ChanCount) ChanCountn_inputs () ChanCountn_outputs () Processornth_plugin (unsigned int) intremove_processor (Processor, ProcessorStreams, bool) + boolremove_sidechain (Processor) intreplace_processor (Processor, Processor, ProcessorStreams) boolreset_plugin_insert (Processor) voidset_active (bool, void*) @@ -1365,7 +1485,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C

Makes a copy of the current state of the Context and saves it on an internal stack of saved states. When restore() is called, it will be restored to the saved state. Multiple calls to save() and restore() can be nested; each call to restore() restores the state from the matching paired save().

It isn't necessary to clear all saved states before a cairo_t is freed. Any saved states will be freed when the Context is destroyed.

restore()

voidscale (double, double)

Modifies the current transformation matrix (CTM) by scaling the X and Y user-space axes by sx and sy respectively. The scaling of the axes takes place after any existing transformation of user space.

sx
scale factor for the X dimension
sy
scale factor for the Y dimension
- voidset_dash (DoubleVector&, double) + voidset_dash (DoubleVector, double) voidset_font_size (double)

Sets the current font matrix to a scale by a factor of size, replacing any font matrix previously set with set_font_size() or set_font_matrix(). This results in a font size of size user space units. (More precisely, this matrix will result in the font's em-square being a by size square in user space.)

If text is drawn without a call to set_font_size(), (nor set_font_matrix() nor set_scaled_font()), the default font size is 10.0.

size
the new font size, in user space units)
voidset_line_cap (LineCap) @@ -1811,6 +1931,8 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
  • ARDOUR:DataType
  • ARDOUR:DeviceStatus
  • ARDOUR:DeviceStatusVector
    • +
  • ARDOUR:IO
    • +
  • ARDOUR:IOProcessor
  • ARDOUR:Location
  • ARDOUR.LuaAPI
  • ARDOUR:LuaOSC:Address
    • @@ -1839,6 +1961,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
  • ARDOUR:RouteListPtr
  • ARDOUR:Session
  • ARDOUR:SessionObject
    • +
  • ARDOUR:SideChain
  • ARDOUR:Source
  • ARDOUR:Tempo
  • ARDOUR:TempoMap
    • @@ -1874,4 +1997,4 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
  • Timecode:BBT_TIME
    • -
    Ardour 4.7-535-g0818257  -  Thu, 31 Mar 2016 01:17:33 +0200
    +
    Ardour 4.7-626-g5e2c9f8  -  Wed, 06 Apr 2016 18:47:33 +0200
    -- 2.37.2