From 8f50dc72be6aad3ea3a1b99b8409262887fd7ff1 Mon Sep 17 00:00:00 2001 From: Robin Gareus Date: Thu, 14 Apr 2016 03:42:15 +0200 Subject: [PATCH] update lua class doc --- .../24_lua-scripting/02_class_reference.html | 119 +++++++++++++++--- 1 file changed, 103 insertions(+), 16 deletions(-) diff --git a/_manual/24_lua-scripting/02_class_reference.html b/_manual/24_lua-scripting/02_class_reference.html index 0cde811..2ba2acc 100644 --- a/_manual/24_lua-scripting/02_class_reference.html +++ b/_manual/24_lua-scripting/02_class_reference.html @@ -130,6 +130,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C

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

is-a: ARDOUR:Processor

+

Applies a declick operation to all audio inputs, passing the same number of audio outputs, and passing through any other types unchanged.

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

↠ ARDOUR:AudioBackend

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

+

PortEngine is an abstract base class that defines the functionality required by Ardour.

A Port is basically an endpoint for a datastream (which can either be continuous, like audio, or event-based, like MIDI). Ports have buffers associated with them into which data can be written (if they are output ports) and from which data can be read (if they input ports). Ports can be connected together so that data written to an output port can be read from an input port. These connections can be 1:1, 1:N OR N:1.

Ports may be associated with software only, or with hardware. Hardware related ports are often referred to as physical, and correspond to some relevant physical entity on a hardware device, such as an audio jack or a MIDI connector. Physical ports may be potentially asked to monitor their inputs, though some implementations may not support this.

Most physical ports will also be considered "terminal", which means that data delivered there or read from there will go to or comes from a system outside of the PortEngine implementation's control (e.g. the analog domain for audio, or external MIDI devices for MIDI). Non-physical ports can also be considered "terminal". For example, the output port of a software synthesizer is a terminal port, because the data contained in its buffer does not and cannot be considered to come from any other port - it is synthesized by its owner.

Ports also have latency associated with them. Each port has a playback latency and a capture latency:

capture latency: how long since the data read from the buffer of a port arrived at at a terminal port. The data will have come from the "outside world" if the terminal port is also physical, or will have been synthesized by the entity that owns the terminal port.

playback latency: how long until the data written to the buffer of port will reach a terminal port.

For more detailed questions about the PortEngine API, consult the JACK API documentation, on which this entire object is based.

Methods
GainControlgain_control ()
@@ -221,6 +223,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C +
Methods
unsigned intbuffer_size ()

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

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

is-a: ARDOUR:Source

+

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

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

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

is-a: ARDOUR:Track

+

A track is an route (bus) with a recordable diskstream and related objects relevant to tracking, playback and editing.

Specifically a track has regions and playlist objects.

Methods
boolisnil ()
@@ -318,9 +323,12 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C

Inherited from ARDOUR:Track

Methods
boolisnil ()
- + + + + @@ -337,10 +345,12 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C + + @@ -348,9 +358,12 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C + + + @@ -397,6 +410,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C

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

is-a: PBD:Controllable

+

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

Methods
Regionbounce (long, long, InterThreadInfo&, Processor, bool)
Regionbounce (InterThreadInfo&)

bounce track from session start to session end to new region

itt
asynchronous progress report and cancel

Returns a new audio region (or nil in case of error)

Regionbounce_range (long, long, InterThreadInfo&, Processor, bool)

Bounce the given range to a new audio region.

start
start time (in samples)
end
end time (in samples)
itt
asynchronous progress report and cancel
endpoint
the processor to tap the signal off (or nil for the top)
include_endpoint
include the given processor in the bounced audio.

Returns a new audio region (or nil in case of error)

boolbounceable (Processor, bool)

Test if the track can be bounced with the given settings. If sends/inserts/returns are present in the signal path or the given track has no audio outputs bouncing is not possible.

endpoint
the processor to tap the signal off (or nil for the top)
include_endpoint
include the given processor in the bounced audio.

Returns true if the track can be bounced, or false otherwise.

boolcan_record ()
Playlistplaylist ()
boolrecord_enabled ()
Methods
boolactive ()
intadd_processor_by_index (Processor, int, ProcessorStreams, bool)

Add a processor to a route such that it ends up with a given index into the visible processors.

index
Index to add the processor at, or -1 to add at the end of the list.

Returns 0 on success, non-0 on failure.

booladd_sidechain (Processor)
Ampamp ()
std::stringcomment ()
boolcustomize_plugin_insert (Processor, unsigned int, ChanCount)

enable custom plugin-insert configuration

proc
Processor to customize
count
number of plugin instances to use (if zero, reset to default)
outs
output port customization

Returns true if successful

Deliverymain_outs ()

the signal processorat at end of the processing chain which produces output

boolmuted ()
ChanCountn_outputs ()
Processornth_plugin (unsigned int)
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

boolremove_sidechain (Processor)
intreplace_processor (Processor, Processor, ProcessorStreams)

replace plugin/processor with another

old
processor to remove
sub
processor to substitute the old one with
err
error report (index where removal vailed, channel-count why it failed) may be nil

Returns 0 on success

boolreset_plugin_insert (Processor)

reset plugin-insert configuration to default, disable customizations.

This is equivalent to calling 

 customize_plugin_insert (proc, 0, unused)
proc
Processor to reset

Returns true if successful

voidset_active (bool, void*)
voidset_comment (std::string, void*)
boolset_strict_io (bool)
@@ -430,6 +444,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 >

+

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.

Methods
AutomationListalist ()
@@ -466,6 +481,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C +
Methods
XMLNodeget_state ()
Methods
ChanCountcount ()
AudioBufferget_audio (unsigned long)
boolsameinstance (BufferSet)

∁ ARDOUR:ChanCount

C‡: ARDOUR::ChanCount

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

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

is-a: ARDOUR:IOProcessor

+

A mixer strip element (Processor) with 1 or 2 IO elements.

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

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

is-a: ARDOUR:AutomationControl

+

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

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

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

is-a: ARDOUR:SessionObject

+

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.

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

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

is-a: ARDOUR:Processor

+

A mixer strip element (Processor) with 1 or 2 IO elements.

Methods
boolactive ()
@@ -772,22 +792,17 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
Methods
IOinput ()
floatprogress

∁ ARDOUR:Location

-

C‡: ARDOUR::Locations

+

C‡: ARDOUR::Location

is-a: PBD:StatefulDestructible

-

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

+

Location on Timeline - abstract representation for Markers, Loop/Punch Ranges, CD-Markers etc.

- - - - - @@ -815,6 +830,26 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
Methods
Locationauto_loop_location ()
Locationauto_punch_location ()
longend ()
longfirst_mark_after (long, bool)
longfirst_mark_after (long, bool)
longlength ()
voidlock ()
boollocked ()
intmove_to (long)
Locationsession_range_location ()
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)
unsigned longsize ()
LuaTabletable ()
+

∁ ARDOUR:Locations

+

C‡: ARDOUR::Locations

+

is-a: PBD:StatefulDestructible

+
+

A collection of session locations including unique dedicated locations (loop, punch, etc)

+ + + + + + + +
Methods
Locationauto_loop_location ()
Locationauto_punch_location ()
longfirst_mark_after (long, bool)
longfirst_mark_after (long, bool)
Locationsession_range_location ()
+

Inherited from PBD:Stateful

+ + + + + +
Methods
voidclear_changes ()

Forget about any changes to this object's properties

OwnedPropertyListproperties ()

ℕ ARDOUR.LuaAPI

@@ -874,6 +909,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
+
Methods
boolempty ()
boolsameinstance (MidiBuffer)
voidsilence (long, long)

Clear (eg zero, or empty) buffer

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

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

is-a: ARDOUR:Track

+

A track is an route (bus) with a recordable diskstream and related objects relevant to tracking, playback and editing.

Specifically a track has regions and playlist objects.

@@ -919,9 +956,12 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C

Inherited from ARDOUR:Track

Methods
boolisnil ()
- + + + + @@ -938,10 +978,12 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C + + @@ -949,9 +991,12 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C + + + @@ -1017,16 +1062,20 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C

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

is-a: 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
Regionbounce (long, long, InterThreadInfo&, Processor, bool)
Regionbounce (InterThreadInfo&)

bounce track from session start to session end to new region

itt
asynchronous progress report and cancel

Returns a new audio region (or nil in case of error)

Regionbounce_range (long, long, InterThreadInfo&, Processor, bool)

Bounce the given range to a new audio region.

start
start time (in samples)
end
end time (in samples)
itt
asynchronous progress report and cancel
endpoint
the processor to tap the signal off (or nil for the top)
include_endpoint
include the given processor in the bounced audio.

Returns a new audio region (or nil in case of error)

boolbounceable (Processor, bool)

Test if the track can be bounced with the given settings. If sends/inserts/returns are present in the signal path or the given track has no audio outputs bouncing is not possible.

endpoint
the processor to tap the signal off (or nil for the top)
include_endpoint
include the given processor in the bounced audio.

Returns true if the track can be bounced, or false otherwise.

boolcan_record ()
Playlistplaylist ()
boolrecord_enabled ()
Methods
boolactive ()
intadd_processor_by_index (Processor, int, ProcessorStreams, bool)

Add a processor to a route such that it ends up with a given index into the visible processors.

index
Index to add the processor at, or -1 to add at the end of the list.

Returns 0 on success, non-0 on failure.

booladd_sidechain (Processor)
Ampamp ()
std::stringcomment ()
boolcustomize_plugin_insert (Processor, unsigned int, ChanCount)

enable custom plugin-insert configuration

proc
Processor to customize
count
number of plugin instances to use (if zero, reset to default)
outs
output port customization

Returns true if successful

Deliverymain_outs ()

the signal processorat at end of the processing chain which produces output

boolmuted ()
ChanCountn_outputs ()
Processornth_plugin (unsigned int)
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

boolremove_sidechain (Processor)
intreplace_processor (Processor, Processor, ProcessorStreams)

replace plugin/processor with another

old
processor to remove
sub
processor to substitute the old one with
err
error report (index where removal vailed, channel-count why it failed) may be nil

Returns 0 on success

boolreset_plugin_insert (Processor)

reset plugin-insert configuration to default, disable customizations.

This is equivalent to calling 

 customize_plugin_insert (proc, 0, unused)
proc
Processor to reset

Returns true if successful

voidset_active (bool, void*)
voidset_comment (std::string, void*)
boolset_strict_io (bool)
+ + + @@ -1060,6 +1109,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C

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

is-a: PBD:StatefulDestructiblePtr

+

A plugin is an external module (usually 3rd party provided) loaded into Ardour for the purpose of digital signal processing.

This class provides an abstraction for methords provided by all supported plugin standards such as presets, name, parameters etc.

Plugins are not used directly in Ardour but always wrapped by a PluginInsert.

Methods
voidadd_region (Region, long, float, 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)
DataTypedata_type ()
voidduplicate (Region, long, long, float)
gap
from the beginning of the region to the next beginning
voidduplicate_range (AudioRange&, float)
voidduplicate_until (Region, long, long, long)
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)
boolisnil ()
@@ -1088,6 +1138,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C

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

is-a: ARDOUR:AutomationControl

+

A control that manipulates a plugin parameter (control port).

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

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

is-a: ARDOUR:Processor

+

Plugin inserts: send data through a plugin

Methods
boolisnil ()
@@ -1145,6 +1197,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C +
Methods
voidactivate ()
Pluginplugin (unsigned int)
voidset_input_map (unsigned int, ChanMapping)
voidset_output_map (unsigned int, ChanMapping)
IOsidechain_input ()
boolstrict_io_configured ()

Inherited from ARDOUR:Processor

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

↠ ARDOUR:PortSet

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

+

An ordered list of Ports, possibly of various types.

This allows access to all the ports as a list, ignoring type, or accessing the nth port of a given type. Note that port(n) and nth_audio_port(n) may NOT return the same port.

Each port is held twice; once in a per-type vector of vectors (_ports) and once in a vector of all port (_all_ports). This is to speed up the fairly common case of iterating over all ports.

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

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

is-a: ARDOUR:SessionObject

+

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

Methods
voidadd (Port)
@@ -1276,6 +1331,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C

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

is-a: 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
voidactivate ()
@@ -1383,14 +1439,17 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C

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

is-a: 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
boolat_natural_position ()
+ + @@ -1399,9 +1458,12 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C + + + @@ -1464,11 +1526,15 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
Methods
boolactive ()
intadd_processor_by_index (Processor, int, ProcessorStreams, bool)

Add a processor to a route such that it ends up with a given index into the visible processors.

index
Index to add the processor at, or -1 to add at the end of the list.

Returns 0 on success, non-0 on failure.

booladd_sidechain (Processor)
Ampamp ()
std::stringcomment ()
boolcustomize_plugin_insert (Processor, unsigned int, ChanCount)

enable custom plugin-insert configuration

proc
Processor to customize
count
number of plugin instances to use (if zero, reset to default)
outs
output port customization

Returns true if successful

boolisnil ()
Deliverymain_outs ()

the signal processorat at end of the processing chain which produces output

ChanCountn_outputs ()
Processornth_plugin (unsigned int)
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

boolremove_sidechain (Processor)
intreplace_processor (Processor, Processor, ProcessorStreams)

replace plugin/processor with another

old
processor to remove
sub
processor to substitute the old one with
err
error report (index where removal vailed, channel-count why it failed) may be nil

Returns 0 on success

boolreset_plugin_insert (Processor)

reset plugin-insert configuration to default, disable customizations.

This is equivalent to calling 

 customize_plugin_insert (proc, 0, unused)
proc
Processor to reset

Returns true if successful

voidset_active (bool, void*)
voidset_comment (std::string, void*)
boolset_name (std::string)
+ + + + @@ -1482,7 +1548,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C - + @@ -1516,6 +1582,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C

↠ ARDOUR:SessionObject

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

Methods
voidabort_reversible_command ()

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

boolactively_recording ()
voidadd_command (Command)
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
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)
longcurrent_end_frame ()
longcurrent_start_frame ()
voidgoto_end ()
voidgoto_start ()
longlast_transport_start ()
Locationlocations ()
Locationslocations ()
std::stringname ()
RouteListnew_route_from_template (unsigned int, std::string, std::string, PlaylistDisposition)

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

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

Returns list of newly created routes

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

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

is-a: ARDOUR:IOProcessor

+

A mixer strip element (Processor) with 1 or 2 IO elements.

Methods
boolisnil ()
@@ -1566,6 +1634,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 >

+

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

Methods
boolisnil ()
@@ -1597,11 +1666,15 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C

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

is-a: ARDOUR:Route

+

A track is an route (bus) with a recordable diskstream and related objects relevant to tracking, playback and editing.

Specifically a track has regions and playlist objects.

Methods
boolisnil ()
- + + + + @@ -1619,10 +1692,12 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C + + @@ -1630,9 +1705,12 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C + + + @@ -1915,21 +1993,23 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
Methods
Regionbounce (long, long, InterThreadInfo&, Processor, bool)
Regionbounce (InterThreadInfo&)

bounce track from session start to session end to new region

itt
asynchronous progress report and cancel

Returns a new audio region (or nil in case of error)

Regionbounce_range (long, long, InterThreadInfo&, Processor, bool)

Bounce the given range to a new audio region.

start
start time (in samples)
end
end time (in samples)
itt
asynchronous progress report and cancel
endpoint
the processor to tap the signal off (or nil for the top)
include_endpoint
include the given processor in the bounced audio.

Returns a new audio region (or nil in case of error)

boolbounceable (Processor, bool)

Test if the track can be bounced with the given settings. If sends/inserts/returns are present in the signal path or the given track has no audio outputs bouncing is not possible.

endpoint
the processor to tap the signal off (or nil for the top)
include_endpoint
include the given processor in the bounced audio.

Returns true if the track can be bounced, or false otherwise.

boolcan_record ()
boolisnil ()
Playlistplaylist ()
Methods
boolactive ()
intadd_processor_by_index (Processor, int, ProcessorStreams, bool)

Add a processor to a route such that it ends up with a given index into the visible processors.

index
Index to add the processor at, or -1 to add at the end of the list.

Returns 0 on success, non-0 on failure.

booladd_sidechain (Processor)
Ampamp ()
std::stringcomment ()
boolcustomize_plugin_insert (Processor, unsigned int, ChanCount)

enable custom plugin-insert configuration

proc
Processor to customize
count
number of plugin instances to use (if zero, reset to default)
outs
output port customization

Returns true if successful

Deliverymain_outs ()

the signal processorat at end of the processing chain which produces output

boolmuted ()
ChanCountn_outputs ()
Processornth_plugin (unsigned int)
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

boolremove_sidechain (Processor)
intreplace_processor (Processor, Processor, ProcessorStreams)

replace plugin/processor with another

old
processor to remove
sub
processor to substitute the old one with
err
error report (index where removal vailed, channel-count why it failed) may be nil

Returns 0 on success

boolreset_plugin_insert (Processor)

reset plugin-insert configuration to default, disable customizations.

This is equivalent to calling 

 customize_plugin_insert (proc, 0, unused)
proc
Processor to reset

Returns true if successful

voidset_active (bool, void*)
voidset_comment (std::string, void*)
boolset_strict_io (bool)
LuaTabletable ()

⋯ C:FloatArray

-

C‡: float*

+

C‡:

+
Methods
LuaMetaTablearray ()
LuaTableget_table ()
boolsameinstance (FloatArray)
voidset_table (LuaTable {float})

⋯ C:IntArray

-

C‡: int*

+

C‡:

+
Methods
LuaMetaTablearray ()
LuaTableget_table ()
boolsameinstance (IntArray)
voidset_table (LuaTable {int})

∁ C:StringList

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

↠ Evoral:Control

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

+

Base class representing some kind of (automatable) control; a fader's gain, for example, or a compressor plugin's threshold.

The class knows the Evoral::Parameter that it is controlling, and has a list of values for automation.

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

↠ Evoral:ControlList

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

+

A list (sequence) of time-stamped values for a control

Methods
boolisnil ()
@@ -2183,7 +2265,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C

C‡: Command

is-a: PBD:StatefulDestructible

-

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

+

Base class for Undo/Redo commands and changesets

Methods
voidadd (double, double, bool, bool)
@@ -2200,6 +2282,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C

C‡: boost::shared_ptr< PBD::Controllable >, boost::weak_ptr< PBD::Controllable >

is-a: PBD:StatefulDestructiblePtr

+

This is a pure virtual class to represent a scalar control.

Note that it contains no storage/state for the controllable thing that it represents. Derived classes must provide set_value()/get_value() methods, which will involve (somehow) an actual location to store the value.

In essence, this is an interface, not a class.

Without overriding upper() and lower(), a derived class will function as a control whose value can range between 0 and 1.0.

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

∁ PBD:ID

C‡: PBD::ID

+

a unique ID to identify objects numerically

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

C‡: boost::shared_ptr< PBD::StatefulDestructible >, boost::weak_ptr< PBD::StatefulDestructible >

is-a: PBD:StatefulPtr

+

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

Constructor
ℂPBD.ID (std::string)
@@ -2286,6 +2371,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C

↠ PBD:StatefulPtr

C‡: boost::shared_ptr< PBD::Stateful >, boost::weak_ptr< PBD::Stateful >

+

Base class for objects with saveable and undoable state

Methods
boolisnil ()
@@ -2595,6 +2681,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
  • ARDOUR:InterThreadInfo
  • ARDOUR:Location
  • ARDOUR:LocationList
    • +
  • ARDOUR:Locations
  • ARDOUR.LuaAPI
  • ARDOUR:LuaOSC:Address
  • ARDOUR:Meter
    • @@ -2672,6 +2759,6 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
  • PBD:XMLNode
  • Timecode:BBT_TIME
    • - + -
    Ardour 4.7-687-gdd57b33  -  Tue, 12 Apr 2016 14:06:18 +0200
    +
    Ardour 4.7-720-g5bbfd0d  -  Thu, 14 Apr 2016 03:41:02 +0200
    Methods
    voidclear_changes ()