X-Git-Url: http://shamusworld.gotdns.org/cgi-bin/gitweb.cgi?a=blobdiff_plain;f=_manual%2F24_lua-scripting%2F02_class_reference.html;h=503e8774823dab3f07dd8ab589f2625ac0992a1c;hb=fd1ad5d44650630a40b1afa2bd6c5278737346b9;hp=2ba2acc7c45d4cce202d15c0ccf7f3d445a1f67c;hpb=8f50dc72be6aad3ea3a1b99b8409262887fd7ff1;p=ardour-manual-diverged diff --git a/_manual/24_lua-scripting/02_class_reference.html b/_manual/24_lua-scripting/02_class_reference.html index 2ba2acc..503e877 100644 --- a/_manual/24_lua-scripting/02_class_reference.html +++ b/_manual/24_lua-scripting/02_class_reference.html @@ -5,7 +5,7 @@ title: Class Reference ---

-This documention is far from complete may be inaccurate and subject to change. +This documentation is far from complete may be inaccurate and subject to change.

@@ -146,10 +146,12 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C voiddeactivate () std::stringdisplay_name () Cast + Ampto_amp () Automatableto_automatable () PluginInsertto_insert () IOProcessorto_ioprocessor () SideChainto_sidechain () + UnknownProcessorto_unknownprocessor ()

Inherited from ARDOUR:SessionObject

@@ -162,7 +164,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.

+

AudioBackend is an high-level abstraction for interacting with the operating system's audio and midi I/O.

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

∁ ARDOUR:AudioEngine

C‡: ARDOUR::AudioEngine

+

is-a: ARDOUR:PortManager

@@ -244,6 +247,27 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
Methods
intstart (bool)
intstop (bool)
+

Inherited from ARDOUR:PortManager

+ + + + + + + + + + + + + + + + + + + +
Methods
intconnect (std::string, std::string)
boolconnected (std::string)
intdisconnect (std::string, std::string)
intdisconnect_port (Port)
LuaTable(int, ...)get_backend_ports (std::string, DataType, PortFlags, StringVector&)
LuaTable(int, ...)get_connections (std::string, StringVector&)
voidget_physical_inputs (DataType, StringVector&)
voidget_physical_outputs (DataType, StringVector&)
Portget_port_by_name (std::string)
name
Full or short name of port

Returns Corresponding Port or 0.

LuaTable(int, ...)get_ports (DataType, PortList&)
std::stringget_pretty_name_by_name (std::string)
ChanCountn_physical_inputs ()
ChanCountn_physical_outputs ()
boolphysically_connected (std::string)
PortEngineport_engine ()
boolport_is_physical (std::string)

↠ ARDOUR:AudioPort

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

is-a: ARDOUR:Port

@@ -272,6 +296,9 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C

Returns true if this Port receives input, otherwise false

boolsends_output ()

Returns true if this Port sends output, otherwise false

+ Cast + AudioPortto_audioport () + MidiPortto_midiport ()

∁ ARDOUR:AudioRange

C‡: ARDOUR::AudioRange

@@ -349,14 +376,16 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C 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

+ boolcustomize_plugin_insert (Processor, unsigned int, ChanCount, 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
sinks
input pins for variable-I/O plugins

Returns true if successful

Deliverymain_outs ()

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

boolmuted () ChanCountn_inputs () ChanCountn_outputs () Processornth_plugin (unsigned int) + Processornth_processor (unsigned int) + Processornth_send (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) @@ -439,6 +468,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C Methods voidclear_changes ()

Forget about any changes to this object's properties

+ IDid () OwnedPropertyListproperties ()

↠ ARDOUR:AutomationList

@@ -543,18 +573,21 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C

calculate peaks

data
data to analyze
min
result, minimum value found in range
max
result, max value found in range
n_samples
number of samples to analyze

∁ ARDOUR:DSP:Biquad

-

C‡: ARDOUR::DSP::BiQuad

+

C‡: ARDOUR::DSP::Biquad

Biquad Filter

+ - + - + + + - +
Constructor
ℂARDOUR.DSP.Biquad (double)

Instantiate Biquad Filter

samplerate
Samplerate
Methods
voidcompute (Type, double, double, double)
voidcompute (Type, double, double, double)

setup filter, compute coefficients

type
filter type (LowPass, HighPass, etc)
freq
filter frequency
Q
filter quality
gain
filter gain
voidreset ()
floatdB_at_freq (float)

filter transfer function (filter response for spectrum visualization)

freq
frequency

Returns gain at given frequency in dB (clamped to -120..+120)

voidreset ()

reset filter state

voidrun (FloatArray, unsigned int)
voidrun (FloatArray, unsigned int)

process audio data

data
pointer to audio-data
n_samples
number of samples to process

∁ ARDOUR:DSP:DspShm

@@ -603,11 +636,11 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C ℂARDOUR.DataType (std::string) Methods DataTypeaudio () -

convenience contructor for DataType::AUDIO

Returns DataType::AUDIO

+

convenience constructor for DataType::AUDIO with managed lifetime

Returns DataType::AUDIO

DataTypemidi () -

convenience contructor for DataType::MIDI

Returns DataType::MIDI

+

convenience constructor for DataType::MIDI with managed lifetime

Returns DataType::MIDI

DataTypenull () -

convenience contructor for DataType::NIL

Returns DataType::NIL

+

convenience constructor for DataType::NIL with managed lifetime

Returns DataType::NIL

char*to_string ()

Inverse of the from-string constructor

@@ -638,10 +671,12 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C voiddeactivate () std::stringdisplay_name () Cast + Ampto_amp () Automatableto_automatable () PluginInsertto_insert () IOProcessorto_ioprocessor () SideChainto_sidechain () + UnknownProcessorto_unknownprocessor ()

Inherited from ARDOUR:SessionObject

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

Forget about any changes to this object's properties

IDid ()
OwnedPropertyListproperties ()

↠ ARDOUR:IO

@@ -767,10 +803,12 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C voiddeactivate () std::stringdisplay_name () Cast + Ampto_amp () Automatableto_automatable () PluginInsertto_insert () IOProcessorto_ioprocessor () SideChainto_sidechain () + UnknownProcessorto_unknownprocessor ()

Inherited from ARDOUR:SessionObject

@@ -787,7 +825,6 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C -
Constructor
ℂARDOUR.InterThreadInfo ()
Data Members
boolcancel
booldone
floatprogress
@@ -815,6 +852,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C Methods voidclear_changes ()

Forget about any changes to this object's properties

+ IDid () OwnedPropertyListproperties ()

∁ ARDOUR:LocationList

@@ -839,8 +877,12 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C Methods Locationauto_loop_location () Locationauto_punch_location () + LuaTable(...)find_all_between (long, long, LocationList&, Flags) longfirst_mark_after (long, bool) - longfirst_mark_after (long, bool) + Locationfirst_mark_at (long, long) + longfirst_mark_before (long, bool) + LuaTable(...)marks_either_side (long, long&, long&) +

Look for the `marks' (either locations which are marks, or start/end points of range markers) either side of a frame. Note that if frame is exactly on a `mark', that mark will not be considered for returning as before/after.

frame
Frame to look for.
before
Filled in with the position of the last `mark' before `frame' (or max_framepos if none exists)
after
Filled in with the position of the next `mark' after `frame' (or max_framepos if none exists)
Locationsession_range_location ()

Inherited from PBD:Stateful

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

Forget about any changes to this object's properties

+ IDid () OwnedPropertyListproperties ()

ℕ ARDOUR.LuaAPI

@@ -908,10 +951,12 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C

Buffer containing 8-bit unsigned char (MIDI) data.

- + + +
Methods
boolempty ()
boolpush_back (long, unsigned long, unsigned char*)
boolpush_event (MidiEvent)
boolsameinstance (MidiBuffer)
voidsilence (long, long)

Clear (eg zero, or empty) buffer

...table (--lua--)

↠ ARDOUR:MidiPort

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

@@ -919,6 +964,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
+ @@ -943,6 +989,9 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C + + +
Methods
MidiBufferget_midi_buffer (unsigned int)
boolinput_active ()
boolisnil ()
voidset_input_active (bool)

Returns true if this Port receives input, otherwise false

boolsends_output ()

Returns true if this Port sends output, otherwise false

Cast
AudioPortto_audioport ()
MidiPortto_midiport ()

↠ ARDOUR:MidiTrack

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

@@ -982,14 +1031,16 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C 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

+ boolcustomize_plugin_insert (Processor, unsigned int, ChanCount, 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
sinks
input pins for variable-I/O plugins

Returns true if successful

Deliverymain_outs ()

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

boolmuted () ChanCountn_inputs () ChanCountn_outputs () Processornth_plugin (unsigned int) + Processornth_processor (unsigned int) + Processornth_send (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) @@ -1132,6 +1183,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C Methods voidclear_changes ()

Forget about any changes to this object's properties

+ IDid () OwnedPropertyListproperties ()

↠ ARDOUR:PluginControl

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

Forget about any changes to this object's properties

+ IDid () OwnedPropertyListproperties ()

↠ ARDOUR:PluginInfo

@@ -1208,10 +1261,12 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C Controlcontrol (Parameter, bool) std::stringdisplay_name () Cast + Ampto_amp () Automatableto_automatable () PluginInsertto_insert () IOProcessorto_ioprocessor () SideChainto_sidechain () + UnknownProcessorto_unknownprocessor ()

Inherited from ARDOUR:SessionObject

@@ -1244,6 +1299,50 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C + + + +

Returns true if this Port receives input, otherwise false

boolsends_output ()

Returns true if this Port sends output, otherwise false

Cast
AudioPortto_audioport ()
MidiPortto_midiport ()
+

∅ ARDOUR:PortEngine

+

C‡: ARDOUR::PortEngine

+
+

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.

+

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

+

∁ ARDOUR:PortList

+

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

+
+ + + + + + + + + +
Constructor
ℂARDOUR.PortList ()
Methods
boolempty ()
LuaIteriter ()
voidreverse ()
unsigned longsize ()
LuaTabletable ()
+

∁ ARDOUR:PortManager

+

C‡: ARDOUR::PortManager

+
+ + + + + + + + + + + + + + + + + + +
Methods
intconnect (std::string, std::string)
boolconnected (std::string)
intdisconnect (std::string, std::string)
intdisconnect_port (Port)
LuaTable(int, ...)get_backend_ports (std::string, DataType, PortFlags, StringVector&)
LuaTable(int, ...)get_connections (std::string, StringVector&)
voidget_physical_inputs (DataType, StringVector&)
voidget_physical_outputs (DataType, StringVector&)
Portget_port_by_name (std::string)
name
Full or short name of port

Returns Corresponding Port or 0.

LuaTable(int, ...)get_ports (DataType, PortList&)
std::stringget_pretty_name_by_name (std::string)
ChanCountn_physical_inputs ()
ChanCountn_physical_outputs ()
boolphysically_connected (std::string)
PortEngineport_engine ()
boolport_is_physical (std::string)

↠ ARDOUR:PortSet

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

@@ -1266,6 +1365,8 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C

C‡: ARDOUR::Plugin::PresetRecord

+ + @@ -1287,10 +1388,12 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C + +
Constructor
ℂARDOUR.PresetRecord ()
Data Members
std::stringlabel
std::stringuri
std::stringdisplay_name ()
boolisnil ()
Cast
Ampto_amp ()
Automatableto_automatable ()
PluginInsertto_insert ()
IOProcessorto_ioprocessor ()
SideChainto_sidechain ()
UnknownProcessorto_unknownprocessor ()

Inherited from ARDOUR:SessionObject

@@ -1387,7 +1490,6 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C -
new_endpoint
New region end point, such that, for example, a region at 0 of length 10 has an endpoint of 9.
voidtrim_front (long)
voidtrim_to (long, long)
boolvalid_transients ()
boolvideo_locked ()
boolwhole_file ()
@@ -1448,8 +1550,8 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C 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

+ boolcustomize_plugin_insert (Processor, unsigned int, ChanCount, 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
sinks
input pins for variable-I/O plugins

Returns true if successful

boolisnil () Deliverymain_outs ()

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

@@ -1457,6 +1559,8 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C ChanCountn_inputs () ChanCountn_outputs () Processornth_plugin (unsigned int) + Processornth_processor (unsigned int) + Processornth_send (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) @@ -1490,6 +1594,11 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C Constructor ℂARDOUR.Route.ProcessorStreams () +

∅ ARDOUR:RouteGroup

+

C‡: ARDOUR::RouteGroup

+
+

A group identifier for routes.

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

A route can at most be in one group.

+

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

∁ ARDOUR:RouteList

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

@@ -1538,9 +1647,11 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C Controllablecontrollable_by_id (ID) longcurrent_end_frame () longcurrent_start_frame () + AudioEngineengine () longframe_rate ()

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

doubleframes_per_timecode_frame () + unsigned intget_block_size () RouteListPtrget_routes () BufferSetget_scratch_buffers (ChanCount, bool) BufferSetget_silent_buffers (ChanCount) @@ -1549,7 +1660,15 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C voidgoto_start () longlast_transport_start () Locationslocations () + Routemaster_out () + Routemonitor_out () std::stringname () + RouteListnew_audio_route (int, int, RouteGroup, unsigned int, std::string) +

Caller must not hold process lock.

name_template
string to use for the start of the name, or "" to use "Bus".
+ AudioTrackListnew_audio_track (int, int, TrackMode, RouteGroup, unsigned int, std::string) +

Caller must not hold process lock

name_template
string to use for the start of the name, or "" to use "Audio".
+ RouteListnew_midi_route (RouteGroup, unsigned int, std::string, PluginInfo, PresetRecord) + MidiTrackListnew_midi_track (ChanCount, ChanCount, PluginInfo, TrackMode, RouteGroup, unsigned int, std::string, PresetRecord) 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

longnominal_frame_rate () @@ -1578,6 +1697,10 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C booltransport_rolling () doubletransport_speed () StringListunknown_processors () + longworst_input_latency () + longworst_output_latency () + longworst_playback_latency () + longworst_track_latency ()

↠ ARDOUR:SessionObject

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

@@ -1618,10 +1741,12 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C voiddeactivate () std::stringdisplay_name () Cast + Ampto_amp () Automatableto_automatable () PluginInsertto_insert () IOProcessorto_ioprocessor () SideChainto_sidechain () + UnknownProcessorto_unknownprocessor ()

Inherited from ARDOUR:SessionObject

@@ -1659,8 +1784,8 @@ 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

- - + +
Methods
voidadd_meter (Meter, BBT_TIME)
voidadd_tempo (Tempo, BBT_TIME)
--MISSING (ARDOUR::MeterSection*)--add_meter (Meter, double, BBT_TIME, long, --MISSING (ARDOUR::PositionLockStyle)--)
--MISSING (ARDOUR::TempoSection*)--add_tempo (Tempo, double, long, --MISSING (ARDOUR::TempoSection::Type)--, --MISSING (ARDOUR::PositionLockStyle)--)

↠ ARDOUR:Track

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

@@ -1696,14 +1821,16 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C 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

+ boolcustomize_plugin_insert (Processor, unsigned int, ChanCount, 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
sinks
input pins for variable-I/O plugins

Returns true if successful

Deliverymain_outs ()

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

boolmuted () ChanCountn_inputs () ChanCountn_outputs () Processornth_plugin (unsigned int) + Processornth_processor (unsigned int) + Processornth_send (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) @@ -1728,6 +1855,40 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C Statefulto_stateful () StatefulDestructibleto_statefuldestructible () +

↠ ARDOUR:UnknownProcessor

+

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

+

is-a: ARDOUR:Processor

+
+

A stub Processor that can be used in place of a `real' one that cannot be created for some reason; usually because it requires a plugin which is not present. UnknownProcessors are special-cased in a few places, notably in route configuration and signal processing, so that on encountering them configuration or processing stops.

When a Processor is missing from a Route, the following processors cannot be configured, as the missing Processor's output port configuration is unknown.

The main utility of the UnknownProcessor is that it allows state to be preserved, so that, for example, loading and re-saving a session on a machine without a particular plugin will not corrupt the session.

+ + + +
Methods
boolisnil ()
+

Inherited from ARDOUR:Processor

+ + + + + + + + + + + + + + + +
Methods
voidactivate ()
boolactive ()
AutomationControlautomation_control (Parameter, bool)
Controlcontrol (Parameter, bool)
voiddeactivate ()
std::stringdisplay_name ()
Cast
Ampto_amp ()
Automatableto_automatable ()
PluginInsertto_insert ()
IOProcessorto_ioprocessor ()
SideChainto_sidechain ()
UnknownProcessorto_unknownprocessor ()
+

Inherited from ARDOUR:SessionObject

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

∁ ARDOUR:WeakAudioSourceList

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

@@ -1993,23 +2154,25 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C LuaTabletable ()

⋯ C:FloatArray

-

C‡:

+

C‡: float*

- + +
Methods
LuaMetaTablearray ()
LuaTableget_table ()
boolsameinstance (FloatArray)
FloatArrayoffset (unsigned int)
boolsameinstance (FloatArray)
voidset_table (LuaTable {float})

⋯ C:IntArray

-

C‡:

+

C‡: int*

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

∁ C:StringList

@@ -2197,8 +2360,8 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C - - + +
Methods
unsigned charchannel ()
unsigned charset_channel ()
unsigned charset_type ()
voidset_channel (unsigned char)
voidset_type (unsigned char)
unsigned chartype ()

Inherited from Evoral:Event

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

Forget about any changes to this object's properties

+ IDid () OwnedPropertyListproperties ()

↠ PBD:Controllable

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

Forget about any changes to this object's properties

+ IDid () OwnedPropertyListproperties ()

∁ PBD:ID

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

Forget about any changes to this object's properties

+ IDid () OwnedPropertyListproperties ()

∅ PBD:StatefulDestructible

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

Forget about any changes to this object's properties

+ IDid () OwnedPropertyListproperties ()

↠ PBD:StatefulDestructiblePtr

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

Forget about any changes to this object's properties

+ IDid () OwnedPropertyListproperties ()

∁ PBD:StatefulDiffCommand

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

Forget about any changes to this object's properties

+ IDid () OwnedPropertyListproperties ()

↠ PBD:StatefulPtr

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

Forget about any changes to this object's properties

+ IDid () boolisnil () OwnedPropertyListproperties () @@ -2448,6 +2618,14 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C +

∈ ARDOUR.PortFlags

+

∈ ARDOUR.PlaylistDisposition

+

∈ ARDOUR.TrackMode

+

∈ ARDOUR.Session.RecordState

+

∈ ARDOUR.Location.Flags

+

∈ Cairo.LineCap

-

∈ ARDOUR.DSP.BiQuad.Type

+

∈ ARDOUR.DSP.Biquad.Type

Class Index

- + -
Ardour 4.7-720-g5bbfd0d  -  Thu, 14 Apr 2016 03:41:02 +0200
+
Ardour 4.7-1385-gca8ac05  -  Tue, 31 May 2016 03:23:16 +0200