From 317b9bf5f9225c835c8c7e85c81a5542107e435a Mon Sep 17 00:00:00 2001 From: Robin Gareus Date: Sat, 27 Aug 2016 19:28:07 +0200 Subject: [PATCH] update lua class doc --- .../24_lua-scripting/02_class_reference.html | 112 +++++++++++++++++- 1 file changed, 108 insertions(+), 4 deletions(-) diff --git a/_manual/24_lua-scripting/02_class_reference.html b/_manual/24_lua-scripting/02_class_reference.html index e1df373..809b4a7 100644 --- a/_manual/24_lua-scripting/02_class_reference.html +++ b/_manual/24_lua-scripting/02_class_reference.html @@ -135,6 +135,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C Methods GainControlgain_control () boolisnil () + boolsameinstance (Amp)

Inherited from ARDOUR:Processor

@@ -188,6 +189,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C + @@ -274,6 +276,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
unsigned intoutput_channels ()
std::stringoutput_device_name ()
unsigned intperiod_size ()
boolsameinstance (AudioBackend)
floatsample_rate ()
intset_buffer_size (unsigned int)

Set the buffer size to be used.

The device is assumed to use a double buffering scheme, so that one buffer's worth of data can be processed by hardware while software works on the other buffer. All known suitable audio APIs support this model (though ALSA allows for alternate numbers of buffers, and CoreAudio doesn't directly expose the concept).

+
Methods
boolisnil ()
boolsameinstance (AudioPort)

Inherited from ARDOUR:Port

@@ -336,6 +339,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C +
boolisnil ()
unsigned intn_channels ()
longreadable_length ()
boolsameinstance (AudioSource)

↠ ARDOUR:AudioTrack

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

@@ -345,6 +349,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C +
Methods
boolisnil ()
boolsameinstance (AudioTrack)

Inherited from ARDOUR:Track

@@ -477,6 +482,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C +
Methods
AutomationControlautomation_control (Parameter, bool)
boolisnil ()
boolsameinstance (Automatable)

↠ ARDOUR:AutomationControl

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

@@ -491,6 +497,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C doubleget_value ()

Get the current effective `user' value based on automation state

boolisnil () + boolsameinstance (AutomationControl) voidset_automation_state (AutoState) voidset_automation_style (AutoStyle) voidset_value (double, GroupControlDisposition) @@ -523,6 +530,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C XMLNodeget_state () boolisnil () Commandmemento_command (XMLNode, XMLNode) + boolsameinstance (AutomationList) booltouch_enabled () booltouching () boolwriting () @@ -718,6 +726,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C +
Methods
boolisnil ()
boolsameinstance (Delivery)

Inherited from ARDOUR:IOProcessor

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

∁ ARDOUR:FluidSynth

+

C‡: ARDOUR::FluidSynth

+
+ + + + + + + + + + + + +
Constructor
ℂARDOUR.FluidSynth (float, int)

instantiate a Synth

samplerate
samplerate
Methods
boolload_sf2 (std::string)
boolmidi_event (unsigned char*, unsigned long)
voidpanic ()
unsigned intprogram_count ()
std::stringprogram_name (unsigned int)
boolselect_program (unsigned int, unsigned char)
boolsynth (FloatArray, FloatArray, unsigned int)

↠ ARDOUR:GainControl

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

is-a: ARDOUR:SlavableAutomationControl,

@@ -783,6 +808,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C +
Methods
boolisnil ()
boolsameinstance (GainControl)

Inherited from ARDOUR:SlavableAutomationControl,

@@ -847,6 +873,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C +
boolphysically_connected ()
Portport_by_name (unsigned int)
intremove_port (Port, void*)
boolsameinstance (IO)

Inherited from ARDOUR:SessionObject

@@ -868,6 +895,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C +
ChanCountnatural_input_streams ()
ChanCountnatural_output_streams ()
IOoutput ()
boolsameinstance (IOProcessor)

Inherited from ARDOUR:Processor

@@ -1094,6 +1122,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C +
MidiBufferget_midi_buffer (unsigned int)
boolinput_active ()
boolisnil ()
boolsameinstance (MidiPort)
voidset_input_active (bool)

Inherited from ARDOUR:Port

@@ -1128,6 +1157,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C +
Methods
boolisnil ()
boolsameinstance (MidiTrack)

Inherited from ARDOUR:Track

@@ -1276,6 +1306,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C + @@ -1321,6 +1352,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C +
boolmonitor_active ()
boolmono ()
Controllablemono_control ()
boolsameinstance (MonitorProcessor)
voidset_cut (unsigned int, bool)
voidset_cut_all (bool)
voidset_dim (unsigned int, bool)
boolisnil ()
boolmuted ()
boolmuted_by_self ()
boolsameinstance (MuteControl)

Inherited from ARDOUR:SlavableAutomationControl,

@@ -1403,6 +1435,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C +
Methods
boolinverted (unsigned int)
boolisnil ()
boolsameinstance (PhaseControl)
voidset_phase_invert (unsigned int, bool)
c
Audio channel index.
yn
true to invert phase, otherwise false.
@@ -1470,6 +1503,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C RegionListPtrregions_with_end_within (Range) RegionListPtrregions_with_start_within (Range) voidremove_region (Region) + boolsameinstance (Playlist) voidsplit (long) voidsplit_region (Region, long, int) Regiontop_region_at (long) @@ -1492,6 +1526,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C + @@ -1505,6 +1540,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C +
Methods
std::stringget_docs ()
PluginInfoget_info ()
LuaTable(int, ...)get_parameter_descriptor (unsigned int, ParameterDescriptor&)
std::stringget_parameter_docs (unsigned int)
boolisnil ()
boolparameter_is_input (unsigned int)
PresetRecordpreset_by_label (std::string)
PresetRecordpreset_by_uri (std::string)
boolsameinstance (Plugin)

Inherited from PBD:StatefulPtr

@@ -1522,6 +1558,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
+
Methods
boolisnil ()
boolsameinstance (PluginControl)

Inherited from ARDOUR:AutomationControl

@@ -1561,7 +1598,19 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C + + + + + + + + + + + +
Constructor
ℂARDOUR.PluginInfo ()
Methods
PresetVectorget_presets (bool)
boolis_instrument ()
boolisnil ()
boolsameinstance (PluginInfo)
Data Members
std::stringcategory
std::stringcreator
ARDOUR:ChanCountn_inputs
ARDOUR:ChanCountn_outputs
std::stringname
std::stringpath
ARDOUR.PluginTypetype
std::stringunique_id

↠ ARDOUR:PluginInsert

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

@@ -1576,6 +1625,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C boolisnil () ChanMappingoutput_map (unsigned int) Pluginplugin (unsigned int) + boolsameinstance (PluginInsert) voidset_input_map (unsigned int, ChanMapping) voidset_output_map (unsigned int, ChanMapping) IOsidechain_input () @@ -1624,6 +1674,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C

Returns Port human readable name

boolreceives_input ()

Returns true if this Port receives input, otherwise false

+ boolsameinstance (Port) boolsends_output ()

Returns true if this Port sends output, otherwise false

Cast @@ -1687,6 +1738,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C Portport (DataType, unsigned long)

nth port of type t, or nth port if t = NIL

t
data type
index
port index
boolremove (Port) + boolsameinstance (PortSet)

∁ ARDOUR:PresentationInfo

C‡: ARDOUR::PresentationInfo

@@ -1719,6 +1771,21 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C booluser boolvalid +

∁ ARDOUR:PresetVector

+

C‡: std::vector<ARDOUR::Plugin::PresetRecord >

+
+ + + + + + + + + + + +
Constructor
ℂARDOUR.PresetVector ()
Methods
LuaTableadd (LuaTable {PresetRecord})
PresetRecordat (unsigned long)
boolempty ()
LuaIteriter ()
voidpush_back (PresetRecord)
unsigned longsize ()
LuaTabletable ()

↠ ARDOUR:Processor

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

is-a: ARDOUR:SessionObject

@@ -1731,6 +1798,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C voiddeactivate () std::stringdisplay_name () boolisnil () + boolsameinstance (Processor) Cast Ampto_amp () Automatableto_automatable () @@ -1748,6 +1816,21 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C Statefulto_stateful () StatefulDestructibleto_statefuldestructible () +

∁ ARDOUR:ProcessorVector

+

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

+
+ + + + + + + + + + + +
Constructor
ℂARDOUR.ProcessorVector ()
Methods
LuaTableadd (LuaTable {Processor})
Processorat (unsigned long)
boolempty ()
LuaIteriter ()
voidpush_back (Processor)
unsigned longsize ()
LuaTabletable ()

∅ ARDOUR:Properties:BoolProperty

C‡: PBD::PropertyDescriptor<bool>

@@ -1811,6 +1894,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C boolposition_locked () voidraise () voidraise_to_top () + boolsameinstance (Region) voidset_hidden (bool) voidset_initial_position (long)

A gui may need to create a region, then place it in an initial position determined by the user. When this takes place within one gui operation, we have to reset _last_position to prevent an implied move.

@@ -1912,6 +1996,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C

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)

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

+ boolsameinstance (Route) voidset_active (bool, void*) voidset_comment (std::string, void*) boolset_name (std::string) @@ -2062,8 +2147,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C AudioTrackListnew_audio_track (int, int, RouteGroup, unsigned int, std::string, unsigned int, TrackMode) RouteListnew_midi_route (RouteGroup, unsigned int, std::string, PluginInfo, PresetRecord, Flag, unsigned int) MidiTrackListnew_midi_track (ChanCount, ChanCount, PluginInfo, PresetRecord, RouteGroup, unsigned int, std::string, unsigned int, TrackMode) - RouteListnew_route_from_template (unsigned int, std::string, std::string, PlaylistDisposition) -

create a new track or bus from a template (XML path)

how_many
how many tracks or busses to create
template_path
path to xml template file
name
name (prefix) of the route to create
pd
Playlist disposition

Returns list of newly created routes

+ RouteListnew_route_from_template (unsigned int, unsigned int, std::string, std::string, PlaylistDisposition) longnominal_frame_rate ()

"native" sample rate of session, regardless of current audioengine rate, pullup/down etc

std::stringpath () @@ -2264,6 +2348,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C Methods boolisnil () std::stringname () + boolsameinstance (SessionObject) Cast Statefulto_stateful () StatefulDestructibleto_statefuldestructible () @@ -2276,6 +2361,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C +
Methods
boolisnil ()
boolsameinstance (SideChain)

Inherited from ARDOUR:IOProcessor

@@ -2322,6 +2408,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C +
doubleget_masters_value ()
boolisnil ()
voidremove_master (AutomationControl)
boolsameinstance (SlavableAutomationControl,)
boolslaved ()
boolslaved_to (AutomationControl)
@@ -2365,6 +2452,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C Methods boolcan_solo () boolisnil () + boolsameinstance (SoloControl) boolself_soloed () boolsoloed () @@ -2418,6 +2506,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C +
Methods
boolisnil ()
boolsameinstance (SoloIsolateControl)
boolself_solo_isolated ()
boolsolo_isolated ()
@@ -2471,6 +2560,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C +
Methods
boolisnil ()
boolsameinstance (SoloSafeControl)
boolsolo_safe ()

Inherited from ARDOUR:SlavableAutomationControl,

@@ -2522,6 +2612,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C +
Methods
boolisnil ()
boolsameinstance (Source)

↠ ARDOUR:Stripable

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

@@ -2565,6 +2656,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C PresentationInfopresentation_info_ptr () AutomationControlrec_enable_control () AutomationControlrec_safe_control () + boolsameinstance (Stripable) AutomationControlsend_enable_control (unsigned int) AutomationControlsend_level_control (unsigned int) std::stringsend_name (unsigned int) @@ -2641,6 +2733,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C boolcan_record () boolisnil () Playlistplaylist () + boolsameinstance (Track) boolset_name (std::string) Cast AudioTrackto_audio_track () @@ -2745,6 +2838,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C +
Methods
boolisnil ()
boolsameinstance (UnknownProcessor)

Inherited from ARDOUR:Processor

@@ -2814,6 +2908,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
+
Methods
std::stringhttp_get (std::string)
ProcessorVectorprocessor_selection (--MISSING (lua_State*)--)

∁ ArdourUI:ArdourMarker

C‡: ArdourMarker

@@ -3255,6 +3350,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C Methods boolisnil () ControlListlist () + boolsameinstance (Control)

↠ Evoral:ControlList

C‡: boost::shared_ptr< Evoral::ControlList >, boost::weak_ptr< Evoral::ControlList >

@@ -3274,6 +3370,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C boolisnil () LuaTable(double, ...)rt_safe_eval (double, bool&)

realtime safe version of eval, may fail if read-lock cannot be taken

where
absolute time in samples
ok
boolean reference if returned value is valid

Returns parameter value

+ boolsameinstance (ControlList) voidset_interpolation (InterpolationStyle)

set the interpolation style of the automation data

is
interpolation style
voidthin (double) @@ -3289,6 +3386,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C +
Methods
boolisnil ()
boolsameinstance (ControlSet)

∁ Evoral:Event

C‡: Evoral::Event<long>

@@ -3422,6 +3520,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C doubleget_value () boolisnil () std::stringname () + boolsameinstance (Controllable)

Inherited from PBD:StatefulPtr

@@ -3537,6 +3636,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
+
Methods
boolisnil ()
boolsameinstance (StatefulDestructible)

Inherited from PBD:StatefulPtr

@@ -3581,6 +3681,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C +
IDid ()
boolisnil ()
OwnedPropertyListproperties ()
boolsameinstance (Stateful)

∁ PBD:XMLNode

C‡: XMLNode

@@ -3996,6 +4097,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
  • ARDOUR:Delivery
  • ARDOUR:DeviceStatus
  • ARDOUR:DeviceStatusVector
    • +
  • ARDOUR:FluidSynth
  • ARDOUR:GainControl
  • ARDOUR:IO
  • ARDOUR:IOProcessor
    • @@ -4030,7 +4132,9 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
  • ARDOUR:PortSet
  • ARDOUR:PresentationInfo
  • ARDOUR:PresetRecord
    • +
  • ARDOUR:PresetVector
  • ARDOUR:Processor
    • +
  • ARDOUR:ProcessorVector
  • ARDOUR:Properties:BoolProperty
  • ARDOUR:Properties:FloatProperty
  • ARDOUR:Properties:FrameposProperty
    • @@ -4109,6 +4213,6 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
  • PBD:XMLNode
  • Timecode:BBT_TIME
    • - + -
    Ardour 5.0-93-g869a9cb  -  Fri, 19 Aug 2016 21:31:42 +0200
    +
    Ardour 5.1-32-gc6ef3a7  -  Sat, 27 Aug 2016 18:49:53 +0200
    -- 2.37.2