From 86de0e478d70dc4074c803dadc7419843f5448e4 Mon Sep 17 00:00:00 2001 From: Robin Gareus Date: Sun, 27 Mar 2016 22:42:31 +0200 Subject: [PATCH] update class reference --- .../24_lua-scripting/02_class_reference.html | 32 ++++++++++++++++--- 1 file changed, 27 insertions(+), 5 deletions(-) diff --git a/_manual/24_lua-scripting/02_class_reference.html b/_manual/24_lua-scripting/02_class_reference.html index 8f71da0..f62a390 100644 --- a/_manual/24_lua-scripting/02_class_reference.html +++ b/_manual/24_lua-scripting/02_class_reference.html @@ -10,6 +10,7 @@ This documention is far from complete may be inaccurate and subject to change.
+

Overview

The top-level entry point are ARDOUR:Session and ArdourUI:Editor. @@ -232,11 +233,13 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C boolactive () intadd_processor_by_index (Processor, int, ProcessorStreams, bool) std::stringcomment () + boolcustomize_plugin_insert (Processor, unsigned int, ChanCount) ChanCountn_inputs () ChanCountn_outputs () Processornth_plugin (unsigned int) intremove_processor (Processor, ProcessorStreams, bool) intreplace_processor (Processor, Processor, ProcessorStreams) + boolreset_plugin_insert (Processor) voidset_active (bool, void*) voidset_comment (std::string, void*) boolset_strict_io (bool) @@ -327,19 +330,35 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C

A count of channels, possibly with many types.

Operators are defined so this may safely be used as if it were a simple (single-typed) integer count of channels.

+ + + + + + + + + + + + + +
Constructor
ℂARDOUR.ChanCount (DataType, unsigned int)

Convenience constructor for making single-typed streams (mono, stereo, midi, etc)

type
data type
count
number of channels
Methods
unsigned intget (DataType)

query channel count for given type

type
data type

Returns channel count for given type

unsigned intn_audio ()

query number of audio channels

Returns number of audio channels

unsigned intn_midi ()

query number of midi channels

Returns number of midi channels

unsigned intn_total ()

query total channel count of all data types

Returns total channel count (audio + midi)

voidreset ()

zero count of all data types

voidset (DataType, unsigned int)

set channel count for given type

count
number of channels
type
data type

∁ ARDOUR:ChanMapping

C‡: ARDOUR::ChanMapping

-

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

+

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

for plugins the form is "pin" -> "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)

voidset (DataType, unsigned int, unsigned int)

set buffer mapping for given data type

from
pin
to
buffer
type
data type

ℕ ARDOUR.DSP

@@ -545,11 +564,13 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C boolactive () intadd_processor_by_index (Processor, int, ProcessorStreams, bool) std::stringcomment () + boolcustomize_plugin_insert (Processor, unsigned int, ChanCount) ChanCountn_inputs () ChanCountn_outputs () Processornth_plugin (unsigned int) intremove_processor (Processor, ProcessorStreams, bool) intreplace_processor (Processor, Processor, ProcessorStreams) + boolreset_plugin_insert (Processor) voidset_active (bool, void*) voidset_comment (std::string, void*) boolset_strict_io (bool) @@ -684,7 +705,6 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C voidset_input_map (unsigned int, ChanMapping) voidset_no_inplace (bool) voidset_output_map (unsigned int, ChanMapping) - voidset_strict_io (bool) boolstrict_io_configured ()

Inherited from ARDOUR:Processor

@@ -854,12 +874,14 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C boolactive () intadd_processor_by_index (Processor, int, ProcessorStreams, bool) std::stringcomment () + boolcustomize_plugin_insert (Processor, unsigned int, ChanCount) boolisnil () ChanCountn_inputs () ChanCountn_outputs () Processornth_plugin (unsigned int) intremove_processor (Processor, ProcessorStreams, bool) intreplace_processor (Processor, Processor, ProcessorStreams) + boolreset_plugin_insert (Processor) voidset_active (bool, void*) voidset_comment (std::string, void*) boolset_name (std::string) @@ -1025,11 +1047,13 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C boolactive () intadd_processor_by_index (Processor, int, ProcessorStreams, bool) std::stringcomment () + boolcustomize_plugin_insert (Processor, unsigned int, ChanCount) ChanCountn_inputs () ChanCountn_outputs () Processornth_plugin (unsigned int) intremove_processor (Processor, ProcessorStreams, bool) intreplace_processor (Processor, Processor, ProcessorStreams) + boolreset_plugin_insert (Processor) voidset_active (bool, void*) voidset_comment (std::string, void*) boolset_strict_io (bool) @@ -1838,6 +1862,4 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
  • Timecode:BBT_TIME
    • -
    Ardour 4.7-469-g3f71e66  -  Sat, 26 Mar 2016 21:11:56 +0100
    - - +
    Ardour 4.7-489-g840c059  -  Sun, 27 Mar 2016 22:39:31 +0200
    -- 2.37.2