From 2e10a3afc069eff317efba86e5014f0717b5bf1b Mon Sep 17 00:00:00 2001 From: Robin Gareus Date: Tue, 9 Aug 2016 16:46:47 +0200 Subject: [PATCH] update lua class doc --- .../24_lua-scripting/02_class_reference.html | 62 +++++++++++++++---- 1 file changed, 49 insertions(+), 13 deletions(-) diff --git a/_manual/24_lua-scripting/02_class_reference.html b/_manual/24_lua-scripting/02_class_reference.html index c5fda36..b415a69 100644 --- a/_manual/24_lua-scripting/02_class_reference.html +++ b/_manual/24_lua-scripting/02_class_reference.html @@ -588,8 +588,8 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C voidmix_buffers_with_gain (FloatArray, FloatArray, unsigned int, float) voidmmult (FloatArray, FloatArray, unsigned int)

matrix multiply multiply every sample of `data' with the corresponding sample at `mult'.

data
multiplicand
mult
multiplicand
n_samples
number of samples in data and mmult
- LuaTable(...)peaks (FloatArray, float&, float&, unsigned int) -

calculate peaks

data
data to analyze
min
result, minimum value found in range
max
result, max value found in range
n_samples
number of samples to analyze
+ LuaTable(...)peaks (FloatArray, float&, float&, unsigned int) + voidprocess_map (BufferSet, ChanMapping, ChanMapping, unsigned int, long, DataType)

∁ ARDOUR:DSP:Biquad

C‡: ARDOUR::DSP::Biquad

@@ -880,9 +880,18 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C + + + + + + + + + @@ -890,6 +899,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C +
Methods
longend ()
Flagsflags ()
boolis_auto_loop ()
boolis_auto_punch ()
boolis_cd_marker ()
boolis_hidden ()
boolis_mark ()
boolis_range_marker ()
boolis_session_range ()
longlength ()
voidlock ()
boollocked ()
boolmatches (Flags)
intmove_to (long)
intset_end (long, bool, bool)

Set end position.

force
true to force setting, even if the given new end is before the current start.
allow_bbt_recompute
True to recompute BBT end time from the new given end time.
s
New end.
intset_start (long, bool, bool)

Set start position.

s
New start.
force
true to force setting, even if the given new start is after the current end.
allow_bbt_recompute
True to recompute BBT start time from the new given start time.
longstart ()
voidunlock ()

Inherited from PBD:Stateful

@@ -925,6 +935,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C + @@ -1031,11 +1042,16 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C

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

longfirst_mark_after (long, bool)
Locationfirst_mark_at (long, long)
longfirst_mark_before (long, bool)
LocationListlist ()
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)
Locationsession_range_location ()
+ + + + +
Methods
voidcopy (MidiBuffer)
boolempty ()
boolpush_back (long, unsigned long, unsigned char*)
boolpush_event (MidiEvent)
voidresize (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.

boolsameinstance (MidiBuffer)
voidsilence (long, long)

Clear (eg zero, or empty) buffer

unsigned longsize ()
...table (--lua--)

↠ ARDOUR:MidiPort

@@ -1244,6 +1260,8 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C + + @@ -2404,6 +2422,12 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
Constructor
ℂARDOUR.ParameterDescriptor ()
Methods
std::stringmidi_note_name (unsigned char)
Data Members
std::stringlabel
boollogarithmic
unsigned longsize ()
LuaTabletable ()
+

ℕ ArdourUI

+
+ + + +
Methods
std::stringhttp_get (std::string)

∁ ArdourUI:ArdourMarker

C‡: ArdourMarker

@@ -2888,6 +2912,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C voidclear () voidset_buffer (unsigned int, unsigned char*, bool) unsigned intsize () + longtime ()

∁ Evoral:MidiEvent

C‡: Evoral::MIDIEvent<long>

@@ -2907,6 +2932,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C voidclear () voidset_buffer (unsigned int, unsigned char*, bool) unsigned intsize () + longtime ()

∁ Evoral:Parameter

C‡: Evoral::Parameter

@@ -2944,21 +2970,28 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C longto

∁ LuaSignal:Set

-

C‡: std::bitset<46ul>

+

C‡: std::bitset<47ul>

- - - - - - - + + + + + + + - + +
Constructor
ℂLuaSignal.Set ()
Methods
LuaTableadd (LuaTable {46ul})
boolany ()
unsigned longcount ()
boolnone ()
Setreset ()
Setset (unsigned long, bool)
unsigned longsize ()
LuaTableadd (LuaTable {47ul})
boolany ()
unsigned longcount ()
boolnone ()
Setreset ()
Setset (unsigned long, bool)
unsigned longsize ()
LuaTabletable ()
booltest (unsigned long)
booltest (unsigned long)
+

ℕ PBD

+
+ + + +
Methods
boolopen_uri (std::string)
boolopen_uri (std::string)

∁ PBD:Command

C‡: Command

@@ -3378,6 +3411,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
  • LuaSignal.DiskOverrun
  • LuaSignal.DiskUnderrun
  • LuaSignal.RegionPropertyChanged
    • +
  • LuaSignal.LuaTimerDS

    • ∈ ArdourMarker.Type

    - + -
    Ardour 5.0-pre0-573-g7745a37  -  Sun, 10 Jul 2016 16:26:53 +0200
    +
    Ardour 5.0-rc2  -  Tue, 09 Aug 2016 16:23:39 +0200