From: Robin Gareus Date: Mon, 3 Oct 2016 02:30:43 +0000 (+0200) Subject: update lua class doc X-Git-Url: http://shamusworld.gotdns.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=7460a6641c2c3b4a51e3578492b3d73d6345305c;p=ardour-manual update lua class doc --- diff --git a/_manual/24_lua-scripting/02_class_reference.html b/_manual/24_lua-scripting/02_class_reference.html index 809b4a7..d5f530c 100644 --- a/_manual/24_lua-scripting/02_class_reference.html +++ b/_manual/24_lua-scripting/02_class_reference.html @@ -150,6 +150,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C PluginInsertto_insert () IOProcessorto_ioprocessor () MonitorProcessorto_monitorprocessor () + PeakMeterto_peakmeter () SideChainto_sidechain () UnknownProcessorto_unknownprocessor () @@ -269,6 +270,61 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C PortEngineport_engine () boolport_is_physical (std::string) +

↠ ARDOUR:AudioPlaylist

+

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

+

is-a: ARDOUR:Playlist

+
+

A named object associated with a Session. Objects derived from this class are expected to be destroyed before the session calls drop_references().

+ + + + + +
Methods
boolisnil ()
longread (FloatArray, FloatArray, FloatArray, long, long, unsigned int)
boolsameinstance (AudioPlaylist)
+

Inherited from ARDOUR:Playlist

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Methods
voidadd_region (Region, long, float, bool, int)
Regioncombine (RegionList)
unsigned intcount_regions_at (long)
Playlistcut (AudioRangeList&, bool)
DataTypedata_type ()
voidduplicate (Region, long, long, float)
gap
from the beginning of the region to the next beginning
voidduplicate_range (AudioRange&, float)
voidduplicate_until (Region, long, long, long)
gap
from the beginning of the region to the next beginning
end
the first frame that does _not_ contain a duplicated frame
Regionfind_next_region (long, RegionPoint, int)
longfind_next_region_boundary (long, int)
voidlower_region (Region)
voidlower_region_to_bottom (Region)
unsigned intn_regions ()
voidraise_region (Region)
voidraise_region_to_top (Region)
Regionregion_by_id (ID)
RegionListPtrregion_list ()
RegionListPtrregions_at (long)
RegionListPtrregions_touched (long, long)
start
Range start.
end
Range end.

Returns regions which have some part within this range.

RegionListPtrregions_with_end_within (Range)
RegionListPtrregions_with_start_within (Range)
voidremove_region (Region)
voidsplit (long)
voidsplit_region (Region, long, int)
Regiontop_region_at (long)
Regiontop_unmuted_region_at (long)
voiduncombine (Region)
Cast
AudioPlaylistto_audioplaylist ()
+

Inherited from ARDOUR:SessionObject

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

↠ ARDOUR:AudioPort

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

is-a: ARDOUR:Port

@@ -386,6 +442,8 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C Processornth_plugin (unsigned int) Processornth_processor (unsigned int) Processornth_send (unsigned int) + PeakMeterpeak_meter () +

************************************************************* 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

boolremove_sidechain (Processor) @@ -395,6 +453,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C

reset plugin-insert configuration to default, disable customizations.

This is equivalent to calling 

 customize_plugin_insert (proc, 0, unused)
proc
Processor to reset

Returns true if successful

voidset_active (bool, void*) voidset_comment (std::string, void*) + voidset_meter_point (MeterPoint, bool) boolset_strict_io (bool) boolsoloed () boolstrict_io () @@ -749,6 +808,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C PluginInsertto_insert () IOProcessorto_ioprocessor () MonitorProcessorto_monitorprocessor () + PeakMeterto_peakmeter () SideChainto_sidechain () UnknownProcessorto_unknownprocessor () @@ -910,6 +970,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C PluginInsertto_insert () IOProcessorto_ioprocessor () MonitorProcessorto_monitorprocessor () + PeakMeterto_peakmeter () SideChainto_sidechain () UnknownProcessorto_unknownprocessor () @@ -952,6 +1013,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C boollocked () boolmatches (Flags) intmove_to (long) + std::stringname () 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_length (long, long, bool) @@ -997,6 +1059,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C 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)
+ voidremove (Location) Locationsession_range_location ()

Inherited from PBD:Stateful

@@ -1011,6 +1074,11 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
+ + + + + @@ -1036,6 +1104,23 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
Methods
LuaTablebuild_filename ()
LuaTable(float, ...)get_plugin_insert_param (PluginInsert, unsigned int, bool&)

get a plugin control parameter value

which
control port to query (starting at 0, including ports of type input and output)
ok
boolean variable contains true or false after call returned. to be checked by caller before using value.
proc
Plugin-Insert

Returns value

LuaTable(float, ...)get_processor_param (Processor, unsigned int, bool&)

get a plugin control parameter value

proc
Plugin-Processor
which
control port to set (starting at 0, including ports of type input and output))
ok
boolean variable contains true or false after call returned. to be checked by caller before using value.

Returns value

LuaTablehsla_to_rgba ()

A convenience function for colorspace HSL to RGB conversion. All ranges are 0..1

Example: 

 local r, g, b, a = ARDOUR.LuaAPI.hsla_to_rgba (hue, saturation, luminosity, alpha)

Returns 4 parameters: red, green, blue, alpha (in range 0..1)

Processornew_luaproc (Session, std::string)

set a plugin control-input parameter value

proc
Plugin-Processor
which
control-input to set (starting at 0)
value
value to set

Returns true on success, false on error or out-of-bounds value

voidusleep (unsigned long)
+

∁ ARDOUR:LuaAPI:Vamp

+

C‡: ARDOUR::LuaAPI::Vamp

+
+ + + + + + + + + + +
Constructor
ℂARDOUR.LuaAPI.Vamp (std::string, float)
Methods
intanalyze (Readable, unsigned int, --MISSING (luabridge::LuaRef)--)
boolinitialize ()

initialize the plugin for use with analyze().

This is equivalent to plugin():initialise (1, 8192, 8192) and prepares a plugin for analyze.

Manual initialization is only required to set plugin-parameters which depend on prior initialization of the plugin.

 vamp:reset ()
+ vamp:initialize ()
+ vamp:plugin():setParameter (0, 1.5)
+ vamp:analyze (r, 0)
Pluginplugin ()
voidreset ()

call plugin():reset() and clear intialization flag

∁ ARDOUR:LuaOSC:Address

C‡: ARDOUR::LuaOSC::Address

@@ -1194,6 +1279,8 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C Processornth_plugin (unsigned int) Processornth_processor (unsigned int) Processornth_send (unsigned int) + PeakMeterpeak_meter () +

************************************************************* 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

boolremove_sidechain (Processor) @@ -1203,6 +1290,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C

reset plugin-insert configuration to default, disable customizations.

This is equivalent to calling 

 customize_plugin_insert (proc, 0, unused)
proc
Processor to reset

Returns true if successful

voidset_active (bool, void*) voidset_comment (std::string, void*) + voidset_meter_point (MeterPoint, bool) boolset_strict_io (bool) boolsoloed () boolstrict_io () @@ -1331,6 +1419,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C PluginInsertto_insert () IOProcessorto_ioprocessor () MonitorProcessorto_monitorprocessor () + PeakMeterto_peakmeter () SideChainto_sidechain () UnknownProcessorto_unknownprocessor () @@ -1426,6 +1515,44 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C booltoggled floatupper +

↠ ARDOUR:PeakMeter

+

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

+

is-a: ARDOUR:Processor

+
+

Meters peaks on the input and stores them for access.

+ + + + + + + +
Methods
boolisnil ()
floatmeter_level (unsigned int, MeterType)
voidreset_max ()
boolsameinstance (PeakMeter)
voidset_type (MeterType)
+

Inherited from ARDOUR:Processor

+ + + + + + + + + + + + + + + +
Methods
voidactivate ()
boolactive ()
voiddeactivate ()
std::stringdisplay_name ()
Cast
Ampto_amp ()
Automatableto_automatable ()
PluginInsertto_insert ()
IOProcessorto_ioprocessor ()
MonitorProcessorto_monitorprocessor ()
PeakMeterto_peakmeter ()
SideChainto_sidechain ()
UnknownProcessorto_unknownprocessor ()
+

Inherited from ARDOUR:SessionObject

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

↠ ARDOUR:PhaseControl

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

is-a: ARDOUR:AutomationControl

@@ -1509,6 +1636,8 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C Regiontop_region_at (long) Regiontop_unmuted_region_at (long) voiduncombine (Region) + Cast + AudioPlaylistto_audioplaylist ()

Inherited from ARDOUR:SessionObject

@@ -1642,6 +1771,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C +
PluginInsertto_insert ()
IOProcessorto_ioprocessor ()
MonitorProcessorto_monitorprocessor ()
PeakMeterto_peakmeter ()
SideChainto_sidechain ()
UnknownProcessorto_unknownprocessor ()
@@ -1805,6 +1935,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C PluginInsertto_insert () IOProcessorto_ioprocessor () MonitorProcessorto_monitorprocessor () + PeakMeterto_peakmeter () SideChainto_sidechain () UnknownProcessorto_unknownprocessor () @@ -1858,6 +1989,17 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C

A list of properties, mapped using their ID

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

+

↠ ARDOUR:Readable

+

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

+
+ + + + + + + +
Methods
boolisnil ()
unsigned intn_channels ()
longread (FloatArray, long, long, int)
longreadable_length ()
boolsameinstance (Readable)

↠ ARDOUR:Region

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

is-a: ARDOUR:SessionObject

@@ -1920,6 +2062,8 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C voidtrim_to (long, long, int) boolvideo_locked () boolwhole_file () + Cast + Readableto_readable ()

Inherited from ARDOUR:SessionObject

@@ -1989,6 +2133,8 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C + + @@ -1999,6 +2145,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C + @@ -2125,11 +2272,13 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C + + @@ -2137,10 +2286,11 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C - + + @@ -2154,6 +2304,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C + @@ -2384,6 +2535,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C +
Processornth_plugin (unsigned int)
Processornth_processor (unsigned int)
Processornth_send (unsigned int)
PeakMeterpeak_meter ()

************************************************************* 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

boolremove_sidechain (Processor)
boolsameinstance (Route)
voidset_active (bool, void*)
voidset_comment (std::string, void*)
voidset_meter_point (MeterPoint, bool)
boolset_name (std::string)
boolset_strict_io (bool)
boolsoloed ()
Controllablecontrollable_by_id (ID)
longcurrent_end_frame ()
longcurrent_start_frame ()
voiddisable_record (bool, bool)
AudioEngineengine ()
longframe_rate ()

"actual" sample rate of session, set by current audioengine rate, pullup/down etc.

doubleframes_per_timecode_frame ()
unsigned intget_block_size ()
boolget_play_loop ()
Routeget_remote_nth_route (unsigned int)
Stripableget_remote_nth_stripable (unsigned int, Flag)
RouteListPtrget_routes ()
BufferSetget_silent_buffers (ChanCount)
RouteListPtrget_tracks ()
voidgoto_end ()
voidgoto_start ()
voidgoto_start (bool)
longlast_transport_start ()
Locationslocations ()
Routemaster_out ()
voidmaybe_enable_record ()
Routemonitor_out ()
std::stringname ()
RouteListnew_audio_route (int, int, RouteGroup, unsigned int, std::string, Flag, unsigned int)
Processorprocessor_by_id (ID)
RecordStaterecord_status ()
voidrequest_locate (long, bool)
voidrequest_play_loop (bool, bool)
voidrequest_stop (bool, bool)
voidrequest_transport_speed (double, bool)
Routeroute_by_id (ID)
PluginInsertto_insert ()
IOProcessorto_ioprocessor ()
MonitorProcessorto_monitorprocessor ()
PeakMeterto_peakmeter ()
SideChainto_sidechain ()
UnknownProcessorto_unknownprocessor ()
@@ -2758,6 +2910,8 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C Processornth_plugin (unsigned int) Processornth_processor (unsigned int) Processornth_send (unsigned int) + PeakMeterpeak_meter () +

************************************************************* 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

boolremove_sidechain (Processor) @@ -2767,6 +2921,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C

reset plugin-insert configuration to default, disable customizations.

This is equivalent to calling 

 customize_plugin_insert (proc, 0, unused)
proc
Processor to reset

Returns true if successful

voidset_active (bool, void*) voidset_comment (std::string, void*) + voidset_meter_point (MeterPoint, bool) boolset_strict_io (bool) boolsoloed () boolstrict_io () @@ -2853,6 +3008,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C PluginInsertto_insert () IOProcessorto_ioprocessor () MonitorProcessorto_monitorprocessor () + PeakMeterto_peakmeter () SideChainto_sidechain () UnknownProcessorto_unknownprocessor () @@ -3157,6 +3313,21 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C boolsameinstance (FloatArray) voidset_table (LuaTable {float}) +

∁ C:FloatVector

+

C‡: std::vector<float >

+
+ + + + + + + + + + + +
Constructor
ℂC.FloatVector ()
Methods
LuaTableadd (LuaTable {float})
floatat (unsigned long)
boolempty ()
LuaIteriter ()
voidpush_back (float)
unsigned longsize ()
LuaTabletable ()

⋯ C:IntArray

C‡: int*

@@ -3698,6 +3869,170 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C Constructor ℂTimecode.BBT_TIME (unsigned int, unsigned int, unsigned int) +

∁ Vamp:Plugin

+

C‡: _VampPlugin::Vamp::Plugin

+

is-a: Vamp:PluginBase

+
+ + + + +
Methods
FeatureSetgetRemainingFeatures ()
FeatureSetprocess (--MISSING (float**)--, RealTime)
+

Inherited from Vamp:PluginBase

+ + + + + + + + + + + + + + + +
Methods
std::stringgetCopyright ()
std::stringgetCurrentProgram ()
std::stringgetDescription ()
std::stringgetIdentifier ()
std::stringgetMaker ()
std::stringgetName ()
floatgetParameter (std::string)
ParameterListgetParameterDescriptors ()
intgetPluginVersion ()
StringVectorgetPrograms ()
std::stringgetType ()
voidselectProgram (std::string)
voidsetParameter (std::string, float)
+

∁ Vamp:Plugin:Feature

+

C‡: _VampPlugin::Vamp::Plugin::Feature

+
+ + + + + + + + +
Data Members
Vamp:RealTimeduration
boolhasDuration
boolhasTimestamp
std::stringlabel
Vamp:RealTimetimestamp
C:FloatVectorvalues
+

∁ Vamp:Plugin:FeatureList

+

C‡: std::vector<_VampPlugin::Vamp::Plugin::Feature >

+
+ + + + + + + + + + + +
Constructor
ℂVamp.Plugin.FeatureList ()
Methods
LuaTableadd (LuaTable {Feature})
Featureat (unsigned long)
boolempty ()
LuaIteriter ()
voidpush_back (Feature)
unsigned longsize ()
LuaTabletable ()
+

∁ Vamp:Plugin:FeatureSet

+

C‡: std::map<int, std::vector<_VampPlugin::Vamp::Plugin::Feature > > > >

+
+ + + + + + + + + + + +
Constructor
ℂVamp.Plugin.FeatureSet ()
Methods
LuaTableadd (LuaTable {Feature})
voidclear ()
unsigned longcount (int)
boolempty ()
LuaIteriter ()
unsigned longsize ()
LuaTabletable ()
+

∁ Vamp:Plugin:OutputDescriptor

+

C‡: _VampPlugin::Vamp::Plugin::OutputDescriptor

+
+ + + + + + + + + + + + + + + + +
Data Members
unsigned longbinCount
C:StringVectorbinNames
std::stringdescription
boolhasDuration
boolhasFixedBinCount
boolhasKnownExtents
std::stringidentifier
boolisQuantized
floatmaxValue
floatminValue
floatquantizeStep
floatsampleRate
_VampPlugin.Vamp.Plugin.OutputDescriptor.SampleTypesampleType
std::stringunit
+

∁ Vamp:Plugin:OutputList

+

C‡: std::vector<_VampPlugin::Vamp::Plugin::OutputDescriptor >

+
+ + + + + + + + + + + +
Constructor
ℂVamp.Plugin.OutputList ()
Methods
LuaTableadd (LuaTable {OutputDescriptor})
OutputDescriptorat (unsigned long)
boolempty ()
LuaIteriter ()
voidpush_back (OutputDescriptor)
unsigned longsize ()
LuaTabletable ()
+

∁ Vamp:PluginBase

+

C‡: _VampPlugin::Vamp::PluginBase

+
+ + + + + + + + + + + + + + + +
Methods
std::stringgetCopyright ()
std::stringgetCurrentProgram ()
std::stringgetDescription ()
std::stringgetIdentifier ()
std::stringgetMaker ()
std::stringgetName ()
floatgetParameter (std::string)
ParameterListgetParameterDescriptors ()
intgetPluginVersion ()
StringVectorgetPrograms ()
std::stringgetType ()
voidselectProgram (std::string)
voidsetParameter (std::string, float)
+

∁ Vamp:PluginBase:ParameterDescriptor

+

C‡: _VampPlugin::Vamp::PluginBase::ParameterDescriptor

+
+ + + + + + + + + + + + +
Data Members
floatdefaultValue
std::stringdescription
std::stringidentifier
boolisQuantized
floatmaxValue
floatminValue
std::stringname
floatquantizeStep
std::stringunit
C:StringVectorvalueNames
+

∁ Vamp:PluginBase:ParameterList

+

C‡: std::vector<_VampPlugin::Vamp::PluginBase::ParameterDescriptor >

+
+ + + + + + + + + + + +
Constructor
ℂVamp.PluginBase.ParameterList ()
Methods
LuaTableadd (LuaTable {ParameterDescriptor})
ParameterDescriptorat (unsigned long)
boolempty ()
LuaIteriter ()
voidpush_back (ParameterDescriptor)
unsigned longsize ()
LuaTabletable ()
+

∁ Vamp:RealTime

+

C‡: _VampPlugin::Vamp::RealTime

+
+ + + + + + + +
Constructor
ℂVamp.RealTime (int, int)
Methods
intmsec ()
std::stringtoString ()
intusec ()

Enum/Constants

∈ PBD.Controllable.GroupControlDisposition

+

∈ _VampPlugin.Vamp.Plugin.OutputDescriptor.SampleType

+

∈ ARDOUR.ChanMapping