X-Git-Url: http://shamusworld.gotdns.org/cgi-bin/gitweb.cgi?a=blobdiff_plain;f=include%2Fclass-reference.html;h=03b88eb4175bb3e4cc5375f9fbba5b8b9682a5c7;hb=2f90765c8261de810292efc26272543f994fc98f;hp=0f42a1ce7d810fe2c76f0ddeeff70f1a7b6346c5;hpb=4e3479eea4c28e386b37d5d67232168f4512bd2d;p=ardour-manual diff --git a/include/class-reference.html b/include/class-reference.html index 0f42a1c..03b88eb 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

@@ -154,7 +153,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
SideChainto_sidechain ()
UnknownProcessorto_unknownprocessor ()
-

Inherited from ARDOUR:SessionObject

+

Inherited from ARDOUR:SessionObjectPtr

@@ -190,7 +189,6 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C - @@ -227,7 +225,6 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C -
Methods
std::stringname ()
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).

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
@@ -279,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

@@ -297,6 +293,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C + @@ -319,7 +316,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
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)
longfind_next_transient (long, int)
voidlower_region (Region)
voidlower_region_to_bottom (Region)
unsigned intn_regions ()
AudioPlaylistto_audioplaylist ()
MidiPlaylistto_midiplaylist ()
-

Inherited from ARDOUR:SessionObject

+

Inherited from ARDOUR:SessionObjectPtr

@@ -334,7 +331,6 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
Methods
std::stringname ()
-
Methods
boolisnil ()
boolsameinstance (AudioPort)

Inherited from ARDOUR:Port

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

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)
@@ -412,11 +407,13 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C boolcan_move () boolcaptured () voidclear_sync_position () + Controlcontrol (Parameter, bool) boolcovers (long) voidcut_end (long, int) voidcut_front (long, int) DataTypedata_type () boolexternal () + boolhas_transients () boolhidden () boolimport () boolis_compound () @@ -460,6 +457,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C LuaTable(long, ...)sync_offset (int&) longsync_position ()

Returns Sync position in session time

+ Int64Listtransients () voidtrim_end (long, int) voidtrim_front (long, int) voidtrim_to (long, long, int) @@ -470,7 +468,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C MidiRegionto_midiregion () Readableto_readable () -

Inherited from ARDOUR:SessionObject

+

Inherited from ARDOUR:SessionObjectPtr

@@ -495,8 +493,6 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C - - @@ -516,9 +512,10 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C +
Methods
std::stringname ()
longread (FloatArray, long, long, int)
longreadable_length ()
longreadable_length ()
boolsameinstance (AudioSource)
boolsameinstance (AudioSource)
floatsample_rate ()
Cast
Readableto_readable ()
boolwritable ()
Cast
AudioSourceto_audiosource ()
FileSourceto_filesource ()
MidiSourceto_midisource ()
-

Inherited from ARDOUR:SessionObject

+

Inherited from ARDOUR:SessionObjectPtr

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

Inherited from ARDOUR:Track

@@ -605,7 +601,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C - + @@ -614,9 +610,11 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C - + + + @@ -645,8 +643,9 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C +
AutomationControlcomp_makeup_control ()
AutomationControlcomp_mode_control ()
std::stringcomp_mode_name (unsigned int)
AutomationControlcomp_redux_control ()
--MISSING (boost::shared_ptr<ARDOUR::ReadOnlyControl>)--comp_redux_control ()
AutomationControlcomp_speed_control ()
std::stringcomp_speed_name (unsigned int)
AutomationControlcomp_threshold_control ()
AutomationControleq_enable_control ()
AutomationControleq_freq_control (unsigned int)
AutomationControleq_gain_control (unsigned int)
AutomationControleq_hpf_control ()
AutomationControleq_q_control (unsigned int)
AutomationControleq_shape_control (unsigned int)
AutomationControlfilter_enable_controllable (bool)
AutomationControlfilter_freq_controllable (bool)
AutomationControlfilter_slope_controllable (bool)
GainControlgain_control ()
boolis_auditioner ()
boolis_hidden ()
GainControltrim_control ()
Cast
Routeto_route ()
VCAto_vca ()
-

Inherited from ARDOUR:SessionObject

+

Inherited from ARDOUR:SessionObjectPtr

@@ -680,7 +679,6 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C -
Methods
std::stringname ()
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> >

@@ -689,7 +687,6 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C -
Methods
boolisnil ()
boolsameinstance (AutomatableSequence)
Cast
Sequenceto_sequence ()
@@ -711,7 +708,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) @@ -721,6 +717,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C boolwritable () Cast Controlto_ctrl () + SlavableAutomationControl,to_slavable ()

Inherited from PBD:Controllable

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

↠ ARDOUR:AutomationList

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

+

is-a: Evoral:ControlList

AutomationList is a stateful wrapper around Evoral::ControlList. It includes session-specifics (such as automation state), control logic (e.g. touch, signals) and acts as proxy to the underlying ControlList which holds the actual data.

@@ -744,7 +742,6 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C - @@ -753,6 +750,31 @@ 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 ()
Statefulto_stateful ()
StatefulDestructibleto_statefuldestructible ()
+

Inherited from Evoral:ControlList

+ + + + + + + + + + + + + + + + + + + + + + + +
Methods
voidadd (double, double, bool, bool)

add automation events

when
absolute time in samples
value
parameter value
with_guards
if true, add guard-points
with_initial
if true, add an initial point if the list is empty
voidclear (double, double)

remove all automation events between the given time range

start
start of range (inclusive) in audio samples
end
end of range (inclusive) in audio samples
voidclear_list ()
doubleeval (double)

query value at given time (takes a read-lock, not safe while writing automation)

where
absolute time in samples

Returns parameter value

EventListevents ()
boolin_write_pass ()
InterpolationStyleinterpolation ()

query interpolation style of the automation data

Returns Interpolation Style

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

voidset_interpolation (InterpolationStyle)

set the interpolation style of the automation data

is
interpolation style
voidthin (double)

Thin the number of events in this list.

The thinning factor corresponds to the area of a triangle computed between three points in the list (time-difference * value-difference). If the area is large, it indicates significant non-linearity between the points.

Time is measured in samples, value is usually normalized to 0..1.

During automation recording we thin the recorded points using this value. If a point is sufficiently co-linear with its neighbours (as defined by the area of the triangle formed by three of them), we will not include it in the list. The larger the value, the more points are excluded, so this effectively measures the amount of thinning to be done.

thinning_factor
area-size (default: 20)
voidtruncate_end (double)

truncate the event list after the given time

last_coordinate
last event to include
voidtruncate_start (double)

truncate the event list to the given time

overall_length
overall length

∁ ARDOUR:BackendVector

C‡: std::vector<ARDOUR::AudioBackendInfo const* >

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

∁ ARDOUR:BeatsFramesConverter

+

C‡: ARDOUR::BeatsFramesConverter

+
+

Converter between quarter-note beats and frames. Takes distances in quarter-note beats or frames from some origin (supplied to the constructor in frames), and converts them to the opposite unit, taking tempo changes into account.

+ + + + + + + + +
Constructor
ℂARDOUR.BeatsFramesConverter (TempoMap, long)
Methods
Beatsfrom (long)

Convert B time to A time (A from B)

longto (Beats)

Convert A time to B time (A to B)

∁ ARDOUR:BufferSet

C‡: ARDOUR::BufferSet

@@ -775,7 +810,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

@@ -973,7 +1007,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

@@ -1005,7 +1038,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
SideChainto_sidechain ()
UnknownProcessorto_unknownprocessor ()
-

Inherited from ARDOUR:SessionObject

+

Inherited from ARDOUR:SessionObjectPtr

@@ -1038,6 +1071,77 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
Methods
std::stringname ()
unsigned longsize ()
LuaTabletable ()
+

∁ ARDOUR:DoubleBeatsFramesConverter

+

C‡: ARDOUR::DoubleBeatsFramesConverter

+
+

Converter between quarter-note beats and frames. Takes distances in quarter-note beats or frames from some origin (supplied to the constructor in frames), and converts them to the opposite unit, taking tempo changes into account.

+ + + + + + + + +
Constructor
ℂARDOUR.DoubleBeatsFramesConverter (TempoMap, long)
Methods
doublefrom (long)

Convert B time to A time (A from B)

longto (double)

Convert A time to B time (A to B)

+

∁ ARDOUR:EventList

+

C‡: std::list<Evoral::ControlEvent* >

+
+ + + + + + + + + + + +
Constructor
ℂARDOUR.EventList ()
Methods
ControlEventback ()
boolempty ()
ControlEventfront ()
LuaIteriter ()
voidreverse ()
unsigned longsize ()
LuaTabletable ()
+

↠ ARDOUR:FileSource

+

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

+

is-a: ARDOUR:Source

+
+

A source associated with a file on disk somewhere

+ + + + + + + + + +
Methods
unsigned shortchannel ()
floatgain ()
boolisnil ()
std::stringorigin ()
std::stringpath ()
std::stringtake_id ()
boolwithin_session ()
+

Inherited from ARDOUR:Source

+ + + + + + + + + + + + + + + + + + +
Methods
std::stringancestor_name ()
boolcan_be_analysed ()
booldestructive ()
boolempty ()
boolhas_been_analysed ()
longlength (long)
longnatural_position ()
longtimeline_position ()
longtimestamp ()
intuse_count ()
boolused ()
boolwritable ()
Cast
AudioSourceto_audiosource ()
FileSourceto_filesource ()
MidiSourceto_midisource ()
+

Inherited from ARDOUR:SessionObjectPtr

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

∁ ARDOUR:FluidSynth

C‡: ARDOUR::FluidSynth

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

Inherited from ARDOUR:SlavableAutomationControl,

@@ -1092,6 +1195,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C +
boolwritable ()
Cast
Controlto_ctrl ()
SlavableAutomationControl,to_slavable ()

Inherited from PBD:Controllable

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

↠ ARDOUR:IO

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

-

is-a: ARDOUR:SessionObject

+

is-a: ARDOUR:SessionObjectPtr

A collection of ports (all input or all output) with connections.

An IO can contain ports of varying types, making routes/inserts/etc with varied combinations of types (eg MIDI and audio) possible.

@@ -1128,9 +1232,8 @@ 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

+

Inherited from ARDOUR:SessionObjectPtr

@@ -1150,7 +1253,6 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C -
Methods
std::stringname ()
ChanCountnatural_input_streams ()
ChanCountnatural_output_streams ()
IOoutput ()
boolsameinstance (IOProcessor)

Inherited from ARDOUR:Processor

@@ -1174,7 +1276,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
SideChainto_sidechain ()
UnknownProcessorto_unknownprocessor ()
-

Inherited from ARDOUR:SessionObject

+

Inherited from ARDOUR:SessionObjectPtr

@@ -1296,6 +1398,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C + + + + + @@ -1452,7 +1558,6 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C - @@ -1469,7 +1574,6 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C -
Methods
std::stringname ()
PluginInfonew_plugin_info (std::string, PluginType)

search a Plugin

id
Plugin Name, ID or URI
type
Plugin Type

Returns PluginInfo or nil if not found

Processornil_proc ()
NotePtrListnote_list (MidiModel)
...plugin_automation (--lua--)

A convenience function to get a Automation Lists and ParamaterDescriptor for a given plugin control.

This is equivalent to the following lua code 

 function (processor, param_id)
   local plugininsert = processor:to_insert ()
@@ -1359,7 +1462,6 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
 
- 

  
Methods

  
boolisnil ()
boolsameinstance (LuaProc)

  
DspShmshmem ()

  
LuaTableReftable ()

  

@@ -1378,7 +1480,11 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
char*name ()
LuaTable(unsigned int, ...)nth_parameter (unsigned int, bool&)
unsigned intparameter_count ()
boolparameter_is_audio (unsigned int)
boolparameter_is_control (unsigned int)
boolparameter_is_input (unsigned int)
boolparameter_is_output (unsigned int)
std::stringparameter_label (unsigned int)
PresetRecordpreset_by_label (std::string)
PresetRecordpreset_by_uri (std::string)
std::stringunique_id ()
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 ()
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

@@ -1533,7 +1637,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

@@ -1552,6 +1655,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
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) + longfind_next_transient (long, int) voidlower_region (Region) voidlower_region_to_bottom (Region) unsigned intn_regions () @@ -1574,7 +1678,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C AudioPlaylistto_audioplaylist () MidiPlaylistto_midiplaylist () -

Inherited from ARDOUR:SessionObject

+

Inherited from ARDOUR:SessionObjectPtr

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

Inherited from ARDOUR:Port

@@ -1629,7 +1732,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

@@ -1640,11 +1742,13 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C boolcan_move () boolcaptured () voidclear_sync_position () + Controlcontrol (Parameter, bool) boolcovers (long) voidcut_end (long, int) voidcut_front (long, int) DataTypedata_type () boolexternal () + boolhas_transients () boolhidden () boolimport () boolis_compound () @@ -1688,6 +1792,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C LuaTable(long, ...)sync_offset (int&) longsync_position ()

Returns Sync position in session time

+ Int64Listtransients () voidtrim_end (long, int) voidtrim_front (long, int) voidtrim_to (long, long, int) @@ -1698,7 +1803,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C MidiRegionto_midiregion () Readableto_readable () -

Inherited from ARDOUR:SessionObject

+

Inherited from ARDOUR:SessionObjectPtr

@@ -1717,7 +1822,6 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C -
Methods
std::stringname ()
boolisnil ()
longlength (long)
MidiModelmodel ()
boolsameinstance (MidiSource)

Inherited from ARDOUR:Source

@@ -1734,9 +1838,10 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C +
boolwritable ()
Cast
AudioSourceto_audiosource ()
FileSourceto_filesource ()
MidiSourceto_midisource ()
-

Inherited from ARDOUR:SessionObject

+

Inherited from ARDOUR:SessionObjectPtr

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

Inherited from ARDOUR:Track

@@ -1823,7 +1927,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C - + @@ -1832,9 +1936,11 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C - + + + @@ -1863,8 +1969,9 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C +
AutomationControlcomp_makeup_control ()
AutomationControlcomp_mode_control ()
std::stringcomp_mode_name (unsigned int)
AutomationControlcomp_redux_control ()
--MISSING (boost::shared_ptr<ARDOUR::ReadOnlyControl>)--comp_redux_control ()
AutomationControlcomp_speed_control ()
std::stringcomp_speed_name (unsigned int)
AutomationControlcomp_threshold_control ()
AutomationControleq_enable_control ()
AutomationControleq_freq_control (unsigned int)
AutomationControleq_gain_control (unsigned int)
AutomationControleq_hpf_control ()
AutomationControleq_q_control (unsigned int)
AutomationControleq_shape_control (unsigned int)
AutomationControlfilter_enable_controllable (bool)
AutomationControlfilter_freq_controllable (bool)
AutomationControlfilter_slope_controllable (bool)
GainControlgain_control ()
boolis_auditioner ()
boolis_hidden ()
GainControltrim_control ()
Cast
Routeto_route ()
VCAto_vca ()
-

Inherited from ARDOUR:SessionObject

+

Inherited from ARDOUR:SessionObjectPtr

@@ -1914,7 +2021,6 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C - @@ -1948,7 +2054,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
Methods
std::stringname ()
boolmonitor_active ()
boolmono ()
Controllablemono_control ()
boolsameinstance (MonitorProcessor)
voidset_cut (unsigned int, bool)
voidset_cut_all (bool)
voidset_dim (unsigned int, bool)
SideChainto_sidechain ()
UnknownProcessorto_unknownprocessor ()
-

Inherited from ARDOUR:SessionObject

+

Inherited from ARDOUR:SessionObjectPtr

@@ -1978,7 +2084,6 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C -
Methods
std::stringname ()
boolisnil ()
boolmuted ()
boolmuted_by_self ()
boolsameinstance (MuteControl)

Inherited from ARDOUR:SlavableAutomationControl,

@@ -2008,6 +2113,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C +
boolwritable ()
Cast
Controlto_ctrl ()
SlavableAutomationControl,to_slavable ()

Inherited from PBD:Controllable

@@ -2022,25 +2128,42 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
IDid ()
OwnedPropertyListproperties ()
+

∁ ARDOUR:NotePtrList

+

C‡: std::list<boost::shared_ptr<Evoral::Note<Evoral::Beats> > > >

+
+ + + + + + + + + + + + + + +
Constructor
ℂARDOUR.NotePtrList ()
Methods
LuaTableadd (LuaTable {Beats})
NotePtrback ()
boolempty ()
NotePtrfront ()
LuaIteriter ()
voidpush_back (NotePtr)
voidreverse ()
unsigned longsize ()
LuaTabletable ()
voidunique ()

∅ ARDOUR:OwnedPropertyList

C‡: PBD::OwnedPropertyList

is-a: ARDOUR:PropertyList

-

A variant of PropertyList that does not delete its property list in its destructor. Objects with their own Properties store them in an OwnedPropertyList to avoid having them deleted at the wrong time.

+

Persistent Property List

A variant of PropertyList that does not delete its property list in its destructor. Objects with their own Properties store them in an OwnedPropertyList to avoid having them deleted at the wrong time.

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

↠ ARDOUR:PannerShell

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

-

is-a: ARDOUR:SessionObject

+

is-a: ARDOUR:SessionObjectPtr

Class to manage panning by instantiating and controlling an appropriate Panner object for a given in/out configuration.

-
Methods
boolbypassed ()
boolisnil ()
boolsameinstance (PannerShell)
voidset_bypassed (bool)
-

Inherited from ARDOUR:SessionObject

+

Inherited from ARDOUR:SessionObjectPtr

@@ -2057,7 +2180,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C - + @@ -2086,7 +2209,6 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C -
Methods
std::stringname ()
Constructor
ℂARDOUR.ParameterDescriptor ()
Methods
std::stringmidi_note_name (unsigned char)
std::stringmidi_note_name (unsigned char, bool)
Data Members
std::stringlabel
boollogarithmic
boolisnil ()
floatmeter_level (unsigned int, MeterType)
voidreset_max ()
boolsameinstance (PeakMeter)
voidset_type (MeterType)

Inherited from ARDOUR:Processor

@@ -2111,7 +2233,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C SideChainto_sidechain () UnknownProcessorto_unknownprocessor () -

Inherited from ARDOUR:SessionObject

+

Inherited from ARDOUR:SessionObjectPtr

@@ -2128,7 +2250,6 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C -
Methods
std::stringname ()
Methods
boolinverted (unsigned int)
boolisnil ()
boolsameinstance (PhaseControl)
voidset_phase_invert (unsigned int, bool)
c
Audio channel index.
yn
true to invert phase, otherwise false.
@@ -2149,6 +2270,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C boolwritable () Cast Controlto_ctrl () + SlavableAutomationControl,to_slavable ()

Inherited from PBD:Controllable

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

↠ ARDOUR:Playlist

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

-

is-a: ARDOUR:SessionObject

+

is-a: ARDOUR:SessionObjectPtr

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

@@ -2183,6 +2305,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C + @@ -2197,7 +2320,6 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C - @@ -2207,7 +2329,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
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)
longfind_next_transient (long, int)
boolisnil ()
voidlower_region (Region)
voidlower_region_to_bottom (Region)
RegionListPtrregions_with_end_within (Range)
RegionListPtrregions_with_start_within (Range)
voidremove_region (Region)
boolsameinstance (Playlist)
voidsplit (long)
voidsplit_region (Region, MusicFrame)
Regiontop_region_at (long)
AudioPlaylistto_audioplaylist ()
MidiPlaylistto_midiplaylist ()
-

Inherited from ARDOUR:SessionObject

+

Inherited from ARDOUR:SessionObjectPtr

@@ -2235,10 +2357,13 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C + + + + - @@ -2269,7 +2394,6 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
Methods
std::stringname ()
char*name ()
LuaTable(unsigned int, ...)nth_parameter (unsigned int, bool&)
unsigned intparameter_count ()
boolparameter_is_audio (unsigned int)
boolparameter_is_control (unsigned int)
boolparameter_is_input (unsigned int)
boolparameter_is_output (unsigned int)
std::stringparameter_label (unsigned int)
PresetRecordpreset_by_label (std::string)
PresetRecordpreset_by_uri (std::string)
boolsameinstance (Plugin)
std::stringunique_id ()
Cast
LuaProcto_luaproc ()
-
Methods
boolisnil ()
boolsameinstance (PluginControl)

Inherited from ARDOUR:AutomationControl

@@ -2288,6 +2412,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C +
boolwritable ()
Cast
Controlto_ctrl ()
SlavableAutomationControl,to_slavable ()

Inherited from PBD:Controllable

@@ -2312,7 +2437,6 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C - @@ -2339,7 +2463,6 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C - @@ -2364,7 +2487,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 ()
SideChainto_sidechain ()
UnknownProcessorto_unknownprocessor ()
-

Inherited from ARDOUR:SessionObject

+

Inherited from ARDOUR:SessionObjectPtr

@@ -2391,7 +2514,6 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C - @@ -2457,7 +2579,6 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C -
Methods
std::stringname ()

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

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

↠ ARDOUR:Processor

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

-

is-a: ARDOUR:SessionObject

+

is-a: ARDOUR:SessionObjectPtr

A mixer strip element - plugin, send, meter, etc

@@ -2521,7 +2642,6 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C - @@ -2534,7 +2654,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
ChanCountinput_streams ()
boolisnil ()
ChanCountoutput_streams ()
boolsameinstance (Processor)
Cast
Ampto_amp ()
Automatableto_automatable ()
SideChainto_sidechain ()
UnknownProcessorto_unknownprocessor ()
-

Inherited from ARDOUR:SessionObject

+

Inherited from ARDOUR:SessionObjectPtr

@@ -2617,11 +2737,10 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C -
Methods
std::stringname ()
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

+

is-a: ARDOUR:SessionObjectPtr

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

@@ -2631,11 +2750,13 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C + + @@ -2659,7 +2780,6 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C - @@ -2681,6 +2801,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C + @@ -2691,7 +2812,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
boolcan_move ()
boolcaptured ()
voidclear_sync_position ()
Controlcontrol (Parameter, bool)
boolcovers (long)
voidcut_end (long, int)
voidcut_front (long, int)
DataTypedata_type ()
boolexternal ()
boolhas_transients ()
boolhidden ()
boolimport ()
boolis_compound ()
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.

LuaTable(long, ...)sync_offset (int&)
longsync_position ()

Returns Sync position in session time

Int64Listtransients ()
voidtrim_end (long, int)
voidtrim_front (long, int)
voidtrim_to (long, long, int)
MidiRegionto_midiregion ()
Readableto_readable ()
-

Inherited from ARDOUR:SessionObject

+

Inherited from ARDOUR:SessionObjectPtr

@@ -2775,7 +2896,6 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C - @@ -2797,7 +2917,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C - + @@ -2806,9 +2926,11 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C - + + + @@ -2837,8 +2959,9 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C +
Methods
std::stringname ()

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)
AutomationControlcomp_makeup_control ()
AutomationControlcomp_mode_control ()
std::stringcomp_mode_name (unsigned int)
AutomationControlcomp_redux_control ()
--MISSING (boost::shared_ptr<ARDOUR::ReadOnlyControl>)--comp_redux_control ()
AutomationControlcomp_speed_control ()
std::stringcomp_speed_name (unsigned int)
AutomationControlcomp_threshold_control ()
AutomationControleq_enable_control ()
AutomationControleq_freq_control (unsigned int)
AutomationControleq_gain_control (unsigned int)
AutomationControleq_hpf_control ()
AutomationControleq_q_control (unsigned int)
AutomationControleq_shape_control (unsigned int)
AutomationControlfilter_enable_controllable (bool)
AutomationControlfilter_freq_controllable (bool)
AutomationControlfilter_slope_controllable (bool)
GainControlgain_control ()
boolis_auditioner ()
boolis_hidden ()
GainControltrim_control ()
Cast
Routeto_route ()
VCAto_vca ()
-

Inherited from ARDOUR:SessionObject

+

Inherited from ARDOUR:SessionObjectPtr

@@ -2856,6 +2979,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
Methods
std::stringname ()

∁ ARDOUR:RouteGroup

C‡: ARDOUR::RouteGroup

+

is-a: ARDOUR:SessionObject

A group identifier for routes.

RouteGroups permit to define properties which are shared among all Routes that use the given identifier.

A route can at most be in one group.

@@ -2880,6 +3004,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C + @@ -2889,11 +3014,20 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C + +
boolis_solo ()
voidmake_subgroup (bool, Placement)
intremove (Route)
unsigned intrgba ()
RouteListPtrroute_list ()
voidset_active (bool, void*)
voidset_color (bool)
voidset_mute (bool)
voidset_recenable (bool)
voidset_relative (bool, void*)
voidset_rgba (unsigned int)

set route-group color and notify UI about change

voidset_route_active (bool)
voidset_select (bool)
voidset_solo (bool)
unsigned longsize ()
+

Inherited from ARDOUR:SessionObject

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

∁ ARDOUR:RouteGroupList

C‡: std::list<ARDOUR::RouteGroup* >

@@ -2964,6 +3098,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C longcurrent_end_frame () longcurrent_start_frame () voiddisable_record (bool, bool) + boolend_is_free () AudioEngineengine () boolexport_track_state (RouteListPtr, std::string) longframe_rate () @@ -3013,6 +3148,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C voidset_control (AutomationControl, double, GroupControlDisposition) voidset_controls (ControlListPtr, double, GroupControlDisposition) voidset_dirty () + voidset_end_is_free (bool) voidset_exclusive_input_active (RouteListPtr, bool, bool) std::stringsnap_name () boolsolo_isolated () @@ -3028,6 +3164,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C booltransport_rolling () doubletransport_speed () StringListunknown_processors () + VCAManagervca_manager () longworst_input_latency () longworst_output_latency () longworst_playback_latency () @@ -3206,7 +3343,17 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C IDid () OwnedPropertyListproperties () -

↠ ARDOUR:SessionObject

+

∁ ARDOUR:SessionObject

+

C‡: ARDOUR::SessionObject

+
+

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

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

↠ ARDOUR:SessionObjectPtr

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

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

@@ -3214,7 +3361,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 () @@ -3227,7 +3373,6 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C -
Methods
boolisnil ()
boolsameinstance (SideChain)

Inherited from ARDOUR:IOProcessor

@@ -3259,7 +3404,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
SideChainto_sidechain ()
UnknownProcessorto_unknownprocessor ()
-

Inherited from ARDOUR:SessionObject

+

Inherited from ARDOUR:SessionObjectPtr

@@ -3280,7 +3425,6 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C -
Methods
std::stringname ()
doubleget_masters_value ()
boolisnil ()
voidremove_master (AutomationControl)
boolsameinstance (SlavableAutomationControl,)
boolslaved ()
boolslaved_to (AutomationControl)
@@ -3301,6 +3445,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C boolwritable () Cast Controlto_ctrl () + SlavableAutomationControl,to_slavable ()

Inherited from PBD:Controllable

@@ -3324,7 +3469,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 ()
@@ -3356,6 +3500,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C boolwritable () Cast Controlto_ctrl () + SlavableAutomationControl,to_slavable ()

Inherited from PBD:Controllable

@@ -3378,7 +3523,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 ()
@@ -3410,6 +3554,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C boolwritable () Cast Controlto_ctrl () + SlavableAutomationControl,to_slavable ()

Inherited from PBD:Controllable

@@ -3432,7 +3577,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,

@@ -3463,6 +3607,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C boolwritable () Cast Controlto_ctrl () + SlavableAutomationControl,to_slavable ()

Inherited from PBD:Controllable

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

↠ ARDOUR:Source

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

-

is-a: ARDOUR:SessionObject

+

is-a: ARDOUR:SessionObjectPtr

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

@@ -3492,7 +3637,6 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C - @@ -3500,9 +3644,10 @@ 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 ()
boolwritable ()
Cast
AudioSourceto_audiosource ()
FileSourceto_filesource ()
MidiSourceto_midisource ()
-

Inherited from ARDOUR:SessionObject

+

Inherited from ARDOUR:SessionObjectPtr

@@ -3528,7 +3673,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
Methods
std::stringname ()

↠ ARDOUR:Stripable

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

-

is-a: ARDOUR:SessionObject

+

is-a: ARDOUR:SessionObjectPtr

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

@@ -3537,7 +3682,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C - + @@ -3546,9 +3691,11 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C - + + + @@ -3568,7 +3715,6 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C - @@ -3579,8 +3725,9 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C +
AutomationControlcomp_makeup_control ()
AutomationControlcomp_mode_control ()
std::stringcomp_mode_name (unsigned int)
AutomationControlcomp_redux_control ()
--MISSING (boost::shared_ptr<ARDOUR::ReadOnlyControl>)--comp_redux_control ()
AutomationControlcomp_speed_control ()
std::stringcomp_speed_name (unsigned int)
AutomationControlcomp_threshold_control ()
AutomationControleq_enable_control ()
AutomationControleq_freq_control (unsigned int)
AutomationControleq_gain_control (unsigned int)
AutomationControleq_hpf_control ()
AutomationControleq_q_control (unsigned int)
AutomationControleq_shape_control (unsigned int)
AutomationControlfilter_enable_controllable (bool)
AutomationControlfilter_freq_controllable (bool)
AutomationControlfilter_slope_controllable (bool)
GainControlgain_control ()
boolis_auditioner ()
boolis_hidden ()
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)
GainControltrim_control ()
Cast
Routeto_route ()
VCAto_vca ()
-

Inherited from ARDOUR:SessionObject

+

Inherited from ARDOUR:SessionObjectPtr

@@ -3588,14 +3735,28 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
Methods
std::stringname ()
Statefulto_stateful ()
StatefulDestructibleto_statefuldestructible ()
+

∁ ARDOUR:StripableList

+

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

+
+ + + + + + + + + + + +
Constructor
ℂARDOUR.StripableList ()
Methods
Stripableback ()
boolempty ()
Stripablefront ()
LuaIteriter ()
voidreverse ()
unsigned longsize ()
LuaTabletable ()

∁ ARDOUR:Tempo

C‡: ARDOUR::Tempo

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

- - + @@ -3612,11 +3773,15 @@ 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
- + + + + + @@ -3653,7 +3818,6 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C - @@ -3712,7 +3876,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C - + @@ -3721,9 +3885,11 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C - + + + @@ -3752,8 +3918,9 @@ 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)
doubleexact_qn_at_frame (long, int)
longframepos_plus_qn (long, Beats)

Add some (fractional) Beats to a session frame position, and return the result in frames. pos can be -ve, if required.

Beatsframewalk_to_qn (long, long)

Count the number of beats that are equivalent to distance when going forward, starting at pos.

MeterSectionmeter_section_at_beat (double)
MeterSectionmeter_section_at_frame (long)
TempoSectiontempo_section_at_frame (long)
boolcan_record ()
boolisnil ()
Playlistplaylist ()
boolsameinstance (Track)
boolset_name (std::string)
Cast
AudioTrackto_audio_track ()
AutomationControlcomp_makeup_control ()
AutomationControlcomp_mode_control ()
std::stringcomp_mode_name (unsigned int)
AutomationControlcomp_redux_control ()
--MISSING (boost::shared_ptr<ARDOUR::ReadOnlyControl>)--comp_redux_control ()
AutomationControlcomp_speed_control ()
std::stringcomp_speed_name (unsigned int)
AutomationControlcomp_threshold_control ()
AutomationControleq_enable_control ()
AutomationControleq_freq_control (unsigned int)
AutomationControleq_gain_control (unsigned int)
AutomationControleq_hpf_control ()
AutomationControleq_q_control (unsigned int)
AutomationControleq_shape_control (unsigned int)
AutomationControlfilter_enable_controllable (bool)
AutomationControlfilter_freq_controllable (bool)
AutomationControlfilter_slope_controllable (bool)
GainControlgain_control ()
boolis_auditioner ()
boolis_hidden ()
GainControltrim_control ()
Cast
Routeto_route ()
VCAto_vca ()
-

Inherited from ARDOUR:SessionObject

+

Inherited from ARDOUR:SessionObjectPtr

@@ -3769,7 +3936,6 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
Methods
std::stringname ()
-
Methods
boolisnil ()
boolsameinstance (UnknownProcessor)

Inherited from ARDOUR:Processor

@@ -3793,7 +3959,77 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
SideChainto_sidechain ()
UnknownProcessorto_unknownprocessor ()
-

Inherited from ARDOUR:SessionObject

+

Inherited from ARDOUR:SessionObjectPtr

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

↠ ARDOUR:VCA

+

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

+

is-a: ARDOUR:Stripable

+
+

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

+ + + + + + + + +
Methods
std::stringfull_name ()
GainControlgain_control ()
boolisnil ()
MuteControlmute_control ()
intnumber ()
SoloControlsolo_control ()
+

Inherited from ARDOUR:Stripable

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Methods
AutomationControlcomp_enable_control ()
AutomationControlcomp_makeup_control ()
AutomationControlcomp_mode_control ()
std::stringcomp_mode_name (unsigned int)
--MISSING (boost::shared_ptr<ARDOUR::ReadOnlyControl>)--comp_redux_control ()
AutomationControlcomp_speed_control ()
std::stringcomp_speed_name (unsigned int)
AutomationControlcomp_threshold_control ()
unsigned inteq_band_cnt ()
std::stringeq_band_name (unsigned int)
AutomationControleq_enable_control ()
AutomationControleq_freq_control (unsigned int)
AutomationControleq_gain_control (unsigned int)
AutomationControleq_q_control (unsigned int)
AutomationControleq_shape_control (unsigned int)
AutomationControlfilter_enable_controllable (bool)
AutomationControlfilter_freq_controllable (bool)
AutomationControlfilter_slope_controllable (bool)
boolis_auditioner ()
boolis_hidden ()
boolis_master ()
boolis_monitor ()
boolis_selected ()
AutomationControlmaster_send_enable_control ()
MonitorProcessormonitor_control ()
AutomationControlpan_azimuth_control ()
AutomationControlpan_elevation_control ()
AutomationControlpan_frontback_control ()
AutomationControlpan_lfe_control ()
AutomationControlpan_width_control ()
PhaseControlphase_control ()
PresentationInfopresentation_info_ptr ()
AutomationControlrec_enable_control ()
AutomationControlrec_safe_control ()
AutomationControlsend_enable_control (unsigned int)
AutomationControlsend_level_control (unsigned int)
std::stringsend_name (unsigned int)
voidset_presentation_order (unsigned int)
SoloIsolateControlsolo_isolate_control ()
SoloSafeControlsolo_safe_control ()
GainControltrim_control ()
Cast
Routeto_route ()
VCAto_vca ()
+

Inherited from ARDOUR:SessionObjectPtr

@@ -3801,6 +4037,39 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
Methods
std::stringname ()
Statefulto_stateful ()
StatefulDestructibleto_statefuldestructible ()
+

∁ ARDOUR:VCAList

+

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

+
+ + + + + + + + + + + +
Constructor
ℂARDOUR.VCAList ()
Methods
VCAback ()
boolempty ()
VCAfront ()
LuaIteriter ()
voidreverse ()
unsigned longsize ()
LuaTabletable ()
+

∁ ARDOUR:VCAManager

+

C‡: ARDOUR::VCAManager

+

is-a: PBD:StatefulDestructible

+
+

Base class for objects with saveable and undoable state with destruction notification

+ + + + +
Methods
VCAvca_by_number (int)
VCAListvcas ()
+

Inherited from PBD:Stateful

+ + + + + + +
Methods
voidclear_changes ()

Forget about any changes to this object's properties

IDid ()
OwnedPropertyListproperties ()

∁ ARDOUR:WeakAudioSourceList

C‡: std::list<boost::weak_ptr<ARDOUR::AudioSource> >

@@ -3932,7 +4201,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C Selectionget_selection () LuaTable(bool, ...)get_selection_extents (long&, long&) boolget_smart_mode () - TrackViewListget_track_views () + TrackViewListget_track_views () intget_videotl_bar_height () doubleget_y_origin () ZoomFocusget_zoom_focus () @@ -4198,7 +4467,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

@@ -4225,7 +4493,6 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C LuaMetaTablearray () LuaTableget_table () FloatArrayoffset (unsigned int) - boolsameinstance (FloatArray) voidset_table (LuaTable {float})

∁ C:FloatArrayVector

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

∁ C:Int64List

+

C‡: std::list<long >

+
+ + + + + + + + + + + + + + +
Constructor
ℂC.Int64List ()
Methods
LuaTableadd (LuaTable {long})
longback ()
boolempty ()
longfront ()
LuaIteriter ()
voidpush_back (long)
voidreverse ()
unsigned longsize ()
LuaTabletable ()
voidunique ()

⋯ C:IntArray

C‡: int*

@@ -4268,7 +4553,6 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C LuaMetaTablearray () LuaTableget_table () IntArrayoffset (unsigned int) - boolsameinstance (IntArray) voidset_table (LuaTable {int})

∁ C:StringList

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

∁ Evoral:ControlEvent

+

C‡: Evoral::ControlEvent

+
+

A single event (time-stamped value) for a control

+ + + +
Data Members
doublevalue
doublewhen

↠ Evoral:ControlList

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

@@ -4473,15 +4765,16 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C

add automation events

when
absolute time in samples
value
parameter value
with_guards
if true, add guard-points
with_initial
if true, add an initial point if the list is empty
voidclear (double, double)

remove all automation events between the given time range

start
start of range (inclusive) in audio samples
end
end of range (inclusive) in audio samples
- doubleeval (double) + voidclear_list () + doubleeval (double)

query value at given time (takes a read-lock, not safe while writing automation)

where
absolute time in samples

Returns parameter value

+ EventListevents () boolin_write_pass () InterpolationStyleinterpolation ()

query interpolation style of the automation data

Returns Interpolation Style

boolisnil () - LuaTable(double, ...)rt_safe_eval (double, bool&) + 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) @@ -4497,7 +4790,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>

@@ -4524,7 +4816,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 () @@ -4574,7 +4865,24 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C - +
Methods
boolisnil ()
boolsameinstance (Sequence)
+

∁ LuaDialog:Dialog

+

C‡: LuaDialog::Dialog

+
+ + + + + +
Constructor
ℂLuaDialog.Dialog (std::string, Lua-Function)
Methods
...run (--lua--)
+

∁ LuaDialog:Message

+

C‡: LuaDialog::Message

+
+ + + + +
Constructor
ℂLuaDialog.Message (std::string, std::string, MessageType, ButtonType)
Methods
intrun ()

∁ LuaSignal:Set

C‡: std::bitset<47ul>

@@ -4642,7 +4950,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

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

Inherited from PBD:StatefulPtr

@@ -4804,7 +5110,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

@@ -5165,7 +5470,6 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
  • ARDOUR.PresentationInfo.Flag.MasterOut
  • ARDOUR.PresentationInfo.Flag.MonitorOut
  • ARDOUR.PresentationInfo.Flag.Auditioner
    • -
  • ARDOUR.PresentationInfo.Flag.Selected
  • ARDOUR.PresentationInfo.Flag.Hidden
  • ARDOUR.PresentationInfo.Flag.GroupOrderSet
  • ARDOUR.PresentationInfo.Flag.StatusMask
    • @@ -5392,6 +5696,30 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
  • Cairo.WrapMode.Char
  • Cairo.WrapMode.WordChar
    • +

    ∈ LuaDialog.Message.MessageType

    + +

    ∈ LuaDialog.Message.ButtonType

    + +

    ∈ LuaDialog.Response

    +

    ∈ LuaSignal.LuaSignal

    - + -
    Ardour 5.7  -  Mon, 27 Feb 2017 15:02:46 +0100
    +
    Ardour 5.10  -  Thu, 15 Jun 2017 02:04:30 +0200