X-Git-Url: http://shamusworld.gotdns.org/cgi-bin/gitweb.cgi?a=blobdiff_plain;f=include%2Fclass-reference.html;h=0f42a1ce7d810fe2c76f0ddeeff70f1a7b6346c5;hb=4e3479eea4c28e386b37d5d67232168f4512bd2d;hp=36c2ad87480a2479237d373e181bf750262c8799;hpb=2098e011e638b5c86c56e68df7757975fc4d728f;p=ardour-manual diff --git a/include/class-reference.html b/include/class-reference.html index 36c2ad8..0f42a1c 100644 --- a/include/class-reference.html +++ b/include/class-reference.html @@ -139,6 +139,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 @@ -149,6 +150,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 () @@ -282,7 +284,8 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C

Inherited from ARDOUR:Playlist

- + + @@ -308,7 +311,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C - + @@ -376,7 +379,9 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C + + @@ -391,6 +396,10 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C + + + + @@ -569,7 +578,9 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C + + @@ -627,7 +638,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C - + @@ -651,7 +662,9 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C + + @@ -747,11 +760,9 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C - -
Methods
voidadd_region (Region, long, float, bool, int)
voidadd_region (Region, long, float, bool, int, double, bool)

Note: this calls set_layer (..., DBL_MAX) so it will reset the layering index of region

Regioncombine (RegionList)
unsigned intcount_regions_at (long)
Playlistcut (AudioRangeList&, bool)
RegionListPtrregions_with_start_within (Range)
voidremove_region (Region)
voidsplit (long)
voidsplit_region (Region, long, int)
voidsplit_region (Region, MusicFrame)
Regiontop_region_at (long)
Regiontop_unmuted_region_at (long)
voiduncombine (Region)
Constructor
ℂARDOUR.AudioRangeList ()
Methods
AudioRangeback ()
boolempty ()
AudioRangefront ()
LuaIteriter ()
voidreverse ()
unsigned longsize ()
Methods
AudioSourceaudio_source (unsigned int)
boolisnil ()
doublemaximum_amplitude (Progress)

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)

************************************************************* 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)
AutomationControlsend_enable_control (unsigned int)
AutomationControlsend_level_control (unsigned int)
std::stringsend_name (unsigned int)
voidset_presentation_order (unsigned int, bool)
voidset_presentation_order (unsigned int)
SoloControlsolo_control ()
SoloIsolateControlsolo_isolate_control ()
SoloSafeControlsolo_safe_control ()
ℂARDOUR.AudioTrackList ()
Methods
LuaTableadd (LuaTable {AudioTrack})
AudioTrackback ()
boolempty ()
AudioTrackfront ()
LuaIteriter ()
voidpush_back (AudioTrack)
voidreverse ()
Constructor
ℂARDOUR.BackendVector ()
Methods
LuaTableadd (ARDOUR::AudioBackendInfo* )
AudioBackendInfoat (unsigned long)
boolempty ()
LuaIteriter ()
voidpush_back (AudioBackendInfo)
unsigned longsize ()
LuaTabletable ()
@@ -805,6 +816,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

@@ -945,6 +990,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C + @@ -955,6 +1001,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 ()
@@ -981,6 +1028,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C + @@ -1019,7 +1067,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C

Inherited from ARDOUR:SlavableAutomationControl,

Constructor
ℂARDOUR.DeviceStatusVector ()
ℂARDOUR.DeviceStatusVector ()
Methods
LuaTableadd (LuaTable {DeviceStatus})
DeviceStatusat (unsigned long)
- + @@ -1111,6 +1159,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C + @@ -1121,6 +1170,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C +
Methods
voidadd_master (AutomationControl)
voidadd_master (AutomationControl, bool)
voidclear_masters ()
intget_boolean_masters ()
doubleget_masters_value ()
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 ()
@@ -1162,13 +1212,13 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C voidlock () boollocked () boolmatches (Flags) - intmove_to (long) + intmove_to (long, unsigned int) std::stringname () - intset_end (long, bool, bool) -

Set end position.

force
true to force setting, even if the given new end is before the current start.
allow_bbt_recompute
True to recompute BBT end time from the new given end time.
s
New end.
- intset_length (long, long, bool) - intset_start (long, bool, bool) -

Set start position.

s
New start.
force
true to force setting, even if the given new start is after the current end.
allow_bbt_recompute
True to recompute BBT start time from the new given start time.
+ intset_end (long, bool, bool, unsigned int) +

Set end position.

force
true to force setting, even if the given new end is before the current start.
allow_beat_recompute
True to recompute BEAT end time from the new given end time.
s
New end.
+ intset_length (long, long, bool, unsigned int) + intset_start (long, bool, bool, unsigned int) +

Set start position.

s
New start.
force
true to force setting, even if the given new start is after the current end.
allow_beat_recompute
True to recompute BEAT start time from the new given start time.
longstart () voidunlock () @@ -1187,7 +1237,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 () @@ -1226,12 +1278,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) @@ -1250,6 +1306,8 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C local acl = ac:alist() return ac:alist(), ac:to_ctrl():list(), t[2] end

Example usage: get the third input parameter of first plugin on the given route (Ardour starts counting at zero). 

 local al, cl, pd = ARDOUR.LuaAPI.plugin_automation (route:nth_plugin (0), 3)

Returns 3 parameters: AutomationList, ControlList, ParamaterDescriptor

+ boolreset_processor_to_default (Processor) +

reset a processor to its default values (only works for plugins )

This is a wrapper which looks up the Processor by plugin-insert.

proc
Plugin-Insert

Returns true on success, false when the processor is not a plugin

...sample_to_timecode (--lua--)

Generic conversion from audio sample count to timecode. (TimecodeType, sample-rate, sample-pos)

boolset_plugin_insert_param (PluginInsert, unsigned int, float) @@ -1481,7 +1539,8 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C

Inherited from ARDOUR:Playlist

- + + @@ -1507,7 +1566,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C - + @@ -1737,7 +1796,9 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C + + @@ -1795,7 +1856,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C - + @@ -1819,7 +1880,9 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C + + @@ -1870,6 +1933,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C + @@ -1880,6 +1944,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C +
Methods
voidadd_region (Region, long, float, bool, int)
voidadd_region (Region, long, float, bool, int, double, bool)

Note: this calls set_layer (..., DBL_MAX) so it will reset the layering index of region

Regioncombine (RegionList)
unsigned intcount_regions_at (long)
Playlistcut (AudioRangeList&, bool)
RegionListPtrregions_with_start_within (Range)
voidremove_region (Region)
voidsplit (long)
voidsplit_region (Region, long, int)
voidsplit_region (Region, MusicFrame)
Regiontop_region_at (long)
Regiontop_unmuted_region_at (long)
voiduncombine (Region)

************************************************************* 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)
AutomationControlsend_enable_control (unsigned int)
AutomationControlsend_level_control (unsigned int)
std::stringsend_name (unsigned int)
voidset_presentation_order (unsigned int, bool)
voidset_presentation_order (unsigned int)
SoloControlsolo_control ()
SoloIsolateControlsolo_isolate_control ()
SoloSafeControlsolo_safe_control ()
ℂARDOUR.MidiTrackList ()
Methods
LuaTableadd (LuaTable {MidiTrack})
MidiTrackback ()
boolempty ()
MidiTrackfront ()
LuaIteriter ()
voidpush_back (MidiTrack)
voidreverse ()
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 ()
@@ -1891,6 +1956,18 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C Statefulto_stateful () StatefulDestructibleto_statefuldestructible () +

∁ ARDOUR:MusicFrame

+

C‡: ARDOUR::MusicFrame

+
+ + + + + + + + +
Constructor
ℂARDOUR.MusicFrame (long, int)
Methods
voidset (long, int)
Data Members
intdivision
longframe

↠ ARDOUR:MuteControl

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

is-a: ARDOUR:SlavableAutomationControl,

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

Inherited from ARDOUR:SlavableAutomationControl,

- + @@ -2019,6 +2096,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C + @@ -2029,6 +2107,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C +
Methods
voidadd_master (AutomationControl)
voidadd_master (AutomationControl, bool)
voidclear_masters ()
intget_boolean_masters ()
doubleget_masters_value ()
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 ()
@@ -2091,7 +2170,8 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C

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

- + + @@ -2119,7 +2199,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C - + @@ -2227,7 +2307,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
Methods
voidadd_region (Region, long, float, bool, int)
voidadd_region (Region, long, float, bool, int, double, bool)

Note: this calls set_layer (..., DBL_MAX) so it will reset the layering index of region

Regioncombine (RegionList)
unsigned intcount_regions_at (long)
Playlistcut (AudioRangeList&, bool)
voidremove_region (Region)
boolsameinstance (Playlist)
voidsplit (long)
voidsplit_region (Region, long, int)
voidsplit_region (Region, MusicFrame)
Regiontop_region_at (long)
Regiontop_unmuted_region_at (long)
voiduncombine (Region)
- + @@ -2269,6 +2349,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C + @@ -2279,6 +2360,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C +
Constructor
ℂARDOUR.PluginInfo ()
ℵARDOUR.PluginInfo ()
Methods
PresetVectorget_presets (bool)
boolis_instrument ()
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 ()
@@ -2328,7 +2410,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 () @@ -2412,6 +2496,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C + @@ -2432,6 +2517,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C + @@ -2444,6 +2530,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 ()
PeakMeterto_meter ()
MonitorProcessorto_monitorprocessor ()
PeakMeterto_peakmeter ()
PluginInsertto_plugininsert ()
SideChainto_sidechain ()
UnknownProcessorto_unknownprocessor ()
@@ -2455,12 +2542,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> >

+ @@ -2470,6 +2576,11 @@ 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 longsize ()
LuaTabletable ()
+

∅ ARDOUR:Progress

+

C‡: ARDOUR::Progress

+
+

A class to handle reporting of progress of something

+

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

∅ ARDOUR:Properties:BoolProperty

C‡: PBD::PropertyDescriptor<bool>

@@ -2602,7 +2713,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 () @@ -2655,7 +2768,9 @@ 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) @@ -2715,7 +2830,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C AutomationControlsend_enable_control (unsigned int) AutomationControlsend_level_control (unsigned int) std::stringsend_name (unsigned int) - voidset_presentation_order (unsigned int, bool) + voidset_presentation_order (unsigned int) SoloControlsolo_control () SoloIsolateControlsolo_isolate_control () SoloSafeControlsolo_safe_control () @@ -2786,7 +2901,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 () @@ -2799,7 +2916,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 () @@ -2831,11 +2950,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) @@ -2843,6 +2965,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C longcurrent_start_frame () voiddisable_record (bool, bool) AudioEngineengine () + boolexport_track_state (RouteListPtr, std::string) longframe_rate ()

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

unsigned intget_block_size () @@ -2856,15 +2979,16 @@ 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 () + voidmaybe_enable_record (bool) Routemonitor_out () std::stringname () RouteListnew_audio_route (int, int, RouteGroup, unsigned int, std::string, Flag, unsigned int) AudioTrackListnew_audio_track (int, int, RouteGroup, unsigned int, std::string, unsigned int, TrackMode) - RouteListnew_midi_route (RouteGroup, unsigned int, std::string, PluginInfo, PresetRecord, Flag, unsigned int) - MidiTrackListnew_midi_track (ChanCount, ChanCount, PluginInfo, PresetRecord, RouteGroup, unsigned int, std::string, unsigned int, TrackMode) + RouteListnew_midi_route (RouteGroup, unsigned int, std::string, bool, PluginInfo, PresetRecord, Flag, unsigned int) + MidiTrackListnew_midi_track (ChanCount, ChanCount, bool, PluginInfo, PresetRecord, RouteGroup, unsigned int, std::string, unsigned int, TrackMode) RouteListnew_route_from_template (unsigned int, unsigned int, std::string, std::string, PlaylistDisposition) RouteGroupnew_route_group (std::string) longnominal_frame_rate () @@ -2886,16 +3010,18 @@ 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 () - booltimecode_drop_frames () - longtimecode_frames_per_hour () longtimecode_frames_per_hour () doubletimecode_frames_per_second () - doubletimecode_frames_per_second () ...timecode_to_sample_lua (--lua--) Tracktrack_by_diskstream_id (ID) longtransport_frame () @@ -2918,21 +3044,25 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C boolget_auto_input () boolget_auto_play () boolget_auto_return () + boolget_count_in () unsigned intget_destructive_xfade_msecs () boolget_external_sync () boolget_glue_new_markers_to_bars_and_beats () boolget_glue_new_regions_to_bars_and_beats () InsertMergePolicyget_insert_merge_policy () boolget_jack_time_master () + boolget_layered_record_mode () unsigned intget_meterbridge_label_height () boolget_midi_copy_is_fork () std::stringget_midi_search_path () + longget_minitimeline_span () SampleFormatget_native_file_data_format () HeaderFormatget_native_file_header_format () boolget_punch_in () boolget_punch_out () std::stringget_raid_path () boolget_realtime_export () + MonitorChoiceget_session_monitoring () boolget_show_busses_on_meterbridge () boolget_show_group_tabs () boolget_show_master_on_meterbridge () @@ -2966,21 +3096,25 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C boolset_auto_input (bool) boolset_auto_play (bool) boolset_auto_return (bool) + boolset_count_in (bool) boolset_destructive_xfade_msecs (unsigned int) boolset_external_sync (bool) boolset_glue_new_markers_to_bars_and_beats (bool) boolset_glue_new_regions_to_bars_and_beats (bool) boolset_insert_merge_policy (InsertMergePolicy) boolset_jack_time_master (bool) + boolset_layered_record_mode (bool) boolset_meterbridge_label_height (unsigned int) boolset_midi_copy_is_fork (bool) boolset_midi_search_path (std::string) + boolset_minitimeline_span (long) boolset_native_file_data_format (SampleFormat) boolset_native_file_header_format (HeaderFormat) boolset_punch_in (bool) boolset_punch_out (bool) boolset_raid_path (std::string) boolset_realtime_export (bool) + boolset_session_monitoring (MonitorChoice) boolset_show_busses_on_meterbridge (bool) boolset_show_group_tabs (bool) boolset_show_master_on_meterbridge (bool) @@ -3015,21 +3149,25 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C boolauto_input boolauto_play boolauto_return + boolcount_in unsigned intdestructive_xfade_msecs boolexternal_sync boolglue_new_markers_to_bars_and_beats boolglue_new_regions_to_bars_and_beats ARDOUR.InsertMergePolicyinsert_merge_policy booljack_time_master + boollayered_record_mode unsigned intmeterbridge_label_height boolmidi_copy_is_fork std::stringmidi_search_path + longminitimeline_span ARDOUR.SampleFormatnative_file_data_format ARDOUR.HeaderFormatnative_file_header_format boolpunch_in boolpunch_out std::stringraid_path boolrealtime_export + ARDOUR.MonitorChoicesession_monitoring boolshow_busses_on_meterbridge boolshow_group_tabs boolshow_master_on_meterbridge @@ -3106,6 +3244,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 @@ -3116,6 +3255,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 () @@ -3134,7 +3274,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C

A PBD::Controllable with associated automation data (AutomationList)

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

Inherited from ARDOUR:SlavableAutomationControl,

Methods
voidadd_master (AutomationControl)
voidadd_master (AutomationControl, bool)
voidclear_masters ()
intget_boolean_masters ()
doubleget_masters_value ()
- + @@ -3245,7 +3385,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C

Inherited from ARDOUR:SlavableAutomationControl,

Methods
voidadd_master (AutomationControl)
voidadd_master (AutomationControl, bool)
voidclear_masters ()
intget_boolean_masters ()
doubleget_masters_value ()
- + @@ -3298,7 +3438,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C

Inherited from ARDOUR:SlavableAutomationControl,

Methods
voidadd_master (AutomationControl)
voidadd_master (AutomationControl, bool)
voidclear_masters ()
intget_boolean_masters ()
doubleget_masters_value ()
- + @@ -3376,6 +3516,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
Methods
voidadd_master (AutomationControl)
voidadd_master (AutomationControl, bool)
voidclear_masters ()
intget_boolean_masters ()
doubleget_masters_value ()
+ @@ -3431,7 +3572,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C - + @@ -3470,7 +3611,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C

Tempo Map - mapping of timecode to musical time. convert audio-samples, sample-rate to Bar/Beat/Tick, Meter/Tempo

Constructor
ℂARDOUR.SourceList ()
ℂARDOUR.SourceList ()
Methods
LuaTableadd (LuaTable {Source})
Sourceat (unsigned long)
AutomationControlsend_enable_control (unsigned int)
AutomationControlsend_level_control (unsigned int)
std::stringsend_name (unsigned int)
voidset_presentation_order (unsigned int, bool)
voidset_presentation_order (unsigned int)
SoloControlsolo_control ()
SoloIsolateControlsolo_isolate_control ()
SoloSafeControlsolo_safe_control ()
- + @@ -3478,6 +3619,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C +
Methods
MeterSectionadd_meter (Meter, double, BBT_TIME, PositionLockStyle)
MeterSectionadd_meter (Meter, double, BBT_TIME, long, PositionLockStyle)
TempoSectionadd_tempo (Tempo, double, long, Type, 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_qn_at_frame (long, int)
MeterSectionmeter_section_at_beat (double)
MeterSectionmeter_section_at_frame (long)
TempoSectiontempo_section_at_frame (long)
TempoSectiontempo_section_at_frame (long)

∁ ARDOUR:TempoSection

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

A section of timeline with a certain Tempo.

- +
Methods
doublec_func ()
doublec ()

Inherited from ARDOUR:MetricSection

@@ -3543,7 +3685,9 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C + + @@ -3601,7 +3745,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C - + @@ -3634,6 +3778,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C + @@ -3644,6 +3789,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)
AutomationControlsend_enable_control (unsigned int)
AutomationControlsend_level_control (unsigned int)
std::stringsend_name (unsigned int)
voidset_presentation_order (unsigned int, bool)
voidset_presentation_order (unsigned int)
SoloControlsolo_control ()
SoloIsolateControlsolo_isolate_control ()
SoloSafeControlsolo_safe_control ()
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 ()
@@ -3662,7 +3808,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 () @@ -3675,7 +3823,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 () @@ -3688,7 +3838,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 () @@ -3719,7 +3871,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 () @@ -3727,6 +3881,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

@@ -3735,15 +3894,19 @@ 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 () voiddeselect_all () LuaTable(...)do_embed (StringVector, ImportDisposition, ImportMode, long&, PluginInfo) - LuaTable(...)do_import (StringVector, ImportDisposition, ImportMode, SrcQuality, long&, PluginInfo) + LuaTable(...)do_import (StringVector, ImportDisposition, ImportMode, SrcQuality, MidiTrackNameSource, --MISSING (ARDOUR::MidiTempoMapDisposition)--, long&, PluginInfo)

Import existing media

booldragging_playhead ()

Returns true if the playhead is currently being dragged, otherwise false

@@ -3765,17 +3928,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) @@ -3783,6 +3950,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 () @@ -3790,6 +3958,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 () @@ -3803,6 +3972,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)
@@ -3812,6 +3982,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 () @@ -3836,7 +4007,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 () @@ -3850,13 +4023,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

@@ -3874,6 +4071,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

@@ -3889,7 +4115,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 () @@ -3903,15 +4131,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*

@@ -3929,6 +4207,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C + @@ -3955,6 +4234,7 @@ 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)
+ @@ -3970,6 +4250,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)
+ @@ -3998,7 +4279,9 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C + + @@ -4012,6 +4295,7 @@ 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)
ℂC.StringList ()
Methods
LuaTableadd (LuaTable {std::string})
std::stringback ()
boolempty ()
std::stringfront ()
LuaIteriter ()
voidpush_back (std::string)
voidreverse ()
+ @@ -4145,6 +4429,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C + @@ -4383,6 +4668,7 @@ 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)
+ @@ -4639,6 +4925,7 @@ 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)
+ @@ -4704,6 +4991,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)
+ @@ -4778,6 +5066,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)
+ @@ -4946,6 +5235,13 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
  • ARDOUR.Placement.PreFader
  • ARDOUR.Placement.PostFader
    • +

    ∈ ARDOUR.MonitorChoice

    +

    ∈ ARDOUR.NoteMode

    +

    ∈ ARDOUR.MidiTrackNameSource

    +

    ∈ ARDOUR.RegionPoint

    +

    ∈ Selection.Operation

    +

    ∈ Editing.SnapType

    - + -
    Ardour 5.5-66-g4992ed1  -  Thu, 08 Dec 2016 13:34:35 +0100
    - +
    Ardour 5.7  -  Mon, 27 Feb 2017 15:02:46 +0100
    Constructor
    ℂVamp.PluginBase.ParameterList ()
    ℂVamp.PluginBase.ParameterList ()
    Methods
    LuaTableadd (LuaTable {ParameterDescriptor})
    ParameterDescriptorat (unsigned long)