X-Git-Url: http://shamusworld.gotdns.org/cgi-bin/gitweb.cgi?a=blobdiff_plain;f=_manual%2F24_lua-scripting%2F02_class_reference.html;h=8940880ea4d4498b40a5f431c2b9f834cd6a9c66;hb=e9607bc8c4713fa3e50f036684683105c3811668;hp=2ba2acc7c45d4cce202d15c0ccf7f3d445a1f67c;hpb=8f50dc72be6aad3ea3a1b99b8409262887fd7ff1;p=ardour-manual diff --git a/_manual/24_lua-scripting/02_class_reference.html b/_manual/24_lua-scripting/02_class_reference.html index 2ba2acc..8940880 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.

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

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

+

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

@@ -229,6 +229,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 +245,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 +294,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

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

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 () - boolrecord_safe () boolset_name (std::string) - voidset_record_enabled (bool, GroupControlDisposition) - voidset_record_safe (bool, GroupControlDisposition) Cast AudioTrackto_audio_track () MidiTrackto_midi_track () @@ -349,14 +370,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) @@ -373,6 +396,26 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C Cast Trackto_track () +

Inherited from ARDOUR:Stripable

+ + + + + + + + + + + + + + + + + + +
Methods
GainControlgain_control ()
boolis_auditioner ()
boolis_hidden ()
boolis_master ()
boolis_monitor ()
boolis_selected ()
MuteControlmute_control ()
PhaseControlphase_control ()
AutomationControlrec_enable_control ()
AutomationControlrec_safe_control ()
SoloControlsolo_control ()
SoloIsolateControlsolo_isolate_control ()
SoloSafeControlsolo_safe_control ()
GainControltrim_control ()
Cast
Routeto_route ()

Inherited from ARDOUR:SessionObject

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

Forget about any changes to this object's properties

IDid ()
OwnedPropertyListproperties ()

↠ ARDOUR:AutomationList

@@ -543,18 +587,23 @@ 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 ()
voidconfigure (double, double, double, double, double)

setup filter, set coefficients directly

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

@@ -576,6 +625,20 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C IntArrayto_int (unsigned long)

access memory as integer array

off
offset in shared memory region

Returns int_32_t[]

+

∁ ARDOUR:DSP:FFTSpectrum

+

C‡: ARDOUR::DSP::FFTSpectrum

+
+ + + + + + + + + + +
Constructor
ℂARDOUR.DSP.FFTSpectrum (unsigned int, double)
Methods
voidexecute ()

process current data in buffer

floatfreq_at_bin (unsigned int)
floatpower_at_bin (unsigned int, float)

query

b
the frequency bin 0 .. window_size / 2
norm
gain factor (set equal to for 1/f normalization)

Returns signal power at given bin (in dBFS)

voidset_data_hann (FloatArray, unsigned int, unsigned int)

∁ ARDOUR:DSP:LowPass

C‡: ARDOUR::DSP::LowPass

@@ -603,11 +666,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

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

@@ -677,13 +740,24 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C

↠ ARDOUR:GainControl

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

-

is-a: ARDOUR:AutomationControl

+

is-a: ARDOUR:SlavableAutomationControl,

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

Methods
boolisnil ()
+

Inherited from ARDOUR:SlavableAutomationControl,

+ + + + + + + + + +
Methods
voidadd_master (AutomationControl)
voidclear_masters ()
intget_boolean_masters ()
doubleget_masters_value ()
voidremove_master (AutomationControl)
boolslaved ()
boolslaved_to (AutomationControl)

Inherited from ARDOUR:AutomationControl

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

Forget about any changes to this object's properties

IDid ()
OwnedPropertyListproperties ()

↠ ARDOUR:IO

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

@@ -787,7 +862,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 +889,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 +914,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,12 +927,15 @@ 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

+ + @@ -902,16 +984,44 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
Methods
LuaTablehsla_to_rgba ()

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)

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)

Processornew_plugin (Session, std::string, PluginType, std::string)
doubleframes_per_grid (Tempo, long)
doublenote_divisor ()
+

∁ ARDOUR:MeterSection

+

C‡: ARDOUR::MeterSection

+

is-a: ARDOUR:MetricSection

+
+

A section of timeline with a certain Meter.

+ + + + + + +
Methods
voidset_beat (double)
voidset_pulse (double)
Cast
Meterto_meter ()
+

Inherited from ARDOUR:MetricSection

+ + + +
Methods
doublepulse ()
+

∁ ARDOUR:MetricSection

+

C‡: ARDOUR::MetricSection

+
+

A section of timeline with a certain Tempo or Meter.

+ + + + +
Methods
doublepulse ()
voidset_pulse (double)

∁ ARDOUR:MidiBuffer

C‡: ARDOUR::MidiBuffer

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

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

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 () - boolrecord_safe () boolset_name (std::string) - voidset_record_enabled (bool, GroupControlDisposition) - voidset_record_safe (bool, GroupControlDisposition) Cast AudioTrackto_audio_track () MidiTrackto_midi_track () @@ -982,14 +1092,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) @@ -1006,6 +1118,26 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C Cast Trackto_track () +

Inherited from ARDOUR:Stripable

+ + + + + + + + + + + + + + + + + + +
Methods
GainControlgain_control ()
boolis_auditioner ()
boolis_hidden ()
boolis_master ()
boolis_monitor ()
boolis_selected ()
MuteControlmute_control ()
PhaseControlphase_control ()
AutomationControlrec_enable_control ()
AutomationControlrec_safe_control ()
SoloControlsolo_control ()
SoloIsolateControlsolo_isolate_control ()
SoloSafeControlsolo_safe_control ()
GainControltrim_control ()
Cast
Routeto_route ()

Inherited from ARDOUR:SessionObject

@@ -1030,6 +1162,59 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
Methods
LuaTabletable ()
voidunique ()
+

↠ ARDOUR:MuteControl

+

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

+

is-a: ARDOUR:SlavableAutomationControl,

+
+

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

+ + + + + +
Methods
boolisnil ()
boolmuted ()
boolmuted_by_self ()
+

Inherited from ARDOUR:SlavableAutomationControl,

+ + + + + + + + + +
Methods
voidadd_master (AutomationControl)
voidclear_masters ()
intget_boolean_masters ()
doubleget_masters_value ()
voidremove_master (AutomationControl)
boolslaved ()
boolslaved_to (AutomationControl)
+

Inherited from ARDOUR:AutomationControl

+ + + + + + + + + + + + + + + + +
Methods
AutomationListalist ()
AutoStateautomation_state ()
AutoStyleautomation_style ()
doubleget_value ()

Get the current effective `user' value based on automation state

voidset_automation_state (AutoState)
voidset_automation_style (AutoStyle)
voidset_value (double, GroupControlDisposition)

Get and Set `internal' value

All derived classes must implement this.

Basic derived classes will ignore

group_override,
but more sophisticated children, notably those that proxy the value setting logic via an object that is aware of group relationships between this control and others, will find it useful.
voidstart_touch (double)
voidstop_touch (bool, double)
boolwritable ()
Cast
Controlto_ctrl ()
+

Inherited from PBD:Controllable

+ + + +
Methods
std::stringname ()
+

Inherited from PBD:StatefulPtr

+ + + + + + +
Methods
voidclear_changes ()

Forget about any changes to this object's properties

IDid ()
OwnedPropertyListproperties ()

∅ ARDOUR:OwnedPropertyList

C‡: PBD::OwnedPropertyList

is-a: ARDOUR:PropertyList

@@ -1058,6 +1243,49 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C booltoggled floatupper +

↠ ARDOUR:PhaseControl

+

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

+

is-a: ARDOUR:AutomationControl

+
+

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

+ + + + + + +
Methods
boolinverted (unsigned int)
boolisnil ()
voidset_phase_invert (unsigned int, bool)
c
Audio channel index.
yn
true to invert phase, otherwise false.
+

Inherited from ARDOUR:AutomationControl

+ + + + + + + + + + + + + + + + +
Methods
AutomationListalist ()
AutoStateautomation_state ()
AutoStyleautomation_style ()
doubleget_value ()

Get the current effective `user' value based on automation state

voidset_automation_state (AutoState)
voidset_automation_style (AutoStyle)
voidset_value (double, GroupControlDisposition)

Get and Set `internal' value

All derived classes must implement this.

Basic derived classes will ignore

group_override,
but more sophisticated children, notably those that proxy the value setting logic via an object that is aware of group relationships between this control and others, will find it useful.
voidstart_touch (double)
voidstop_touch (bool, double)
boolwritable ()
Cast
Controlto_ctrl ()
+

Inherited from PBD:Controllable

+ + + +
Methods
std::stringname ()
+

Inherited from PBD:StatefulPtr

+ + + + + + +
Methods
voidclear_changes ()

Forget about any changes to this object's properties

IDid ()
OwnedPropertyListproperties ()

↠ ARDOUR:Playlist

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

is-a: ARDOUR:SessionObject

@@ -1085,6 +1313,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C voidraise_region (Region) voidraise_region_to_top (Region) Regionregion_by_id (ID) + RegionListPtrregion_list () RegionListPtrregions_at (long) RegionListPtrregions_touched (long, long)
start
Range start.
end
Range end.

Returns regions which have some part within this range.

@@ -1132,6 +1361,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 +1401,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

@@ -1204,14 +1435,14 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C - - + +
Methods
boolactive ()
AutomationControlautomation_control (Parameter, bool)
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 +1475,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 +1541,8 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C

C‡: ARDOUR::Plugin::PresetRecord

+ + @@ -1281,16 +1558,16 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C - - + +
Constructor
ℂARDOUR.PresetRecord ()
Data Members
std::stringlabel
std::stringuri
Methods
voidactivate ()
boolactive ()
AutomationControlautomation_control (Parameter, bool)
Controlcontrol (Parameter, bool)
voiddeactivate ()
std::stringdisplay_name ()
boolisnil ()
Cast
Ampto_amp ()
Automatableto_automatable ()
PluginInsertto_insert ()
IOProcessorto_ioprocessor ()
SideChainto_sidechain ()
UnknownProcessorto_unknownprocessor ()

Inherited from ARDOUR:SessionObject

@@ -1387,7 +1664,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 ()
@@ -1437,7 +1713,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C

↠ ARDOUR:Route

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

-

is-a: ARDOUR:SessionObject

+

is-a: ARDOUR:Stripable

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

@@ -1448,8 +1724,8 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C - - + + @@ -1457,6 +1733,8 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C + + @@ -1474,6 +1752,26 @@ 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

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)
Cast
Trackto_track ()
+

Inherited from ARDOUR:Stripable

+ + + + + + + + + + + + + + + + + + +
Methods
GainControlgain_control ()
boolis_auditioner ()
boolis_hidden ()
boolis_master ()
boolis_monitor ()
boolis_selected ()
MuteControlmute_control ()
PhaseControlphase_control ()
AutomationControlrec_enable_control ()
AutomationControlrec_safe_control ()
SoloControlsolo_control ()
SoloIsolateControlsolo_isolate_control ()
SoloSafeControlsolo_safe_control ()
GainControltrim_control ()
Cast
Routeto_route ()

Inherited from ARDOUR:SessionObject

@@ -1490,6 +1788,11 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
Methods
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 +1841,13 @@ 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 () + Routeget_remote_nth_route (unsigned int) + Stripableget_remote_nth_stripable (unsigned int, Flag) RouteListPtrget_routes () BufferSetget_scratch_buffers (ChanCount, bool) BufferSetget_silent_buffers (ChanCount) @@ -1549,7 +1856,13 @@ 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, 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_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 () @@ -1560,9 +1873,9 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C voidrequest_locate (long, bool) voidrequest_stop (bool, bool) voidrequest_transport_speed (double, bool) - Routeroute_by_id (ID) - Routeroute_by_name (std::string) - Routeroute_by_remote_id (unsigned int) + Routeroute_by_id (ID) + Routeroute_by_name (std::string) + Routeroute_by_selected_count (unsigned int) 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 () @@ -1573,11 +1886,15 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C booltimecode_drop_frames () longtimecode_frames_per_hour () doubletimecode_frames_per_second () - Tracktrack_by_diskstream_id (ID) + Tracktrack_by_diskstream_id (ID) longtransport_frame () 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 >

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

@@ -1631,6 +1948,212 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
Statefulto_stateful ()
StatefulDestructibleto_statefuldestructible ()
+

↠ ARDOUR:SlavableAutomationControl,

+

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

+

is-a: ARDOUR:AutomationControl

+
+

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

+ + + + + + + + + + +
Methods
voidadd_master (AutomationControl)
voidclear_masters ()
intget_boolean_masters ()
doubleget_masters_value ()
boolisnil ()
voidremove_master (AutomationControl)
boolslaved ()
boolslaved_to (AutomationControl)
+

Inherited from ARDOUR:AutomationControl

+ + + + + + + + + + + + + + + + +
Methods
AutomationListalist ()
AutoStateautomation_state ()
AutoStyleautomation_style ()
doubleget_value ()

Get the current effective `user' value based on automation state

voidset_automation_state (AutoState)
voidset_automation_style (AutoStyle)
voidset_value (double, GroupControlDisposition)

Get and Set `internal' value

All derived classes must implement this.

Basic derived classes will ignore

group_override,
but more sophisticated children, notably those that proxy the value setting logic via an object that is aware of group relationships between this control and others, will find it useful.
voidstart_touch (double)
voidstop_touch (bool, double)
boolwritable ()
Cast
Controlto_ctrl ()
+

Inherited from PBD:Controllable

+ + + +
Methods
std::stringname ()
+

Inherited from PBD:StatefulPtr

+ + + + + + +
Methods
voidclear_changes ()

Forget about any changes to this object's properties

IDid ()
OwnedPropertyListproperties ()
+

↠ ARDOUR:SoloControl

+

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

+

is-a: ARDOUR:SlavableAutomationControl,

+
+

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

+ + + + + + +
Methods
boolcan_solo ()
boolisnil ()
boolself_soloed ()
boolsoloed ()
+

Inherited from ARDOUR:SlavableAutomationControl,

+ + + + + + + + + +
Methods
voidadd_master (AutomationControl)
voidclear_masters ()
intget_boolean_masters ()
doubleget_masters_value ()
voidremove_master (AutomationControl)
boolslaved ()
boolslaved_to (AutomationControl)
+

Inherited from ARDOUR:AutomationControl

+ + + + + + + + + + + + + + + + +
Methods
AutomationListalist ()
AutoStateautomation_state ()
AutoStyleautomation_style ()
doubleget_value ()

Get the current effective `user' value based on automation state

voidset_automation_state (AutoState)
voidset_automation_style (AutoStyle)
voidset_value (double, GroupControlDisposition)

Get and Set `internal' value

All derived classes must implement this.

Basic derived classes will ignore

group_override,
but more sophisticated children, notably those that proxy the value setting logic via an object that is aware of group relationships between this control and others, will find it useful.
voidstart_touch (double)
voidstop_touch (bool, double)
boolwritable ()
Cast
Controlto_ctrl ()
+

Inherited from PBD:Controllable

+ + + +
Methods
std::stringname ()
+

Inherited from PBD:StatefulPtr

+ + + + + + +
Methods
voidclear_changes ()

Forget about any changes to this object's properties

IDid ()
OwnedPropertyListproperties ()
+

↠ ARDOUR:SoloIsolateControl

+

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

+

is-a: ARDOUR:SlavableAutomationControl,

+
+

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

+ + + + + +
Methods
boolisnil ()
boolself_solo_isolated ()
boolsolo_isolated ()
+

Inherited from ARDOUR:SlavableAutomationControl,

+ + + + + + + + + +
Methods
voidadd_master (AutomationControl)
voidclear_masters ()
intget_boolean_masters ()
doubleget_masters_value ()
voidremove_master (AutomationControl)
boolslaved ()
boolslaved_to (AutomationControl)
+

Inherited from ARDOUR:AutomationControl

+ + + + + + + + + + + + + + + + +
Methods
AutomationListalist ()
AutoStateautomation_state ()
AutoStyleautomation_style ()
doubleget_value ()

Get the current effective `user' value based on automation state

voidset_automation_state (AutoState)
voidset_automation_style (AutoStyle)
voidset_value (double, GroupControlDisposition)

Get and Set `internal' value

All derived classes must implement this.

Basic derived classes will ignore

group_override,
but more sophisticated children, notably those that proxy the value setting logic via an object that is aware of group relationships between this control and others, will find it useful.
voidstart_touch (double)
voidstop_touch (bool, double)
boolwritable ()
Cast
Controlto_ctrl ()
+

Inherited from PBD:Controllable

+ + + +
Methods
std::stringname ()
+

Inherited from PBD:StatefulPtr

+ + + + + + +
Methods
voidclear_changes ()

Forget about any changes to this object's properties

IDid ()
OwnedPropertyListproperties ()
+

↠ ARDOUR:SoloSafeControl

+

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

+

is-a: ARDOUR:SlavableAutomationControl,

+
+

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

+ + + + +
Methods
boolisnil ()
boolsolo_safe ()
+

Inherited from ARDOUR:SlavableAutomationControl,

+ + + + + + + + + +
Methods
voidadd_master (AutomationControl)
voidclear_masters ()
intget_boolean_masters ()
doubleget_masters_value ()
voidremove_master (AutomationControl)
boolslaved ()
boolslaved_to (AutomationControl)
+

Inherited from ARDOUR:AutomationControl

+ + + + + + + + + + + + + + + + +
Methods
AutomationListalist ()
AutoStateautomation_state ()
AutoStyleautomation_style ()
doubleget_value ()

Get the current effective `user' value based on automation state

voidset_automation_state (AutoState)
voidset_automation_style (AutoStyle)
voidset_value (double, GroupControlDisposition)

Get and Set `internal' value

All derived classes must implement this.

Basic derived classes will ignore

group_override,
but more sophisticated children, notably those that proxy the value setting logic via an object that is aware of group relationships between this control and others, will find it useful.
voidstart_touch (double)
voidstop_touch (bool, double)
boolwritable ()
Cast
Controlto_ctrl ()
+

Inherited from PBD:Controllable

+ + + +
Methods
std::stringname ()
+

Inherited from PBD:StatefulPtr

+ + + + + + +
Methods
voidclear_changes ()

Forget about any changes to this object's properties

IDid ()
OwnedPropertyListproperties ()

↠ ARDOUR:Source

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

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

↠ ARDOUR:Stripable

+

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

+

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
GainControlgain_control ()
boolis_auditioner ()
boolis_hidden ()
boolis_master ()
boolis_monitor ()
boolis_selected ()
boolisnil ()
MuteControlmute_control ()
PhaseControlphase_control ()
AutomationControlrec_enable_control ()
AutomationControlrec_safe_control ()
SoloControlsolo_control ()
SoloIsolateControlsolo_isolate_control ()
SoloSafeControlsolo_safe_control ()
GainControltrim_control ()
Cast
Routeto_route ()
+

Inherited from ARDOUR:SessionObject

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

∁ ARDOUR:Tempo

C‡: ARDOUR::Tempo

@@ -1659,9 +2215,27 @@ 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)
MeterSectionadd_meter (Meter, double, BBT_TIME, long, PositionLockStyle)
TempoSectionadd_tempo (Tempo, double, long, Type, PositionLockStyle)
MeterSectionmeter_section_at_beat (double)
MeterSectionmeter_section_at_frame (long)
TempoSectiontempo_section_at_frame (long)
+

∁ ARDOUR:TempoSection

+

C‡: ARDOUR::TempoSection

+

is-a: ARDOUR:MetricSection

+
+

A section of timeline with a certain Tempo.

+ + + +
Methods
doublec_func ()
+

Inherited from ARDOUR:MetricSection

+ + + + +
Methods
doublepulse ()
voidset_pulse (double)

↠ ARDOUR:Track

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

is-a: ARDOUR:Route

@@ -1678,11 +2252,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C boolcan_record () boolisnil () Playlistplaylist () - boolrecord_enabled () - boolrecord_safe () boolset_name (std::string) - voidset_record_enabled (bool, GroupControlDisposition) - voidset_record_safe (bool, GroupControlDisposition) Cast AudioTrackto_audio_track () MidiTrackto_midi_track () @@ -1696,14 +2266,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) @@ -1720,6 +2292,58 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C Cast Trackto_track () +

Inherited from ARDOUR:Stripable

+ + + + + + + + + + + + + + + + + + +
Methods
GainControlgain_control ()
boolis_auditioner ()
boolis_hidden ()
boolis_master ()
boolis_monitor ()
boolis_selected ()
MuteControlmute_control ()
PhaseControlphase_control ()
AutomationControlrec_enable_control ()
AutomationControlrec_safe_control ()
SoloControlsolo_control ()
SoloIsolateControlsolo_isolate_control ()
SoloSafeControlsolo_safe_control ()
GainControltrim_control ()
Cast
Routeto_route ()
+

Inherited from ARDOUR:SessionObject

+ + + + + + +
Methods
std::stringname ()
Cast
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 ()
voiddeactivate ()
std::stringdisplay_name ()
Cast
Ampto_amp ()
Automatableto_automatable ()
PluginInsertto_insert ()
IOProcessorto_ioprocessor ()
SideChainto_sidechain ()
UnknownProcessorto_unknownprocessor ()

Inherited from ARDOUR:SessionObject

@@ -1993,23 +2617,25 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
Methods
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

@@ -2129,6 +2755,59 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C voidunset_dash ()

This function disables a dash pattern that was set with set_dash()

+

∁ Cairo:ImageSurface

+

C‡: LuaCairo::ImageSurface

+
+

wrap RefPtr< Cairo::ImageSurface >

Image surfaces provide the ability to render to memory buffers either allocated by cairo or by the calling code. The supported image formats are those defined in Cairo::Format.

+ + + + + + + + + + + + + + + +
Constructor
ℂCairo.ImageSurface (Format, int, int)
Methods
Contextcontext ()

Returns a context object to perform operations on the surface

unsigned char*get_data ()

Get a pointer to the data of the image surface, for direct inspection or modification.

Return value: a pointer to the image data of this surface or NULL if is not an image surface.

intget_height ()

Gets the height of the ImageSurface in pixels

intget_stride ()

Returns the stride of the image surface in bytes (or 0 if surface is not an image surface). The stride is the distance in bytes from the beginning of one row of the image data to the beginning of the next row.

intget_width ()

Gets the width of the ImageSurface in pixels

voidset_as_source (Context, int, int)
+

∁ Cairo:PangoLayout

+

C‡: LuaCairo::PangoLayout

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Constructor
ℂCairo.PangoLayout (Context, std::string)
Methods
intget_character_count ()

Returns the number of Unicode characters in the the text of layout.

Returns The number of Unicode characters in the text of layout.

EllipsizeModeget_ellipsize ()

Gets the type of ellipsization being performed for layout. See set_ellipsize()

Use is_ellipsized() to query whether any paragraphs were actually ellipsized.

Returns The current ellipsization mode for layout.

...get_pixel_size (--lua--)

Determines the logical width and height of a Pango::Layout in device units.

std::stringget_text ()

Gets the text in the layout. The returned text should not be freed or modified.

Returns The text in the layout.

WrapModeget_wrap ()

Gets the wrap mode for the layout.

Use is_wrapped() to query whether any paragraphs were actually wrapped.

Returns Active wrap mode.

boolis_ellipsized ()

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.

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)

Sets the layout text and attribute list from marked-up text (see markup format). Replaces the current text and attribute list.

markup
Some marked-up text.
voidset_text (std::string)

Set the text of the layout.

text
The text for the layout.
voidset_width (int)

Sets the width to which the lines of the Pango::Layout should wrap or ellipsized. The default value is -1: no width set.

width
The desired width in Pango units, or -1 to indicate that no wrapping or ellipsization should be performed.
voidset_wrap (WrapMode)

Sets the wrap mode; the wrap mode only has effect if a width is set on the layout with set_width(). To turn off wrapping, set the width to -1.

wrap
The wrap mode.
voidshow_in_cairo_context (Context)

∁ Evoral:Beats

C‡: Evoral::Beats

@@ -2197,8 +2876,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

@@ -2245,21 +2924,21 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C longto

∁ LuaSignal:Set

-

C‡: std::bitset<47ul>

+

C‡: std::bitset<46ul>

- - - - - - - + + + + + + + - +
Constructor
ℂLuaSignal.Set ()
Methods
LuaTableadd (LuaTable {47ul})
boolany ()
unsigned longcount ()
boolnone ()
Setreset ()
Setset (unsigned long, bool)
unsigned longsize ()
LuaTableadd (LuaTable {46ul})
boolany ()
unsigned longcount ()
boolnone ()
Setreset ()
Setset (unsigned long, bool)
unsigned longsize ()
LuaTabletable ()
booltest (unsigned long)
booltest (unsigned long)

∁ PBD:Command

C‡: Command

@@ -2276,6 +2955,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 +2974,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

@@ -2306,6 +2987,21 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C Methods std::stringto_s () +

∁ PBD:IdVector

+

C‡: std::vector<PBD::ID >

+
+ + + + + + + + + + + +
Constructor
ℂPBD.IdVector ()
Methods
LuaTableadd (LuaTable {ID})
IDat (unsigned long)
boolempty ()
LuaIteriter ()
voidpush_back (ID)
unsigned longsize ()
LuaTabletable ()

∁ PBD:Stateful

C‡: PBD::Stateful

@@ -2314,6 +3010,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 +3024,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 +3041,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 +3065,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 +3076,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 () @@ -2426,6 +3127,21 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
  • ARDOUR.PluginType.LXVST
  • ARDOUR.PluginType.Lua
    • +

    ∈ ARDOUR.PresentationInfo.Flag

    +

    ∈ ARDOUR.AutoStyle

    ∈ ARDOUR.AutomationType

    ∈ ARDOUR.SrcQuality

    +

    ∈ ARDOUR.PortFlags

    +

    ∈ ARDOUR.PlaylistDisposition

    +

    ∈ ARDOUR.PositionLockStyle

    + +

    ∈ ARDOUR.TempoSection.Type

    + +

    ∈ ARDOUR.TrackMode

    +

    ∈ ARDOUR.Session.RecordState

    +

    ∈ ARDOUR.Location.Flags

    +

    ∈ Cairo.LineCap

    +

    ∈ Cairo.Format

    + +

    ∈ Pango.EllipsizeMode

    + +

    ∈ Pango.WrapMode

    +

    ∈ LuaSignal.LuaSignal

    -

    ∈ ARDOUR.DSP.BiQuad.Type

    +

    ∈ ARDOUR.DSP.Biquad.Type

    Class Index

    - + -
    Ardour 4.7-720-g5bbfd0d  -  Thu, 14 Apr 2016 03:41:02 +0200
    +
    Ardour 5.0-pre0-406-g3267b48  -  Mon, 04 Jul 2016 00:40:28 +0200