X-Git-Url: http://shamusworld.gotdns.org/cgi-bin/gitweb.cgi?a=blobdiff_plain;f=include%2Fclass-reference.html;h=d1bf9c45f9b099def3ce6acf0c46a21933f587bd;hb=82ed19e6c575a708f3b39c2f5fc2ac1fa7e9b550;hp=8b7a996c501a72d1af0fe51f064978c01f39651d;hpb=f56f05b33bf5b64f0ad3f47074d1759c96b65156;p=ardour-manual diff --git a/include/class-reference.html b/include/class-reference.html index 8b7a996..d1bf9c4 100644 --- a/include/class-reference.html +++ b/include/class-reference.html @@ -130,7 +130,6 @@ 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

@@ -139,6 +138,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C + @@ -149,6 +149,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C +
boolactive ()
voiddeactivate ()
std::stringdisplay_name ()
booldisplay_to_user ()
ChanCountinput_streams ()
ChanCountoutput_streams ()
Cast
PeakMeterto_meter ()
MonitorProcessorto_monitorprocessor ()
PeakMeterto_peakmeter ()
PluginInsertto_plugininsert ()
SideChainto_sidechain ()
UnknownProcessorto_unknownprocessor ()
@@ -188,7 +189,6 @@ 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).

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

check buffer for silence

nframes
number of frames to check
n
first non zero sample (if any)

Returns true if all samples are zero

FloatArraydata (long) voidread_from (FloatArray, long, long, long) - boolsameinstance (AudioBuffer) voidsilence (long, long)

silence buffer

len
number of samples to clear
offset
start offset
@@ -277,7 +276,6 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C Methods boolisnil () longread (FloatArray, FloatArray, FloatArray, long, long, unsigned int) - boolsameinstance (AudioPlaylist)

Inherited from ARDOUR:Playlist

@@ -309,7 +307,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C - + @@ -332,7 +330,6 @@ 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)
-
Methods
boolisnil ()
boolsameinstance (AudioPort)

Inherited from ARDOUR:Port

@@ -377,7 +374,9 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C + + @@ -396,7 +395,6 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C -
Constructor
ℂARDOUR.AudioRangeList ()
Methods
AudioRangeback ()
boolempty ()
AudioRangefront ()
LuaIteriter ()
voidreverse ()
unsigned longsize ()

Returns the maximum (linear) amplitude of the region, or a -ve number if the Progress object reports that the process was cancelled.

doublerms (Progress)

Returns the maximum (rms) signal power of the region, or a -1 if the Progress object reports that the process was cancelled.

boolsameinstance (AudioRegion)
floatscale_amplitude ()
voidset_scale_amplitude (float)
@@ -491,8 +489,6 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C longread (FloatArray, long, long, int) longreadable_length () longreadable_length () - boolsameinstance (AudioSource) - boolsameinstance (AudioSource) floatsample_rate () Cast Readableto_readable () @@ -530,7 +526,6 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C -
Methods
boolisnil ()
boolsameinstance (AudioTrack)

Inherited from ARDOUR:Track

@@ -574,7 +569,9 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C + + @@ -656,7 +653,9 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C + + @@ -672,7 +671,6 @@ 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)
ℂARDOUR.AudioTrackList ()
Methods
LuaTableadd (LuaTable {AudioTrack})
AudioTrackback ()
boolempty ()
AudioTrackfront ()
LuaIteriter ()
voidpush_back (AudioTrack)
voidreverse ()
Methods
AutomationControlautomation_control (Parameter, bool)
boolisnil ()
boolsameinstance (Automatable)

↠ ARDOUR:AutomatableSequence

C‡: boost::shared_ptr< ARDOUR::AutomatableSequence<Evoral::Beats> >, boost::weak_ptr< ARDOUR::AutomatableSequence<Evoral::Beats> >

@@ -681,7 +679,6 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C -
Methods
boolisnil ()
boolsameinstance (AutomatableSequence)
Cast
Sequenceto_sequence ()
@@ -703,7 +700,6 @@ 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) @@ -736,7 +732,6 @@ 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 () @@ -752,11 +747,9 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C Constructor ℂARDOUR.BackendVector () Methods - LuaTableadd (ARDOUR::AudioBackendInfo* ) AudioBackendInfoat (unsigned long) boolempty () LuaIteriter () - voidpush_back (AudioBackendInfo) unsigned longsize () LuaTabletable () @@ -769,7 +762,6 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C ChanCountcount () AudioBufferget_audio (unsigned long) MidiBufferget_midi (unsigned long) - boolsameinstance (BufferSet)

∁ ARDOUR:ChanCount

C‡: ARDOUR::ChanCount

@@ -810,6 +802,40 @@ 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})
AutomationControlback ()
boolempty ()
AutomationControlfront ()
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

@@ -933,7 +959,6 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C -
Methods
boolisnil ()
PannerShellpanner_shell ()
boolsameinstance (Delivery)

Inherited from ARDOUR:IOProcessor

@@ -950,6 +975,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C + @@ -960,6 +986,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C +
boolactive ()
voiddeactivate ()
std::stringdisplay_name ()
booldisplay_to_user ()
ChanCountinput_streams ()
ChanCountoutput_streams ()
Cast
PeakMeterto_meter ()
MonitorProcessorto_monitorprocessor ()
PeakMeterto_peakmeter ()
PluginInsertto_plugininsert ()
SideChainto_sidechain ()
UnknownProcessorto_unknownprocessor ()
@@ -986,6 +1013,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C + @@ -1019,7 +1047,6 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
Constructor
ℂARDOUR.DeviceStatusVector ()
ℂARDOUR.DeviceStatusVector ()
Methods
LuaTableadd (LuaTable {DeviceStatus})
DeviceStatusat (unsigned long)
-
Methods
boolisnil ()
boolsameinstance (GainControl)

Inherited from ARDOUR:SlavableAutomationControl,

@@ -1085,7 +1112,6 @@ 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

@@ -1107,7 +1133,6 @@ 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

@@ -1116,6 +1141,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C + @@ -1126,6 +1152,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C +
boolactive ()
voiddeactivate ()
std::stringdisplay_name ()
booldisplay_to_user ()
ChanCountinput_streams ()
ChanCountoutput_streams ()
Cast
PeakMeterto_meter ()
MonitorProcessorto_monitorprocessor ()
PeakMeterto_peakmeter ()
PluginInsertto_plugininsert ()
SideChainto_sidechain ()
UnknownProcessorto_unknownprocessor ()
@@ -1192,7 +1219,9 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C Constructor ℂARDOUR.LocationList () Methods + Locationback () boolempty () + Locationfront () LuaIteriter () voidreverse () unsigned longsize () @@ -1231,12 +1260,16 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C Methods ...build_filename (--lua--)

Creates a filename from a series of elements using the correct separator for filenames.

No attempt is made to force the resulting filename to be an absolute path. If the first element is a relative path, the result will be a relative path.

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

A convenience function to expand RGBA parameters from an integer

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

Example: 

 local r, g, b, a = ARDOUR.LuaAPI.color_to_rgba (0x88aa44ff)
+ cairo_ctx:set_source_rgba (ARDOUR.LuaAPI.color_to_rgba (0x11336699)

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

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

...hsla_to_rgba (--lua--)

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)

+ longmonotonic_time () Processornew_luaproc (Session, std::string)

create a new Lua Processor (Plugin)

s
Session Handle
p
Identifier or Name of the Processor

Returns Processor object (may be nil)

NotePtrnew_noteptr (unsigned char, Beats, Beats, unsigned char, unsigned char) @@ -1308,7 +1341,6 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C -
Methods
boolisnil ()
boolsameinstance (LuaProc)
DspShmshmem ()
LuaTableReftable ()
@@ -1401,7 +1433,6 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C boolpush_event (Event) 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 () @@ -1418,7 +1449,6 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C boolisnil () NoteDiffCommandnew_note_diff_command (std::string)

Start a new NoteDiff command.

This has no side-effects on the model or Session, the returned command can be held on to for as long as the caller wishes, or discarded without formality, until apply_command is called and ownership is taken.

- boolsameinstance (MidiModel)

Inherited from ARDOUR:AutomatableSequence

@@ -1482,7 +1512,6 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
-
Methods
boolisnil ()
boolsameinstance (MidiPlaylist)
voidset_note_mode (NoteMode)

Inherited from ARDOUR:Playlist

@@ -1515,7 +1544,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) @@ -1540,7 +1569,6 @@ 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

@@ -1578,7 +1606,6 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C doublelength_beats () MidiSourcemidi_source (unsigned int) MidiModelmodel () - boolsameinstance (MidiRegion) doublestart_beats ()

Inherited from ARDOUR:Region

@@ -1666,7 +1693,6 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C boolisnil () longlength (long) MidiModelmodel () - boolsameinstance (MidiSource)

Inherited from ARDOUR:Source

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

Inherited from ARDOUR:Track

@@ -1745,7 +1770,9 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C + + @@ -1827,7 +1854,9 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C + + @@ -1859,7 +1888,6 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C - @@ -1878,6 +1906,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C + @@ -1888,6 +1917,7 @@ 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)
ℂARDOUR.MidiTrackList ()
Methods
LuaTableadd (LuaTable {MidiTrack})
MidiTrackback ()
boolempty ()
MidiTrackfront ()
LuaIteriter ()
voidpush_back (MidiTrack)
voidreverse ()
boolmonitor_active ()
boolmono ()
Controllablemono_control ()
boolsameinstance (MonitorProcessor)
voidset_cut (unsigned int, bool)
voidset_cut_all (bool)
voidset_dim (unsigned int, bool)
boolactive ()
voiddeactivate ()
std::stringdisplay_name ()
booldisplay_to_user ()
ChanCountinput_streams ()
ChanCountoutput_streams ()
Cast
PeakMeterto_meter ()
MonitorProcessorto_monitorprocessor ()
PeakMeterto_peakmeter ()
PluginInsertto_plugininsert ()
SideChainto_sidechain ()
UnknownProcessorto_unknownprocessor ()
@@ -1921,7 +1951,6 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C boolisnil () boolmuted () boolmuted_by_self () - boolsameinstance (MuteControl)

Inherited from ARDOUR:SlavableAutomationControl,

@@ -1980,7 +2009,6 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C -
Methods
boolbypassed ()
boolisnil ()
boolsameinstance (PannerShell)
voidset_bypassed (bool)

Inherited from ARDOUR:SessionObject

@@ -2029,7 +2057,6 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C boolisnil () floatmeter_level (unsigned int, MeterType) voidreset_max () - boolsameinstance (PeakMeter) voidset_type (MeterType)

Inherited from ARDOUR:Processor

@@ -2039,6 +2066,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C boolactive () voiddeactivate () std::stringdisplay_name () + booldisplay_to_user () ChanCountinput_streams () ChanCountoutput_streams () Cast @@ -2049,6 +2077,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C PeakMeterto_meter () MonitorProcessorto_monitorprocessor () PeakMeterto_peakmeter () + PluginInsertto_plugininsert () SideChainto_sidechain () UnknownProcessorto_unknownprocessor () @@ -2069,7 +2098,6 @@ 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.
@@ -2138,9 +2166,8 @@ 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, MusicFrame) + voidsplit_region (Region, MusicFrame) Regiontop_region_at (long) Regiontop_unmuted_region_at (long) voiduncombine (Region) @@ -2179,7 +2206,6 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C boolparameter_is_input (unsigned int) PresetRecordpreset_by_label (std::string) PresetRecordpreset_by_uri (std::string) - boolsameinstance (Plugin) std::stringunique_id () Cast LuaProcto_luaproc () @@ -2210,7 +2236,6 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C -
Methods
boolisnil ()
boolsameinstance (PluginControl)

Inherited from ARDOUR:AutomationControl

@@ -2253,7 +2278,6 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C - @@ -2280,7 +2304,6 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C - @@ -2290,6 +2313,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C + @@ -2300,6 +2324,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C +
PresetVectorget_presets (bool)
boolis_instrument ()
boolisnil ()
boolsameinstance (PluginInfo)
Data Members
std::stringcategory
std::stringcreator
ChanMappingoutput_map (unsigned int)
Pluginplugin (unsigned int)
boolreset_parameters_to_default ()
boolsameinstance (PluginInsert)
voidset_input_map (unsigned int, ChanMapping)
voidset_output_map (unsigned int, ChanMapping)
boolstrict_io_configured ()
Methods
boolactive ()
std::stringdisplay_name ()
booldisplay_to_user ()
ChanCountinput_streams ()
ChanCountoutput_streams ()
Cast
PeakMeterto_meter ()
MonitorProcessorto_monitorprocessor ()
PeakMeterto_peakmeter ()
PluginInsertto_plugininsert ()
SideChainto_sidechain ()
UnknownProcessorto_unknownprocessor ()
@@ -2330,7 +2355,6 @@ 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 @@ -2349,7 +2373,9 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C Constructor ℂARDOUR.PortList () Methods + Portback () boolempty () + Portfront () LuaIteriter () voidreverse () unsigned longsize () @@ -2394,7 +2420,6 @@ 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

@@ -2433,6 +2458,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C + @@ -2453,10 +2479,10 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C + - @@ -2465,6 +2491,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C +
Constructor
ℂARDOUR.PresetVector ()
ℂARDOUR.PresetVector ()
Methods
LuaTableadd (LuaTable {PresetRecord})
PresetRecordat (unsigned long)
boolactive ()
voiddeactivate ()
std::stringdisplay_name ()
booldisplay_to_user ()
ChanCountinput_streams ()
boolisnil ()
ChanCountoutput_streams ()
boolsameinstance (Processor)
Cast
Ampto_amp ()
Automatableto_automatable ()
PeakMeterto_meter ()
MonitorProcessorto_monitorprocessor ()
PeakMeterto_peakmeter ()
PluginInsertto_plugininsert ()
SideChainto_sidechain ()
UnknownProcessorto_unknownprocessor ()
@@ -2476,12 +2503,31 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C Statefulto_stateful () StatefulDestructibleto_statefuldestructible () +

∁ ARDOUR:ProcessorList

+

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

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

∁ ARDOUR:ProcessorVector

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

+ @@ -2532,7 +2578,6 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C -
Constructor
ℂARDOUR.ProcessorVector ()
ℂARDOUR.ProcessorVector ()
Methods
LuaTableadd (LuaTable {Processor})
Processorat (unsigned long)
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 >

@@ -2574,7 +2619,6 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C doublequarter_note () 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.

@@ -2628,7 +2672,9 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C Constructor ℂARDOUR.RegionList () Methods + Regionback () boolempty () + Regionfront () LuaIteriter () voidreverse () unsigned longsize () @@ -2681,12 +2727,13 @@ 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)

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*) voidset_meter_point (MeterPoint, bool) @@ -2812,7 +2859,9 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C Constructor ℂARDOUR.RouteGroupList () Methods + RouteGroupback () boolempty () + RouteGroupfront () LuaIteriter () voidreverse () unsigned longsize () @@ -2825,7 +2874,9 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C Constructor ℂARDOUR.RouteList () Methods + Routeback () boolempty () + Routefront () LuaIteriter () voidreverse () unsigned longsize () @@ -2857,11 +2908,14 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C

abort an open undo command This must only be called after begin_reversible_command ()

boolactively_recording () voidadd_command (Command) + voidadd_internal_sends (Route, Placement, RouteListPtr) StatefulDiffCommandadd_stateful_diff_command (StatefulDestructiblePtr)

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 +2937,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 +2968,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 () @@ -3112,7 +3172,6 @@ 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 () @@ -3125,7 +3184,6 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C -
Methods
boolisnil ()
boolsameinstance (SideChain)

Inherited from ARDOUR:IOProcessor

@@ -3142,6 +3200,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C + @@ -3152,6 +3211,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C +
boolactive ()
voiddeactivate ()
std::stringdisplay_name ()
booldisplay_to_user ()
ChanCountinput_streams ()
ChanCountoutput_streams ()
Cast
PeakMeterto_meter ()
MonitorProcessorto_monitorprocessor ()
PeakMeterto_peakmeter ()
PluginInsertto_plugininsert ()
SideChainto_sidechain ()
UnknownProcessorto_unknownprocessor ()
@@ -3176,7 +3236,6 @@ 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) @@ -3220,7 +3279,6 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C Methods boolcan_solo () boolisnil () - boolsameinstance (SoloControl) boolself_soloed () boolsoloed () @@ -3274,7 +3332,6 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C -
Methods
boolisnil ()
boolsameinstance (SoloIsolateControl)
boolself_solo_isolated ()
boolsolo_isolated ()
@@ -3328,7 +3385,6 @@ 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,

@@ -3388,7 +3444,6 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C boolisnil () longlength (long) longnatural_position () - boolsameinstance (Source) longtimeline_position () longtimestamp () intuse_count () @@ -3412,6 +3467,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C + @@ -3463,7 +3519,6 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C - @@ -3489,8 +3544,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C

Tempo, the speed at which musical time progresses (BPM).

Constructor
ℂARDOUR.SourceList ()
ℂARDOUR.SourceList ()
Methods
LuaTableadd (LuaTable {Source})
Sourceat (unsigned long)
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)
- - + @@ -3507,7 +3561,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
Constructor
ℂARDOUR.Tempo (double, double)
npm
Note Types per minute
type
Note Type (default `4': quarter note)
ℂARDOUR.Tempo (double, double, double)
Methods
doubleframes_per_note_type (long)

audio samples per note type. if you want an instantaneous value for this, use TempoMap::frames_per_quarter_note_at() instead.

sr
samplerate
- + @@ -3548,7 +3602,6 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C - @@ -3580,7 +3633,9 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C + + @@ -3662,7 +3717,6 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
Methods
MeterSectionadd_meter (Meter, double, BBT_TIME, long, PositionLockStyle)
TempoSectionadd_tempo (Tempo, double, long, Type, PositionLockStyle)
TempoSectionadd_tempo (Tempo, double, long, PositionLockStyle)
BBT_TIMEbbt_at_frame (long)

Returns the BBT time corresponding to the supplied frame position.

frame
the position in audio samples.

Returns the BBT time at the frame position .

doubleexact_beat_at_frame (long, int)
boolcan_record ()
boolisnil ()
Playlistplaylist ()
boolsameinstance (Track)
boolset_name (std::string)
Cast
AudioTrackto_audio_track ()

************************************************************* 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)
-
Methods
boolisnil ()
boolsameinstance (UnknownProcessor)

Inherited from ARDOUR:Processor

@@ -3671,6 +3725,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C + @@ -3681,6 +3736,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C +
boolactive ()
voiddeactivate ()
std::stringdisplay_name ()
booldisplay_to_user ()
ChanCountinput_streams ()
ChanCountoutput_streams ()
Cast
PeakMeterto_meter ()
MonitorProcessorto_monitorprocessor ()
PeakMeterto_peakmeter ()
PluginInsertto_plugininsert ()
SideChainto_sidechain ()
UnknownProcessorto_unknownprocessor ()
@@ -3699,7 +3755,9 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C Constructor ℂARDOUR.WeakAudioSourceList () Methods + AudioSourceback () boolempty () + AudioSourcefront () LuaIteriter () voidreverse () unsigned longsize () @@ -3712,7 +3770,9 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C Constructor ℂARDOUR.WeakRouteList () Methods + Routeback () boolempty () + Routefront () LuaIteriter () voidreverse () unsigned longsize () @@ -3725,7 +3785,9 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C Constructor ℂARDOUR.WeakSourceList () Methods + Sourceback () boolempty () + Sourcefront () LuaIteriter () voidreverse () unsigned longsize () @@ -3756,7 +3818,9 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C ℂArdourUI.ArdourMarkerList () Methods LuaTableadd (ArdourMarker* ) + ArdourMarkerback () boolempty () + ArdourMarkerfront () LuaIteriter () voidpush_back (ArdourMarker) voidreverse () @@ -3764,6 +3828,11 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C LuaTabletable () voidunique () +

∅ ArdourUI:AxisView

+

C‡: AxisView

+
+

AxisView defines the abstract base class for horizontal and vertical presentations of Stripables.

+

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

∁ ArdourUI:Editor

C‡: PublicEditor

@@ -3772,9 +3841,13 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C Methods voidaccess_action (std::string, std::string) voidadd_location_from_playhead_cursor () + TrackViewListaxis_views_from_routes (RouteListPtr) voidcenter_screen (long) + voidclear_playlist (Playlist) + voidclear_playlists (TimeAxisView) voidconsider_auditioning (Region)

Possibly start the audition of a region. If

r
is 0, or not an AudioRegion any current audition is cancelled. If we are currently auditioning
r
will start.
r
Region to consider.
r,
the audition will be cancelled. Otherwise an audition of
+ voidcopy_playlists (TimeAxisView) MouseModecurrent_mouse_mode ()

Returns The current mouse mode (gain, object, range, timefx etc.) (defined in editing_syms.h)

longcurrent_page_samples () @@ -3802,17 +3875,21 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C LuaTable(long, ...)get_nudge_distance (long, long&) longget_paste_offset (long, unsigned int, long) LuaTable(...)get_pointer_position (double&, double&) + RouteTimeAxisViewget_route_view_by_route_id (ID) Selectionget_selection () LuaTable(bool, ...)get_selection_extents (long&, long&) boolget_smart_mode () + TrackViewListget_track_views () intget_videotl_bar_height () doubleget_y_origin () ZoomFocusget_zoom_focus () voidgoto_nth_marker (int) + voidhide_track_in_display (TimeAxisView, bool) longleftmost_sample () voidmaximise_editing_space () voidmaybe_locate_with_edit_preroll (long) voidmouse_add_new_marker (long, bool) + voidnew_playlists (TimeAxisView) voidnew_region_from_selection () voidoverride_visible_track_count () longpixel_to_sample (double) @@ -3820,6 +3897,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C voidplay_with_preroll () voidredo (unsigned int)

Redo some transactions.

n
Number of transaction to redo.
+ RegionViewregionview_from_region (Region) voidremove_last_capture () voidremove_location_at_playhead_cursor () voidremove_tracks () @@ -3827,6 +3905,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C voidreset_y_origin (double) voidreset_zoom (long) voidrestore_editing_space () + RouteTimeAxisViewrtav_from_route (Route) doublesample_to_pixel (long) boolscroll_down_one_track (bool) voidscroll_tracks_down_line () @@ -3840,6 +3919,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C voidset_mouse_mode (MouseMode, bool)

Set the mouse mode (gain, object, range, timefx etc.)

m
Mouse mode (defined in editing_syms.h)
force
Perform the effects of the change even if no change is required (ie even if the current mouse mode is equal to
voidset_punch_range (long, long, std::string) + voidset_selection (SelectionList, Operation) voidset_show_measures (bool) voidset_snap_mode (SnapMode)

Set the snap mode.

m
Snap mode (defined in editing_syms.h)
@@ -3849,6 +3929,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C voidset_video_timeline_height (int) voidset_zoom_focus (ZoomFocus) boolshow_measures () + voidshow_track_in_display (TimeAxisView, bool) SnapModesnap_mode () SnapTypesnap_type () boolstationary_playhead () @@ -3873,7 +3954,9 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C ℂArdourUI.ArdourMarkerList () Methods LuaTableadd (ArdourMarker* ) + ArdourMarkerback () boolempty () + ArdourMarkerfront () LuaIteriter () voidpush_back (ArdourMarker) voidreverse () @@ -3887,13 +3970,37 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C

Class to represent list of selected regions.

- -
Methods
voidclear_all ()

Empty this RegionSelection.

longend_frame ()
unsigned longn_midi_regions ()
RegionListregionlist ()
longstart ()
+

∅ ArdourUI:RegionView

+

C‡: RegionView

+

is-a: ArdourUI:TimeAxisViewItem

+
+

Base class for items that may appear upon a TimeAxisView.

+

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

+

∁ ArdourUI:RouteTimeAxisView

+

C‡: RouteTimeAxisView

+

is-a: ArdourUI:RouteUI

+
+

Base class for objects with auto-disconnection. trackable must be inherited when objects shall automatically invalidate slots referring to them on destruction. A slot built from a member function of a trackable derived type installs a callback that is invoked when the trackable object is destroyed or overwritten.

add_destroy_notify_callback() and remove_destroy_notify_callback() can be used to manually install and remove callbacks when notification of the object dying is needed.

notify_callbacks() invokes and removes all previously installed callbacks and can therefore be used to disconnect from all signals.

Note that there is no virtual destructor. Don't use trackable* as pointer type for managing your data or the destructors of your derived types won't be called when deleting your objects.

 signal
+ + + +
Cast
TimeAxisViewto_timeaxisview ()
+

∅ ArdourUI:RouteUI

+

C‡: RouteUI

+

is-a: ArdourUI:Selectable

+
+

Base class for objects with auto-disconnection. trackable must be inherited when objects shall automatically invalidate slots referring to them on destruction. A slot built from a member function of a trackable derived type installs a callback that is invoked when the trackable object is destroyed or overwritten.

add_destroy_notify_callback() and remove_destroy_notify_callback() can be used to manually install and remove callbacks when notification of the object dying is needed.

notify_callbacks() invokes and removes all previously installed callbacks and can therefore be used to disconnect from all signals.

Note that there is no virtual destructor. Don't use trackable* as pointer type for managing your data or the destructors of your derived types won't be called when deleting your objects.

 signal
+

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

+

∅ ArdourUI:Selectable

+

C‡: Selectable

+
+

Base class for objects with auto-disconnection. trackable must be inherited when objects shall automatically invalidate slots referring to them on destruction. A slot built from a member function of a trackable derived type installs a callback that is invoked when the trackable object is destroyed or overwritten.

add_destroy_notify_callback() and remove_destroy_notify_callback() can be used to manually install and remove callbacks when notification of the object dying is needed.

notify_callbacks() invokes and removes all previously installed callbacks and can therefore be used to disconnect from all signals.

Note that there is no virtual destructor. Don't use trackable* as pointer type for managing your data or the destructors of your derived types won't be called when deleting your objects.

 signal
+

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

∁ ArdourUI:Selection

C‡: Selection

@@ -3911,6 +4018,35 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C ArdourUI:TimeSelectiontime ArdourUI:TrackSelectiontracks +

∁ ArdourUI:SelectionList

+

C‡: std::list<Selectable* >

+
+ + + + + + + + + + + + + +
Constructor
ℂArdourUI.SelectionList ()
Methods
Selectableback ()
boolempty ()
Selectablefront ()
LuaIteriter ()
voidpush_back (Selectable)
voidreverse ()
unsigned longsize ()
LuaTabletable ()
voidunique ()
+

∅ ArdourUI:TimeAxisView

+

C‡: TimeAxisView

+

is-a: ArdourUI:AxisView

+
+

Abstract base class for time-axis views (horizontal editor 'strips')

This class provides the basic LHS controls and display methods. This should be extended to create functional time-axis based views.

+

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

+

∅ ArdourUI:TimeAxisViewItem

+

C‡: TimeAxisViewItem

+

is-a: ArdourUI:Selectable

+
+

Base class for items that may appear upon a TimeAxisView.

+

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

∁ ArdourUI:TimeSelection

C‡: TimeSelection

is-a: ARDOUR:AudioRangeList

@@ -3926,7 +4062,9 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C Constructor ℂARDOUR.AudioRangeList () Methods + AudioRangeback () boolempty () + AudioRangefront () LuaIteriter () voidreverse () unsigned longsize () @@ -3940,15 +4078,65 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C

Inherited from ArdourUI:TrackViewList

+
Methods
boolcontains (TimeAxisView)
RouteListroutelist ()
+

Inherited from ArdourUI:TrackViewStdList

+ + + + + + + + + + + + + +
Constructor
ℂArdourUI.TrackViewStdList ()
Methods
TimeAxisViewback ()
boolempty ()
TimeAxisViewfront ()
LuaIteriter ()
voidpush_back (TimeAxisView)
voidreverse ()
unsigned longsize ()
LuaTabletable ()
voidunique ()

∁ ArdourUI:TrackViewList

C‡: TrackViewList

+

is-a: ArdourUI:TrackViewStdList

+
Methods
boolcontains (TimeAxisView)
RouteListroutelist ()
+

Inherited from ArdourUI:TrackViewStdList

+ + + + + + + + + + + + + +
Constructor
ℂArdourUI.TrackViewStdList ()
Methods
TimeAxisViewback ()
boolempty ()
TimeAxisViewfront ()
LuaIteriter ()
voidpush_back (TimeAxisView)
voidreverse ()
unsigned longsize ()
LuaTabletable ()
voidunique ()
+

∁ ArdourUI:TrackViewStdList

+

C‡: std::list<TimeAxisView* >

+
+ + + + + + + + + + + + + +
Constructor
ℂArdourUI.TrackViewStdList ()
Methods
TimeAxisViewback ()
boolempty ()
TimeAxisViewfront ()
LuaIteriter ()
voidpush_back (TimeAxisView)
voidreverse ()
unsigned longsize ()
LuaTabletable ()
voidunique ()

⋯ C:ByteArray

C‡: unsigned char*

@@ -3957,7 +4145,6 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C LuaMetaTablearray () LuaTableget_table () unsigned char*offset (unsigned int) - boolsameinstance (unsigned char*) voidset_table (LuaTable {unsigned char})

∁ C:DoubleVector

@@ -3966,6 +4153,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C + @@ -3983,7 +4171,6 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C -
Constructor
ℂC.DoubleVector ()
ℂC.DoubleVector ()
Methods
LuaTableadd (LuaTable {double})
doubleat (unsigned long)
LuaMetaTablearray ()
LuaTableget_table ()
FloatArrayoffset (unsigned int)
boolsameinstance (FloatArray)
voidset_table (LuaTable {float})

∁ C:FloatArrayVector

@@ -3992,6 +4179,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C + @@ -4007,6 +4195,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
Constructor
ℂC.FloatArrayVector ()
ℂC.FloatArrayVector ()
Methods
LuaTableadd (LuaTable {FloatArray})
FloatArrayat (unsigned long)
+ @@ -4024,7 +4213,6 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C -
Constructor
ℂC.FloatVector ()
ℂC.FloatVector ()
Methods
LuaTableadd (LuaTable {float})
floatat (unsigned long)
LuaMetaTablearray ()
LuaTableget_table ()
IntArrayoffset (unsigned int)
boolsameinstance (IntArray)
voidset_table (LuaTable {int})

∁ C:StringList

@@ -4035,7 +4223,9 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C ℂC.StringList () Methods LuaTableadd (LuaTable {std::string}) + std::stringback () boolempty () + std::stringfront () LuaIteriter () voidpush_back (std::string) voidreverse () @@ -4049,6 +4239,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C + @@ -4182,6 +4373,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C + @@ -4213,7 +4405,6 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C -
Constructor
ℂC.StringVector ()
ℂC.StringVector ()
Methods
LuaTableadd (LuaTable {std::string})
std::stringat (unsigned long)

Queries whether the layout had to ellipsize any paragraphs.

This returns true if the ellipsization mode for layout is not Pango::ELLIPSIZE_NONE, a positive width is set on layout, and there are paragraphs exceeding that width that have to be ellipsized.

Returns true if any paragraphs had to be ellipsized, false otherwise.

boolis_wrapped ()

Queries whether the layout had to wrap any paragraphs.

This returns true if a positive width is set on layout, ellipsization mode of layout is set to Pango::ELLIPSIZE_NONE, and there are paragraphs exceeding the layout width that have to be wrapped.

Returns true if any paragraphs had to be wrapped, false otherwise.

voidlayout_cairo_path (Context)
voidset_ellipsize (EllipsizeMode)

Sets the type of ellipsization being performed for layout. Depending on the ellipsization mode ellipsize text is removed from the start, middle, or end of text so they fit within the width and height of layout set with set_width() and set_height().

If the layout contains characters such as newlines that force it to be layed out in multiple paragraphs, then whether each paragraph is ellipsized separately or the entire layout is ellipsized as a whole depends on the set height of the layout. See set_height() for details.

ellipsize
The new ellipsization mode for layout.
voidset_markup (std::string)
Methods
boolisnil ()
ControlListlist ()
boolsameinstance (Control)

↠ Evoral:ControlList

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

@@ -4233,7 +4424,6 @@ 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) @@ -4249,7 +4439,6 @@ 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>

@@ -4276,7 +4465,6 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C Beatslength () unsigned charnote () unsigned charoff_velocity () - boolsameinstance (NotePtr) Beatstime () unsigned charvelocity () @@ -4326,7 +4514,6 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C -
Methods
boolisnil ()
boolsameinstance (Sequence)

∁ LuaSignal:Set

C‡: std::bitset<47ul>

@@ -4394,7 +4581,6 @@ 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

@@ -4420,6 +4606,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
+ @@ -4510,7 +4697,6 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
Constructor
ℂPBD.IdVector ()
ℂPBD.IdVector ()
Methods
LuaTableadd (LuaTable {ID})
IDat (unsigned long)
-
Methods
boolisnil ()
boolsameinstance (StatefulDestructible)

Inherited from PBD:StatefulPtr

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

∁ PBD:XMLNode

C‡: XMLNode

@@ -4676,6 +4861,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C + @@ -4741,6 +4927,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
Constructor
ℂVamp.Plugin.FeatureList ()
ℂVamp.Plugin.FeatureList ()
Methods
LuaTableadd (LuaTable {Feature})
Featureat (unsigned long)
+ @@ -4815,6 +5002,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
Constructor
ℂVamp.Plugin.OutputList ()
ℂVamp.Plugin.OutputList ()
Methods
LuaTableadd (LuaTable {OutputDescriptor})
OutputDescriptorat (unsigned long)
+ @@ -5204,6 +5392,13 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
  • ArdourUI.MarkerType.PunchIn
  • ArdourUI.MarkerType.PunchOut
    • +

    ∈ Selection.Operation

    +

    ∈ Editing.SnapType

    - + -
    Ardour 5.6-14-g7330357e1  -  Tue, 14 Feb 2017 15:03:20 +0100
    +
    Ardour 5.8-155-g51d43c6e1  -  Thu, 16 Mar 2017 21:47:44 +0100
    Constructor
    ℂVamp.PluginBase.ParameterList ()
    ℂVamp.PluginBase.ParameterList ()
    Methods
    LuaTableadd (LuaTable {ParameterDescriptor})
    ParameterDescriptorat (unsigned long)