X-Git-Url: http://shamusworld.gotdns.org/cgi-bin/gitweb.cgi?a=blobdiff_plain;f=include%2Fclass-reference.html;fp=include%2Fclass-reference.html;h=ae1be7d393c8322f67b31ba94e33ab3cc987fcb4;hb=82a9a26335237c714f9638107174c98e55714c9d;hp=d1bf9c45f9b099def3ce6acf0c46a21933f587bd;hpb=780f980e8629073dbb7f5d28a72801f2dc0b9425;p=ardour-manual diff --git a/include/class-reference.html b/include/class-reference.html index d1bf9c4..ae1be7d 100644 --- a/include/class-reference.html +++ b/include/class-reference.html @@ -153,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

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

@@ -406,11 +407,13 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C + + @@ -454,6 +457,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C + @@ -464,7 +468,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
Methods
std::stringname ()
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 ()
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

@@ -508,9 +512,10 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C +
Methods
std::stringname ()
boolwritable ()
Cast
AudioSourceto_audiosource ()
FileSourceto_filesource ()
MidiSourceto_midisource ()
-

Inherited from ARDOUR:SessionObject

+

Inherited from ARDOUR:SessionObjectPtr

@@ -596,7 +601,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C - + @@ -605,9 +610,11 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C - + + + @@ -637,7 +644,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
Methods
std::stringname ()
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 ()
Cast
Routeto_route ()
-

Inherited from ARDOUR:SessionObject

+

Inherited from ARDOUR:SessionObjectPtr

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

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

@@ -740,6 +748,31 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
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* >

@@ -753,6 +786,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

@@ -990,7 +1036,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

@@ -1023,6 +1069,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

@@ -1092,7 +1209,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.

@@ -1113,7 +1230,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
Portport_by_name (unsigned int)
intremove_port (Port, void*)
-

Inherited from ARDOUR:SessionObject

+

Inherited from ARDOUR:SessionObjectPtr

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

Inherited from ARDOUR:SessionObject

+

Inherited from ARDOUR:SessionObjectPtr

@@ -1278,6 +1395,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C + + + + + @@ -1530,6 +1652,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C + @@ -1552,7 +1675,7 @@ 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 +1477,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 ()
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

@@ -1616,11 +1739,13 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C + + @@ -1664,6 +1789,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C + @@ -1674,7 +1800,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
Methods
std::stringname ()
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 ()
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

@@ -1709,9 +1835,10 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C +
Methods
std::stringname ()
boolwritable ()
Cast
AudioSourceto_audiosource ()
FileSourceto_filesource ()
MidiSourceto_midisource ()
-

Inherited from ARDOUR:SessionObject

+

Inherited from ARDOUR:SessionObjectPtr

@@ -1797,7 +1924,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C - + @@ -1806,9 +1933,11 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C - + + + @@ -1838,7 +1967,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
Methods
std::stringname ()
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 ()
Cast
Routeto_route ()
-

Inherited from ARDOUR:SessionObject

+

Inherited from ARDOUR:SessionObjectPtr

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

Inherited from ARDOUR:SessionObject

+

Inherited from ARDOUR:SessionObjectPtr

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

@@ -2011,7 +2158,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
boolisnil ()
voidset_bypassed (bool)
-

Inherited from ARDOUR:SessionObject

+

Inherited from ARDOUR:SessionObjectPtr

@@ -2028,7 +2175,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C - + @@ -2081,7 +2228,7 @@ 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
SideChainto_sidechain ()
UnknownProcessorto_unknownprocessor ()
-

Inherited from ARDOUR:SessionObject

+

Inherited from ARDOUR:SessionObjectPtr

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

↠ 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().

@@ -2152,6 +2299,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C + @@ -2175,7 +2323,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)
AudioPlaylistto_audioplaylist ()
MidiPlaylistto_midiplaylist ()
-

Inherited from ARDOUR:SessionObject

+

Inherited from ARDOUR:SessionObjectPtr

@@ -2203,7 +2351,11 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C + + + + @@ -2328,7 +2480,7 @@ 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)
std::stringunique_id ()
SideChainto_sidechain ()
UnknownProcessorto_unknownprocessor ()
-

Inherited from ARDOUR:SessionObject

+

Inherited from ARDOUR:SessionObjectPtr

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

↠ 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

@@ -2495,7 +2647,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

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

↠ 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().

@@ -2591,11 +2743,13 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C + + @@ -2640,6 +2794,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C + @@ -2650,7 +2805,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 ()
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

@@ -2755,7 +2910,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C - + @@ -2764,9 +2919,11 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C - + + + @@ -2796,7 +2953,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
Methods
std::stringname ()
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 ()
Cast
Routeto_route ()
-

Inherited from ARDOUR:SessionObject

+

Inherited from ARDOUR:SessionObjectPtr

@@ -2814,6 +2971,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.

@@ -2838,6 +2996,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C + @@ -2847,11 +3006,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* >

@@ -2922,6 +3090,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 () @@ -2971,6 +3140,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 () @@ -3164,7 +3334,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().

@@ -3215,7 +3395,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

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

↠ 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().

@@ -3451,9 +3631,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

@@ -3479,7 +3660,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().

@@ -3488,7 +3669,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C - + @@ -3497,9 +3678,11 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C - + + + @@ -3530,7 +3713,7 @@ 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 ()
Cast
Routeto_route ()
-

Inherited from ARDOUR:SessionObject

+

Inherited from ARDOUR:SessionObjectPtr

@@ -3566,6 +3749,10 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C + + + + @@ -3660,7 +3847,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C - + @@ -3669,9 +3856,11 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C - + + + @@ -3701,7 +3890,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
Methods
std::stringname ()

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)
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 ()
Cast
Routeto_route ()
-

Inherited from ARDOUR:SessionObject

+

Inherited from ARDOUR:SessionObjectPtr

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

Inherited from ARDOUR:SessionObject

+

Inherited from ARDOUR:SessionObjectPtr

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

@@ -4406,6 +4613,15 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C boolisnil () ControlListlist () +

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

@@ -4416,8 +4632,10 @@ 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
+ 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

@@ -4515,6 +4733,24 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C Methods boolisnil () +

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

@@ -5101,7 +5337,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
    • @@ -5328,6 +5563,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.8-155-g51d43c6e1  -  Thu, 16 Mar 2017 21:47:44 +0100
    +
    Ardour 5.9  -  Mon, 15 May 2017 22:51:18 +0200