From 10ed3719edfb68e676023a5c43d21fb9bcaf4a37 Mon Sep 17 00:00:00 2001 From: Robin Gareus Date: Sat, 18 Feb 2017 00:17:00 +0100 Subject: [PATCH] Update lua class documentation --- include/class-reference.html | 85 +++++++++++++++++++++++++++++++++--- 1 file changed, 80 insertions(+), 5 deletions(-) diff --git a/include/class-reference.html b/include/class-reference.html index 8b7a996..45c4103 100644 --- a/include/class-reference.html +++ b/include/class-reference.html @@ -309,7 +309,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C RegionListPtrregions_with_start_within (Range) voidremove_region (Region) voidsplit (long) - voidsplit_region (Region, MusicFrame) + voidsplit_region (Region, MusicFrame) Regiontop_region_at (long) Regiontop_unmuted_region_at (long) voiduncombine (Region) @@ -574,7 +574,9 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C

************************************************************* Pure interface begins here*************************************************************

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

+ intremove_processors (ProcessorList, ProcessorStreams) boolremove_sidechain (Processor) + intreorder_processors (ProcessorList, ProcessorStreams) intreplace_processor (Processor, Processor, ProcessorStreams)

replace plugin/processor with another

old
processor to remove
sub
processor to substitute the old one with
err
error report (index where removal vailed, channel-count why it failed) may be nil

Returns 0 on success

boolreset_plugin_insert (Processor) @@ -810,6 +812,38 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C voidset (DataType, unsigned int, unsigned int)

set buffer mapping for given data type

from
numeric source id
to
buffer
type
data type
+

∁ ARDOUR:ControlList

+

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

+
+ + + + + + + + + + + + +
Constructor
ℂARDOUR.ControlList ()
Methods
LuaTableadd (LuaTable {AutomationControl})
boolempty ()
LuaIteriter ()
voidpush_back (AutomationControl)
voidreverse ()
unsigned longsize ()
LuaTabletable ()
voidunique ()
+

∁ ARDOUR:ControlListPtr

+

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

+
+ + + + + + + + + + + + +
Constructor
ℂARDOUR.ControlListPtr ()
Methods
LuaTableadd (LuaTable {AutomationControl})
boolempty ()
LuaIteriter ()
voidpush_back (AutomationControl)
voidreverse ()
unsigned longsize ()
LuaTabletable ()
voidunique ()

ℕ ARDOUR.DSP

@@ -1515,7 +1549,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C - + @@ -1745,7 +1779,9 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C + + @@ -2140,7 +2176,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C - + @@ -2476,6 +2512,22 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
RegionListPtrregions_with_start_within (Range)
voidremove_region (Region)
voidsplit (long)
voidsplit_region (Region, MusicFrame)
voidsplit_region (Region, MusicFrame)
Regiontop_region_at (long)
Regiontop_unmuted_region_at (long)
voiduncombine (Region)

************************************************************* Pure interface begins here*************************************************************

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

intremove_processors (ProcessorList, ProcessorStreams)
boolremove_sidechain (Processor)
intreorder_processors (ProcessorList, ProcessorStreams)
intreplace_processor (Processor, Processor, ProcessorStreams)

replace plugin/processor with another

old
processor to remove
sub
processor to substitute the old one with
err
error report (index where removal vailed, channel-count why it failed) may be nil

Returns 0 on success

boolreset_plugin_insert (Processor)
voidremove_region (Region)
boolsameinstance (Playlist)
voidsplit (long)
voidsplit_region (Region, MusicFrame)
voidsplit_region (Region, MusicFrame)
Regiontop_region_at (long)
Regiontop_unmuted_region_at (long)
voiduncombine (Region)
Statefulto_stateful ()
StatefulDestructibleto_statefuldestructible ()
+

∁ ARDOUR:ProcessorList

+

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

+
+ + + + + + + + + + + + +
Constructor
ℂARDOUR.ProcessorList ()
Methods
LuaTableadd (LuaTable {Processor})
boolempty ()
LuaIteriter ()
voidpush_back (Processor)
voidreverse ()
unsigned longsize ()
LuaTabletable ()
voidunique ()

∁ ARDOUR:ProcessorVector

C‡: std::vector<boost::shared_ptr<ARDOUR::Processor> >

@@ -2681,7 +2733,9 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C

************************************************************* Pure interface begins here*************************************************************

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

+ intremove_processors (ProcessorList, ProcessorStreams) boolremove_sidechain (Processor) + intreorder_processors (ProcessorList, ProcessorStreams) intreplace_processor (Processor, Processor, ProcessorStreams)

replace plugin/processor with another

old
processor to remove
sub
processor to substitute the old one with
err
error report (index where removal vailed, channel-count why it failed) may be nil

Returns 0 on success

boolreset_plugin_insert (Processor) @@ -2861,7 +2915,9 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C

create an StatefulDiffCommand from the given object and add it to the stack.

This function must only be called after begin_reversible_command. Failing to do so may lead to a crash.

sfd
the object to diff

Returns the allocated StatefulDiffCommand (already added via add_command)

voidbegin_reversible_command (std::string)

begin collecting undo information

This call must always be followed by either begin_reversible_command() or commit_reversible_command()

cmd_name
human readable name for the undo operation
+ voidcancel_all_solo () SessionConfigurationcfg () + voidclear_all_solo_state (RouteListPtr) voidcommit_reversible_command (Command)

finalize an undo command and commit pending transactions

This must only be called after begin_reversible_command ()

cmd
(additional) command to add
Controllablecontrollable_by_id (ID) @@ -2883,6 +2939,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C voidgoto_end () voidgoto_start (bool) longlast_transport_start () + boollistening () Locationslocations () Routemaster_out () voidmaybe_enable_record (bool) @@ -2913,8 +2970,13 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C intsave_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)

Returns zero on success

voidscripts_changed () + voidset_control (AutomationControl, double, GroupControlDisposition) + voidset_controls (ControlListPtr, double, GroupControlDisposition) voidset_dirty () + voidset_exclusive_input_active (RouteListPtr, bool, bool) std::stringsnap_name () + boolsolo_isolated () + boolsoloing () Sourcesource_by_id (ID) TempoMaptempo_map () booltimecode_drop_frames () @@ -3580,7 +3642,9 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C

************************************************************* Pure interface begins here*************************************************************

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

+ intremove_processors (ProcessorList, ProcessorStreams) boolremove_sidechain (Processor) + intreorder_processors (ProcessorList, ProcessorStreams) intreplace_processor (Processor, Processor, ProcessorStreams)

replace plugin/processor with another

old
processor to remove
sub
processor to substitute the old one with
err
error report (index where removal vailed, channel-count why it failed) may be nil

Returns 0 on success

boolreset_plugin_insert (Processor) @@ -4328,6 +4392,13 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C boolisnil () boolsameinstance (Sequence) +

ℕ LuaCairo

+
+ + + + +
Methods
...color_to_rgba (--lua--)

expand RGBA color to parameters

convert a Canvas::Color (uint32_t 0xRRGGBBAA) into double RGBA values which can be passed as parameters to Cairo::Context::set_source_rgba

Returns r, g, b, a

∁ LuaSignal:Set

C‡: std::bitset<47ul>

@@ -5313,6 +5384,8 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
  • ARDOUR:BufferSet
  • ARDOUR:ChanCount
  • ARDOUR:ChanMapping
    • +
  • ARDOUR:ControlList
    • +
  • ARDOUR:ControlListPtr
  • ARDOUR.DSP
  • ARDOUR:DSP:Biquad
  • ARDOUR:DSP:DspShm
    • @@ -5371,6 +5444,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
  • ARDOUR:PresetRecord
  • ARDOUR:PresetVector
  • ARDOUR:Processor
    • +
  • ARDOUR:ProcessorList
  • ARDOUR:ProcessorVector
  • ARDOUR:Progress
  • ARDOUR:Properties:BoolProperty
    • @@ -5439,6 +5513,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
  • Evoral:ParameterDescriptor
  • Evoral:Range
  • Evoral:Sequence
    • +
  • LuaCairo
  • LuaSignal:Set
  • PBD
  • PBD:Command
    • @@ -5468,6 +5543,6 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
  • Vamp:PluginBase:ParameterList
  • Vamp:RealTime
    • - + -
    Ardour 5.6-14-g7330357e1  -  Tue, 14 Feb 2017 15:03:20 +0100
    +
    Ardour 5.6-64-gdcce5f008  -  Fri, 17 Feb 2017 23:55:07 +0100
    -- 2.37.2