X-Git-Url: http://shamusworld.gotdns.org/cgi-bin/gitweb.cgi?a=blobdiff_plain;ds=sidebyside;f=_manual%2F24_lua-scripting%2F02_class_reference.html;h=2ba2acc7c45d4cce202d15c0ccf7f3d445a1f67c;hb=8f50dc72be6aad3ea3a1b99b8409262887fd7ff1;hp=0cde811307e3f3f5e2602011f8c4f3a2755ba1a8;hpb=9bca305233a422a852d093538be53ce3ad50d308;p=ardour-manual 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.
Methods | ||
---|---|---|
GainControl | gain_control () |
Methods | ||
---|---|---|
unsigned int | buffer_size () | |
check buffer for silence
Returns true if all samples are zero | ||
FloatArray | data (long) | |
void | read_from (FloatArray, long, long, long) | |
bool | sameinstance (AudioBuffer) | |
void | silence (long, long) | |
silence buffer
|
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().
Methods | ||
---|---|---|
bool | isnil () |
Methods | ||
---|---|---|
bool | isnil () |
Methods | ||
---|---|---|
Region | bounce (long, long, InterThreadInfo&, Processor, bool) | |
Region | bounce (InterThreadInfo&) | |
bounce track from session start to session end to new region
Returns a new audio region (or nil in case of error) | ||
Region | bounce_range (long, long, InterThreadInfo&, Processor, bool) | |
Bounce the given range to a new audio region.
Returns a new audio region (or nil in case of error) | ||
bool | bounceable (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.
Returns true if the track can be bounced, or false otherwise. | ||
bool | can_record () | |
Playlist | playlist () | |
bool | record_enabled () | |
Methods | ||
bool | active () | |
int | add_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.
Returns 0 on success, non-0 on failure. | ||
bool | add_sidechain (Processor) | |
Amp | amp () | |
std::string | comment () | |
bool | customize_plugin_insert (Processor, unsigned int, ChanCount) | |
enable custom plugin-insert configuration
Returns true if successful | ||
Delivery | main_outs () | |
the signal processorat at end of the processing chain which produces output | ||
bool | muted () | |
ChanCount | n_outputs () | |
Processor | nth_plugin (unsigned int) | |
int | remove_processor (Processor, ProcessorStreams, bool) | |
remove plugin/processor
Returns 0 on success | ||
bool | remove_sidechain (Processor) | |
int | replace_processor (Processor, Processor, ProcessorStreams) | |
replace plugin/processor with another
Returns 0 on success | ||
bool | reset_plugin_insert (Processor) | |
reset plugin-insert configuration to default, disable customizations. This is equivalent to calling customize_plugin_insert (proc, 0, unused)
Returns true if successful | ||
void | set_active (bool, void*) | |
void | set_comment (std::string, void*) | |
bool | set_strict_io (bool) |
Methods | ||
---|---|---|
AutomationList | alist () |
Methods | ||
---|---|---|
XMLNode | get_state () | |
Methods | ||
ChanCount | count () | |
AudioBuffer | get_audio (unsigned long) | |
bool | sameinstance (BufferSet) |
C‡: ARDOUR::ChanCount
@@ -599,6 +615,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to CC‡: 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.
Methods | ||
---|---|---|
bool | isnil () |
Methods | ||
---|---|---|
bool | isnil () |
Methods | ||
---|---|---|
bool | active () |
Methods | ||
---|---|---|
IO | input () | |
float | progress |
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.
Methods | ||
---|---|---|
Location | auto_loop_location () | |
Location | auto_punch_location () | |
long | end () | |
long | first_mark_after (long, bool) | |
long | first_mark_after (long, bool) | |
long | length () | |
void | lock () | |
bool | locked () | |
int | move_to (long) | |
Location | session_range_location () | |
int | set_end (long, bool, bool) | |
Set end position.
| ||
int | set_length (long, long, bool) | |
unsigned long | size () | |
LuaTable | table () |
C‡: ARDOUR::Locations
+is-a: PBD:StatefulDestructible
+ +A collection of session locations including unique dedicated locations (loop, punch, etc)
Methods | ||
---|---|---|
Location | auto_loop_location () | |
Location | auto_punch_location () | |
long | first_mark_after (long, bool) | |
long | first_mark_after (long, bool) | |
Location | session_range_location () |
Methods | ||
---|---|---|
void | clear_changes () | |
Forget about any changes to this object's properties | ||
OwnedPropertyList | properties () |
Methods | ||
---|---|---|
bool | empty () | |
bool | sameinstance (MidiBuffer) | |
void | silence (long, long) | |
Clear (eg zero, or empty) buffer |
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.
Methods | ||
---|---|---|
bool | isnil () |
Methods | ||
---|---|---|
Region | bounce (long, long, InterThreadInfo&, Processor, bool) | |
Region | bounce (InterThreadInfo&) | |
bounce track from session start to session end to new region
Returns a new audio region (or nil in case of error) | ||
Region | bounce_range (long, long, InterThreadInfo&, Processor, bool) | |
Bounce the given range to a new audio region.
Returns a new audio region (or nil in case of error) | ||
bool | bounceable (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.
Returns true if the track can be bounced, or false otherwise. | ||
bool | can_record () | |
Playlist | playlist () | |
bool | record_enabled () | |
Methods | ||
bool | active () | |
int | add_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.
Returns 0 on success, non-0 on failure. | ||
bool | add_sidechain (Processor) | |
Amp | amp () | |
std::string | comment () | |
bool | customize_plugin_insert (Processor, unsigned int, ChanCount) | |
enable custom plugin-insert configuration
Returns true if successful | ||
Delivery | main_outs () | |
the signal processorat at end of the processing chain which produces output | ||
bool | muted () | |
ChanCount | n_outputs () | |
Processor | nth_plugin (unsigned int) | |
int | remove_processor (Processor, ProcessorStreams, bool) | |
remove plugin/processor
Returns 0 on success | ||
bool | remove_sidechain (Processor) | |
int | replace_processor (Processor, Processor, ProcessorStreams) | |
replace plugin/processor with another
Returns 0 on success | ||
bool | reset_plugin_insert (Processor) | |
reset plugin-insert configuration to default, disable customizations. This is equivalent to calling customize_plugin_insert (proc, 0, unused)
Returns true if successful | ||
void | set_active (bool, void*) | |
void | set_comment (std::string, void*) | |
bool | set_strict_io (bool) |
Methods | ||
---|---|---|
void | add_region (Region, long, float, bool) | |
Note: this calls set_layer (..., DBL_MAX) so it will reset the layering index of region | ||
Region | combine (RegionList) | |
unsigned int | count_regions_at (long) | |
Playlist | cut (AudioRangeList&, bool) | |
DataType | data_type () | |
void | duplicate (Region, long, long, float) | |
| ||
void | duplicate_range (AudioRange&, float) | |
void | duplicate_until (Region, long, long, long) | |
| ||
Region | find_next_region (long, RegionPoint, int) | |
long | find_next_region_boundary (long, int) | |
bool | isnil () |
Methods | ||
---|---|---|
std::string | get_docs () |
Methods | ||
---|---|---|
bool | isnil () |
Methods | ||
---|---|---|
void | activate () | |
Plugin | plugin (unsigned int) | |
void | set_input_map (unsigned int, ChanMapping) | |
void | set_output_map (unsigned int, ChanMapping) | |
IO | sidechain_input () | |
bool | strict_io_configured () |
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.
Methods | ||
---|---|---|
void | add (Port) |
Methods | ||
---|---|---|
void | activate () |
Methods | ||
---|---|---|
bool | at_natural_position () |
Methods | ||
---|---|---|
bool | active () | |
int | add_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.
Returns 0 on success, non-0 on failure. | ||
bool | add_sidechain (Processor) | |
Amp | amp () | |
std::string | comment () | |
bool | customize_plugin_insert (Processor, unsigned int, ChanCount) | |
enable custom plugin-insert configuration
Returns true if successful | ||
bool | isnil () | |
Delivery | main_outs () | |
the signal processorat at end of the processing chain which produces output | ||
ChanCount | n_outputs () | |
Processor | nth_plugin (unsigned int) | |
int | remove_processor (Processor, ProcessorStreams, bool) | |
remove plugin/processor
Returns 0 on success | ||
bool | remove_sidechain (Processor) | |
int | replace_processor (Processor, Processor, ProcessorStreams) | |
replace plugin/processor with another
Returns 0 on success | ||
bool | reset_plugin_insert (Processor) | |
reset plugin-insert configuration to default, disable customizations. This is equivalent to calling customize_plugin_insert (proc, 0, unused)
Returns true if successful | ||
void | set_active (bool, void*) | |
void | set_comment (std::string, void*) | |
bool | set_name (std::string) |
Methods | ||
---|---|---|
void | abort_reversible_command () | |
abort an open undo command This must only be called after begin_reversible_command () | ||
bool | actively_recording () | |
void | add_command (Command) | |
StatefulDiffCommand | add_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.
Returns the allocated StatefulDiffCommand (already added via add_command) | ||
void | begin_reversible_command (std::string) | |
begin collecting undo information This call must always be followed by either begin_reversible_command() or commit_reversible_command()
| ||
void | commit_reversible_command (Command) | |
finalize an undo command and commit pending transactions This must only be called after begin_reversible_command ()
| ||
Controllable | controllable_by_id (ID) | |
long | current_end_frame () | |
long | current_start_frame () | |
void | goto_end () | |
void | goto_start () | |
long | last_transport_start () | |
Location | locations () | |
Locations | locations () | |
std::string | name () | |
RouteList | new_route_from_template (unsigned int, std::string, std::string, PlaylistDisposition) | |
create a new track or bus from a template (XML path)
Returns list of newly created routes |
Methods | ||
---|---|---|
bool | isnil () |
Methods | ||
---|---|---|
bool | isnil () |
Methods | ||
---|---|---|
bool | isnil () |
Methods | ||
---|---|---|
Region | bounce (long, long, InterThreadInfo&, Processor, bool) | |
Region | bounce (InterThreadInfo&) | |
bounce track from session start to session end to new region
Returns a new audio region (or nil in case of error) | ||
Region | bounce_range (long, long, InterThreadInfo&, Processor, bool) | |
Bounce the given range to a new audio region.
Returns a new audio region (or nil in case of error) | ||
bool | bounceable (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.
Returns true if the track can be bounced, or false otherwise. | ||
bool | can_record () | |
bool | isnil () | |
Playlist | playlist () | |
Methods | ||
bool | active () | |
int | add_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.
Returns 0 on success, non-0 on failure. | ||
bool | add_sidechain (Processor) | |
Amp | amp () | |
std::string | comment () | |
bool | customize_plugin_insert (Processor, unsigned int, ChanCount) | |
enable custom plugin-insert configuration
Returns true if successful | ||
Delivery | main_outs () | |
the signal processorat at end of the processing chain which produces output | ||
bool | muted () | |
ChanCount | n_outputs () | |
Processor | nth_plugin (unsigned int) | |
int | remove_processor (Processor, ProcessorStreams, bool) | |
remove plugin/processor
Returns 0 on success | ||
bool | remove_sidechain (Processor) | |
int | replace_processor (Processor, Processor, ProcessorStreams) | |
replace plugin/processor with another
Returns 0 on success | ||
bool | reset_plugin_insert (Processor) | |
reset plugin-insert configuration to default, disable customizations. This is equivalent to calling customize_plugin_insert (proc, 0, unused)
Returns true if successful | ||
void | set_active (bool, void*) | |
void | set_comment (std::string, void*) | |
bool | set_strict_io (bool) | |
LuaTable | table () |
C‡: float*
+C‡:
Methods | ||
---|---|---|
LuaMetaTable | array () | |
LuaTable | get_table () | |
bool | sameinstance (FloatArray) | |
void | set_table (LuaTable {float}) |
C‡: int*
+C‡:
Methods | ||
---|---|---|
LuaMetaTable | array () | |
LuaTable | get_table () | |
bool | sameinstance (IntArray) | |
void | set_table (LuaTable {int}) |
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.
Methods | ||
---|---|---|
bool | isnil () |
Methods | ||
---|---|---|
void | add (double, double, bool, bool) |
Methods | ||
---|---|---|
std::string | name () |
Methods | ||
---|---|---|
double | get_value () |
Constructor | ||
---|---|---|
ℂ | PBD.ID (std::string) |
Methods | ||
---|---|---|
bool | isnil () |
Methods | ||
---|---|---|
void | clear_changes () |