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

Overview

The top-level entry point are ARDOUR:Session and ArdourUI:Editor. Most other Classes are used indirectly starting with a Session function. e.g. Session:get_routes().

A few classes are dedicated to certain script types, e.g. Lua DSP processors have exclusive access to ARDOUR.DSP and ARDOUR:ChanMapping. Action Hooks Scripts to LuaSignal:Set etc.

Detailed documentation (parameter names, method description) is not yet available. Please stay tuned.

Short introduction to Ardour classes

Ardour's structure is object oriented. The main object is the Session. A Session contains Audio Tracks, Midi Tracks and Busses. Audio and Midi tracks are derived from a more general "Track" Object, which in turn is derived from a "Route" (aka Bus). (We say "An Audio Track is-a Track is-a Route"). Tracks contain specifics. For Example a track has-a diskstream (for file i/o).

Operations are performed on objects. One gets a reference to an object and then calls a method. e.g obj = Session:route_by_name("Audio") obj:set_name("Guitar").

Lua automatically follows C++ class inheritance. e.g one can directly call all SessionObject and Route methods on Track object. However lua does not automatically promote objects. A Route object which just happens to be a Track needs to be explicitly cast to a Track. Methods for casts are provided with each class. Note that the cast may fail and return a nil reference.

Likewise multiple inheritance is a non-trivial issue in Lua. To avoid performance penalties involved with lookups, explicit casts are required in this case. One example is ARDOUR:SessionObject which is-a StatefulDestructible which inherits from both Stateful and Destructible.

Object lifetimes are managed by the Session. Most Objects cannot be directly created, but one asks the Session to create or destroy them. This is mainly due to realtime constrains: you cannot simply remove a track that is currently processing audio. There are various factory methods for object creation or removal.

Pass by Reference

Since Lua functions are closures, C++ methods that pass arguments by reference cannot be used as-is. All parameters passed to a C++ method which uses references are returned as Lua Table. If the C++ method also returns a value it is prefixed. Two parameters are returned: the value and a Lua Table holding the parameters.

C++

void set_ref (int& var, long& val)
{
	printf ("%d %ld\n", var, val);
	var = 5;
	val = 7;
}

Lua

local var = 0;
ref = set_ref (var, 2);
-- output from C++ printf()
0 2
-- var is still 0 here
print (ref[1], ref[2])
5 7

int set_ref2 (int &var, std::string unused)
{
	var = 5;
	return 3;
}

rv, ref = set_ref2 (0, "hello");
print (rv, ref[1], ref[2])
3 5 hello

Pointer Classes

Libardour makes extensive use of reference counted boost::shared_ptr to manage lifetimes. The Lua bindings provide a complete abstraction of this. There are no pointers in Lua. For example a ARDOUR:Route is a pointer in C++, but Lua functions operate on it like it was a class instance.

shared_ptr are reference counted. Once assigned to a Lua variable, the C++ object will be kept and remains valid. It is good practice to assign references to Lua local variables or reset the variable to nil to drop the ref.

All pointer classes have a isnil () method. This is for two cases: Construction may fail. e.g. ARDOUR.LuaAPI.newplugin() may not be able to find the given plugin and hence cannot create an object.

The second case if for boost::weak_ptr. As opposed to boost::shared_ptr weak-pointers are not reference counted. The object may vanish at any time. If Lua code calls a method on a nil object, the interpreter will raise an exception and the script will not continue. This is not unlike a = nil a:test() which results in en error "attempt to index a nil value".

From the Lua side of things there is no distinction between weak and shared pointers. They behave identically. Below they're indicated in orange and have an arrow to indicate the pointer type. Pointer Classes cannot be created in Lua scripts. It always requires a call to C++ to create the Object and obtain a reference to it.

Class Documentation

ℕ ARDOUR

Methods
RCConfiguration	config ()
std::string	user_cache_directory (std::string)
	Returns the path to the directory used to store user specific caches (e.g. plugin indices, blacklist/whitelist) it defaults to XDG_CACHE_HOME
std::string	user_config_directory (int)
	user_config_directory() exists IF version was negative. version of the program. If version is negative, the build-time string PROGRAM_VERSION will be used to determine the version number. Returns the path to the directory used to store user specific configuration files for the given

↠ ARDOUR:Amp

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

is-a: ARDOUR:Processor

Gain Stage (Fader, Trim).

Methods
float	apply_gain (AudioBuffer&, long, long, float, float, long)
GainControl	gain_control ()
bool	isnil ()

Inherited from ARDOUR:Processor

Methods
void	activate ()
bool	active ()
long	capture_offset ()
void	deactivate ()
std::string	display_name ()
bool	display_to_user ()
long	input_latency ()
ChanCount	input_streams ()
long	output_latency ()
ChanCount	output_streams ()
long	playback_offset ()
long	signal_latency ()
Cast
Amp	to_amp ()
Automatable	to_automatable ()
DelayLine	to_delayline ()
DiskIOProcessor	to_diskioprocessor ()
DiskReader	to_diskreader ()
DiskWriter	to_diskwriter ()
PluginInsert	to_insert ()
InternalSend	to_internalsend ()
IOProcessor	to_ioprocessor ()
Latent	to_latent ()
PeakMeter	to_meter ()
MonitorProcessor	to_monitorprocessor ()
PeakMeter	to_peakmeter ()
PluginInsert	to_plugininsert ()
PolarityProcessor	to_polarityprocessor ()
Send	to_send ()
SideChain	to_sidechain ()
UnknownProcessor	to_unknownprocessor ()

Inherited from ARDOUR:SessionObjectPtr

Methods
std::string	name ()
Cast
Stateful	to_stateful ()
StatefulDestructible	to_statefuldestructible ()

↠ ARDOUR:AsyncMIDIPort

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

is-a: ARDOUR:MidiPort

Methods
bool	isnil ()
int	write (unsigned char*, unsigned long, unsigned int)

Inherited from ARDOUR:MidiPort

Methods
MidiBuffer	get_midi_buffer (unsigned int)
bool	input_active ()
void	set_input_active (bool)
Cast
AsyncMIDIPort	to_asyncmidiport ()

Inherited from ARDOUR:Port

Methods
int	connect (std::string)
bool	connected ()
	Returns true if this port is connected to anything
bool	connected_to (std::string)
	o Port name Returns true if this port is connected to o, otherwise false.
int	disconnect (std::string)
int	disconnect_all ()
PortFlags	flags ()
	Returns flags
LuaTable(...)	get_connected_latency_range (LatencyRange&, bool)
std::string	name ()
	Returns Port short name
bool	physically_connected ()
std::string	pretty_name (bool)
	Returns Port human readable name
LatencyRange	private_latency_range (bool)
LatencyRange	public_latency_range (bool)
bool	receives_input ()
	Returns true if this Port receives input, otherwise false
bool	sends_output ()
	Returns true if this Port sends output, otherwise false
Cast
AsyncMIDIPort	to_asyncmidiport ()
AudioPort	to_audioport ()
MidiPort	to_midiport ()

↠ ARDOUR:AudioBackend

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

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

Methods
unsigned int	buffer_size ()
std::string	device_name ()
std::string	driver_name ()
	override this if this implementation returns true from requires_driver_selection()
float	dsp_load ()
	return the fraction of the time represented by the current buffer size that is being used for each buffer process cycle, as a value from 0.0 to 1.0 E.g. if the buffer size represents 5msec and current processing takes 1msec, the returned value should be 0.2. Implementations can feel free to smooth the values returned over time (e.g. high pass filtering, or its equivalent).
DeviceStatusVector	enumerate_devices ()
	Returns a collection of DeviceStatuses identifying devices discovered by this backend since the start of the process. Any of the names in each DeviceStatus may be used to identify a device in other calls to the backend, though any of them may become invalid at any time.
StringVector	enumerate_drivers ()
	If the return value of requires_driver_selection() is true, then this function can return the list of known driver names. If the return value of requires_driver_selection() is false, then this function should not be called. If it is called its return value is an empty vector of strings.
DeviceStatusVector	enumerate_input_devices ()
	Returns a collection of DeviceStatuses identifying input devices discovered by this backend since the start of the process. Any of the names in each DeviceStatus may be used to identify a device in other calls to the backend, though any of them may become invalid at any time.
DeviceStatusVector	enumerate_output_devices ()
	Returns a collection of DeviceStatuses identifying output devices discovered by this backend since the start of the process. Any of the names in each DeviceStatus may be used to identify a device in other calls to the backend, though any of them may become invalid at any time.
AudioBackendInfo	info ()
	Return the AudioBackendInfo object from which this backend was constructed.
unsigned int	input_channels ()
std::string	input_device_name ()
bool	isnil ()
unsigned int	output_channels ()
std::string	output_device_name ()
unsigned int	period_size ()
float	sample_rate ()
int	set_buffer_size (unsigned int)
	Set the buffer size to be used. The device is assumed to use a double buffering scheme, so that one buffer's worth of data can be processed by hardware while software works on the other buffer. All known suitable audio APIs support this model (though ALSA allows for alternate numbers of buffers, and CoreAudio doesn't directly expose the concept).
int	set_device_name (std::string)
	Set the name of the device to be used
int	set_driver (std::string)
	Returns zero if the backend can successfully use `drivername` as the driver, non-zero otherwise. Should not be used unless the backend returns true from requires_driver_selection()
int	set_input_device_name (std::string)
	Set the name of the input device to be used if using separate input/output devices. use_separate_input_and_output_devices()
int	set_output_device_name (std::string)
	Set the name of the output device to be used if using separate input/output devices. use_separate_input_and_output_devices()
int	set_peridod_size (unsigned int)
	Set the period size to be used. must be called before starting the backend.
int	set_sample_rate (float)
	Set the sample rate to be used
bool	use_separate_input_and_output_devices ()
	An optional alternate interface for backends to provide a facility to select separate input and output devices. If a backend returns true then enumerate_input_devices() and enumerate_output_devices() will be used instead of enumerate_devices() to enumerate devices. Similarly set_input/output_device_name() should be used to set devices instead of set_device_name().

∁ ARDOUR:AudioBackendInfo

C‡: ARDOUR::AudioBackendInfo

Data Members
char*	name

∁ ARDOUR:AudioBuffer

C‡: ARDOUR::AudioBuffer

Buffer containing audio data.

Methods
void	apply_gain (float, long)
	Apply a fixed gain factor to the audio buffer gain gain factor len number of samples to amplify
bool	check_silence (unsigned int, unsigned int&)
	Check buffer for silence nframes number of samples to check n first non zero sample (if any) Returns true if all samples are zero
FloatArray	data (long)
void	read_from (FloatArray, long, long, long)
void	silence (long, long)
	silence buffer len number of samples to clear offset start offset

∁ ARDOUR:AudioEngine

C‡: ARDOUR::AudioEngine

is-a: ARDOUR:PortManager

Methods
BackendVector	available_backends ()
std::string	current_backend_name ()
bool	freewheeling ()
float	get_dsp_load ()
std::string	get_last_backend_error ()
long	processed_samples ()
bool	running ()
AudioBackend	set_backend (std::string, std::string, std::string)
int	set_buffer_size (unsigned int)
int	set_device_name (std::string)
int	set_sample_rate (float)
bool	setup_required ()
int	start (bool)
int	stop (bool)

Inherited from ARDOUR:PortManager

Methods
int	connect (std::string, std::string)
bool	connected (std::string)
int	disconnect (std::string, std::string)
int	disconnect_port (Port)
LuaTable(int, ...)	get_backend_ports (std::string, DataType, PortFlags, StringVector&)
LuaTable(int, ...)	get_connections (std::string, StringVector&)
void	get_physical_inputs (DataType, StringVector&, MidiPortFlags, MidiPortFlags)
void	get_physical_outputs (DataType, StringVector&, MidiPortFlags, MidiPortFlags)
Port	get_port_by_name (std::string)
	name Full or short name of port Returns Corresponding Port or 0.
LuaTable(int, ...)	get_ports (DataType, PortList&)
std::string	get_pretty_name_by_name (std::string)
ChanCount	n_physical_inputs ()
ChanCount	n_physical_outputs ()
bool	physically_connected (std::string)
PortEngine	port_engine ()
bool	port_is_physical (std::string)
void	reset_input_meters ()

↠ ARDOUR:AudioPlaylist

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

is-a: ARDOUR:Playlist

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 ()
long	read (FloatArray, FloatArray, FloatArray, long, long, unsigned int)
	start Start position in session samples. cnt Number of samples to read.

Inherited from ARDOUR:Playlist

Methods
void	add_region (Region, long, float, bool, int, double, 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)
	gap from the beginning of the region to the next beginning
void	duplicate_range (AudioRange&, float)
void	duplicate_until (Region, long, long, long)
	gap from the beginning of the region to the next beginning end the first sample that does _not_ contain a duplicated sample
bool	empty ()
Region	find_next_region (long, RegionPoint, int)
long	find_next_region_boundary (long, int)
long	find_next_transient (long, int)
ID	get_orig_track_id ()
bool	hidden ()
void	lower_region (Region)
void	lower_region_to_bottom (Region)
unsigned int	n_regions ()
void	raise_region (Region)
void	raise_region_to_top (Region)
Region	region_by_id (ID)
RegionListPtr	region_list ()
RegionListPtr	regions_at (long)
RegionListPtr	regions_touched (long, long)
	start Range start. end Range end. Returns regions which have some part within this range.
RegionListPtr	regions_with_end_within (Range)
RegionListPtr	regions_with_start_within (Range)
void	remove_region (Region)
bool	set_name (std::string)
bool	shared ()
void	split_region (Region, MusicSample)
Region	top_region_at (long)
Region	top_unmuted_region_at (long)
void	uncombine (Region)
bool	used ()
Cast
AudioPlaylist	to_audioplaylist ()
MidiPlaylist	to_midiplaylist ()

Inherited from ARDOUR:SessionObjectPtr

Methods
std::string	name ()
Cast
Stateful	to_stateful ()
StatefulDestructible	to_statefuldestructible ()

↠ ARDOUR:AudioPort

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

is-a: ARDOUR:Port

Methods
bool	isnil ()

Inherited from ARDOUR:Port

Methods
int	connect (std::string)
bool	connected ()
	Returns true if this port is connected to anything
bool	connected_to (std::string)
	o Port name Returns true if this port is connected to o, otherwise false.
int	disconnect (std::string)
int	disconnect_all ()
PortFlags	flags ()
	Returns flags
LuaTable(...)	get_connected_latency_range (LatencyRange&, bool)
std::string	name ()
	Returns Port short name
bool	physically_connected ()
std::string	pretty_name (bool)
	Returns Port human readable name
LatencyRange	private_latency_range (bool)
LatencyRange	public_latency_range (bool)
bool	receives_input ()
	Returns true if this Port receives input, otherwise false
bool	sends_output ()
	Returns true if this Port sends output, otherwise false
Cast
AsyncMIDIPort	to_asyncmidiport ()
AudioPort	to_audioport ()
MidiPort	to_midiport ()

∁ ARDOUR:AudioPortMeters

C‡: std::map<std::string, ARDOUR::PortManager::DPM >

Constructor
ℂ	ARDOUR.AudioPortMeters ()
Methods
LuaTable	add (std::string, ARDOUR::PortManager::DPM )
...	at (--lua--)
void	clear ()
unsigned long	count (std::string)
bool	empty ()
LuaIter	iter ()
unsigned long	size ()
LuaTable	table ()

∁ ARDOUR:AudioRange

C‡: ARDOUR::AudioRange

Constructor
ℂ	ARDOUR.AudioRange (long, long, unsigned int)
Methods
bool	equal (AudioRange)
long	length ()
Data Members
long	end
unsigned int	id
long	start

∁ ARDOUR:AudioRangeList

C‡: std::list<ARDOUR::AudioRange >

Constructor
ℂ	ARDOUR.AudioRangeList ()
Methods
AudioRange	back ()
bool	empty ()
AudioRange	front ()
LuaIter	iter ()
void	reverse ()
unsigned long	size ()
LuaTable	table ()

↠ ARDOUR:AudioRegion

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

is-a: ARDOUR:Region

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

Methods
AudioSource	audio_source (unsigned int)
bool	fade_in_active ()
bool	fade_out_active ()
bool	isnil ()
double	maximum_amplitude (Progress)
	Returns the maximum (linear) amplitude of the region, or a -ve number if the Progress object reports that the process was cancelled.
double	rms (Progress)
	Returns the maximum (rms) signal power of the region, or a -1 if the Progress object reports that the process was cancelled.
float	scale_amplitude ()
LuaTable(int, ...)	separate_by_channel (RegionVector&)
void	set_fade_in_active (bool)
void	set_fade_in_length (long)
void	set_fade_in_shape (FadeShape)
void	set_fade_out_active (bool)
void	set_fade_out_length (long)
void	set_fade_out_shape (FadeShape)
void	set_scale_amplitude (float)

Inherited from ARDOUR:Region

Methods
bool	at_natural_position ()
bool	automatic ()
bool	can_move ()
bool	captured ()
void	captured_xruns (XrunPositions&, bool)
void	clear_sync_position ()
Control	control (Parameter, bool)
bool	covers (long)
void	cut_end (long, int)
void	cut_front (long, int)
DataType	data_type ()
bool	external ()
bool	has_transients ()
bool	hidden ()
bool	import ()
bool	is_compound ()
unsigned int	layer ()
long	length ()
bool	locked ()
void	lower ()
void	lower_to_bottom ()
StringVector	master_source_names ()
SourceList	master_sources ()
void	move_start (long, int)
void	move_to_natural_position ()
bool	muted ()
unsigned int	n_channels ()
void	nudge_position (long)
bool	opaque ()
Playlist	playlist ()
long	position ()
	How the region parameters play together: POSITION: first sample of the region along the timeline START: first sample of the region within its source(s) LENGTH: number of samples the region represents
bool	position_locked ()
double	quarter_note ()
void	raise ()
void	raise_to_top ()
void	set_hidden (bool)
void	set_initial_position (long)
	A gui may need to create a region, then place it in an initial position determined by the user. When this takes place within one gui operation, we have to reset _last_position to prevent an implied move.
void	set_length (long, int)
void	set_locked (bool)
void	set_muted (bool)
bool	set_name (std::string)
	Note: changing the name of a Region does not constitute an edit
void	set_opaque (bool)
void	set_position (long, int)
void	set_position_locked (bool)
void	set_start (long)
void	set_sync_position (long)
	Set the region's sync point. absolute_pos Session time.
void	set_video_locked (bool)
float	shift ()
Source	source (unsigned int)
long	start ()
float	stretch ()
bool	sync_marked ()
LuaTable(long, ...)	sync_offset (int&)
long	sync_position ()
	Returns Sync position in session time
Int64List	transients ()
void	trim_end (long, int)
void	trim_front (long, int)
void	trim_to (long, long, int)
bool	video_locked ()
bool	whole_file ()
Cast
AudioRegion	to_audioregion ()
MidiRegion	to_midiregion ()
Readable	to_readable ()

Inherited from ARDOUR:SessionObjectPtr

Methods
std::string	name ()
Cast
Stateful	to_stateful ()
StatefulDestructible	to_statefuldestructible ()

↠ ARDOUR:AudioRom

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

is-a: ARDOUR:Readable

Methods
bool	isnil ()
AudioRom	new_rom (FloatArray, unsigned long)

Inherited from ARDOUR:Readable

Methods
ReadableList	load (Session&, std::string)
unsigned int	n_channels ()
long	read (FloatArray, long, long, int)
long	readable_length ()

↠ ARDOUR:AudioSource

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
std::string	captured_for ()
bool	empty ()
bool	isnil ()
bool	isnil ()
long	length (long)
unsigned int	n_channels ()
unsigned int	n_channels ()
long	read (FloatArray, long, long, int)
long	readable_length ()
long	readable_length ()
float	sample_rate ()
Cast
Readable	to_readable ()

Inherited from ARDOUR:Source

Methods
std::string	ancestor_name ()
bool	can_be_analysed ()
XrunPositions	captured_xruns ()
bool	has_been_analysed ()
long	natural_position ()
long	timeline_position ()
long	timestamp ()
int	use_count ()
bool	used ()
bool	writable ()
Cast
AudioSource	to_audiosource ()
FileSource	to_filesource ()
MidiSource	to_midisource ()

Inherited from ARDOUR:SessionObjectPtr

Methods
std::string	name ()
Cast
Stateful	to_stateful ()
StatefulDestructible	to_statefuldestructible ()

↠ ARDOUR:AudioTrack

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

is-a: ARDOUR:Track

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

Specifically a track has a playlist object that describes material to be played from disk, and modifies that object during recording and editing.

Methods
bool	isnil ()

Inherited from ARDOUR:Track

Methods
Region	bounce (InterThreadInfo&, std::string)
	bounce track from session start to session end to new region itt asynchronous progress report and cancel Returns a new audio region (or nil in case of error)
Region	bounce_range (long, long, InterThreadInfo&, Processor, bool, std::string)
	Bounce the given range to a new audio region. start start time (in samples) end end time (in samples) itt asynchronous progress report and cancel endpoint the processor to tap the signal off (or nil for the top) include_endpoint include the given processor in the bounced audio. Returns a new audio region (or nil in case of error)
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. 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.
bool	can_record ()
int	find_and_use_playlist (DataType, ID)
Playlist	playlist ()
bool	set_name (std::string)
int	use_copy_playlist ()
int	use_new_playlist (DataType)
int	use_playlist (DataType, Playlist)
Cast
AudioTrack	to_audio_track ()
MidiTrack	to_midi_track ()

Inherited from ARDOUR:Route

Methods
bool	active ()
int	add_foldback_send (Route, bool)
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. index Index to add the processor at, or -1 to add at the end of the list. Returns 0 on success, non-0 on failure.
bool	add_sidechain (Processor)
Amp	amp ()
std::string	comment ()
bool	customize_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
DataType	data_type ()
IO	input ()
Delivery	main_outs ()
	the signal processorat at end of the processing chain which produces output
bool	muted ()
ChanCount	n_inputs ()
ChanCount	n_outputs ()
Processor	nth_plugin (unsigned int)
Processor	nth_processor (unsigned int)
Processor	nth_send (unsigned int)
IO	output ()
PannerShell	panner_shell ()
PeakMeter	peak_meter ()
	*********************************************************** Pure interface begins here***********************************************************
long	playback_latency (bool)
int	remove_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
int	remove_processors (ProcessorList, ProcessorStreams)
bool	remove_sidechain (Processor)
int	reorder_processors (ProcessorList, ProcessorStreams)
int	replace_processor (Processor, Processor, ProcessorStreams)
	replace plugin/processor with another old processor to remove sub processor to substitute the old one with err error report (index where removal vailed, channel-count why it failed) may be nil Returns 0 on success
bool	reset_plugin_insert (Processor)
	reset plugin-insert configuration to default, disable customizations. This is equivalent to calling customize_plugin_insert (proc, 0, unused) proc Processor to reset Returns true if successful
void	set_active (bool, void*)
void	set_comment (std::string, void*)
void	set_meter_point (MeterPoint)
bool	set_strict_io (bool)
long	signal_latency ()
bool	soloed ()
bool	strict_io ()
Processor	the_instrument ()
	Return the first processor that accepts has at least one MIDI input and at least one audio output. In the vast majority of cases, this will be "the instrument". This does not preclude other MIDI->audio processors later in the processing chain, but that would be a special case not covered by this utility function.
Amp	trim ()
Cast
Track	to_track ()

Inherited from ARDOUR:Stripable

Methods
AutomationControl	comp_enable_controllable ()
AutomationControl	comp_makeup_controllable ()
AutomationControl	comp_mode_controllable ()
std::string	comp_mode_name (unsigned int)
ReadOnlyControl	comp_redux_controllable ()
AutomationControl	comp_speed_controllable ()
std::string	comp_speed_name (unsigned int)
AutomationControl	comp_threshold_controllable ()
unsigned int	eq_band_cnt ()
std::string	eq_band_name (unsigned int)
AutomationControl	eq_enable_controllable ()
AutomationControl	eq_freq_controllable (unsigned int)
AutomationControl	eq_gain_controllable (unsigned int)
AutomationControl	eq_q_controllable (unsigned int)
AutomationControl	eq_shape_controllable (unsigned int)
AutomationControl	filter_enable_controllable (bool)
AutomationControl	filter_freq_controllable (bool)
AutomationControl	filter_slope_controllable (bool)
GainControl	gain_control ()
bool	is_auditioner ()
bool	is_hidden ()
bool	is_master ()
bool	is_monitor ()
bool	is_private_route ()
bool	is_selected ()
AutomationControl	master_send_enable_controllable ()
MonitorProcessor	monitor_control ()
MuteControl	mute_control ()
AutomationControl	pan_azimuth_control ()
AutomationControl	pan_elevation_control ()
AutomationControl	pan_frontback_control ()
AutomationControl	pan_lfe_control ()
AutomationControl	pan_width_control ()
PhaseControl	phase_control ()
PresentationInfo	presentation_info_ptr ()
AutomationControl	rec_enable_control ()
AutomationControl	rec_safe_control ()
AutomationControl	send_enable_controllable (unsigned int)
AutomationControl	send_level_controllable (unsigned int)
std::string	send_name (unsigned int)
AutomationControl	send_pan_azimuth_controllable (unsigned int)
AutomationControl	send_pan_azimuth_enable_controllable (unsigned int)
void	set_presentation_order (unsigned int)
bool	slaved ()
bool	slaved_to (VCA)
SoloControl	solo_control ()
SoloIsolateControl	solo_isolate_control ()
SoloSafeControl	solo_safe_control ()
GainControl	trim_control ()
Cast
Automatable	to_automatable ()
Route	to_route ()
Slavable	to_slavable ()
VCA	to_vca ()

Inherited from ARDOUR:SessionObjectPtr

Methods
std::string	name ()
Cast
Stateful	to_stateful ()
StatefulDestructible	to_statefuldestructible ()

∁ ARDOUR:AudioTrackList

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

Constructor
ℂ	ARDOUR.AudioTrackList ()
Methods
LuaTable	add (LuaTable {AudioTrack})
AudioTrack	back ()
bool	empty ()
AudioTrack	front ()
LuaIter	iter ()
void	push_back (AudioTrack)
void	reverse ()
unsigned long	size ()
LuaTable	table ()
void	unique ()

↠ ARDOUR:Automatable

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

is-a: Evoral:ControlSet

Methods
AutomationControl	automation_control (Parameter, bool)
bool	isnil ()
Cast
Slavable	to_slavable ()

↠ ARDOUR:AutomatableSequence

C‡: boost::shared_ptr< ARDOUR::AutomatableSequence<Temporal::Beats> >, boost::weak_ptr< ARDOUR::AutomatableSequence<Temporal::Beats> >

is-a: ARDOUR:Automatable

Methods
bool	isnil ()
Cast
Sequence	to_sequence ()

Inherited from ARDOUR:Automatable

Methods
AutomationControl	automation_control (Parameter, bool)
Cast
Slavable	to_slavable ()

↠ ARDOUR:AutomationControl

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

is-a: PBD:Controllable

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

Methods
AutomationList	alist ()
AutoState	automation_state ()
ParameterDescriptor	desc ()
double	get_value ()
	Get `internal' value Returns raw value as used for the plugin/processor control port
bool	isnil ()
double	lower ()
double	normal ()
void	set_automation_state (AutoState)
void	set_value (double, GroupControlDisposition)
	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. value raw numeric value to set group_override if and how to propagate value to grouped controls
void	start_touch (double)
void	stop_touch (double)
bool	toggled ()
double	upper ()
bool	writable ()
Cast
Control	to_ctrl ()
SlavableAutomationControl	to_slavable ()

Inherited from PBD:Controllable

Methods
std::string	name ()

Inherited from PBD:StatefulPtr

Methods
void	clear_changes ()
	Forget about any changes to this object's properties
ID	id ()
OwnedPropertyList	properties ()

↠ ARDOUR:AutomationList

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

is-a: Evoral:ControlList

AutomationList is a stateful wrapper around Evoral::ControlList. It includes session-specifics (such as automation state), control logic (e.g. touch, signals) and acts as proxy to the underlying ControlList which holds the actual data.

Methods
XMLNode	get_state ()
bool	isnil ()
Command	memento_command (XMLNode, XMLNode)
bool	touch_enabled ()
bool	touching ()
bool	writing ()
Cast
ControlList	list ()
Stateful	to_stateful ()
StatefulDestructible	to_statefuldestructible ()

Inherited from Evoral:ControlList

Methods
void	add (double, double, bool, bool)
	Add an event to this list. This method is intended to write automation in realtime. If the transport is stopped, guard-points will be added regardless of parameter with_guards. when absolute time in samples value parameter value with_guards if true, add guard-points with_initial if true, add an initial point if the list is empty
void	clear (double, double)
	Remove all events in the given time range from this list. start start of range (inclusive) in audio samples end end of range (inclusive) in audio samples
void	clear_list ()
bool	editor_add (double, double, bool)
	Add an event to this list. This method is intended for making manual changes from the GUI. An event will only be created if no other event exists at the given time. when absolute time in samples value parameter value with_guards if true, add guard-points Returns true if an event was added.
double	eval (double)
	Queries the event value at the given time (takes a read-lock, not safe while writing automation). where absolute time in samples Returns parameter value
EventList	events ()
	Returns the list of events
bool	in_write_pass ()
	Returns true if transport is running and this list is in write mode
InterpolationStyle	interpolation ()
	query interpolation style of the automation data Returns Interpolation Style
LuaTable(double, ...)	rt_safe_eval (double, bool&)
	Realtime safe version of eval(). This may fail if a read-lock cannot be taken. where absolute time in samples ok boolean reference if returned value is valid Returns parameter value
bool	set_interpolation (InterpolationStyle)
	Sets the interpolation style of the automation data. This will fail when asking for Logarithmic scale and min,max crosses 0 or Exponential scale with min != 0. is interpolation style Returns true if style change was successful
unsigned long	size ()
void	thin (double)
	Thin the number of events in this list. The thinning factor corresponds to the area of a triangle computed between three points in the list (time-difference * value-difference). If the area is large, it indicates significant non-linearity between the points. Time is measured in samples, value is usually normalized to 0..1. During automation recording we thin the recorded points using this value. If a point is sufficiently co-linear with its neighbours (as defined by the area of the triangle formed by three of them), we will not include it in the list. The larger the value, the more points are excluded, so this effectively measures the amount of thinning to be done. thinning_factor area-size (default: 20)
void	truncate_end (double)
	Remove all events after the given time from this list. last_coordinate time in audio samples of the last event to keep
void	truncate_start (double)
	Remove all events up to to the given time from this list. overall_length overall length in audio samples
Cast
AutomationList	to_automationlist ()

∁ ARDOUR:BackendVector

C‡: std::vector<ARDOUR::AudioBackendInfo const* >

Constructor
ℂ	ARDOUR.BackendVector ()
Methods
AudioBackendInfo	at (unsigned long)
bool	empty ()
LuaIter	iter ()
unsigned long	size ()
LuaTable	table ()

∁ ARDOUR:BeatsSamplesConverter

C‡: ARDOUR::BeatsSamplesConverter

Converter between quarter-note beats and samples. Takes distances in quarter-note beats or samples from some origin (supplied to the constructor in samples), and converts them to the opposite unit, taking tempo changes into account.

Constructor
ℂ	ARDOUR.BeatsSamplesConverter (TempoMap, long)
Methods
Beats	from (long)
	Convert B time to A time (A from B)
long	to (Beats)
	Convert A time to B time (A to B)

∁ ARDOUR:BufferSet

C‡: ARDOUR::BufferSet

A set of buffers of various types.

These are mainly accessed from Session and passed around as scratch buffers (eg as parameters to run() methods) to do in-place signal processing.

There are two types of counts associated with a BufferSet - available, and the 'use count'. Available is the actual number of allocated buffers (and so is the maximum acceptable value for the use counts).

The use counts are how things determine the form of their input and inform others the form of their output (eg what they did to the BufferSet). Setting the use counts is realtime safe.

Methods
ChanCount	available ()
ChanCount	count ()
AudioBuffer	get_audio (unsigned long)
MidiBuffer	get_midi (unsigned long)

∁ ARDOUR:ChanCount

C‡: ARDOUR::ChanCount

A count of channels, possibly with many types.

Operators are defined so this may safely be used as if it were a simple (single-typed) integer count of channels.

Constructor
ℂ	ARDOUR.ChanCount (DataType, unsigned int)
	Convenience constructor for making single-typed streams (mono, stereo, midi, etc) type data type count number of channels
Methods
unsigned int	get (DataType)
	query channel count for given type t data type Returns channel count for given type
unsigned int	n_audio ()
	query number of audio channels Returns number of audio channels
unsigned int	n_midi ()
	query number of midi channels Returns number of midi channels
unsigned int	n_total ()
	query total channel count of all data types Returns total channel count (audio + midi)
void	reset ()
	zero count of all data types
void	set (DataType, unsigned int)
	set channel count for given type t data type count number of channels
void	set_audio (unsigned int)
	set number of audio channels a number of audio channels
void	set_midi (unsigned int)
	set number of audio channels m number of midi channels

∁ ARDOUR:ChanMapping

C‡: ARDOUR::ChanMapping

A mapping from one set of channels to another. The general form is 1 source (from), many sinks (to). numeric IDs are used to identify sources and sinks.

for plugins this is used to map "plugin-pin" to "audio-buffer"

Constructor
ℂ	ARDOUR.ChanMapping ()
Methods
ChanCount	count ()
unsigned int	get (DataType, unsigned int)
	get buffer mapping for given data type and pin type data type from numeric source id Returns mapped buffer number (or ChanMapping::Invalid)
bool	is_monotonic ()
	Test if this mapping is monotonic (useful to see if inplace processing is feasible) Returns true if the map is a strict monotonic set
unsigned int	n_total ()
void	set (DataType, unsigned int, unsigned int)
	set buffer mapping for given data type type data type from numeric source id to buffer

∁ ARDOUR:ControlList

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

Constructor
ℂ	ARDOUR.ControlList ()
Methods
LuaTable	add (LuaTable {AutomationControl})
AutomationControl	back ()
bool	empty ()
AutomationControl	front ()
LuaIter	iter ()
void	push_back (AutomationControl)
void	reverse ()
unsigned long	size ()
LuaTable	table ()
void	unique ()

∁ ARDOUR:ControlListPtr

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

Constructor
ℂ	ARDOUR.ControlListPtr ()
Methods
LuaTable	add (LuaTable {AutomationControl})
bool	empty ()
LuaIter	iter ()
void	push_back (AutomationControl)
void	reverse ()
unsigned long	size ()
LuaTable	table ()
void	unique ()

ℕ ARDOUR.DSP

Methods
float	accurate_coefficient_to_dB (float)
void	apply_gain_to_buffer (FloatArray, unsigned int, float)
float	compute_peak (FloatArray, unsigned int, float)
void	copy_vector (FloatArray, FloatArray, unsigned int)
float	dB_to_coefficient (float)
float	fast_coefficient_to_dB (float)
void	find_peaks (FloatArray, unsigned int, FloatArray, FloatArray)
float	log_meter (float)
	non-linear power-scale meter deflection power signal power (dB) Returns deflected value
float	log_meter_coeff (float)
	non-linear power-scale meter deflection coeff signal value Returns deflected value
void	memset (FloatArray, float, unsigned int)
	lua wrapper to memset()
void	mix_buffers_no_gain (FloatArray, FloatArray, unsigned int)
void	mix_buffers_with_gain (FloatArray, FloatArray, unsigned int, float)
void	mmult (FloatArray, FloatArray, unsigned int)
	matrix multiply multiply every sample of `data' with the corresponding sample at `mult'. data multiplicand mult multiplicand n_samples number of samples in data and mmult
LuaTable(...)	peaks (FloatArray, float&, float&, unsigned int)
void	process_map (BufferSet, ChanCount, ChanMapping, ChanMapping, unsigned int, long)

∁ ARDOUR:DSP:Biquad

C‡: ARDOUR::DSP::Biquad

Biquad Filter

Constructor
ℂ	ARDOUR.DSP.Biquad (double)
	Instantiate Biquad Filter samplerate Samplerate
Methods
void	compute (Type, double, double, double)
	setup filter, compute coefficients t filter type (LowPass, HighPass, etc) freq filter frequency Q filter quality gain filter gain
void	configure (double, double, double, double, double)
	setup filter, set coefficients directly
float	dB_at_freq (float)
	filter transfer function (filter response for spectrum visualization) freq frequency Returns gain at given frequency in dB (clamped to -120..+120)
void	reset ()
	reset filter state
void	run (FloatArray, unsigned int)
	process audio data data pointer to audio-data n_samples number of samples to process

∁ ARDOUR:DSP:Convolution

C‡: ARDOUR::DSP::Convolution

Constructor
ℂ	ARDOUR.DSP.Convolution (Session&, unsigned int, unsigned int)
Methods
bool	add_impdata (unsigned int, unsigned int, Readable, float, unsigned int, long, long, unsigned int)
unsigned int	latency ()
unsigned int	n_inputs ()
unsigned int	n_outputs ()
bool	ready ()
void	restart ()
void	run (BufferSet&, ChanMapping, ChanMapping, unsigned int, long)

∁ ARDOUR:DSP:Convolver

C‡: ARDOUR::DSP::Convolver

is-a: ARDOUR:DSP:Convolution

Constructor
ℂ	ARDOUR.DSP.Convolver (Session&, std::string, IRChannelConfig, IRSettings)
Methods
void	run_mono (FloatArray, unsigned int)
void	run_stereo (FloatArray, FloatArray, unsigned int)

Inherited from ARDOUR:DSP:Convolution

Constructor
ℂ	ARDOUR.DSP.Convolution (Session&, unsigned int, unsigned int)
Methods
bool	add_impdata (unsigned int, unsigned int, Readable, float, unsigned int, long, long, unsigned int)
unsigned int	latency ()
unsigned int	n_inputs ()
unsigned int	n_outputs ()
bool	ready ()
void	restart ()
void	run (BufferSet&, ChanMapping, ChanMapping, unsigned int, long)

∁ ARDOUR:DSP:DspShm

C‡: ARDOUR::DSP::DspShm

C/C++ Shared Memory

A convenience class representing a C array of float[] or int32_t[] data values. This is useful for lua scripts to perform DSP operations directly using C/C++ with CPU Hardware acceleration.

Access to this memory area is always 4 byte aligned. The data is interpreted either as float or as int.

This memory area can also be shared between different instances or the same lua plugin (DSP, GUI).

Since memory allocation is not realtime safe it should be allocated during dsp_init() or dsp_configure(). The memory is free()ed automatically when the lua instance is destroyed.

Constructor
ℂ	ARDOUR.DSP.DspShm (unsigned long)
Methods
void	allocate (unsigned long)
	[re] allocate memory in host's memory space s size, total number of float or integer elements to store.
int	atomic_get_int (unsigned long)
	atomically read integer at offset This involves a memory barrier. This call is intended for buffers which are shared with another instance. off offset in shared memory region Returns value at offset
void	atomic_set_int (unsigned long, int)
	atomically set integer at offset This involves a memory barrier. This call is intended for buffers which are shared with another instance. off offset in shared memory region val value to set
void	clear ()
	clear memory (set to zero)
FloatArray	to_float (unsigned long)
	access memory as float array off offset in shared memory region Returns float[]
IntArray	to_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
void	execute ()
	process current data in buffer
float	freq_at_bin (unsigned int)
float	power_at_bin (unsigned int, float)
	query bin the frequency bin 0 .. window_size / 2 norm gain factor (set equal to `bin` for 1/f normalization) Returns signal power at given bin (in dBFS)
void	set_data_hann (FloatArray, unsigned int, unsigned int)

∁ ARDOUR:DSP:Generator

C‡: ARDOUR::DSP::Generator

Constructor
ℂ	ARDOUR.DSP.Generator ()
Methods
void	run (FloatArray, unsigned int)
void	set_type (Type)

∁ ARDOUR:DSP:IRSettings

C‡: ARDOUR::DSP::Convolver::IRSettings

Constructor
ℂ	ARDOUR.DSP.IRSettings ()
Methods
unsigned int	get_channel_delay (unsigned int)
float	get_channel_gain (unsigned int)
void	set_channel_delay (unsigned int, unsigned int)
void	set_channel_gain (unsigned int, float)
Data Members
float	gain
unsigned int	pre_delay

∁ ARDOUR:DSP:LTCReader

C‡: ARDOUR::LTCReader

Constructor
ℂ	ARDOUR.DSP.LTCReader (int, LTC_TV_STANDARD)
Methods
LuaTable(long, ...)	read (unsigned int&, unsigned int&, unsigned int&, unsigned int&)
void	write (FloatArray, long, long)

∁ ARDOUR:DSP:LowPass

C‡: ARDOUR::DSP::LowPass

1st order Low Pass filter

Constructor
ℂ	ARDOUR.DSP.LowPass (double, float)
	instantiate a LPF samplerate samplerate freq cut-off frequency
Methods
void	ctrl (FloatArray, float, unsigned int)
	filter control data This is useful for parameter smoothing. data pointer to control-data array val target value n_samples array length
void	proc (FloatArray, unsigned int)
	process audio data data pointer to audio-data n_samples number of samples to process
void	reset ()
	reset filter state
void	set_cutoff (float)
	update filter cut-off frequency freq cut-off frequency

∁ ARDOUR:DataType

C‡: ARDOUR::DataType

A type of Data Ardour is capable of processing.

The majority of this class is dedicated to conversion to and from various other type representations, simple comparison between then, etc. This code is deliberately 'ugly' so other code doesn't have to be.

Constructor
ℂ	ARDOUR.DataType (std::string)
Methods
DataType	audio ()
	convenience constructor for DataType::AUDIO with managed lifetime Returns DataType::AUDIO
DataType	midi ()
	convenience constructor for DataType::MIDI with managed lifetime Returns DataType::MIDI
DataType	null ()
	convenience constructor for DataType::NIL with managed lifetime Returns DataType::NIL
char*	to_string ()
	Inverse of the from-string constructor

↠ ARDOUR:DelayLine

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

is-a: ARDOUR:Processor

Meters peaks on the input and stores them for access.

Methods
long	delay ()
bool	isnil ()

Inherited from ARDOUR:Processor

Methods
void	activate ()
bool	active ()
long	capture_offset ()
void	deactivate ()
std::string	display_name ()
bool	display_to_user ()
long	input_latency ()
ChanCount	input_streams ()
long	output_latency ()
ChanCount	output_streams ()
long	playback_offset ()
long	signal_latency ()
Cast
Amp	to_amp ()
Automatable	to_automatable ()
DelayLine	to_delayline ()
DiskIOProcessor	to_diskioprocessor ()
DiskReader	to_diskreader ()
DiskWriter	to_diskwriter ()
PluginInsert	to_insert ()
InternalSend	to_internalsend ()
IOProcessor	to_ioprocessor ()
Latent	to_latent ()
PeakMeter	to_meter ()
MonitorProcessor	to_monitorprocessor ()
PeakMeter	to_peakmeter ()
PluginInsert	to_plugininsert ()
PolarityProcessor	to_polarityprocessor ()
Send	to_send ()
SideChain	to_sidechain ()
UnknownProcessor	to_unknownprocessor ()

Inherited from ARDOUR:SessionObjectPtr

Methods
std::string	name ()
Cast
Stateful	to_stateful ()
StatefulDestructible	to_statefuldestructible ()

↠ ARDOUR:Delivery

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

is-a: ARDOUR:IOProcessor

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

Methods
bool	isnil ()
PannerShell	panner_shell ()

Inherited from ARDOUR:IOProcessor

Methods
IO	input ()
ChanCount	natural_input_streams ()
ChanCount	natural_output_streams ()
IO	output ()

Inherited from ARDOUR:Processor

Methods
void	activate ()
bool	active ()
long	capture_offset ()
void	deactivate ()
std::string	display_name ()
bool	display_to_user ()
long	input_latency ()
ChanCount	input_streams ()
long	output_latency ()
ChanCount	output_streams ()
long	playback_offset ()
long	signal_latency ()
Cast
Amp	to_amp ()
Automatable	to_automatable ()
DelayLine	to_delayline ()
DiskIOProcessor	to_diskioprocessor ()
DiskReader	to_diskreader ()
DiskWriter	to_diskwriter ()
PluginInsert	to_insert ()
InternalSend	to_internalsend ()
IOProcessor	to_ioprocessor ()
Latent	to_latent ()
PeakMeter	to_meter ()
MonitorProcessor	to_monitorprocessor ()
PeakMeter	to_peakmeter ()
PluginInsert	to_plugininsert ()
PolarityProcessor	to_polarityprocessor ()
Send	to_send ()
SideChain	to_sidechain ()
UnknownProcessor	to_unknownprocessor ()

Inherited from ARDOUR:SessionObjectPtr

Methods
std::string	name ()
Cast
Stateful	to_stateful ()
StatefulDestructible	to_statefuldestructible ()

∁ ARDOUR:DeviceStatus

C‡: ARDOUR::AudioBackend::DeviceStatus

used to list device names along with whether or not they are currently available.

Data Members
bool	available
std::string	name

∁ ARDOUR:DeviceStatusVector

C‡: std::vector<ARDOUR::AudioBackend::DeviceStatus >

Constructor
ℂ	ARDOUR.DeviceStatusVector ()
ℂ	ARDOUR.DeviceStatusVector ()
Methods
LuaTable	add (LuaTable {DeviceStatus})
DeviceStatus	at (unsigned long)
void	clear ()
bool	empty ()
LuaIter	iter ()
void	push_back (DeviceStatus)
unsigned long	size ()
LuaTable	table ()
...	to_array (--lua--)

↠ ARDOUR:DiskIOProcessor

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

is-a: ARDOUR:Processor

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

Methods
bool	isnil ()

Inherited from ARDOUR:Processor

Methods
void	activate ()
bool	active ()
long	capture_offset ()
void	deactivate ()
std::string	display_name ()
bool	display_to_user ()
long	input_latency ()
ChanCount	input_streams ()
long	output_latency ()
ChanCount	output_streams ()
long	playback_offset ()
long	signal_latency ()
Cast
Amp	to_amp ()
Automatable	to_automatable ()
DelayLine	to_delayline ()
DiskIOProcessor	to_diskioprocessor ()
DiskReader	to_diskreader ()
DiskWriter	to_diskwriter ()
PluginInsert	to_insert ()
InternalSend	to_internalsend ()
IOProcessor	to_ioprocessor ()
Latent	to_latent ()
PeakMeter	to_meter ()
MonitorProcessor	to_monitorprocessor ()
PeakMeter	to_peakmeter ()
PluginInsert	to_plugininsert ()
PolarityProcessor	to_polarityprocessor ()
Send	to_send ()
SideChain	to_sidechain ()
UnknownProcessor	to_unknownprocessor ()

Inherited from ARDOUR:SessionObjectPtr

Methods
std::string	name ()
Cast
Stateful	to_stateful ()
StatefulDestructible	to_statefuldestructible ()

↠ ARDOUR:DiskReader

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

is-a: ARDOUR:DiskIOProcessor

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

Methods
bool	isnil ()

Inherited from ARDOUR:Processor

Methods
void	activate ()
bool	active ()
long	capture_offset ()
void	deactivate ()
std::string	display_name ()
bool	display_to_user ()
long	input_latency ()
ChanCount	input_streams ()
long	output_latency ()
ChanCount	output_streams ()
long	playback_offset ()
long	signal_latency ()
Cast
Amp	to_amp ()
Automatable	to_automatable ()
DelayLine	to_delayline ()
DiskIOProcessor	to_diskioprocessor ()
DiskReader	to_diskreader ()
DiskWriter	to_diskwriter ()
PluginInsert	to_insert ()
InternalSend	to_internalsend ()
IOProcessor	to_ioprocessor ()
Latent	to_latent ()
PeakMeter	to_meter ()
MonitorProcessor	to_monitorprocessor ()
PeakMeter	to_peakmeter ()
PluginInsert	to_plugininsert ()
PolarityProcessor	to_polarityprocessor ()
Send	to_send ()
SideChain	to_sidechain ()
UnknownProcessor	to_unknownprocessor ()

Inherited from ARDOUR:SessionObjectPtr

Methods
std::string	name ()
Cast
Stateful	to_stateful ()
StatefulDestructible	to_statefuldestructible ()

↠ ARDOUR:DiskWriter

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

is-a: ARDOUR:DiskIOProcessor

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

Methods
bool	isnil ()

Inherited from ARDOUR:Processor

Methods
void	activate ()
bool	active ()
long	capture_offset ()
void	deactivate ()
std::string	display_name ()
bool	display_to_user ()
long	input_latency ()
ChanCount	input_streams ()
long	output_latency ()
ChanCount	output_streams ()
long	playback_offset ()
long	signal_latency ()
Cast
Amp	to_amp ()
Automatable	to_automatable ()
DelayLine	to_delayline ()
DiskIOProcessor	to_diskioprocessor ()
DiskReader	to_diskreader ()
DiskWriter	to_diskwriter ()
PluginInsert	to_insert ()
InternalSend	to_internalsend ()
IOProcessor	to_ioprocessor ()
Latent	to_latent ()
PeakMeter	to_meter ()
MonitorProcessor	to_monitorprocessor ()
PeakMeter	to_peakmeter ()
PluginInsert	to_plugininsert ()
PolarityProcessor	to_polarityprocessor ()
Send	to_send ()
SideChain	to_sidechain ()
UnknownProcessor	to_unknownprocessor ()

Inherited from ARDOUR:SessionObjectPtr

Methods
std::string	name ()
Cast
Stateful	to_stateful ()
StatefulDestructible	to_statefuldestructible ()

∁ ARDOUR:DoubleBeatsSamplesConverter

C‡: ARDOUR::DoubleBeatsSamplesConverter

Constructor
ℂ	ARDOUR.DoubleBeatsSamplesConverter (TempoMap, long)
Methods
double	from (long)
	Convert B time to A time (A from B)
long	to (double)
	Convert A time to B time (A to B)

∁ ARDOUR:EventList

C‡: std::list<Evoral::ControlEvent* >

Constructor
ℂ	ARDOUR.EventList ()
Methods
ControlEvent	back ()
bool	empty ()
ControlEvent	front ()
LuaIter	iter ()
void	reverse ()
unsigned long	size ()
LuaTable	table ()

↠ ARDOUR:FileSource

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

is-a: ARDOUR:Source

A source associated with a file on disk somewhere

Methods
unsigned short	channel ()
float	gain ()
bool	isnil ()
std::string	origin ()
std::string	path ()
std::string	take_id ()
bool	within_session ()

Inherited from ARDOUR:Source

Methods
std::string	ancestor_name ()
bool	can_be_analysed ()
XrunPositions	captured_xruns ()
bool	empty ()
bool	has_been_analysed ()
long	length (long)
long	natural_position ()
long	timeline_position ()
long	timestamp ()
int	use_count ()
bool	used ()
bool	writable ()
Cast
AudioSource	to_audiosource ()
FileSource	to_filesource ()
MidiSource	to_midisource ()

Inherited from ARDOUR:SessionObjectPtr

Methods
std::string	name ()
Cast
Stateful	to_stateful ()
StatefulDestructible	to_statefuldestructible ()

∁ ARDOUR:FluidSynth

C‡: ARDOUR::FluidSynth

Constructor
ℂ	ARDOUR.FluidSynth (float, int)
	instantiate a Synth samplerate samplerate polyphony polyphony
Methods
bool	load_sf2 (std::string)
bool	midi_event (unsigned char*, unsigned long)
void	panic ()
unsigned int	program_count ()
std::string	program_name (unsigned int)
bool	select_program (unsigned int, unsigned char)
bool	synth (FloatArray, FloatArray, unsigned int)

↠ ARDOUR:GainControl

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

is-a: ARDOUR:SlavableAutomationControl

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

Methods
bool	isnil ()

Inherited from ARDOUR:SlavableAutomationControl

Methods
void	add_master (AutomationControl)
void	clear_masters ()
int	get_boolean_masters ()
double	get_masters_value ()
void	remove_master (AutomationControl)
bool	slaved ()
bool	slaved_to (AutomationControl)

Inherited from ARDOUR:AutomationControl

Methods
AutomationList	alist ()
AutoState	automation_state ()
ParameterDescriptor	desc ()
double	get_value ()
	Get `internal' value Returns raw value as used for the plugin/processor control port
double	lower ()
double	normal ()
void	set_automation_state (AutoState)
void	set_value (double, GroupControlDisposition)
	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. value raw numeric value to set group_override if and how to propagate value to grouped controls
void	start_touch (double)
void	stop_touch (double)
bool	toggled ()
double	upper ()
bool	writable ()
Cast
Control	to_ctrl ()
SlavableAutomationControl	to_slavable ()

Inherited from PBD:Controllable

Methods
std::string	name ()

Inherited from PBD:StatefulPtr

Methods
void	clear_changes ()
	Forget about any changes to this object's properties
ID	id ()
OwnedPropertyList	properties ()

↠ ARDOUR:IO

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

is-a: ARDOUR:SessionObjectPtr

A collection of ports (all input or all output) with connections.

An IO can contain ports of varying types, making routes/inserts/etc with varied combinations of types (eg MIDI and audio) possible.

Methods
bool	active ()
int	add_port (std::string, void*, DataType)
	Add a port. destination Name of port to connect new port to. src Source for emitted ConfigurationChanged signal. type Data type of port. Default value (NIL) will use this IO's default type.
AudioPort	audio (unsigned int)
int	connect (Port, std::string, void*)
int	disconnect (Port, std::string, void*)
int	disconnect_all (void*)
bool	has_port (Port)
bool	isnil ()
long	latency ()
MidiPort	midi (unsigned int)
ChanCount	n_ports ()
Port	nth (unsigned int)
bool	physically_connected ()
Port	port_by_name (unsigned int)
long	public_latency ()
int	remove_port (Port, void*)

Inherited from ARDOUR:SessionObjectPtr

Methods
std::string	name ()
Cast
Stateful	to_stateful ()
StatefulDestructible	to_statefuldestructible ()

↠ ARDOUR:IOProcessor

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

is-a: ARDOUR:Processor

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

Methods
IO	input ()
bool	isnil ()
ChanCount	natural_input_streams ()
ChanCount	natural_output_streams ()
IO	output ()

Inherited from ARDOUR:Processor

Methods
void	activate ()
bool	active ()
long	capture_offset ()
void	deactivate ()
std::string	display_name ()
bool	display_to_user ()
long	input_latency ()
ChanCount	input_streams ()
long	output_latency ()
ChanCount	output_streams ()
long	playback_offset ()
long	signal_latency ()
Cast
Amp	to_amp ()
Automatable	to_automatable ()
DelayLine	to_delayline ()
DiskIOProcessor	to_diskioprocessor ()
DiskReader	to_diskreader ()
DiskWriter	to_diskwriter ()
PluginInsert	to_insert ()
InternalSend	to_internalsend ()
IOProcessor	to_ioprocessor ()
Latent	to_latent ()
PeakMeter	to_meter ()
MonitorProcessor	to_monitorprocessor ()
PeakMeter	to_peakmeter ()
PluginInsert	to_plugininsert ()
PolarityProcessor	to_polarityprocessor ()
Send	to_send ()
SideChain	to_sidechain ()
UnknownProcessor	to_unknownprocessor ()

Inherited from ARDOUR:SessionObjectPtr

Methods
std::string	name ()
Cast
Stateful	to_stateful ()
StatefulDestructible	to_statefuldestructible ()

∁ ARDOUR:InterThreadInfo

C‡: ARDOUR::InterThreadInfo

Constructor
ℂ	ARDOUR.InterThreadInfo ()
Data Members
bool	done
float	progress

↠ ARDOUR:InternalReturn

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

is-a: ARDOUR:Return

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

Methods
bool	isnil ()

Inherited from ARDOUR:IOProcessor

Methods
IO	input ()
ChanCount	natural_input_streams ()
ChanCount	natural_output_streams ()
IO	output ()

Inherited from ARDOUR:Processor

Methods
void	activate ()
bool	active ()
long	capture_offset ()
void	deactivate ()
std::string	display_name ()
bool	display_to_user ()
long	input_latency ()
ChanCount	input_streams ()
long	output_latency ()
ChanCount	output_streams ()
long	playback_offset ()
long	signal_latency ()
Cast
Amp	to_amp ()
Automatable	to_automatable ()
DelayLine	to_delayline ()
DiskIOProcessor	to_diskioprocessor ()
DiskReader	to_diskreader ()
DiskWriter	to_diskwriter ()
PluginInsert	to_insert ()
InternalSend	to_internalsend ()
IOProcessor	to_ioprocessor ()
Latent	to_latent ()
PeakMeter	to_meter ()
MonitorProcessor	to_monitorprocessor ()
PeakMeter	to_peakmeter ()
PluginInsert	to_plugininsert ()
PolarityProcessor	to_polarityprocessor ()
Send	to_send ()
SideChain	to_sidechain ()
UnknownProcessor	to_unknownprocessor ()

Inherited from ARDOUR:SessionObjectPtr

Methods
std::string	name ()
Cast
Stateful	to_stateful ()
StatefulDestructible	to_statefuldestructible ()

↠ ARDOUR:InternalSend

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

is-a: ARDOUR:Send

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

Methods
bool	allow_feedback ()
std::string	display_name ()
bool	feeds (Route)
bool	isnil ()
void	set_allow_feedback (bool)
bool	set_name (std::string)
Route	source_route ()
Route	target_route ()

Inherited from ARDOUR:Send

Methods
GainControl	gain_control ()
long	get_delay_in ()
long	get_delay_out ()
bool	is_foldback ()
Cast
InternalSend	to_internalsend ()

Inherited from ARDOUR:Delivery

Methods
PannerShell	panner_shell ()

Inherited from ARDOUR:IOProcessor

Methods
IO	input ()
ChanCount	natural_input_streams ()
ChanCount	natural_output_streams ()
IO	output ()

Inherited from ARDOUR:Processor

Methods
void	activate ()
bool	active ()
long	capture_offset ()
void	deactivate ()
bool	display_to_user ()
long	input_latency ()
ChanCount	input_streams ()
long	output_latency ()
ChanCount	output_streams ()
long	playback_offset ()
long	signal_latency ()
Cast
Amp	to_amp ()
Automatable	to_automatable ()
DelayLine	to_delayline ()
DiskIOProcessor	to_diskioprocessor ()
DiskReader	to_diskreader ()
DiskWriter	to_diskwriter ()
PluginInsert	to_insert ()
InternalSend	to_internalsend ()
IOProcessor	to_ioprocessor ()
Latent	to_latent ()
PeakMeter	to_meter ()
MonitorProcessor	to_monitorprocessor ()
PeakMeter	to_peakmeter ()
PluginInsert	to_plugininsert ()
PolarityProcessor	to_polarityprocessor ()
Send	to_send ()
SideChain	to_sidechain ()
UnknownProcessor	to_unknownprocessor ()

Inherited from ARDOUR:SessionObjectPtr

Methods
std::string	name ()
Cast
Stateful	to_stateful ()
StatefulDestructible	to_statefuldestructible ()

∁ ARDOUR:LatencyRange

C‡: ARDOUR::LatencyRange

Constructor
ℂ	ARDOUR.LatencyRange ()
Data Members
unsigned int	max
unsigned int	min

↠ ARDOUR:Latent

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

Methods
long	effective_latency ()
bool	isnil ()
void	set_user_latency (long)
void	unset_user_latency ()
long	user_latency ()

∁ ARDOUR:Location

C‡: ARDOUR::Location

is-a: PBD:StatefulDestructible

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

Methods
long	end ()
Flags	flags ()
bool	is_auto_loop ()
bool	is_auto_punch ()
bool	is_cd_marker ()
bool	is_hidden ()
bool	is_mark ()
bool	is_range_marker ()
bool	is_session_range ()
long	length ()
void	lock ()
bool	locked ()
bool	matches (Flags)
int	move_to (long, unsigned int)
std::string	name ()
int	set (long, long, bool, unsigned int)
int	set_end (long, bool, bool, unsigned int)
	Set end position. force true to force setting, even if the given new end is before the current start. allow_beat_recompute True to recompute BEAT end time from the new given end time. s New end.
int	set_length (long, long, bool, unsigned int)
void	set_name (std::string)
	Set location name
int	set_start (long, bool, bool, unsigned int)
	Set start position. s New start. force true to force setting, even if the given new start is after the current end. allow_beat_recompute True to recompute BEAT start time from the new given start time.
long	start ()
void	unlock ()

Inherited from PBD:Stateful

Methods
void	clear_changes ()
	Forget about any changes to this object's properties
ID	id ()
OwnedPropertyList	properties ()

∁ ARDOUR:LocationList

C‡: std::list<ARDOUR::Location* >

Constructor
ℂ	ARDOUR.LocationList ()
Methods
Location	back ()
bool	empty ()
Location	front ()
LuaIter	iter ()
void	reverse ()
unsigned long	size ()
LuaTable	table ()

∁ ARDOUR:Locations

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 ()
LuaTable(...)	find_all_between (long, long, LocationList&, Flags)
long	first_mark_after (long, bool)
Location	first_mark_at (long, long)
long	first_mark_before (long, bool)
LocationList	list ()
Location	mark_at (long, long)
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 sample. Note that if sample is exactly on a `mark', that mark will not be considered for returning as before/after. sample Frame to look for. before Filled in with the position of the last `mark' before `sample' (or max_samplepos if none exists) after Filled in with the position of the next `mark' after `sample' (or max_samplepos if none exists)
void	remove (Location)
Location	session_range_location ()

Inherited from PBD:Stateful

Methods
void	clear_changes ()
	Forget about any changes to this object's properties
ID	id ()
OwnedPropertyList	properties ()

ℕ ARDOUR.LuaAPI

Methods
std::string	ascii_dtostr (double)
...	build_filename (--lua--)
	Creates a filename from a series of elements using the correct separator for filenames. No attempt is made to force the resulting filename to be an absolute path. If the first element is a relative path, the result will be a relative path.
...	color_to_rgba (--lua--)
	A convenience function to expand RGBA parameters from an integer convert a Canvas::Color (uint32_t 0xRRGGBBAA) into double RGBA values which can be passed as parameters to Cairo::Context::set_source_rgba Example: local r, g, b, a = ARDOUR.LuaAPI.color_to_rgba (0x88aa44ff) cairo_ctx:set_source_rgba (ARDOUR.LuaAPI.color_to_rgba (0x11336699) Returns 4 parameters: red, green, blue, alpha (in range 0..1)
std::string	file_get_contents (std::string)
bool	file_test (std::string, FileTest)
LuaTable(float, ...)	get_plugin_insert_param (PluginInsert, unsigned int, bool&)
	get a plugin control parameter value pi Plugin-Insert which control port to query (starting at 0, including ports of type input and output) ok boolean variable contains true or false after call returned. to be checked by caller before using value. Returns value
LuaTable(float, ...)	get_processor_param (Processor, unsigned int, bool&)
	get a plugin control parameter value proc Plugin-Processor which control port to set (starting at 0, including ports of type input and output)) ok boolean variable contains true or false after call returned. to be checked by caller before using value. Returns value
...	hsla_to_rgba (--lua--)
	A convenience function for colorspace HSL to RGB conversion. All ranges are 0..1 Example: local r, g, b, a = ARDOUR.LuaAPI.hsla_to_rgba (hue, saturation, luminosity, alpha) Returns 4 parameters: red, green, blue, alpha (in range 0..1)
PluginInfoList	list_plugins ()
	List all installed plugins
long	monotonic_time ()
Processor	new_luaproc (Session, std::string)
	create a new Lua Processor (Plugin) s Session Handle name Identifier or Name of the Processor Returns Processor object (may be nil)
NotePtr	new_noteptr (unsigned char, Beats, Beats, unsigned char, unsigned char)
Processor	new_plugin (Session, std::string, PluginType, std::string)
	create a new Plugin Instance s Session Handle name Plugin Name, ID or URI type Plugin Type preset name of plugin-preset to load, leave empty "" to not load any preset after instantiation Returns Processor or nil
PluginInfo	new_plugin_info (std::string, PluginType)
	search a Plugin name Plugin Name, ID or URI type Plugin Type Returns PluginInfo or nil if not found
Processor	nil_proc ()
NotePtrList	note_list (MidiModel)
std::string	path_get_basename (std::string)
...	plugin_automation (--lua--)
	A convenience function to get a Automation Lists and ParamaterDescriptor for a given plugin control. This is equivalent to the following lua code function (processor, param_id) local plugininsert = processor:to_insert () local plugin = plugininsert:plugin(0) local _, t = plugin:get_parameter_descriptor(param_id, ARDOUR.ParameterDescriptor ()) local ctrl = Evoral.Parameter (ARDOUR.AutomationType.PluginAutomation, 0, param_id) local ac = pi:automation_control (ctrl, false) local acl = ac:alist() return ac:alist(), ac:to_ctrl():list(), t[2] end Example usage: get the third input parameter of first plugin on the given route (Ardour starts counting at zero). local al, cl, pd = ARDOUR.LuaAPI.plugin_automation (route:nth_plugin (0), 3) Returns 3 parameters: AutomationList, ControlList, ParamaterDescriptor
bool	reset_processor_to_default (Processor)
	reset a processor to its default values (only works for plugins ) This is a wrapper which looks up the Processor by plugin-insert. proc Plugin-Insert Returns true on success, false when the processor is not a plugin
...	sample_to_timecode (--lua--)
	Generic conversion from audio sample count to timecode. (TimecodeType, sample-rate, sample-pos)
void	segfault ()
	Crash Test Dummy
bool	set_plugin_insert_param (PluginInsert, unsigned int, float)
	set a plugin control-input parameter value This is a wrapper around set_processor_param which looks up the Processor by plugin-insert. pi Plugin-Insert which control-input to set (starting at 0) value value to set Returns true on success, false on error or out-of-bounds value
bool	set_processor_param (Processor, unsigned int, float)
	set a plugin control-input parameter value proc Plugin-Processor which control-input to set (starting at 0) value value to set Returns true on success, false on error or out-of-bounds value
...	timecode_to_sample (--lua--)
	Generic conversion from timecode to audio sample count. (TimecodeType, sample-rate, hh, mm, ss, ff)
void	usleep (unsigned long)
bool	wait_for_process_callback (unsigned long, long)
	Delay execution until next prcess cycle starts. n_cycles process-cycles to wait for. 0: means wait until next cycle-start, otherwise skip given number of cycles. timeout_ms wait at most this many milliseconds Returns true on success, false if timeout was reached or engine was not running

∁ ARDOUR:LuaAPI:Rubberband

C‡: ARDOUR::LuaAPI::Rubberband

Constructor
ℂ	ARDOUR.LuaAPI.Rubberband (AudioRegion, bool)
Methods
unsigned int	n_channels ()
AudioRegion	process (Lua-Function)
Readable	readable ()
long	readable_length ()
bool	set_mapping (Lua-Function)
bool	set_strech_and_pitch (double, double)

∁ ARDOUR:LuaAPI:Vamp

C‡: ARDOUR::LuaAPI::Vamp

Constructor
ℂ	ARDOUR.LuaAPI.Vamp (std::string, float)
Methods
int	analyze (Readable, unsigned int, Lua-Function)
	high-level abstraction to process a single channel of the given Readable. If the plugin is not yet initialized, initialize() is called. if `fn` is not nil, it is called with the immediate Vamp::Plugin::Features on every process call. r readable channel channel to process cb lua callback function or nil Returns 0 on success
bool	initialize ()
	initialize the plugin for use with analyze(). This is equivalent to plugin():initialise (1, ssiz, bsiz) and prepares a plugin for analyze. (by preferred step and block sizes are used. if the plugin does not specify them or they're larger than 8K, both are set to 1024) Manual initialization is only required to set plugin-parameters which depend on prior initialization of the plugin. vamp:reset () vamp:initialize () vamp:plugin():setParameter (0, 1.5, nil) vamp:analyze (r, 0)
StringVector	list_plugins ()
Plugin	plugin ()
FeatureSet	process (FloatArrayVector, RealTime)
	process given array of audio-samples. This is a lua-binding for vamp:plugin():process () d audio-data, the vector must match the configured channel count and hold a complete buffer for every channel as set during plugin():initialise() rt timestamp matching the provided buffer. Returns features extracted from that data (if the plugin is causal)
void	reset ()
	call plugin():reset() and clear intialization flag

∁ ARDOUR:LuaOSC:Address

C‡: ARDOUR::LuaOSC::Address

OSC transmitter

A Class to send OSC messages.

Constructor
ℂ	ARDOUR.LuaOSC.Address (std::string)
	Construct a new OSC transmitter object uri the destination uri e.g. "osc.udp://localhost:7890"
Methods
...	send (--lua--)
	Transmit an OSC message Path (string) and type (string) must always be given. The number of following args must match the type. Supported types are: 'i': integer (lua number) 'f': float (lua number) 'd': double (lua number) 'h': 64bit integer (lua number) 's': string (lua string) 'c': character (lua string) 'T': boolean (lua bool) -- this is not implicily True, a lua true/false must be given 'F': boolean (lua bool) -- this is not implicily False, a lua true/false must be given lua: lua arguments: path, types, ... Returns boolean true if successful, false on error.

↠ ARDOUR:LuaProc

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

is-a: ARDOUR:Plugin

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

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

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

Methods
bool	isnil ()
DspShm	shmem ()
LuaTableRef	table ()

Inherited from ARDOUR:Plugin

Methods
IOPortDescription	describe_io_port (DataType, bool, unsigned int)
std::string	get_docs ()
PluginInfo	get_info ()
LuaTable(int, ...)	get_parameter_descriptor (unsigned int, ParameterDescriptor&)
std::string	get_parameter_docs (unsigned int)
char*	label ()
bool	load_preset (PresetRecord)
	Set parameters using a preset
char*	maker ()
char*	name ()
LuaTable(unsigned int, ...)	nth_parameter (unsigned int, bool&)
unsigned int	parameter_count ()
bool	parameter_is_audio (unsigned int)
bool	parameter_is_control (unsigned int)
bool	parameter_is_input (unsigned int)
bool	parameter_is_output (unsigned int)
std::string	parameter_label (unsigned int)
PresetRecord	preset_by_label (std::string)
PresetRecord	preset_by_uri (std::string)
std::string	unique_id ()
Cast
LuaProc	to_luaproc ()

Inherited from PBD:StatefulPtr

Methods
void	clear_changes ()
	Forget about any changes to this object's properties
ID	id ()
OwnedPropertyList	properties ()

∁ ARDOUR:LuaTableRef

C‡: ARDOUR::LuaTableRef

Methods
...	get (--lua--)
...	set (--lua--)

∁ ARDOUR:MIDIPortMeters

C‡: std::map<std::string, ARDOUR::PortManager::MPM >

Constructor
ℂ	ARDOUR.MIDIPortMeters ()
Methods
LuaTable	add (std::string, ARDOUR::PortManager::MPM )
...	at (--lua--)
void	clear ()
unsigned long	count (std::string)
bool	empty ()
LuaIter	iter ()
unsigned long	size ()
LuaTable	table ()

∁ ARDOUR:Meter

C‡: ARDOUR::Meter

Meter, or time signature (beats per bar, and which note type is a beat).

Constructor
ℂ	ARDOUR.Meter (double, double)
Methods
double	divisions_per_bar ()
double	note_divisor ()
double	samples_per_bar (Tempo, long)
double	samples_per_grid (Tempo, long)

∁ ARDOUR:MeterSection

C‡: ARDOUR::MeterSection

is-a: ARDOUR:MetricSection

A section of timeline with a certain Meter.

Methods
BBT_TIME	bbt ()
double	beat ()
void	set_beat (double)
Cast
Meter	to_meter ()

Inherited from ARDOUR:MetricSection

Methods
bool	initial ()
bool	is_tempo ()
double	minute ()
double	minute_at_sample (long)
double	pulse ()
long	sample ()
long	sample_at_minute (double)
void	set_pulse (double)

∁ ARDOUR:MetricSection

C‡: ARDOUR::MetricSection

A section of timeline with a certain Tempo or Meter.

Methods
bool	initial ()
bool	is_tempo ()
double	minute ()
double	minute_at_sample (long)
double	pulse ()
long	sample ()
long	sample_at_minute (double)
void	set_pulse (double)

∁ ARDOUR:MidiBuffer

C‡: ARDOUR::MidiBuffer

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

Methods
void	copy (MidiBuffer)
bool	empty ()
bool	push_back (long, EventType, unsigned long, unsigned char*)
bool	push_event (Event)
void	resize (unsigned long)
	Reallocate the buffer used internally to handle at least size_t units of data. The buffer is not silent after this operation. the capacity argument passed to the constructor must have been non-zero.
void	silence (long, long)
	Clear (eg zero, or empty) buffer
unsigned long	size ()
...	table (--lua--)

↠ ARDOUR:MidiModel

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

is-a: ARDOUR:AutomatableSequence

This is a higher level (than MidiBuffer) model of MIDI data, with separate representations for notes (instead of just unassociated note on/off events) and controller data. Controller data is represented as part of the Automatable base (i.e. in a map of AutomationList, keyed by Parameter). Because of this MIDI controllers and automatable controllers/widgets/etc are easily interchangeable.

Methods
void	apply_command (Session, Command)
bool	isnil ()
NoteDiffCommand	new_note_diff_command (std::string)
	Start a new NoteDiff command. This has no side-effects on the model or Session, the returned command can be held on to for as long as the caller wishes, or discarded without formality, until apply_command is called and ownership is taken.

Inherited from ARDOUR:AutomatableSequence

Cast
Sequence	to_sequence ()

Inherited from ARDOUR:Automatable

Methods
AutomationControl	automation_control (Parameter, bool)
Cast
Slavable	to_slavable ()

∅ ARDOUR:MidiModel:DiffCommand

C‡: ARDOUR::MidiModel::DiffCommand

is-a: PBD:Command

Base class for Undo/Redo commands and changesets

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

Inherited from PBD:Command

Methods
std::string	name ()
void	set_name (std::string)

Inherited from PBD:Stateful

Methods
void	clear_changes ()
	Forget about any changes to this object's properties
ID	id ()
OwnedPropertyList	properties ()

∁ ARDOUR:MidiModel:NoteDiffCommand

C‡: ARDOUR::MidiModel::NoteDiffCommand

is-a: ARDOUR:MidiModel:DiffCommand

Base class for Undo/Redo commands and changesets

Methods
void	add (NotePtr)
void	remove (NotePtr)

Inherited from PBD:Command

Methods
std::string	name ()
void	set_name (std::string)

Inherited from PBD:Stateful

Methods
void	clear_changes ()
	Forget about any changes to this object's properties
ID	id ()
OwnedPropertyList	properties ()

↠ ARDOUR:MidiPlaylist

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

is-a: ARDOUR:Playlist

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 ()
void	set_note_mode (NoteMode)

Inherited from ARDOUR:Playlist

Methods
void	add_region (Region, long, float, bool, int, double, 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)
	gap from the beginning of the region to the next beginning
void	duplicate_range (AudioRange&, float)
void	duplicate_until (Region, long, long, long)
	gap from the beginning of the region to the next beginning end the first sample that does _not_ contain a duplicated sample
bool	empty ()
Region	find_next_region (long, RegionPoint, int)
long	find_next_region_boundary (long, int)
long	find_next_transient (long, int)
ID	get_orig_track_id ()
bool	hidden ()
void	lower_region (Region)
void	lower_region_to_bottom (Region)
unsigned int	n_regions ()
void	raise_region (Region)
void	raise_region_to_top (Region)
Region	region_by_id (ID)
RegionListPtr	region_list ()
RegionListPtr	regions_at (long)
RegionListPtr	regions_touched (long, long)
	start Range start. end Range end. Returns regions which have some part within this range.
RegionListPtr	regions_with_end_within (Range)
RegionListPtr	regions_with_start_within (Range)
void	remove_region (Region)
bool	set_name (std::string)
bool	shared ()
void	split_region (Region, MusicSample)
Region	top_region_at (long)
Region	top_unmuted_region_at (long)
void	uncombine (Region)
bool	used ()
Cast
AudioPlaylist	to_audioplaylist ()
MidiPlaylist	to_midiplaylist ()

Inherited from ARDOUR:SessionObjectPtr

Methods
std::string	name ()
Cast
Stateful	to_stateful ()
StatefulDestructible	to_statefuldestructible ()

↠ ARDOUR:MidiPort

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

is-a: ARDOUR:Port

Methods
MidiBuffer	get_midi_buffer (unsigned int)
bool	input_active ()
bool	isnil ()
void	set_input_active (bool)
Cast
AsyncMIDIPort	to_asyncmidiport ()

Inherited from ARDOUR:Port

Methods
int	connect (std::string)
bool	connected ()
	Returns true if this port is connected to anything
bool	connected_to (std::string)
	o Port name Returns true if this port is connected to o, otherwise false.
int	disconnect (std::string)
int	disconnect_all ()
PortFlags	flags ()
	Returns flags
LuaTable(...)	get_connected_latency_range (LatencyRange&, bool)
std::string	name ()
	Returns Port short name
bool	physically_connected ()
std::string	pretty_name (bool)
	Returns Port human readable name
LatencyRange	private_latency_range (bool)
LatencyRange	public_latency_range (bool)
bool	receives_input ()
	Returns true if this Port receives input, otherwise false
bool	sends_output ()
	Returns true if this Port sends output, otherwise false
Cast
AsyncMIDIPort	to_asyncmidiport ()
AudioPort	to_audioport ()
MidiPort	to_midiport ()

↠ ARDOUR:MidiRegion

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

is-a: ARDOUR:Region

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	do_export (std::string)
	Export the MIDI data of the MidiRegion to a new MIDI file (SMF).
bool	isnil ()
double	length_beats ()
MidiSource	midi_source (unsigned int)
MidiModel	model ()
double	start_beats ()

Inherited from ARDOUR:Region

Methods
bool	at_natural_position ()
bool	automatic ()
bool	can_move ()
bool	captured ()
void	captured_xruns (XrunPositions&, bool)
void	clear_sync_position ()
Control	control (Parameter, bool)
bool	covers (long)
void	cut_end (long, int)
void	cut_front (long, int)
DataType	data_type ()
bool	external ()
bool	has_transients ()
bool	hidden ()
bool	import ()
bool	is_compound ()
unsigned int	layer ()
long	length ()
bool	locked ()
void	lower ()
void	lower_to_bottom ()
StringVector	master_source_names ()
SourceList	master_sources ()
void	move_start (long, int)
void	move_to_natural_position ()
bool	muted ()
unsigned int	n_channels ()
void	nudge_position (long)
bool	opaque ()
Playlist	playlist ()
long	position ()
	How the region parameters play together: POSITION: first sample of the region along the timeline START: first sample of the region within its source(s) LENGTH: number of samples the region represents
bool	position_locked ()
double	quarter_note ()
void	raise ()
void	raise_to_top ()
void	set_hidden (bool)
void	set_initial_position (long)
	A gui may need to create a region, then place it in an initial position determined by the user. When this takes place within one gui operation, we have to reset _last_position to prevent an implied move.
void	set_length (long, int)
void	set_locked (bool)
void	set_muted (bool)
bool	set_name (std::string)
	Note: changing the name of a Region does not constitute an edit
void	set_opaque (bool)
void	set_position (long, int)
void	set_position_locked (bool)
void	set_start (long)
void	set_sync_position (long)
	Set the region's sync point. absolute_pos Session time.
void	set_video_locked (bool)
float	shift ()
Source	source (unsigned int)
long	start ()
float	stretch ()
bool	sync_marked ()
LuaTable(long, ...)	sync_offset (int&)
long	sync_position ()
	Returns Sync position in session time
Int64List	transients ()
void	trim_end (long, int)
void	trim_front (long, int)
void	trim_to (long, long, int)
bool	video_locked ()
bool	whole_file ()
Cast
AudioRegion	to_audioregion ()
MidiRegion	to_midiregion ()
Readable	to_readable ()

Inherited from ARDOUR:SessionObjectPtr

Methods
std::string	name ()
Cast
Stateful	to_stateful ()
StatefulDestructible	to_statefuldestructible ()

↠ ARDOUR:MidiSource

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

is-a: ARDOUR:Source

Source for MIDI data

Methods
bool	empty ()
bool	isnil ()
long	length (long)
MidiModel	model ()

Inherited from ARDOUR:Source

Methods
std::string	ancestor_name ()
bool	can_be_analysed ()
XrunPositions	captured_xruns ()
bool	has_been_analysed ()
long	natural_position ()
long	timeline_position ()
long	timestamp ()
int	use_count ()
bool	used ()
bool	writable ()
Cast
AudioSource	to_audiosource ()
FileSource	to_filesource ()
MidiSource	to_midisource ()

Inherited from ARDOUR:SessionObjectPtr

Methods
std::string	name ()
Cast
Stateful	to_stateful ()
StatefulDestructible	to_statefuldestructible ()

↠ ARDOUR:MidiTrack

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 recording, playback and editing.

Specifically a track has a playlist object that describes material to be played from disk, and modifies that object during recording and editing.

Methods
bool	isnil ()
bool	write_immediate_event (EventType, unsigned long, unsigned char*)

Inherited from ARDOUR:Track

Methods
Region	bounce (InterThreadInfo&, std::string)
	bounce track from session start to session end to new region itt asynchronous progress report and cancel Returns a new audio region (or nil in case of error)
Region	bounce_range (long, long, InterThreadInfo&, Processor, bool, std::string)
	Bounce the given range to a new audio region. start start time (in samples) end end time (in samples) itt asynchronous progress report and cancel endpoint the processor to tap the signal off (or nil for the top) include_endpoint include the given processor in the bounced audio. Returns a new audio region (or nil in case of error)
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. 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.
bool	can_record ()
int	find_and_use_playlist (DataType, ID)
Playlist	playlist ()
bool	set_name (std::string)
int	use_copy_playlist ()
int	use_new_playlist (DataType)
int	use_playlist (DataType, Playlist)
Cast
AudioTrack	to_audio_track ()
MidiTrack	to_midi_track ()

Inherited from ARDOUR:Route

Methods
bool	active ()
int	add_foldback_send (Route, bool)
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. index Index to add the processor at, or -1 to add at the end of the list. Returns 0 on success, non-0 on failure.
bool	add_sidechain (Processor)
Amp	amp ()
std::string	comment ()
bool	customize_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
DataType	data_type ()
IO	input ()
Delivery	main_outs ()
	the signal processorat at end of the processing chain which produces output
bool	muted ()
ChanCount	n_inputs ()
ChanCount	n_outputs ()
Processor	nth_plugin (unsigned int)
Processor	nth_processor (unsigned int)
Processor	nth_send (unsigned int)
IO	output ()
PannerShell	panner_shell ()
PeakMeter	peak_meter ()
	*********************************************************** Pure interface begins here***********************************************************
long	playback_latency (bool)
int	remove_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
int	remove_processors (ProcessorList, ProcessorStreams)
bool	remove_sidechain (Processor)
int	reorder_processors (ProcessorList, ProcessorStreams)
int	replace_processor (Processor, Processor, ProcessorStreams)
	replace plugin/processor with another old processor to remove sub processor to substitute the old one with err error report (index where removal vailed, channel-count why it failed) may be nil Returns 0 on success
bool	reset_plugin_insert (Processor)
	reset plugin-insert configuration to default, disable customizations. This is equivalent to calling customize_plugin_insert (proc, 0, unused) proc Processor to reset Returns true if successful
void	set_active (bool, void*)
void	set_comment (std::string, void*)
void	set_meter_point (MeterPoint)
bool	set_strict_io (bool)
long	signal_latency ()
bool	soloed ()
bool	strict_io ()
Processor	the_instrument ()
	Return the first processor that accepts has at least one MIDI input and at least one audio output. In the vast majority of cases, this will be "the instrument". This does not preclude other MIDI->audio processors later in the processing chain, but that would be a special case not covered by this utility function.
Amp	trim ()
Cast
Track	to_track ()

Inherited from ARDOUR:Stripable

Methods
AutomationControl	comp_enable_controllable ()
AutomationControl	comp_makeup_controllable ()
AutomationControl	comp_mode_controllable ()
std::string	comp_mode_name (unsigned int)
ReadOnlyControl	comp_redux_controllable ()
AutomationControl	comp_speed_controllable ()
std::string	comp_speed_name (unsigned int)
AutomationControl	comp_threshold_controllable ()
unsigned int	eq_band_cnt ()
std::string	eq_band_name (unsigned int)
AutomationControl	eq_enable_controllable ()
AutomationControl	eq_freq_controllable (unsigned int)
AutomationControl	eq_gain_controllable (unsigned int)
AutomationControl	eq_q_controllable (unsigned int)
AutomationControl	eq_shape_controllable (unsigned int)
AutomationControl	filter_enable_controllable (bool)
AutomationControl	filter_freq_controllable (bool)
AutomationControl	filter_slope_controllable (bool)
GainControl	gain_control ()
bool	is_auditioner ()
bool	is_hidden ()
bool	is_master ()
bool	is_monitor ()
bool	is_private_route ()
bool	is_selected ()
AutomationControl	master_send_enable_controllable ()
MonitorProcessor	monitor_control ()
MuteControl	mute_control ()
AutomationControl	pan_azimuth_control ()
AutomationControl	pan_elevation_control ()
AutomationControl	pan_frontback_control ()
AutomationControl	pan_lfe_control ()
AutomationControl	pan_width_control ()
PhaseControl	phase_control ()
PresentationInfo	presentation_info_ptr ()
AutomationControl	rec_enable_control ()
AutomationControl	rec_safe_control ()
AutomationControl	send_enable_controllable (unsigned int)
AutomationControl	send_level_controllable (unsigned int)
std::string	send_name (unsigned int)
AutomationControl	send_pan_azimuth_controllable (unsigned int)
AutomationControl	send_pan_azimuth_enable_controllable (unsigned int)
void	set_presentation_order (unsigned int)
bool	slaved ()
bool	slaved_to (VCA)
SoloControl	solo_control ()
SoloIsolateControl	solo_isolate_control ()
SoloSafeControl	solo_safe_control ()
GainControl	trim_control ()
Cast
Automatable	to_automatable ()
Route	to_route ()
Slavable	to_slavable ()
VCA	to_vca ()

Inherited from ARDOUR:SessionObjectPtr

Methods
std::string	name ()
Cast
Stateful	to_stateful ()
StatefulDestructible	to_statefuldestructible ()

∁ ARDOUR:MidiTrackList

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

Constructor
ℂ	ARDOUR.MidiTrackList ()
Methods
LuaTable	add (LuaTable {MidiTrack})
MidiTrack	back ()
bool	empty ()
MidiTrack	front ()
LuaIter	iter ()
void	push_back (MidiTrack)
void	reverse ()
unsigned long	size ()
LuaTable	table ()
void	unique ()

↠ ARDOUR:MonitorProcessor

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

is-a: ARDOUR:Processor

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

Methods
Controllable	channel_cut_control (unsigned int)
Controllable	channel_dim_control (unsigned int)
Controllable	channel_polarity_control (unsigned int)
Controllable	channel_solo_control (unsigned int)
bool	cut (unsigned int)
bool	cut_all ()
Controllable	cut_control ()
bool	dim_all ()
Controllable	dim_control ()
float	dim_level ()
Controllable	dim_level_control ()
bool	dimmed (unsigned int)
bool	inverted (unsigned int)
bool	isnil ()
bool	monitor_active ()
bool	mono ()
Controllable	mono_control ()
void	set_cut (unsigned int, bool)
void	set_cut_all (bool)
void	set_dim (unsigned int, bool)
void	set_dim_all (bool)
void	set_mono (bool)
void	set_polarity (unsigned int, bool)
void	set_solo (unsigned int, bool)
Controllable	solo_boost_control ()
float	solo_boost_level ()
bool	soloed (unsigned int)

Inherited from ARDOUR:Processor

Methods
void	activate ()
bool	active ()
long	capture_offset ()
void	deactivate ()
std::string	display_name ()
bool	display_to_user ()
long	input_latency ()
ChanCount	input_streams ()
long	output_latency ()
ChanCount	output_streams ()
long	playback_offset ()
long	signal_latency ()
Cast
Amp	to_amp ()
Automatable	to_automatable ()
DelayLine	to_delayline ()
DiskIOProcessor	to_diskioprocessor ()
DiskReader	to_diskreader ()
DiskWriter	to_diskwriter ()
PluginInsert	to_insert ()
InternalSend	to_internalsend ()
IOProcessor	to_ioprocessor ()
Latent	to_latent ()
PeakMeter	to_meter ()
MonitorProcessor	to_monitorprocessor ()
PeakMeter	to_peakmeter ()
PluginInsert	to_plugininsert ()
PolarityProcessor	to_polarityprocessor ()
Send	to_send ()
SideChain	to_sidechain ()
UnknownProcessor	to_unknownprocessor ()

Inherited from ARDOUR:SessionObjectPtr

Methods
std::string	name ()
Cast
Stateful	to_stateful ()
StatefulDestructible	to_statefuldestructible ()

∁ ARDOUR:MusicSample

C‡: ARDOUR::MusicSample

Constructor
ℂ	ARDOUR.MusicSample (long, int)
Methods
void	set (long, int)
Data Members
int	division
long	sample

↠ 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
bool	isnil ()
bool	muted ()
bool	muted_by_self ()

Inherited from ARDOUR:SlavableAutomationControl

Methods
void	add_master (AutomationControl)
void	clear_masters ()
int	get_boolean_masters ()
double	get_masters_value ()
void	remove_master (AutomationControl)
bool	slaved ()
bool	slaved_to (AutomationControl)

Inherited from ARDOUR:AutomationControl

Methods
AutomationList	alist ()
AutoState	automation_state ()
ParameterDescriptor	desc ()
double	get_value ()
	Get `internal' value Returns raw value as used for the plugin/processor control port
double	lower ()
double	normal ()
void	set_automation_state (AutoState)
void	set_value (double, GroupControlDisposition)
	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. value raw numeric value to set group_override if and how to propagate value to grouped controls
void	start_touch (double)
void	stop_touch (double)
bool	toggled ()
double	upper ()
bool	writable ()
Cast
Control	to_ctrl ()
SlavableAutomationControl	to_slavable ()

Inherited from PBD:Controllable

Methods
std::string	name ()

Inherited from PBD:StatefulPtr

Methods
void	clear_changes ()
	Forget about any changes to this object's properties
ID	id ()
OwnedPropertyList	properties ()

∁ ARDOUR:NotePtrList

C‡: std::list<boost::shared_ptr<Evoral::Note<Temporal::Beats> > > >

Constructor
ℂ	ARDOUR.NotePtrList ()
Methods
LuaTable	add (LuaTable {Beats})
NotePtr	back ()
bool	empty ()
NotePtr	front ()
LuaIter	iter ()
void	push_back (NotePtr)
void	reverse ()
unsigned long	size ()
LuaTable	table ()
void	unique ()

∅ ARDOUR:OwnedPropertyList

C‡: PBD::OwnedPropertyList

is-a: ARDOUR:PropertyList

Persistent Property List

A variant of PropertyList that does not delete its property list in its destructor. Objects with their own Properties store them in an OwnedPropertyList to avoid having them deleted at the wrong time.

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

∁ ARDOUR:PDC

C‡: ARDOUR::Latent

Methods
void	force_zero_latency (bool)
bool	zero_latency ()

↠ ARDOUR:PannerShell

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

is-a: ARDOUR:SessionObjectPtr

Class to manage panning by instantiating and controlling an appropriate Panner object for a given in/out configuration.

Methods
bool	bypassed ()
bool	isnil ()
void	set_bypassed (bool)

Inherited from ARDOUR:SessionObjectPtr

Methods
std::string	name ()
Cast
Stateful	to_stateful ()
StatefulDestructible	to_statefuldestructible ()

∁ ARDOUR:ParameterDescriptor

C‡: ARDOUR::ParameterDescriptor

is-a: Evoral:ParameterDescriptor

Descriptor of a parameter or control.

Essentially a union of LADSPA, VST and LV2 info.

Constructor
ℂ	ARDOUR.ParameterDescriptor ()
Methods
std::string	midi_note_name (unsigned char, bool)
Data Members
unsigned int	display_priority
	higher is more important http://lv2plug.in/ns/ext/port-props#displayPriority
bool	enumeration
bool	inline_ctrl
bool	integer_step
std::string	label
float	largestep
std::string	print_fmt
	format string for pretty printing
float	smallstep
bool	sr_dependent
float	step

Inherited from Evoral:ParameterDescriptor

Constructor
ℂ	Evoral.ParameterDescriptor ()
Data Members
bool	logarithmic
	True for log-scale parameters
float	lower
	Minimum value (in Hz, for frequencies)
float	normal
	Default value
bool	toggled
	True iff parameter is boolean
float	upper
	Maximum value (in Hz, for frequencies)

↠ ARDOUR:PeakMeter

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

is-a: ARDOUR:Processor

Meters peaks on the input and stores them for access.

Methods
bool	isnil ()
float	meter_level (unsigned int, MeterType)
MeterType	meter_type ()
void	reset_max ()
void	set_meter_type (MeterType)

Inherited from ARDOUR:Processor

Methods
void	activate ()
bool	active ()
long	capture_offset ()
void	deactivate ()
std::string	display_name ()
bool	display_to_user ()
long	input_latency ()
ChanCount	input_streams ()
long	output_latency ()
ChanCount	output_streams ()
long	playback_offset ()
long	signal_latency ()
Cast
Amp	to_amp ()
Automatable	to_automatable ()
DelayLine	to_delayline ()
DiskIOProcessor	to_diskioprocessor ()
DiskReader	to_diskreader ()
DiskWriter	to_diskwriter ()
PluginInsert	to_insert ()
InternalSend	to_internalsend ()
IOProcessor	to_ioprocessor ()
Latent	to_latent ()
PeakMeter	to_meter ()
MonitorProcessor	to_monitorprocessor ()
PeakMeter	to_peakmeter ()
PluginInsert	to_plugininsert ()
PolarityProcessor	to_polarityprocessor ()
Send	to_send ()
SideChain	to_sidechain ()
UnknownProcessor	to_unknownprocessor ()

Inherited from ARDOUR:SessionObjectPtr

Methods
std::string	name ()
Cast
Stateful	to_stateful ()
StatefulDestructible	to_statefuldestructible ()

↠ 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
bool	inverted (unsigned int)
bool	isnil ()
void	set_phase_invert (unsigned int, bool)
	c Audio channel index. yn true to invert phase, otherwise false.

Inherited from ARDOUR:AutomationControl

Methods
AutomationList	alist ()
AutoState	automation_state ()
ParameterDescriptor	desc ()
double	get_value ()
	Get `internal' value Returns raw value as used for the plugin/processor control port
double	lower ()
double	normal ()
void	set_automation_state (AutoState)
void	set_value (double, GroupControlDisposition)
	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. value raw numeric value to set group_override if and how to propagate value to grouped controls
void	start_touch (double)
void	stop_touch (double)
bool	toggled ()
double	upper ()
bool	writable ()
Cast
Control	to_ctrl ()
SlavableAutomationControl	to_slavable ()

Inherited from PBD:Controllable

Methods
std::string	name ()

Inherited from PBD:StatefulPtr

Methods
void	clear_changes ()
	Forget about any changes to this object's properties
ID	id ()
OwnedPropertyList	properties ()

↠ ARDOUR:Playlist

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

is-a: ARDOUR:SessionObjectPtr

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

Methods
void	add_region (Region, long, float, bool, int, double, 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)
	gap from the beginning of the region to the next beginning
void	duplicate_range (AudioRange&, float)
void	duplicate_until (Region, long, long, long)
	gap from the beginning of the region to the next beginning end the first sample that does _not_ contain a duplicated sample
bool	empty ()
Region	find_next_region (long, RegionPoint, int)
long	find_next_region_boundary (long, int)
long	find_next_transient (long, int)
ID	get_orig_track_id ()
bool	hidden ()
bool	isnil ()
void	lower_region (Region)
void	lower_region_to_bottom (Region)
unsigned int	n_regions ()
void	raise_region (Region)
void	raise_region_to_top (Region)
Region	region_by_id (ID)
RegionListPtr	region_list ()
RegionListPtr	regions_at (long)
RegionListPtr	regions_touched (long, long)
	start Range start. end Range end. Returns regions which have some part within this range.
RegionListPtr	regions_with_end_within (Range)
RegionListPtr	regions_with_start_within (Range)
void	remove_region (Region)
bool	set_name (std::string)
bool	shared ()
void	split_region (Region, MusicSample)
Region	top_region_at (long)
Region	top_unmuted_region_at (long)
void	uncombine (Region)
bool	used ()
Cast
AudioPlaylist	to_audioplaylist ()
MidiPlaylist	to_midiplaylist ()

Inherited from ARDOUR:SessionObjectPtr

Methods
std::string	name ()
Cast
Stateful	to_stateful ()
StatefulDestructible	to_statefuldestructible ()

∁ ARDOUR:PlaylistList

C‡: std::vector<boost::shared_ptr<ARDOUR::Playlist> >

Constructor
ℂ	ARDOUR.PlaylistList ()
ℂ	ARDOUR.PlaylistList ()
Methods
LuaTable	add (LuaTable {Playlist})
Playlist	at (unsigned long)
void	clear ()
bool	empty ()
LuaIter	iter ()
void	push_back (Playlist)
unsigned long	size ()
LuaTable	table ()
...	to_array (--lua--)

↠ ARDOUR:Plugin

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

is-a: PBD:StatefulDestructiblePtr

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

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

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

Methods
IOPortDescription	describe_io_port (DataType, bool, unsigned int)
std::string	get_docs ()
PluginInfo	get_info ()
LuaTable(int, ...)	get_parameter_descriptor (unsigned int, ParameterDescriptor&)
std::string	get_parameter_docs (unsigned int)
bool	isnil ()
char*	label ()
bool	load_preset (PresetRecord)
	Set parameters using a preset
char*	maker ()
char*	name ()
LuaTable(unsigned int, ...)	nth_parameter (unsigned int, bool&)
unsigned int	parameter_count ()
bool	parameter_is_audio (unsigned int)
bool	parameter_is_control (unsigned int)
bool	parameter_is_input (unsigned int)
bool	parameter_is_output (unsigned int)
std::string	parameter_label (unsigned int)
PresetRecord	preset_by_label (std::string)
PresetRecord	preset_by_uri (std::string)
std::string	unique_id ()
Cast
LuaProc	to_luaproc ()

Inherited from PBD:StatefulPtr

Methods
void	clear_changes ()
	Forget about any changes to this object's properties
ID	id ()
OwnedPropertyList	properties ()

∁ ARDOUR:Plugin:IOPortDescription

C‡: ARDOUR::Plugin::IOPortDescription

Data Members
unsigned int	group_channel
std::string	group_name
bool	is_sidechain
std::string	name

↠ ARDOUR:PluginControl

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

is-a: ARDOUR:AutomationControl

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

Methods
bool	isnil ()

Inherited from ARDOUR:AutomationControl

Methods
AutomationList	alist ()
AutoState	automation_state ()
ParameterDescriptor	desc ()
double	get_value ()
	Get `internal' value Returns raw value as used for the plugin/processor control port
double	lower ()
double	normal ()
void	set_automation_state (AutoState)
void	set_value (double, GroupControlDisposition)
	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. value raw numeric value to set group_override if and how to propagate value to grouped controls
void	start_touch (double)
void	stop_touch (double)
bool	toggled ()
double	upper ()
bool	writable ()
Cast
Control	to_ctrl ()
SlavableAutomationControl	to_slavable ()

Inherited from PBD:Controllable

Methods
std::string	name ()

Inherited from PBD:StatefulPtr

Methods
void	clear_changes ()
	Forget about any changes to this object's properties
ID	id ()
OwnedPropertyList	properties ()

↠ ARDOUR:PluginInfo

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

Constructor
ℵ	ARDOUR.PluginInfo ()
Methods
PresetVector	get_presets (bool)
bool	is_instrument ()
bool	isnil ()
Data Members
std::string	category
std::string	creator
ARDOUR:ChanCount	n_inputs
ARDOUR:ChanCount	n_outputs
std::string	name
std::string	path
ARDOUR.PluginType	type
std::string	unique_id

∁ ARDOUR:PluginInfoList

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

Constructor
ℂ	ARDOUR.PluginInfoList ()
Methods
LuaTable	add (LuaTable {PluginInfo})
PluginInfo	back ()
bool	empty ()
PluginInfo	front ()
LuaIter	iter ()
void	push_back (PluginInfo)
void	reverse ()
unsigned long	size ()
LuaTable	table ()
void	unique ()

↠ ARDOUR:PluginInsert

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

is-a: ARDOUR:Processor

Plugin inserts: send data through a plugin

Methods
void	activate ()
void	clear_stats ()
void	deactivate ()
void	enable (bool)
bool	enabled ()
unsigned int	get_count ()
LuaTable(bool, ...)	get_stats (unsigned long&, unsigned long&, double&, double&)
bool	has_sidechain ()
ChanMapping	input_map (unsigned int)
bool	is_channelstrip ()
bool	is_instrument ()
bool	isnil ()
ChanCount	natural_input_streams ()
ChanCount	natural_output_streams ()
ChanMapping	output_map (unsigned int)
Plugin	plugin (unsigned int)
bool	reset_parameters_to_default ()
void	set_input_map (unsigned int, ChanMapping)
void	set_output_map (unsigned int, ChanMapping)
void	set_thru_map (ChanMapping)
long	signal_latency ()
bool	strict_io_configured ()
ChanMapping	thru_map ()
PluginType	type ()
bool	write_immediate_event (EventType, unsigned long, unsigned char*)

Inherited from ARDOUR:Processor

Methods
bool	active ()
long	capture_offset ()
std::string	display_name ()
bool	display_to_user ()
long	input_latency ()
ChanCount	input_streams ()
long	output_latency ()
ChanCount	output_streams ()
long	playback_offset ()
Cast
Amp	to_amp ()
Automatable	to_automatable ()
DelayLine	to_delayline ()
DiskIOProcessor	to_diskioprocessor ()
DiskReader	to_diskreader ()
DiskWriter	to_diskwriter ()
PluginInsert	to_insert ()
InternalSend	to_internalsend ()
IOProcessor	to_ioprocessor ()
Latent	to_latent ()
PeakMeter	to_meter ()
MonitorProcessor	to_monitorprocessor ()
PeakMeter	to_peakmeter ()
PluginInsert	to_plugininsert ()
PolarityProcessor	to_polarityprocessor ()
Send	to_send ()
SideChain	to_sidechain ()
UnknownProcessor	to_unknownprocessor ()

Inherited from ARDOUR:SessionObjectPtr

Methods
std::string	name ()
Cast
Stateful	to_stateful ()
StatefulDestructible	to_statefuldestructible ()

ℕ ARDOUR.PluginType

Methods
std::string	name (PluginType, bool)

↠ ARDOUR:PolarityProcessor

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

is-a: ARDOUR:Processor

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

Methods
bool	isnil ()

Inherited from ARDOUR:Processor

Methods
void	activate ()
bool	active ()
long	capture_offset ()
void	deactivate ()
std::string	display_name ()
bool	display_to_user ()
long	input_latency ()
ChanCount	input_streams ()
long	output_latency ()
ChanCount	output_streams ()
long	playback_offset ()
long	signal_latency ()
Cast
Amp	to_amp ()
Automatable	to_automatable ()
DelayLine	to_delayline ()
DiskIOProcessor	to_diskioprocessor ()
DiskReader	to_diskreader ()
DiskWriter	to_diskwriter ()
PluginInsert	to_insert ()
InternalSend	to_internalsend ()
IOProcessor	to_ioprocessor ()
Latent	to_latent ()
PeakMeter	to_meter ()
MonitorProcessor	to_monitorprocessor ()
PeakMeter	to_peakmeter ()
PluginInsert	to_plugininsert ()
PolarityProcessor	to_polarityprocessor ()
Send	to_send ()
SideChain	to_sidechain ()
UnknownProcessor	to_unknownprocessor ()

Inherited from ARDOUR:SessionObjectPtr

Methods
std::string	name ()
Cast
Stateful	to_stateful ()
StatefulDestructible	to_statefuldestructible ()

↠ ARDOUR:Port

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

Methods
int	connect (std::string)
bool	connected ()
	Returns true if this port is connected to anything
bool	connected_to (std::string)
	o Port name Returns true if this port is connected to o, otherwise false.
int	disconnect (std::string)
int	disconnect_all ()
PortFlags	flags ()
	Returns flags
LuaTable(...)	get_connected_latency_range (LatencyRange&, bool)
bool	isnil ()
std::string	name ()
	Returns Port short name
bool	physically_connected ()
std::string	pretty_name (bool)
	Returns Port human readable name
LatencyRange	private_latency_range (bool)
LatencyRange	public_latency_range (bool)
bool	receives_input ()
	Returns true if this Port receives input, otherwise false
bool	sends_output ()
	Returns true if this Port sends output, otherwise false
Cast
AsyncMIDIPort	to_asyncmidiport ()
AudioPort	to_audioport ()
MidiPort	to_midiport ()

∅ ARDOUR:PortEngine

C‡: ARDOUR::PortEngine

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
Port	back ()
bool	empty ()
Port	front ()
LuaIter	iter ()
void	reverse ()
unsigned long	size ()
LuaTable	table ()

∁ ARDOUR:PortManager

C‡: ARDOUR::PortManager

Methods
int	connect (std::string, std::string)
bool	connected (std::string)
int	disconnect (std::string, std::string)
int	disconnect_port (Port)
LuaTable(int, ...)	get_backend_ports (std::string, DataType, PortFlags, StringVector&)
LuaTable(int, ...)	get_connections (std::string, StringVector&)
void	get_physical_inputs (DataType, StringVector&, MidiPortFlags, MidiPortFlags)
void	get_physical_outputs (DataType, StringVector&, MidiPortFlags, MidiPortFlags)
Port	get_port_by_name (std::string)
	name Full or short name of port Returns Corresponding Port or 0.
LuaTable(int, ...)	get_ports (DataType, PortList&)
std::string	get_pretty_name_by_name (std::string)
ChanCount	n_physical_inputs ()
ChanCount	n_physical_outputs ()
bool	physically_connected (std::string)
PortEngine	port_engine ()
bool	port_is_physical (std::string)
void	reset_input_meters ()

↠ ARDOUR:PortSet

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

An ordered list of Ports, possibly of various types.

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

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

Methods
void	add (Port)
void	clear ()
	Remove all ports from the PortSet. Ports are not deregistered with the engine, it's the caller's responsibility to not leak here!
bool	contains (Port)
bool	empty ()
bool	isnil ()
unsigned long	num_ports (DataType)
Port	port (DataType, unsigned long)
	nth port of type t, or nth port if t = NIL t data type index port index
bool	remove (Port)

∁ ARDOUR:PresentationInfo

C‡: ARDOUR::PresentationInfo

is-a: PBD:Stateful

Base class for objects with saveable and undoable state

Methods
unsigned int	color ()
Flag	flags ()
unsigned int	order ()
void	set_color (unsigned int)
bool	special (bool)

Inherited from PBD:Stateful

Methods
void	clear_changes ()
	Forget about any changes to this object's properties
ID	id ()
OwnedPropertyList	properties ()

∁ ARDOUR:PresetRecord

C‡: ARDOUR::Plugin::PresetRecord

Constructor
ℂ	ARDOUR.PresetRecord ()
Data Members
std::string	label
std::string	uri
bool	user
bool	valid

∁ ARDOUR:PresetVector

C‡: std::vector<ARDOUR::Plugin::PresetRecord >

Constructor
ℂ	ARDOUR.PresetVector ()
ℂ	ARDOUR.PresetVector ()
Methods
LuaTable	add (LuaTable {PresetRecord})
PresetRecord	at (unsigned long)
void	clear ()
bool	empty ()
LuaIter	iter ()
void	push_back (PresetRecord)
unsigned long	size ()
LuaTable	table ()
...	to_array (--lua--)

↠ ARDOUR:Processor

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

is-a: ARDOUR:SessionObjectPtr

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

Methods
void	activate ()
bool	active ()
long	capture_offset ()
void	deactivate ()
std::string	display_name ()
bool	display_to_user ()
long	input_latency ()
ChanCount	input_streams ()
bool	isnil ()
long	output_latency ()
ChanCount	output_streams ()
long	playback_offset ()
long	signal_latency ()
Cast
Amp	to_amp ()
Automatable	to_automatable ()
DelayLine	to_delayline ()
DiskIOProcessor	to_diskioprocessor ()
DiskReader	to_diskreader ()
DiskWriter	to_diskwriter ()
PluginInsert	to_insert ()
InternalSend	to_internalsend ()
IOProcessor	to_ioprocessor ()
Latent	to_latent ()
PeakMeter	to_meter ()
MonitorProcessor	to_monitorprocessor ()
PeakMeter	to_peakmeter ()
PluginInsert	to_plugininsert ()
PolarityProcessor	to_polarityprocessor ()
Send	to_send ()
SideChain	to_sidechain ()
UnknownProcessor	to_unknownprocessor ()

Inherited from ARDOUR:SessionObjectPtr

Methods
std::string	name ()
Cast
Stateful	to_stateful ()
StatefulDestructible	to_statefuldestructible ()

∁ ARDOUR:ProcessorList

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

Constructor
ℂ	ARDOUR.ProcessorList ()
Methods
LuaTable	add (LuaTable {Processor})
Processor	back ()
bool	empty ()
Processor	front ()
LuaIter	iter ()
void	push_back (Processor)
void	reverse ()
unsigned long	size ()
LuaTable	table ()
void	unique ()

∁ ARDOUR:ProcessorVector

C‡: std::vector<boost::shared_ptr<ARDOUR::Processor> >

Constructor
ℂ	ARDOUR.ProcessorVector ()
ℂ	ARDOUR.ProcessorVector ()
Methods
LuaTable	add (LuaTable {Processor})
Processor	at (unsigned long)
void	clear ()
bool	empty ()
LuaIter	iter ()
void	push_back (Processor)
unsigned long	size ()
LuaTable	table ()
...	to_array (--lua--)

∅ ARDOUR:Progress

C‡: ARDOUR::Progress

A class to handle reporting of progress of something

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

∅ ARDOUR:Properties:BoolProperty

C‡: PBD::PropertyDescriptor<bool>

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

∅ ARDOUR:Properties:FloatProperty

C‡: PBD::PropertyDescriptor<float>

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

∅ ARDOUR:Properties:SampleposProperty

C‡: PBD::PropertyDescriptor<long>

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

∁ ARDOUR:PropertyChange

C‡: PBD::PropertyChange

A list of IDs of Properties that have changed in some situation or other

Methods
bool	containsBool (BoolProperty)
bool	containsFloat (FloatProperty)
bool	containsSamplePos (SampleposProperty)

∅ ARDOUR:PropertyList

C‡: PBD::PropertyList

A list of properties, mapped using their ID

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

∁ ARDOUR:RCConfiguration

C‡: ARDOUR::RCConfiguration

is-a: PBD:Configuration

Base class for objects with saveable and undoable state

Methods
AFLPosition	get_afl_position ()
bool	get_all_safe ()
bool	get_allow_special_bus_removal ()
bool	get_ask_replace_instrument ()
bool	get_ask_setup_instrument ()
float	get_audio_capture_buffer_seconds ()
float	get_audio_playback_buffer_seconds ()
std::string	get_auditioner_output_left ()
std::string	get_auditioner_output_right ()
bool	get_auto_analyse_audio ()
bool	get_auto_connect_standard_busses ()
bool	get_auto_input_does_talkback ()
AutoReturnTarget	get_auto_return_target_list ()
bool	get_automation_follows_regions ()
float	get_automation_interval_msecs ()
double	get_automation_thinning_factor ()
BufferingPreset	get_buffering_preset ()
std::string	get_click_emphasis_sound ()
float	get_click_gain ()
bool	get_click_record_only ()
std::string	get_click_sound ()
bool	get_clicking ()
bool	get_conceal_lv1_if_lv2_exists ()
bool	get_conceal_vst2_if_vst3_exists ()
bool	get_copy_demo_sessions ()
bool	get_create_xrun_marker ()
FadeShape	get_default_fade_shape ()
std::string	get_default_session_parent_dir ()
DenormalModel	get_denormal_model ()
bool	get_denormal_protection ()
bool	get_disable_disarm_during_roll ()
bool	get_discover_audio_units ()
bool	get_discover_vst_on_start ()
unsigned int	get_disk_choice_space_threshold ()
std::string	get_donate_url ()
EditMode	get_edit_mode ()
bool	get_exclusive_solo ()
float	get_export_preroll ()
float	get_export_silence_threshold ()
unsigned int	get_feedback_interval_ms ()
bool	get_first_midi_bank_is_zero ()
std::string	get_freesound_download_dir ()
bool	get_hide_dummy_backend ()
bool	get_hiding_groups_deactivates_groups ()
int	get_history_depth ()
int	get_initial_program_change ()
AutoConnectOption	get_input_auto_connect ()
int	get_inter_scene_gap_samples ()
bool	get_latched_record_enable ()
LayerModel	get_layer_model ()
unsigned int	get_limit_n_automatables ()
bool	get_link_send_and_route_panner ()
std::string	get_linux_pingback_url ()
ListenPosition	get_listen_position ()
bool	get_locate_while_waiting_for_sync ()
LoopFadeChoice	get_loop_fade_choice ()
bool	get_loop_is_mode ()
std::string	get_ltc_output_port ()
float	get_ltc_output_volume ()
bool	get_ltc_send_continuously ()
float	get_max_gain ()
unsigned int	get_max_recent_sessions ()
unsigned int	get_max_recent_templates ()
float	get_max_transport_speed ()
float	get_meter_falloff ()
MeterType	get_meter_type_bus ()
MeterType	get_meter_type_master ()
MeterType	get_meter_type_track ()
std::string	get_midi_audition_synth_uri ()
bool	get_midi_clock_sets_tempo ()
bool	get_midi_feedback ()
bool	get_midi_input_follows_selection ()
float	get_midi_track_buffer_seconds ()
unsigned int	get_minimum_disk_read_bytes ()
unsigned int	get_minimum_disk_write_bytes ()
bool	get_mmc_control ()
int	get_mmc_receive_device_id ()
int	get_mmc_send_device_id ()
std::string	get_monitor_bus_preferred_bundle ()
MonitorModel	get_monitoring_model ()
int	get_mtc_qf_speed_tolerance ()
bool	get_mute_affects_control_outs ()
bool	get_mute_affects_main_outs ()
bool	get_mute_affects_post_fader ()
bool	get_mute_affects_pre_fader ()
bool	get_new_plugins_active ()
unsigned int	get_osc_port ()
std::string	get_osx_pingback_url ()
AutoConnectOption	get_output_auto_connect ()
unsigned int	get_periodic_safety_backup_interval ()
bool	get_periodic_safety_backups ()
PFLPosition	get_pfl_position ()
std::string	get_plugin_path_lxvst ()
std::string	get_plugin_path_vst ()
std::string	get_plugin_path_vst3 ()
bool	get_plugins_stop_with_transport ()
long	get_postroll ()
long	get_preroll ()
float	get_preroll_seconds ()
int	get_processor_usage ()
bool	get_quieten_at_speed ()
long	get_range_location_minimum ()
RangeSelectionAfterSplit	get_range_selection_after_split ()
bool	get_recording_resets_xrun_count ()
std::string	get_reference_manual_url ()
bool	get_region_boundaries_from_onscreen_tracks ()
bool	get_region_boundaries_from_selected_tracks ()
RegionEquivalence	get_region_equivalence ()
RegionSelectionAfterSplit	get_region_selection_after_split ()
bool	get_replicate_missing_region_channels ()
bool	get_reset_default_speed_on_stop ()
bool	get_run_all_transport_masters_always ()
bool	get_save_history ()
int	get_saved_history_depth ()
bool	get_send_ltc ()
bool	get_send_midi_clock ()
bool	get_send_mmc ()
bool	get_send_mtc ()
bool	get_show_solo_mutes ()
bool	get_show_video_export_info ()
bool	get_show_video_server_dialog ()
ShuttleBehaviour	get_shuttle_behaviour ()
float	get_shuttle_max_speed ()
float	get_shuttle_speed_factor ()
float	get_shuttle_speed_threshold ()
ShuttleUnits	get_shuttle_units ()
bool	get_skip_playback ()
bool	get_solo_control_is_listen_control ()
float	get_solo_mute_gain ()
bool	get_solo_mute_override ()
bool	get_stop_at_session_end ()
bool	get_stop_recording_on_xrun ()
bool	get_strict_io ()
bool	get_timecode_sync_frame_rate ()
bool	get_trace_midi_input ()
bool	get_trace_midi_output ()
TracksAutoNamingRule	get_tracks_auto_naming ()
float	get_transient_sensitivity ()
bool	get_transport_masters_just_roll_when_sync_lost ()
bool	get_try_autostart_engine ()
std::string	get_tutorial_manual_url ()
std::string	get_updates_url ()
bool	get_use_click_emphasis ()
bool	get_use_lxvst ()
bool	get_use_macvst ()
bool	get_use_master_volume ()
bool	get_use_monitor_bus ()
bool	get_use_osc ()
bool	get_use_plugin_own_gui ()
bool	get_use_tranzport ()
bool	get_use_windows_vst ()
bool	get_verbose_plugin_scan ()
bool	get_verify_remove_last_capture ()
bool	get_video_advanced_setup ()
std::string	get_video_server_docroot ()
std::string	get_video_server_url ()
int	get_vst_scan_timeout ()
std::string	get_windows_pingback_url ()
std::string	get_xjadeo_binary ()
bool	set_afl_position (AFLPosition)
bool	set_all_safe (bool)
bool	set_allow_special_bus_removal (bool)
bool	set_ask_replace_instrument (bool)
bool	set_ask_setup_instrument (bool)
bool	set_audio_capture_buffer_seconds (float)
bool	set_audio_playback_buffer_seconds (float)
bool	set_auditioner_output_left (std::string)
bool	set_auditioner_output_right (std::string)
bool	set_auto_analyse_audio (bool)
bool	set_auto_connect_standard_busses (bool)
bool	set_auto_input_does_talkback (bool)
bool	set_auto_return_target_list (AutoReturnTarget)
bool	set_automation_follows_regions (bool)
bool	set_automation_interval_msecs (float)
bool	set_automation_thinning_factor (double)
bool	set_buffering_preset (BufferingPreset)
bool	set_click_emphasis_sound (std::string)
bool	set_click_gain (float)
bool	set_click_record_only (bool)
bool	set_click_sound (std::string)
bool	set_clicking (bool)
bool	set_conceal_lv1_if_lv2_exists (bool)
bool	set_conceal_vst2_if_vst3_exists (bool)
bool	set_copy_demo_sessions (bool)
bool	set_create_xrun_marker (bool)
bool	set_default_fade_shape (FadeShape)
bool	set_default_session_parent_dir (std::string)
bool	set_denormal_model (DenormalModel)
bool	set_denormal_protection (bool)
bool	set_disable_disarm_during_roll (bool)
bool	set_discover_audio_units (bool)
bool	set_discover_vst_on_start (bool)
bool	set_disk_choice_space_threshold (unsigned int)
bool	set_donate_url (std::string)
bool	set_edit_mode (EditMode)
bool	set_exclusive_solo (bool)
bool	set_export_preroll (float)
bool	set_export_silence_threshold (float)
bool	set_feedback_interval_ms (unsigned int)
bool	set_first_midi_bank_is_zero (bool)
bool	set_freesound_download_dir (std::string)
bool	set_hide_dummy_backend (bool)
bool	set_hiding_groups_deactivates_groups (bool)
bool	set_history_depth (int)
bool	set_initial_program_change (int)
bool	set_input_auto_connect (AutoConnectOption)
bool	set_inter_scene_gap_samples (int)
bool	set_latched_record_enable (bool)
bool	set_layer_model (LayerModel)
bool	set_limit_n_automatables (unsigned int)
bool	set_link_send_and_route_panner (bool)
bool	set_linux_pingback_url (std::string)
bool	set_listen_position (ListenPosition)
bool	set_locate_while_waiting_for_sync (bool)
bool	set_loop_fade_choice (LoopFadeChoice)
bool	set_loop_is_mode (bool)
bool	set_ltc_output_port (std::string)
bool	set_ltc_output_volume (float)
bool	set_ltc_send_continuously (bool)
bool	set_max_gain (float)
bool	set_max_recent_sessions (unsigned int)
bool	set_max_recent_templates (unsigned int)
bool	set_max_transport_speed (float)
bool	set_meter_falloff (float)
bool	set_meter_type_bus (MeterType)
bool	set_meter_type_master (MeterType)
bool	set_meter_type_track (MeterType)
bool	set_midi_audition_synth_uri (std::string)
bool	set_midi_clock_sets_tempo (bool)
bool	set_midi_feedback (bool)
bool	set_midi_input_follows_selection (bool)
bool	set_midi_track_buffer_seconds (float)
bool	set_minimum_disk_read_bytes (unsigned int)
bool	set_minimum_disk_write_bytes (unsigned int)
bool	set_mmc_control (bool)
bool	set_mmc_receive_device_id (int)
bool	set_mmc_send_device_id (int)
bool	set_monitor_bus_preferred_bundle (std::string)
bool	set_monitoring_model (MonitorModel)
bool	set_mtc_qf_speed_tolerance (int)
bool	set_mute_affects_control_outs (bool)
bool	set_mute_affects_main_outs (bool)
bool	set_mute_affects_post_fader (bool)
bool	set_mute_affects_pre_fader (bool)
bool	set_new_plugins_active (bool)
bool	set_osc_port (unsigned int)
bool	set_osx_pingback_url (std::string)
bool	set_output_auto_connect (AutoConnectOption)
bool	set_periodic_safety_backup_interval (unsigned int)
bool	set_periodic_safety_backups (bool)
bool	set_pfl_position (PFLPosition)
bool	set_plugin_path_lxvst (std::string)
bool	set_plugin_path_vst (std::string)
bool	set_plugin_path_vst3 (std::string)
bool	set_plugins_stop_with_transport (bool)
bool	set_postroll (long)
bool	set_preroll (long)
bool	set_preroll_seconds (float)
bool	set_processor_usage (int)
bool	set_quieten_at_speed (bool)
bool	set_range_location_minimum (long)
bool	set_range_selection_after_split (RangeSelectionAfterSplit)
bool	set_recording_resets_xrun_count (bool)
bool	set_reference_manual_url (std::string)
bool	set_region_boundaries_from_onscreen_tracks (bool)
bool	set_region_boundaries_from_selected_tracks (bool)
bool	set_region_equivalence (RegionEquivalence)
bool	set_region_selection_after_split (RegionSelectionAfterSplit)
bool	set_replicate_missing_region_channels (bool)
bool	set_reset_default_speed_on_stop (bool)
bool	set_run_all_transport_masters_always (bool)
bool	set_save_history (bool)
bool	set_saved_history_depth (int)
bool	set_send_ltc (bool)
bool	set_send_midi_clock (bool)
bool	set_send_mmc (bool)
bool	set_send_mtc (bool)
bool	set_show_solo_mutes (bool)
bool	set_show_video_export_info (bool)
bool	set_show_video_server_dialog (bool)
bool	set_shuttle_behaviour (ShuttleBehaviour)
bool	set_shuttle_max_speed (float)
bool	set_shuttle_speed_factor (float)
bool	set_shuttle_speed_threshold (float)
bool	set_shuttle_units (ShuttleUnits)
bool	set_skip_playback (bool)
bool	set_solo_control_is_listen_control (bool)
bool	set_solo_mute_gain (float)
bool	set_solo_mute_override (bool)
bool	set_stop_at_session_end (bool)
bool	set_stop_recording_on_xrun (bool)
bool	set_strict_io (bool)
bool	set_timecode_sync_frame_rate (bool)
bool	set_trace_midi_input (bool)
bool	set_trace_midi_output (bool)
bool	set_tracks_auto_naming (TracksAutoNamingRule)
bool	set_transient_sensitivity (float)
bool	set_transport_masters_just_roll_when_sync_lost (bool)
bool	set_try_autostart_engine (bool)
bool	set_tutorial_manual_url (std::string)
bool	set_updates_url (std::string)
bool	set_use_click_emphasis (bool)
bool	set_use_lxvst (bool)
bool	set_use_macvst (bool)
bool	set_use_master_volume (bool)
bool	set_use_monitor_bus (bool)
bool	set_use_osc (bool)
bool	set_use_plugin_own_gui (bool)
bool	set_use_tranzport (bool)
bool	set_use_windows_vst (bool)
bool	set_verbose_plugin_scan (bool)
bool	set_verify_remove_last_capture (bool)
bool	set_video_advanced_setup (bool)
bool	set_video_server_docroot (std::string)
bool	set_video_server_url (std::string)
bool	set_vst_scan_timeout (int)
bool	set_windows_pingback_url (std::string)
bool	set_xjadeo_binary (std::string)
Properties
ARDOUR.AFLPosition	afl_position
bool	all_safe
bool	allow_special_bus_removal
bool	ask_replace_instrument
bool	ask_setup_instrument
float	audio_capture_buffer_seconds
float	audio_playback_buffer_seconds
std::string	auditioner_output_left
std::string	auditioner_output_right
bool	auto_analyse_audio
bool	auto_connect_standard_busses
bool	auto_input_does_talkback
ARDOUR.AutoReturnTarget	auto_return_target_list
bool	automation_follows_regions
float	automation_interval_msecs
double	automation_thinning_factor
ARDOUR.BufferingPreset	buffering_preset
std::string	click_emphasis_sound
float	click_gain
bool	click_record_only
std::string	click_sound
bool	clicking
bool	conceal_lv1_if_lv2_exists
bool	conceal_vst2_if_vst3_exists
bool	copy_demo_sessions
bool	create_xrun_marker
ARDOUR.FadeShape	default_fade_shape
std::string	default_session_parent_dir
ARDOUR.DenormalModel	denormal_model
bool	denormal_protection
bool	disable_disarm_during_roll
bool	discover_audio_units
bool	discover_vst_on_start
unsigned int	disk_choice_space_threshold
std::string	donate_url
ARDOUR.EditMode	edit_mode
bool	exclusive_solo
float	export_preroll
float	export_silence_threshold
unsigned int	feedback_interval_ms
bool	first_midi_bank_is_zero
std::string	freesound_download_dir
bool	hide_dummy_backend
bool	hiding_groups_deactivates_groups
int	history_depth
int	initial_program_change
ARDOUR.AutoConnectOption	input_auto_connect
int	inter_scene_gap_samples
bool	latched_record_enable
ARDOUR.LayerModel	layer_model
unsigned int	limit_n_automatables
bool	link_send_and_route_panner
std::string	linux_pingback_url
ARDOUR.ListenPosition	listen_position
bool	locate_while_waiting_for_sync
ARDOUR.LoopFadeChoice	loop_fade_choice
bool	loop_is_mode
std::string	ltc_output_port
float	ltc_output_volume
bool	ltc_send_continuously
float	max_gain
unsigned int	max_recent_sessions
unsigned int	max_recent_templates
float	max_transport_speed
float	meter_falloff
ARDOUR.MeterType	meter_type_bus
ARDOUR.MeterType	meter_type_master
ARDOUR.MeterType	meter_type_track
std::string	midi_audition_synth_uri
bool	midi_clock_sets_tempo
bool	midi_feedback
bool	midi_input_follows_selection
float	midi_track_buffer_seconds
unsigned int	minimum_disk_read_bytes
unsigned int	minimum_disk_write_bytes
bool	mmc_control
int	mmc_receive_device_id
int	mmc_send_device_id
std::string	monitor_bus_preferred_bundle
ARDOUR.MonitorModel	monitoring_model
int	mtc_qf_speed_tolerance
bool	mute_affects_control_outs
bool	mute_affects_main_outs
bool	mute_affects_post_fader
bool	mute_affects_pre_fader
bool	new_plugins_active
unsigned int	osc_port
std::string	osx_pingback_url
ARDOUR.AutoConnectOption	output_auto_connect
unsigned int	periodic_safety_backup_interval
bool	periodic_safety_backups
ARDOUR.PFLPosition	pfl_position
std::string	plugin_path_lxvst
std::string	plugin_path_vst
std::string	plugin_path_vst3
bool	plugins_stop_with_transport
long	postroll
long	preroll
float	preroll_seconds
int	processor_usage
bool	quieten_at_speed
long	range_location_minimum
ARDOUR.RangeSelectionAfterSplit	range_selection_after_split
bool	recording_resets_xrun_count
std::string	reference_manual_url
bool	region_boundaries_from_onscreen_tracks
bool	region_boundaries_from_selected_tracks
ARDOUR.RegionEquivalence	region_equivalence
ARDOUR.RegionSelectionAfterSplit	region_selection_after_split
bool	replicate_missing_region_channels
bool	reset_default_speed_on_stop
bool	run_all_transport_masters_always
bool	save_history
int	saved_history_depth
bool	send_ltc
bool	send_midi_clock
bool	send_mmc
bool	send_mtc
bool	show_solo_mutes
bool	show_video_export_info
bool	show_video_server_dialog
ARDOUR.ShuttleBehaviour	shuttle_behaviour
float	shuttle_max_speed
float	shuttle_speed_factor
float	shuttle_speed_threshold
ARDOUR.ShuttleUnits	shuttle_units
bool	skip_playback
bool	solo_control_is_listen_control
float	solo_mute_gain
bool	solo_mute_override
bool	stop_at_session_end
bool	stop_recording_on_xrun
bool	strict_io
bool	timecode_sync_frame_rate
bool	trace_midi_input
bool	trace_midi_output
ARDOUR.TracksAutoNamingRule	tracks_auto_naming
float	transient_sensitivity
bool	transport_masters_just_roll_when_sync_lost
bool	try_autostart_engine
std::string	tutorial_manual_url
std::string	updates_url
bool	use_click_emphasis
bool	use_lxvst
bool	use_macvst
bool	use_master_volume
bool	use_monitor_bus
bool	use_osc
bool	use_plugin_own_gui
bool	use_tranzport
bool	use_windows_vst
bool	verbose_plugin_scan
bool	verify_remove_last_capture
bool	video_advanced_setup
std::string	video_server_docroot
std::string	video_server_url
int	vst_scan_timeout
std::string	windows_pingback_url
std::string	xjadeo_binary

Inherited from PBD:Stateful

Methods
void	clear_changes ()
	Forget about any changes to this object's properties
ID	id ()
OwnedPropertyList	properties ()

∁ ARDOUR:RawMidiParser

C‡: ARDOUR::RawMidiParser

Constructor
ℂ	ARDOUR.RawMidiParser ()
Methods
unsigned long	buffer_size ()
unsigned char*	midi_buffer ()
bool	process_byte (unsigned char)
void	reset ()

↠ ARDOUR:ReadOnlyControl

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

is-a: PBD:StatefulDestructiblePtr

Methods
ParameterDescriptor	desc ()
std::string	describe_parameter ()
double	get_parameter ()
bool	isnil ()

Inherited from PBD:StatefulPtr

Methods
void	clear_changes ()
	Forget about any changes to this object's properties
ID	id ()
OwnedPropertyList	properties ()

↠ ARDOUR:Readable

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

Methods
bool	isnil ()
ReadableList	load (Session&, std::string)
unsigned int	n_channels ()
long	read (FloatArray, long, long, int)
long	readable_length ()

∁ ARDOUR:ReadableList

C‡: std::vector<boost::shared_ptr<ARDOUR::Readable> >

Constructor
ℂ	ARDOUR.ReadableList ()
ℂ	ARDOUR.ReadableList ()
Methods
LuaTable	add (LuaTable {Readable})
Readable	at (unsigned long)
void	clear ()
bool	empty ()
LuaIter	iter ()
void	push_back (Readable)
unsigned long	size ()
LuaTable	table ()
...	to_array (--lua--)

↠ ARDOUR:Region

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

is-a: ARDOUR:SessionObjectPtr

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	at_natural_position ()
bool	automatic ()
bool	can_move ()
bool	captured ()
void	captured_xruns (XrunPositions&, bool)
void	clear_sync_position ()
Control	control (Parameter, bool)
bool	covers (long)
void	cut_end (long, int)
void	cut_front (long, int)
DataType	data_type ()
bool	external ()
bool	has_transients ()
bool	hidden ()
bool	import ()
bool	is_compound ()
bool	isnil ()
unsigned int	layer ()
long	length ()
bool	locked ()
void	lower ()
void	lower_to_bottom ()
StringVector	master_source_names ()
SourceList	master_sources ()
void	move_start (long, int)
void	move_to_natural_position ()
bool	muted ()
unsigned int	n_channels ()
void	nudge_position (long)
bool	opaque ()
Playlist	playlist ()
long	position ()
	How the region parameters play together: POSITION: first sample of the region along the timeline START: first sample of the region within its source(s) LENGTH: number of samples the region represents
bool	position_locked ()
double	quarter_note ()
void	raise ()
void	raise_to_top ()
void	set_hidden (bool)
void	set_initial_position (long)
	A gui may need to create a region, then place it in an initial position determined by the user. When this takes place within one gui operation, we have to reset _last_position to prevent an implied move.
void	set_length (long, int)
void	set_locked (bool)
void	set_muted (bool)
bool	set_name (std::string)
	Note: changing the name of a Region does not constitute an edit
void	set_opaque (bool)
void	set_position (long, int)
void	set_position_locked (bool)
void	set_start (long)
void	set_sync_position (long)
	Set the region's sync point. absolute_pos Session time.
void	set_video_locked (bool)
float	shift ()
Source	source (unsigned int)
long	start ()
float	stretch ()
bool	sync_marked ()
LuaTable(long, ...)	sync_offset (int&)
long	sync_position ()
	Returns Sync position in session time
Int64List	transients ()
void	trim_end (long, int)
void	trim_front (long, int)
void	trim_to (long, long, int)
bool	video_locked ()
bool	whole_file ()
Cast
AudioRegion	to_audioregion ()
MidiRegion	to_midiregion ()
Readable	to_readable ()

Inherited from ARDOUR:SessionObjectPtr

Methods
std::string	name ()
Cast
Stateful	to_stateful ()
StatefulDestructible	to_statefuldestructible ()

∁ ARDOUR:RegionFactory

C‡: ARDOUR::RegionFactory

Methods
Region	clone_region (Region, bool, bool)
Region	region_by_id (ID)
RegionMap	regions ()

∁ ARDOUR:RegionList

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

Constructor
ℂ	ARDOUR.RegionList ()
Methods
Region	back ()
bool	empty ()
Region	front ()
LuaIter	iter ()
void	reverse ()
unsigned long	size ()
LuaTable	table ()

∁ ARDOUR:RegionListPtr

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

Constructor
ℂ	ARDOUR.RegionListPtr ()
Methods
LuaTable	add (LuaTable {Region})
bool	empty ()
LuaIter	iter ()
void	push_back (Region)
void	reverse ()
unsigned long	size ()
LuaTable	table ()
void	unique ()

∁ ARDOUR:RegionMap

C‡: std::map<PBD::ID, boost::shared_ptr<ARDOUR::Region> > >

Constructor
ℂ	ARDOUR.RegionMap ()
Methods
LuaTable	add (LuaTable {Region})
...	at (--lua--)
void	clear ()
unsigned long	count (ID)
bool	empty ()
LuaIter	iter ()
unsigned long	size ()
LuaTable	table ()

∁ ARDOUR:RegionVector

C‡: std::vector<boost::shared_ptr<ARDOUR::Region> >

Constructor
ℂ	ARDOUR.RegionVector ()
ℂ	ARDOUR.RegionVector ()
Methods
LuaTable	add (LuaTable {Region})
Region	at (unsigned long)
void	clear ()
bool	empty ()
LuaIter	iter ()
void	push_back (Region)
unsigned long	size ()
LuaTable	table ()
...	to_array (--lua--)

↠ ARDOUR:Return

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

is-a: ARDOUR:IOProcessor

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

Methods
bool	isnil ()

Inherited from ARDOUR:IOProcessor

Methods
IO	input ()
ChanCount	natural_input_streams ()
ChanCount	natural_output_streams ()
IO	output ()

Inherited from ARDOUR:Processor

Methods
void	activate ()
bool	active ()
long	capture_offset ()
void	deactivate ()
std::string	display_name ()
bool	display_to_user ()
long	input_latency ()
ChanCount	input_streams ()
long	output_latency ()
ChanCount	output_streams ()
long	playback_offset ()
long	signal_latency ()
Cast
Amp	to_amp ()
Automatable	to_automatable ()
DelayLine	to_delayline ()
DiskIOProcessor	to_diskioprocessor ()
DiskReader	to_diskreader ()
DiskWriter	to_diskwriter ()
PluginInsert	to_insert ()
InternalSend	to_internalsend ()
IOProcessor	to_ioprocessor ()
Latent	to_latent ()
PeakMeter	to_meter ()
MonitorProcessor	to_monitorprocessor ()
PeakMeter	to_peakmeter ()
PluginInsert	to_plugininsert ()
PolarityProcessor	to_polarityprocessor ()
Send	to_send ()
SideChain	to_sidechain ()
UnknownProcessor	to_unknownprocessor ()

Inherited from ARDOUR:SessionObjectPtr

Methods
std::string	name ()
Cast
Stateful	to_stateful ()
StatefulDestructible	to_statefuldestructible ()

↠ ARDOUR:Route

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

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

Methods
bool	active ()
int	add_foldback_send (Route, bool)
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. index Index to add the processor at, or -1 to add at the end of the list. Returns 0 on success, non-0 on failure.
bool	add_sidechain (Processor)
Amp	amp ()
std::string	comment ()
bool	customize_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
DataType	data_type ()
IO	input ()
bool	isnil ()
Delivery	main_outs ()
	the signal processorat at end of the processing chain which produces output
bool	muted ()
ChanCount	n_inputs ()
ChanCount	n_outputs ()
Processor	nth_plugin (unsigned int)
Processor	nth_processor (unsigned int)
Processor	nth_send (unsigned int)
IO	output ()
PannerShell	panner_shell ()
PeakMeter	peak_meter ()
	*********************************************************** Pure interface begins here***********************************************************
long	playback_latency (bool)
int	remove_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
int	remove_processors (ProcessorList, ProcessorStreams)
bool	remove_sidechain (Processor)
int	reorder_processors (ProcessorList, ProcessorStreams)
int	replace_processor (Processor, Processor, ProcessorStreams)
	replace plugin/processor with another old processor to remove sub processor to substitute the old one with err error report (index where removal vailed, channel-count why it failed) may be nil Returns 0 on success
bool	reset_plugin_insert (Processor)
	reset plugin-insert configuration to default, disable customizations. This is equivalent to calling customize_plugin_insert (proc, 0, unused) proc Processor to reset Returns true if successful
void	set_active (bool, void*)
void	set_comment (std::string, void*)
void	set_meter_point (MeterPoint)
bool	set_name (std::string)
bool	set_strict_io (bool)
long	signal_latency ()
bool	soloed ()
bool	strict_io ()
Processor	the_instrument ()
	Return the first processor that accepts has at least one MIDI input and at least one audio output. In the vast majority of cases, this will be "the instrument". This does not preclude other MIDI->audio processors later in the processing chain, but that would be a special case not covered by this utility function.
Amp	trim ()
Cast
Track	to_track ()

Inherited from ARDOUR:Stripable

Methods
AutomationControl	comp_enable_controllable ()
AutomationControl	comp_makeup_controllable ()
AutomationControl	comp_mode_controllable ()
std::string	comp_mode_name (unsigned int)
ReadOnlyControl	comp_redux_controllable ()
AutomationControl	comp_speed_controllable ()
std::string	comp_speed_name (unsigned int)
AutomationControl	comp_threshold_controllable ()
unsigned int	eq_band_cnt ()
std::string	eq_band_name (unsigned int)
AutomationControl	eq_enable_controllable ()
AutomationControl	eq_freq_controllable (unsigned int)
AutomationControl	eq_gain_controllable (unsigned int)
AutomationControl	eq_q_controllable (unsigned int)
AutomationControl	eq_shape_controllable (unsigned int)
AutomationControl	filter_enable_controllable (bool)
AutomationControl	filter_freq_controllable (bool)
AutomationControl	filter_slope_controllable (bool)
GainControl	gain_control ()
bool	is_auditioner ()
bool	is_hidden ()
bool	is_master ()
bool	is_monitor ()
bool	is_private_route ()
bool	is_selected ()
AutomationControl	master_send_enable_controllable ()
MonitorProcessor	monitor_control ()
MuteControl	mute_control ()
AutomationControl	pan_azimuth_control ()
AutomationControl	pan_elevation_control ()
AutomationControl	pan_frontback_control ()
AutomationControl	pan_lfe_control ()
AutomationControl	pan_width_control ()
PhaseControl	phase_control ()
PresentationInfo	presentation_info_ptr ()
AutomationControl	rec_enable_control ()
AutomationControl	rec_safe_control ()
AutomationControl	send_enable_controllable (unsigned int)
AutomationControl	send_level_controllable (unsigned int)
std::string	send_name (unsigned int)
AutomationControl	send_pan_azimuth_controllable (unsigned int)
AutomationControl	send_pan_azimuth_enable_controllable (unsigned int)
void	set_presentation_order (unsigned int)
bool	slaved ()
bool	slaved_to (VCA)
SoloControl	solo_control ()
SoloIsolateControl	solo_isolate_control ()
SoloSafeControl	solo_safe_control ()
GainControl	trim_control ()
Cast
Automatable	to_automatable ()
Route	to_route ()
Slavable	to_slavable ()
VCA	to_vca ()

Inherited from ARDOUR:SessionObjectPtr

Methods
std::string	name ()
Cast
Stateful	to_stateful ()
StatefulDestructible	to_statefuldestructible ()

∁ ARDOUR:Route:ProcessorStreams

C‡: ARDOUR::Route::ProcessorStreams

A record of the stream configuration at some point in the processor list. Used to return where and why an processor list configuration request failed.

Constructor
ℂ	ARDOUR.Route.ProcessorStreams ()

∁ ARDOUR:RouteGroup

C‡: ARDOUR::RouteGroup

is-a: ARDOUR:SessionObject

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.

Methods
int	add (Route)
	Add a route to a group. Adding a route which is already in the group is allowed; nothing will happen. r Route to add.
void	clear ()
void	destroy_subgroup ()
bool	empty ()
int	group_master_number ()
bool	has_subgroup ()
bool	is_active ()
bool	is_color ()
bool	is_gain ()
bool	is_hidden ()
bool	is_monitoring ()
bool	is_mute ()
bool	is_recenable ()
bool	is_relative ()
bool	is_route_active ()
bool	is_select ()
bool	is_solo ()
void	make_subgroup (bool, Placement)
int	remove (Route)
unsigned int	rgba ()
RouteListPtr	route_list ()
void	set_active (bool, void*)
void	set_color (bool)
void	set_gain (bool)
void	set_hidden (bool, void*)
void	set_monitoring (bool)
void	set_mute (bool)
void	set_recenable (bool)
void	set_relative (bool, void*)
void	set_rgba (unsigned int)
	set route-group color and notify UI about change
void	set_route_active (bool)
void	set_select (bool)
void	set_solo (bool)
unsigned long	size ()

Inherited from ARDOUR:SessionObject

Methods
std::string	name ()
Cast
Stateful	to_stateful ()

∁ ARDOUR:RouteGroupList

C‡: std::list<ARDOUR::RouteGroup* >

Constructor
ℂ	ARDOUR.RouteGroupList ()
Methods
RouteGroup	back ()
bool	empty ()
RouteGroup	front ()
LuaIter	iter ()
void	reverse ()
unsigned long	size ()
LuaTable	table ()

∁ ARDOUR:RouteList

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

Constructor
ℂ	ARDOUR.RouteList ()
Methods
Route	back ()
bool	empty ()
Route	front ()
LuaIter	iter ()
void	reverse ()
unsigned long	size ()
LuaTable	table ()

∁ ARDOUR:RouteListPtr

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

Constructor
ℂ	ARDOUR.RouteListPtr ()
Methods
LuaTable	add (LuaTable {Route})
bool	empty ()
LuaIter	iter ()
void	push_back (Route)
void	reverse ()
unsigned long	size ()
LuaTable	table ()
void	unique ()

↠ ARDOUR:Send

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

is-a: ARDOUR:Delivery

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

Methods
GainControl	gain_control ()
long	get_delay_in ()
long	get_delay_out ()
bool	is_foldback ()
bool	isnil ()
Cast
InternalSend	to_internalsend ()

Inherited from ARDOUR:Delivery

Methods
PannerShell	panner_shell ()

Inherited from ARDOUR:IOProcessor

Methods
IO	input ()
ChanCount	natural_input_streams ()
ChanCount	natural_output_streams ()
IO	output ()

Inherited from ARDOUR:Processor

Methods
void	activate ()
bool	active ()
long	capture_offset ()
void	deactivate ()
std::string	display_name ()
bool	display_to_user ()
long	input_latency ()
ChanCount	input_streams ()
long	output_latency ()
ChanCount	output_streams ()
long	playback_offset ()
long	signal_latency ()
Cast
Amp	to_amp ()
Automatable	to_automatable ()
DelayLine	to_delayline ()
DiskIOProcessor	to_diskioprocessor ()
DiskReader	to_diskreader ()
DiskWriter	to_diskwriter ()
PluginInsert	to_insert ()
InternalSend	to_internalsend ()
IOProcessor	to_ioprocessor ()
Latent	to_latent ()
PeakMeter	to_meter ()
MonitorProcessor	to_monitorprocessor ()
PeakMeter	to_peakmeter ()
PluginInsert	to_plugininsert ()
PolarityProcessor	to_polarityprocessor ()
Send	to_send ()
SideChain	to_sidechain ()
UnknownProcessor	to_unknownprocessor ()

Inherited from ARDOUR:SessionObjectPtr

Methods
std::string	name ()
Cast
Stateful	to_stateful ()
StatefulDestructible	to_statefuldestructible ()

∁ ARDOUR:Session

C‡: ARDOUR::Session

Ardour Session

Methods
void	abort_reversible_command ()
	abort an open undo command This must only be called after begin_reversible_command ()
bool	actively_recording ()
double	actual_speed ()
void	add_command (Command)
void	add_internal_send (Route, Processor, Route)
void	add_internal_sends (Route, Placement, RouteListPtr)
int	add_master_bus (ChanCount)
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. sfd the object to diff 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() cmd_name human readable name for the undo operation
void	cancel_all_solo ()
SessionConfiguration	cfg ()
void	clear_all_solo_state (RouteListPtr)
void	commit_reversible_command (Command)
	finalize an undo command and commit pending transactions This must only be called after begin_reversible_command () cmd (additional) command to add
Controllable	controllable_by_id (ID)
long	current_end_sample ()
long	current_start_sample ()
void	disable_record (bool, bool)
AudioEngine	engine ()
double	engine_speed ()
bool	export_track_state (RouteListPtr, std::string)
unsigned int	get_block_size ()
bool	get_play_loop ()
Route	get_remote_nth_route (unsigned int)
Stripable	get_remote_nth_stripable (unsigned int, Flag)
RouteList	get_routelist (bool, Flag)
RouteListPtr	get_routes ()
BufferSet	get_scratch_buffers (ChanCount, bool)
BufferSet	get_silent_buffers (ChanCount)
StripableList	get_stripables ()
RouteListPtr	get_tracks ()
unsigned int	get_xrun_count ()
void	goto_end ()
void	goto_start (bool)
long	last_transport_start ()
bool	listening ()
Locations	locations ()
Route	master_out ()
void	maybe_enable_record (bool)
Route	monitor_out ()
std::string	name ()
RouteList	new_audio_route (int, int, RouteGroup, unsigned int, std::string, Flag, unsigned int)
AudioTrackList	new_audio_track (int, int, RouteGroup, unsigned int, std::string, unsigned int, TrackMode, bool)
RouteList	new_midi_route (RouteGroup, unsigned int, std::string, bool, PluginInfo, PresetRecord, Flag, unsigned int)
MidiTrackList	new_midi_track (ChanCount, ChanCount, bool, PluginInfo, PresetRecord, RouteGroup, unsigned int, std::string, unsigned int, TrackMode, bool)
RouteList	new_route_from_template (unsigned int, unsigned int, std::string, std::string, PlaylistDisposition)
RouteGroup	new_route_group (std::string)
long	nominal_sample_rate ()
	"native" sample rate of session, regardless of current audioengine rate, pullup/down etc
std::string	path ()
SessionPlaylists	playlists ()
bool	plot_process_graph (std::string)
Processor	processor_by_id (ID)
RecordState	record_status ()
void	remove_route_group (RouteGroup)
void	request_bounded_roll (long, long)
void	request_locate (long, LocateTransportDisposition, TransportRequestSource)
void	request_play_loop (bool, bool)
void	request_stop (bool, bool, TransportRequestSource)
void	request_transport_speed (double, bool, TransportRequestSource)
void	reset_xrun_count ()
Route	route_by_id (ID)
Route	route_by_name (std::string)
Route	route_by_selected_count (unsigned int)
RouteGroupList	route_groups ()
long	sample_rate ()
	"actual" sample rate of session, set by current audioengine rate, pullup/down etc.
...	sample_to_timecode_lua (--lua--)
double	samples_per_timecode_frame ()
int	save_state (std::string, bool, bool, 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) for_archive save only data relevant for session-archive only_used_assets skip Sources that are not used, mainly useful with `for_archive` Returns zero on success
void	scripts_changed ()
bool	session_range_is_free ()
void	set_control (AutomationControl, double, GroupControlDisposition)
void	set_controls (ControlListPtr, double, GroupControlDisposition)
void	set_dirty ()
void	set_exclusive_input_active (RouteListPtr, bool, bool)
void	set_session_range_is_free (bool)
std::string	snap_name ()
bool	solo_isolated ()
bool	soloing ()
Source	source_by_id (ID)
Stripable	stripable_by_id (ID)
TempoMap	tempo_map ()
bool	timecode_drop_frames ()
long	timecode_frames_per_hour ()
double	timecode_frames_per_second ()
...	timecode_to_sample_lua (--lua--)
bool	transport_rolling ()
	Returns true if the the transport is actively (audible) rolling. playback speed is not zero, and count-in as well as latency-preroll is complete, and _transport_sample changes every process cycle.
long	transport_sample ()
double	transport_speed ()
bool	transport_state_rolling ()
	Returns true if the transport state (TFSM) is rolling. Note: the transport may not yet move if pre-roll or count-in in ongoing.
bool	transport_stopped ()
	Returns true if the transport state (TFSM) is stopped
bool	transport_stopped_or_stopping ()
	Returns true if the transport state (TFSM) is stopped or stopping
bool	transport_will_roll_forwards ()
StringList	unknown_processors ()
VCAManager	vca_manager ()
long	worst_input_latency ()
long	worst_latency_preroll ()
long	worst_output_latency ()
long	worst_route_latency ()

∁ ARDOUR:SessionConfiguration

C‡: ARDOUR::SessionConfiguration

is-a: PBD:Configuration

Base class for objects with saveable and undoable state

Methods
std::string	get_audio_search_path ()
bool	get_auto_input ()
bool	get_auto_play ()
bool	get_auto_return ()
bool	get_count_in ()
bool	get_external_sync ()
bool	get_glue_new_markers_to_bars_and_beats ()
bool	get_glue_new_regions_to_bars_and_beats ()
InsertMergePolicy	get_insert_merge_policy ()
bool	get_jack_time_master ()
bool	get_layered_record_mode ()
unsigned int	get_meterbridge_label_height ()
bool	get_midi_copy_is_fork ()
std::string	get_midi_search_path ()
long	get_minitimeline_span ()
SampleFormat	get_native_file_data_format ()
HeaderFormat	get_native_file_header_format ()
bool	get_punch_in ()
bool	get_punch_out ()
std::string	get_raid_path ()
bool	get_realtime_export ()
MonitorChoice	get_session_monitoring ()
bool	get_show_busses_on_meterbridge ()
bool	get_show_group_tabs ()
bool	get_show_master_on_meterbridge ()
bool	get_show_midi_on_meterbridge ()
bool	get_show_monitor_on_meterbridge ()
bool	get_show_mute_on_meterbridge ()
bool	get_show_name_on_meterbridge ()
bool	get_show_rec_on_meterbridge ()
bool	get_show_region_fades ()
bool	get_show_solo_on_meterbridge ()
bool	get_show_summary ()
std::string	get_slave_timecode_offset ()
unsigned int	get_subframes_per_frame ()
std::string	get_take_name ()
TimecodeFormat	get_timecode_format ()
std::string	get_timecode_generator_offset ()
long	get_timecode_offset ()
bool	get_timecode_offset_negative ()
bool	get_track_name_number ()
bool	get_track_name_take ()
bool	get_use_monitor_fades ()
bool	get_use_region_fades ()
bool	get_use_transport_fades ()
bool	get_use_video_file_fps ()
bool	get_use_video_sync ()
float	get_video_pullup ()
bool	get_videotimeline_pullup ()
double	get_wave_amplitude_zoom ()
unsigned short	get_wave_zoom_factor ()
bool	set_audio_search_path (std::string)
bool	set_auto_input (bool)
bool	set_auto_play (bool)
bool	set_auto_return (bool)
bool	set_count_in (bool)
bool	set_external_sync (bool)
bool	set_glue_new_markers_to_bars_and_beats (bool)
bool	set_glue_new_regions_to_bars_and_beats (bool)
bool	set_insert_merge_policy (InsertMergePolicy)
bool	set_jack_time_master (bool)
bool	set_layered_record_mode (bool)
bool	set_meterbridge_label_height (unsigned int)
bool	set_midi_copy_is_fork (bool)
bool	set_midi_search_path (std::string)
bool	set_minitimeline_span (long)
bool	set_native_file_data_format (SampleFormat)
bool	set_native_file_header_format (HeaderFormat)
bool	set_punch_in (bool)
bool	set_punch_out (bool)
bool	set_raid_path (std::string)
bool	set_realtime_export (bool)
bool	set_session_monitoring (MonitorChoice)
bool	set_show_busses_on_meterbridge (bool)
bool	set_show_group_tabs (bool)
bool	set_show_master_on_meterbridge (bool)
bool	set_show_midi_on_meterbridge (bool)
bool	set_show_monitor_on_meterbridge (bool)
bool	set_show_mute_on_meterbridge (bool)
bool	set_show_name_on_meterbridge (bool)
bool	set_show_rec_on_meterbridge (bool)
bool	set_show_region_fades (bool)
bool	set_show_solo_on_meterbridge (bool)
bool	set_show_summary (bool)
bool	set_slave_timecode_offset (std::string)
bool	set_subframes_per_frame (unsigned int)
bool	set_take_name (std::string)
bool	set_timecode_format (TimecodeFormat)
bool	set_timecode_generator_offset (std::string)
bool	set_timecode_offset (long)
bool	set_timecode_offset_negative (bool)
bool	set_track_name_number (bool)
bool	set_track_name_take (bool)
bool	set_use_monitor_fades (bool)
bool	set_use_region_fades (bool)
bool	set_use_transport_fades (bool)
bool	set_use_video_file_fps (bool)
bool	set_use_video_sync (bool)
bool	set_video_pullup (float)
bool	set_videotimeline_pullup (bool)
bool	set_wave_amplitude_zoom (double)
bool	set_wave_zoom_factor (unsigned short)
Properties
std::string	audio_search_path
bool	auto_input
bool	auto_play
bool	auto_return
bool	count_in
bool	external_sync
bool	glue_new_markers_to_bars_and_beats
bool	glue_new_regions_to_bars_and_beats
ARDOUR.InsertMergePolicy	insert_merge_policy
bool	jack_time_master
bool	layered_record_mode
unsigned int	meterbridge_label_height
bool	midi_copy_is_fork
std::string	midi_search_path
long	minitimeline_span
ARDOUR.SampleFormat	native_file_data_format
ARDOUR.HeaderFormat	native_file_header_format
bool	punch_in
bool	punch_out
std::string	raid_path
bool	realtime_export
ARDOUR.MonitorChoice	session_monitoring
bool	show_busses_on_meterbridge
bool	show_group_tabs
bool	show_master_on_meterbridge
bool	show_midi_on_meterbridge
bool	show_monitor_on_meterbridge
bool	show_mute_on_meterbridge
bool	show_name_on_meterbridge
bool	show_rec_on_meterbridge
bool	show_region_fades
bool	show_solo_on_meterbridge
bool	show_summary
std::string	slave_timecode_offset
unsigned int	subframes_per_frame
std::string	take_name
Timecode.TimecodeFormat	timecode_format
std::string	timecode_generator_offset
long	timecode_offset
bool	timecode_offset_negative
bool	track_name_number
bool	track_name_take
bool	use_monitor_fades
bool	use_region_fades
bool	use_transport_fades
bool	use_video_file_fps
bool	use_video_sync
float	video_pullup
bool	videotimeline_pullup
double	wave_amplitude_zoom
unsigned short	wave_zoom_factor

Inherited from PBD:Stateful

Methods
void	clear_changes ()
	Forget about any changes to this object's properties
ID	id ()
OwnedPropertyList	properties ()

∁ ARDOUR:SessionObject

C‡: 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
std::string	name ()
Cast
Stateful	to_stateful ()

↠ ARDOUR:SessionObjectPtr

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

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

Methods
bool	isnil ()
std::string	name ()
Cast
Stateful	to_stateful ()
StatefulDestructible	to_statefuldestructible ()

↠ ARDOUR:SessionPlaylists

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

Methods
Playlist	by_id (ID)
Playlist	by_name (std::string)
PlaylistList	get_unused ()
PlaylistList	get_used ()
bool	isnil ()
unsigned int	n_playlists ()
PlaylistList	playlists_for_track (Track)
	Returns list of Playlists that are associated with a track
unsigned int	region_use_count (Region)
unsigned int	source_use_count (Source)

↠ ARDOUR:SideChain

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

is-a: ARDOUR:IOProcessor

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

Methods
bool	isnil ()

Inherited from ARDOUR:IOProcessor

Methods
IO	input ()
ChanCount	natural_input_streams ()
ChanCount	natural_output_streams ()
IO	output ()

Inherited from ARDOUR:Processor

Methods
void	activate ()
bool	active ()
long	capture_offset ()
void	deactivate ()
std::string	display_name ()
bool	display_to_user ()
long	input_latency ()
ChanCount	input_streams ()
long	output_latency ()
ChanCount	output_streams ()
long	playback_offset ()
long	signal_latency ()
Cast
Amp	to_amp ()
Automatable	to_automatable ()
DelayLine	to_delayline ()
DiskIOProcessor	to_diskioprocessor ()
DiskReader	to_diskreader ()
DiskWriter	to_diskwriter ()
PluginInsert	to_insert ()
InternalSend	to_internalsend ()
IOProcessor	to_ioprocessor ()
Latent	to_latent ()
PeakMeter	to_meter ()
MonitorProcessor	to_monitorprocessor ()
PeakMeter	to_peakmeter ()
PluginInsert	to_plugininsert ()
PolarityProcessor	to_polarityprocessor ()
Send	to_send ()
SideChain	to_sidechain ()
UnknownProcessor	to_unknownprocessor ()

Inherited from ARDOUR:SessionObjectPtr

Methods
std::string	name ()
Cast
Stateful	to_stateful ()
StatefulDestructible	to_statefuldestructible ()

↠ ARDOUR:Slavable

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

Methods
void	assign (VCA)
bool	assigned_to (VCAManager, VCA)
	recursively test for master assignment to given VCA
bool	isnil ()
VCAVector	masters (VCAManager)
void	unassign (VCA)

↠ 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
void	add_master (AutomationControl)
void	clear_masters ()
int	get_boolean_masters ()
double	get_masters_value ()
bool	isnil ()
void	remove_master (AutomationControl)
bool	slaved ()
bool	slaved_to (AutomationControl)

Inherited from ARDOUR:AutomationControl

Methods
AutomationList	alist ()
AutoState	automation_state ()
ParameterDescriptor	desc ()
double	get_value ()
	Get `internal' value Returns raw value as used for the plugin/processor control port
double	lower ()
double	normal ()
void	set_automation_state (AutoState)
void	set_value (double, GroupControlDisposition)
	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. value raw numeric value to set group_override if and how to propagate value to grouped controls
void	start_touch (double)
void	stop_touch (double)
bool	toggled ()
double	upper ()
bool	writable ()
Cast
Control	to_ctrl ()
SlavableAutomationControl	to_slavable ()

Inherited from PBD:Controllable

Methods
std::string	name ()

Inherited from PBD:StatefulPtr

Methods
void	clear_changes ()
	Forget about any changes to this object's properties
ID	id ()
OwnedPropertyList	properties ()

↠ 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
bool	can_solo ()
bool	isnil ()
bool	self_soloed ()
bool	soloed ()

Inherited from ARDOUR:SlavableAutomationControl

Methods
void	add_master (AutomationControl)
void	clear_masters ()
int	get_boolean_masters ()
double	get_masters_value ()
void	remove_master (AutomationControl)
bool	slaved ()
bool	slaved_to (AutomationControl)

Inherited from ARDOUR:AutomationControl

Methods
AutomationList	alist ()
AutoState	automation_state ()
ParameterDescriptor	desc ()
double	get_value ()
	Get `internal' value Returns raw value as used for the plugin/processor control port
double	lower ()
double	normal ()
void	set_automation_state (AutoState)
void	set_value (double, GroupControlDisposition)
	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. value raw numeric value to set group_override if and how to propagate value to grouped controls
void	start_touch (double)
void	stop_touch (double)
bool	toggled ()
double	upper ()
bool	writable ()
Cast
Control	to_ctrl ()
SlavableAutomationControl	to_slavable ()

Inherited from PBD:Controllable

Methods
std::string	name ()

Inherited from PBD:StatefulPtr

Methods
void	clear_changes ()
	Forget about any changes to this object's properties
ID	id ()
OwnedPropertyList	properties ()

↠ 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
bool	isnil ()
bool	self_solo_isolated ()
bool	solo_isolated ()

Inherited from ARDOUR:SlavableAutomationControl

Methods
void	add_master (AutomationControl)
void	clear_masters ()
int	get_boolean_masters ()
double	get_masters_value ()
void	remove_master (AutomationControl)
bool	slaved ()
bool	slaved_to (AutomationControl)

Inherited from ARDOUR:AutomationControl

Methods
AutomationList	alist ()
AutoState	automation_state ()
ParameterDescriptor	desc ()
double	get_value ()
	Get `internal' value Returns raw value as used for the plugin/processor control port
double	lower ()
double	normal ()
void	set_automation_state (AutoState)
void	set_value (double, GroupControlDisposition)
	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. value raw numeric value to set group_override if and how to propagate value to grouped controls
void	start_touch (double)
void	stop_touch (double)
bool	toggled ()
double	upper ()
bool	writable ()
Cast
Control	to_ctrl ()
SlavableAutomationControl	to_slavable ()

Inherited from PBD:Controllable

Methods
std::string	name ()

Inherited from PBD:StatefulPtr

Methods
void	clear_changes ()
	Forget about any changes to this object's properties
ID	id ()
OwnedPropertyList	properties ()

↠ 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
bool	isnil ()
bool	solo_safe ()

Inherited from ARDOUR:SlavableAutomationControl

Methods
void	add_master (AutomationControl)
void	clear_masters ()
int	get_boolean_masters ()
double	get_masters_value ()
void	remove_master (AutomationControl)
bool	slaved ()
bool	slaved_to (AutomationControl)

Inherited from ARDOUR:AutomationControl

Methods
AutomationList	alist ()
AutoState	automation_state ()
ParameterDescriptor	desc ()
double	get_value ()
	Get `internal' value Returns raw value as used for the plugin/processor control port
double	lower ()
double	normal ()
void	set_automation_state (AutoState)
void	set_value (double, GroupControlDisposition)
	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. value raw numeric value to set group_override if and how to propagate value to grouped controls
void	start_touch (double)
void	stop_touch (double)
bool	toggled ()
double	upper ()
bool	writable ()
Cast
Control	to_ctrl ()
SlavableAutomationControl	to_slavable ()

Inherited from PBD:Controllable

Methods
std::string	name ()

Inherited from PBD:StatefulPtr

Methods
void	clear_changes ()
	Forget about any changes to this object's properties
ID	id ()
OwnedPropertyList	properties ()

↠ ARDOUR:Source

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

is-a: ARDOUR:SessionObjectPtr

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

Methods
std::string	ancestor_name ()
bool	can_be_analysed ()
XrunPositions	captured_xruns ()
bool	empty ()
bool	has_been_analysed ()
bool	isnil ()
long	length (long)
long	natural_position ()
long	timeline_position ()
long	timestamp ()
int	use_count ()
bool	used ()
bool	writable ()
Cast
AudioSource	to_audiosource ()
FileSource	to_filesource ()
MidiSource	to_midisource ()

Inherited from ARDOUR:SessionObjectPtr

Methods
std::string	name ()
Cast
Stateful	to_stateful ()
StatefulDestructible	to_statefuldestructible ()

∁ ARDOUR:SourceList

C‡: std::vector<boost::shared_ptr<ARDOUR::Source> >

Constructor
ℂ	ARDOUR.SourceList ()
ℂ	ARDOUR.SourceList ()
Methods
LuaTable	add (LuaTable {Source})
Source	at (unsigned long)
void	clear ()
bool	empty ()
LuaIter	iter ()
void	push_back (Source)
unsigned long	size ()
LuaTable	table ()
...	to_array (--lua--)

↠ ARDOUR:Stripable

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

is-a: ARDOUR:SessionObjectPtr

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

Methods
AutomationControl	comp_enable_controllable ()
AutomationControl	comp_makeup_controllable ()
AutomationControl	comp_mode_controllable ()
std::string	comp_mode_name (unsigned int)
ReadOnlyControl	comp_redux_controllable ()
AutomationControl	comp_speed_controllable ()
std::string	comp_speed_name (unsigned int)
AutomationControl	comp_threshold_controllable ()
unsigned int	eq_band_cnt ()
std::string	eq_band_name (unsigned int)
AutomationControl	eq_enable_controllable ()
AutomationControl	eq_freq_controllable (unsigned int)
AutomationControl	eq_gain_controllable (unsigned int)
AutomationControl	eq_q_controllable (unsigned int)
AutomationControl	eq_shape_controllable (unsigned int)
AutomationControl	filter_enable_controllable (bool)
AutomationControl	filter_freq_controllable (bool)
AutomationControl	filter_slope_controllable (bool)
GainControl	gain_control ()
bool	is_auditioner ()
bool	is_hidden ()
bool	is_master ()
bool	is_monitor ()
bool	is_private_route ()
bool	is_selected ()
bool	isnil ()
AutomationControl	master_send_enable_controllable ()
MonitorProcessor	monitor_control ()
MuteControl	mute_control ()
AutomationControl	pan_azimuth_control ()
AutomationControl	pan_elevation_control ()
AutomationControl	pan_frontback_control ()
AutomationControl	pan_lfe_control ()
AutomationControl	pan_width_control ()
PhaseControl	phase_control ()
PresentationInfo	presentation_info_ptr ()
AutomationControl	rec_enable_control ()
AutomationControl	rec_safe_control ()
AutomationControl	send_enable_controllable (unsigned int)
AutomationControl	send_level_controllable (unsigned int)
std::string	send_name (unsigned int)
AutomationControl	send_pan_azimuth_controllable (unsigned int)
AutomationControl	send_pan_azimuth_enable_controllable (unsigned int)
void	set_presentation_order (unsigned int)
bool	slaved ()
bool	slaved_to (VCA)
SoloControl	solo_control ()
SoloIsolateControl	solo_isolate_control ()
SoloSafeControl	solo_safe_control ()
GainControl	trim_control ()
Cast
Automatable	to_automatable ()
Route	to_route ()
Slavable	to_slavable ()
VCA	to_vca ()

Inherited from ARDOUR:SessionObjectPtr

Methods
std::string	name ()
Cast
Stateful	to_stateful ()
StatefulDestructible	to_statefuldestructible ()

∁ ARDOUR:StripableList

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

Constructor
ℂ	ARDOUR.StripableList ()
Methods
Stripable	back ()
bool	empty ()
Stripable	front ()
LuaIter	iter ()
void	reverse ()
unsigned long	size ()
LuaTable	table ()

∁ ARDOUR:Tempo

C‡: ARDOUR::Tempo

Tempo, the speed at which musical time progresses (BPM).

Constructor
ℂ	ARDOUR.Tempo (double, double, double)
Methods
double	end_note_types_per_minute ()
double	note_type ()
double	note_types_per_minute ()
double	quarter_notes_per_minute ()
double	samples_per_note_type (long)
	audio samples per note type. if you want an instantaneous value for this, use TempoMap::samples_per_quarter_note_at() instead. sr samplerate
double	samples_per_quarter_note (long)
	audio samples per quarter note. if you want an instantaneous value for this, use TempoMap::samples_per_quarter_note_at() instead. sr samplerate

∁ ARDOUR:TempoMap

C‡: ARDOUR::TempoMap

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

Methods
MeterSection	add_meter (Meter, BBT_TIME, long, PositionLockStyle)
TempoSection	add_tempo (Tempo, double, long, PositionLockStyle)
BBT_TIME	bbt_at_sample (long)
	Returns the BBT time corresponding to the supplied sample position. sample the position in audio samples. Returns the BBT time at the sample position .
double	exact_beat_at_sample (long, int)
double	exact_qn_at_sample (long, int)
Beats	framewalk_to_qn (long, long)
	Count the number of beats that are equivalent to distance when going forward, starting at pos.
MeterSection	meter_section_at_beat (double)
MeterSection	meter_section_at_sample (long)
TempoSection	next_tempo_section (TempoSection)
TempoSection	previous_tempo_section (TempoSection)
long	samplepos_plus_qn (long, Beats)
	Add some (fractional) Beats to a session sample position, and return the result in samples. pos can be -ve, if required.
TempoSection	tempo_section_at_sample (long)

∁ ARDOUR:TempoSection

C‡: ARDOUR::TempoSection

is-a: ARDOUR:MetricSection

A section of timeline with a certain Tempo.

Methods
bool	active ()
double	c ()
bool	clamped ()
bool	locked_to_meter ()
Cast
Tempo	to_tempo ()

Inherited from ARDOUR:MetricSection

Methods
bool	initial ()
bool	is_tempo ()
double	minute ()
double	minute_at_sample (long)
double	pulse ()
long	sample ()
long	sample_at_minute (double)
void	set_pulse (double)

↠ ARDOUR:Track

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

is-a: ARDOUR:Route

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

Specifically a track has a playlist object that describes material to be played from disk, and modifies that object during recording and editing.

Methods
Region	bounce (InterThreadInfo&, std::string)
	bounce track from session start to session end to new region itt asynchronous progress report and cancel Returns a new audio region (or nil in case of error)
Region	bounce_range (long, long, InterThreadInfo&, Processor, bool, std::string)
	Bounce the given range to a new audio region. start start time (in samples) end end time (in samples) itt asynchronous progress report and cancel endpoint the processor to tap the signal off (or nil for the top) include_endpoint include the given processor in the bounced audio. Returns a new audio region (or nil in case of error)
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. 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.
bool	can_record ()
int	find_and_use_playlist (DataType, ID)
bool	isnil ()
Playlist	playlist ()
bool	set_name (std::string)
int	use_copy_playlist ()
int	use_new_playlist (DataType)
int	use_playlist (DataType, Playlist)
Cast
AudioTrack	to_audio_track ()
MidiTrack	to_midi_track ()

Inherited from ARDOUR:Route

Methods
bool	active ()
int	add_foldback_send (Route, bool)
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. index Index to add the processor at, or -1 to add at the end of the list. Returns 0 on success, non-0 on failure.
bool	add_sidechain (Processor)
Amp	amp ()
std::string	comment ()
bool	customize_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
DataType	data_type ()
IO	input ()
Delivery	main_outs ()
	the signal processorat at end of the processing chain which produces output
bool	muted ()
ChanCount	n_inputs ()
ChanCount	n_outputs ()
Processor	nth_plugin (unsigned int)
Processor	nth_processor (unsigned int)
Processor	nth_send (unsigned int)
IO	output ()
PannerShell	panner_shell ()
PeakMeter	peak_meter ()
	*********************************************************** Pure interface begins here***********************************************************
long	playback_latency (bool)
int	remove_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
int	remove_processors (ProcessorList, ProcessorStreams)
bool	remove_sidechain (Processor)
int	reorder_processors (ProcessorList, ProcessorStreams)
int	replace_processor (Processor, Processor, ProcessorStreams)
	replace plugin/processor with another old processor to remove sub processor to substitute the old one with err error report (index where removal vailed, channel-count why it failed) may be nil Returns 0 on success
bool	reset_plugin_insert (Processor)
	reset plugin-insert configuration to default, disable customizations. This is equivalent to calling customize_plugin_insert (proc, 0, unused) proc Processor to reset Returns true if successful
void	set_active (bool, void*)
void	set_comment (std::string, void*)
void	set_meter_point (MeterPoint)
bool	set_strict_io (bool)
long	signal_latency ()
bool	soloed ()
bool	strict_io ()
Processor	the_instrument ()
	Return the first processor that accepts has at least one MIDI input and at least one audio output. In the vast majority of cases, this will be "the instrument". This does not preclude other MIDI->audio processors later in the processing chain, but that would be a special case not covered by this utility function.
Amp	trim ()
Cast
Track	to_track ()

Inherited from ARDOUR:Stripable

Methods
AutomationControl	comp_enable_controllable ()
AutomationControl	comp_makeup_controllable ()
AutomationControl	comp_mode_controllable ()
std::string	comp_mode_name (unsigned int)
ReadOnlyControl	comp_redux_controllable ()
AutomationControl	comp_speed_controllable ()
std::string	comp_speed_name (unsigned int)
AutomationControl	comp_threshold_controllable ()
unsigned int	eq_band_cnt ()
std::string	eq_band_name (unsigned int)
AutomationControl	eq_enable_controllable ()
AutomationControl	eq_freq_controllable (unsigned int)
AutomationControl	eq_gain_controllable (unsigned int)
AutomationControl	eq_q_controllable (unsigned int)
AutomationControl	eq_shape_controllable (unsigned int)
AutomationControl	filter_enable_controllable (bool)
AutomationControl	filter_freq_controllable (bool)
AutomationControl	filter_slope_controllable (bool)
GainControl	gain_control ()
bool	is_auditioner ()
bool	is_hidden ()
bool	is_master ()
bool	is_monitor ()
bool	is_private_route ()
bool	is_selected ()
AutomationControl	master_send_enable_controllable ()
MonitorProcessor	monitor_control ()
MuteControl	mute_control ()
AutomationControl	pan_azimuth_control ()
AutomationControl	pan_elevation_control ()
AutomationControl	pan_frontback_control ()
AutomationControl	pan_lfe_control ()
AutomationControl	pan_width_control ()
PhaseControl	phase_control ()
PresentationInfo	presentation_info_ptr ()
AutomationControl	rec_enable_control ()
AutomationControl	rec_safe_control ()
AutomationControl	send_enable_controllable (unsigned int)
AutomationControl	send_level_controllable (unsigned int)
std::string	send_name (unsigned int)
AutomationControl	send_pan_azimuth_controllable (unsigned int)
AutomationControl	send_pan_azimuth_enable_controllable (unsigned int)
void	set_presentation_order (unsigned int)
bool	slaved ()
bool	slaved_to (VCA)
SoloControl	solo_control ()
SoloIsolateControl	solo_isolate_control ()
SoloSafeControl	solo_safe_control ()
GainControl	trim_control ()
Cast
Automatable	to_automatable ()
Route	to_route ()
Slavable	to_slavable ()
VCA	to_vca ()

Inherited from ARDOUR:SessionObjectPtr

Methods
std::string	name ()
Cast
Stateful	to_stateful ()
StatefulDestructible	to_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
bool	isnil ()

Inherited from ARDOUR:Processor

Methods
void	activate ()
bool	active ()
long	capture_offset ()
void	deactivate ()
std::string	display_name ()
bool	display_to_user ()
long	input_latency ()
ChanCount	input_streams ()
long	output_latency ()
ChanCount	output_streams ()
long	playback_offset ()
long	signal_latency ()
Cast
Amp	to_amp ()
Automatable	to_automatable ()
DelayLine	to_delayline ()
DiskIOProcessor	to_diskioprocessor ()
DiskReader	to_diskreader ()
DiskWriter	to_diskwriter ()
PluginInsert	to_insert ()
InternalSend	to_internalsend ()
IOProcessor	to_ioprocessor ()
Latent	to_latent ()
PeakMeter	to_meter ()
MonitorProcessor	to_monitorprocessor ()
PeakMeter	to_peakmeter ()
PluginInsert	to_plugininsert ()
PolarityProcessor	to_polarityprocessor ()
Send	to_send ()
SideChain	to_sidechain ()
UnknownProcessor	to_unknownprocessor ()

Inherited from ARDOUR:SessionObjectPtr

Methods
std::string	name ()
Cast
Stateful	to_stateful ()
StatefulDestructible	to_statefuldestructible ()

↠ ARDOUR:VCA

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

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

Methods
std::string	full_name ()
GainControl	gain_control ()
bool	isnil ()
MuteControl	mute_control ()
int	number ()
SoloControl	solo_control ()

Inherited from ARDOUR:Stripable

Methods
AutomationControl	comp_enable_controllable ()
AutomationControl	comp_makeup_controllable ()
AutomationControl	comp_mode_controllable ()
std::string	comp_mode_name (unsigned int)
ReadOnlyControl	comp_redux_controllable ()
AutomationControl	comp_speed_controllable ()
std::string	comp_speed_name (unsigned int)
AutomationControl	comp_threshold_controllable ()
unsigned int	eq_band_cnt ()
std::string	eq_band_name (unsigned int)
AutomationControl	eq_enable_controllable ()
AutomationControl	eq_freq_controllable (unsigned int)
AutomationControl	eq_gain_controllable (unsigned int)
AutomationControl	eq_q_controllable (unsigned int)
AutomationControl	eq_shape_controllable (unsigned int)
AutomationControl	filter_enable_controllable (bool)
AutomationControl	filter_freq_controllable (bool)
AutomationControl	filter_slope_controllable (bool)
bool	is_auditioner ()
bool	is_hidden ()
bool	is_master ()
bool	is_monitor ()
bool	is_private_route ()
bool	is_selected ()
AutomationControl	master_send_enable_controllable ()
MonitorProcessor	monitor_control ()
AutomationControl	pan_azimuth_control ()
AutomationControl	pan_elevation_control ()
AutomationControl	pan_frontback_control ()
AutomationControl	pan_lfe_control ()
AutomationControl	pan_width_control ()
PhaseControl	phase_control ()
PresentationInfo	presentation_info_ptr ()
AutomationControl	rec_enable_control ()
AutomationControl	rec_safe_control ()
AutomationControl	send_enable_controllable (unsigned int)
AutomationControl	send_level_controllable (unsigned int)
std::string	send_name (unsigned int)
AutomationControl	send_pan_azimuth_controllable (unsigned int)
AutomationControl	send_pan_azimuth_enable_controllable (unsigned int)
void	set_presentation_order (unsigned int)
bool	slaved ()
bool	slaved_to (VCA)
SoloIsolateControl	solo_isolate_control ()
SoloSafeControl	solo_safe_control ()
GainControl	trim_control ()
Cast
Automatable	to_automatable ()
Route	to_route ()
Slavable	to_slavable ()
VCA	to_vca ()

Inherited from ARDOUR:SessionObjectPtr

Methods
std::string	name ()
Cast
Stateful	to_stateful ()
StatefulDestructible	to_statefuldestructible ()

∁ ARDOUR:VCAList

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

Constructor
ℂ	ARDOUR.VCAList ()
Methods
VCA	back ()
bool	empty ()
VCA	front ()
LuaIter	iter ()
void	reverse ()
unsigned long	size ()
LuaTable	table ()

∁ ARDOUR:VCAManager

C‡: ARDOUR::VCAManager

is-a: PBD:StatefulDestructible

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

Methods
VCAList	create_vca (unsigned int, std::string)
unsigned long	n_vcas ()
void	remove_vca (VCA)
VCA	vca_by_name (std::string)
VCA	vca_by_number (int)
VCAList	vcas ()

Inherited from PBD:Stateful

Methods
void	clear_changes ()
	Forget about any changes to this object's properties
ID	id ()
OwnedPropertyList	properties ()

∁ ARDOUR:VCAVector

C‡: std::vector<boost::shared_ptr<ARDOUR::VCA> >

Constructor
ℂ	ARDOUR.VCAVector ()
Methods
VCA	at (unsigned long)
bool	empty ()
LuaIter	iter ()
unsigned long	size ()
LuaTable	table ()

∁ ARDOUR:WeakAudioSourceList

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

Constructor
ℂ	ARDOUR.WeakAudioSourceList ()
Methods
AudioSource	back ()
bool	empty ()
AudioSource	front ()
LuaIter	iter ()
void	reverse ()
unsigned long	size ()
LuaTable	table ()

∁ ARDOUR:WeakRouteList

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

Constructor
ℂ	ARDOUR.WeakRouteList ()
Methods
Route	back ()
bool	empty ()
Route	front ()
LuaIter	iter ()
void	reverse ()
unsigned long	size ()
LuaTable	table ()

∁ ARDOUR:WeakSourceList

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

Constructor
ℂ	ARDOUR.WeakSourceList ()
Methods
Source	back ()
bool	empty ()
Source	front ()
LuaIter	iter ()
void	reverse ()
unsigned long	size ()
LuaTable	table ()

∁ ARDOUR:XrunPositions

C‡: std::vector<long >

Constructor
ℂ	ARDOUR.XrunPositions ()
ℂ	ARDOUR.XrunPositions ()
Methods
LuaTable	add (LuaTable {long})
long	at (unsigned long)
void	clear ()
bool	empty ()
LuaIter	iter ()
void	push_back (long)
unsigned long	size ()
LuaTable	table ()
...	to_array (--lua--)

ℕ ArdourUI

Methods
LuaTable	actionlist ()
UIConfiguration	config ()
std::string	http_get (std::string)
void	mixer_screenshot (std::string)
ProcessorVector	processor_selection ()
unsigned int	translate_order (InsertAt)

∁ ArdourUI:ArdourMarker

C‡: ArdourMarker

Location Marker

Editor ruler representation of a location marker or range on the timeline.

Methods
std::string	name ()
long	position ()
Type	type ()

∁ ArdourUI:ArdourMarkerList

C‡: std::list<ArdourMarker* >

Constructor
ℂ	ArdourUI.ArdourMarkerList ()
Methods
ArdourMarker	back ()
bool	empty ()
ArdourMarker	front ()
LuaIter	iter ()
...	push_back (--lua--)
void	reverse ()
unsigned long	size ()
LuaTable	table ()
void	unique ()

∅ ArdourUI:AxisView

C‡: AxisView

AxisView defines the abstract base class for horizontal and vertical presentations of Stripables.

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

∁ ArdourUI:Editor

C‡: PublicEditor

This class contains just the public interface of the Editor class, in order to decouple it from the private implementation, so that callers of PublicEditor need not be recompiled if private methods or member variables change.

Methods
void	access_action (std::string, std::string)
void	add_location_from_playhead_cursor ()
void	add_location_mark (long)
TrackViewList	axis_views_from_routes (RouteListPtr)
void	center_screen (long)
void	clear_playlist (Playlist)
void	clear_playlists (RouteUI)
void	consider_auditioning (Region)
	Possibly start the audition of a region. If `r` is 0, or not an AudioRegion any current audition is cancelled. If we are currently auditioning `r` , the audition will be cancelled. Otherwise an audition of `r` will start. r Region to consider auditioning
void	copy_playlists (RouteUI)
MouseMode	current_mouse_mode ()
	Returns The current mouse mode (gain, object, range, timefx etc.) (defined in editing_syms.h)
long	current_page_samples ()
void	deselect_all ()
LuaTable(...)	do_embed (StringVector, ImportDisposition, ImportMode, long&, PluginInfo)
LuaTable(...)	do_import (StringVector, ImportDisposition, ImportMode, SrcQuality, MidiTrackNameSource, MidiTempoMapDisposition, long&, PluginInfo)
	Import existing media
bool	dragging_playhead ()
	Returns true if the playhead is currently being dragged, otherwise false
MouseMode	effective_mouse_mode ()
void	export_audio ()
	Open main export dialog
void	export_range ()
	Open export dialog with current range pre-selected
void	export_selection ()
	Open export dialog with current selection pre-selected
LuaTable(Location, ...)	find_location_from_marker (ArdourMarker, bool&)
ArdourMarker	find_marker_from_location_id (ID, bool)
void	fit_selection ()
bool	follow_playhead ()
	Returns true if the editor is following the playhead
long	get_current_zoom ()
Selection	get_cut_buffer ()
unsigned int	get_grid_beat_divisions (long)
LuaTable(Beats, ...)	get_grid_type_as_beats (bool&, long)
LuaTable(long, ...)	get_nudge_distance (long, long&)
long	get_paste_offset (long, unsigned int, long)
LuaTable(...)	get_pointer_position (double&, double&)
Selection	get_selection ()
LuaTable(bool, ...)	get_selection_extents (long&, long&)
bool	get_smart_mode ()
StripableTimeAxisView	get_stripable_time_axis_by_id (ID)
TrackViewList	get_track_views ()
int	get_videotl_bar_height ()
double	get_y_origin ()
ZoomFocus	get_zoom_focus ()
void	goto_nth_marker (int)
GridType	grid_type ()
void	hide_track_in_display (TimeAxisView, bool)
long	leftmost_sample ()
void	maximise_editing_space ()
void	maybe_locate_with_edit_preroll (long)
void	mouse_add_new_marker (long, bool)
void	new_playlists (RouteUI)
void	new_region_from_selection ()
void	override_visible_track_count ()
long	pixel_to_sample (double)
void	play_selection ()
void	play_with_preroll ()
void	redo (unsigned int)
	Redo some transactions. n Number of transaction to redo.
RegionView	regionview_from_region (Region)
void	remove_last_capture ()
void	remove_location_at_playhead_cursor ()
void	remove_tracks ()
void	reset_x_origin (long)
void	reset_y_origin (double)
void	reset_zoom (long)
void	restore_editing_space ()
RouteTimeAxisView	rtav_from_route (Route)
double	sample_to_pixel (long)
bool	scroll_down_one_track (bool)
void	scroll_tracks_down_line ()
void	scroll_tracks_up_line ()
bool	scroll_up_one_track (bool)
void	select_all_tracks ()
void	select_all_visible_lanes ()
void	separate_region_from_selection ()
void	set_follow_playhead (bool, bool)
	Set whether the editor should follow the playhead. yn true to follow playhead, otherwise false. catch_up true to reset the editor view to show the playhead (if yn == true), otherwise false.
void	set_loop_range (long, long, std::string)
void	set_mouse_mode (MouseMode, bool)
	Set the mouse mode (gain, object, range, timefx etc.) m Mouse mode (defined in editing_syms.h) force Perform the effects of the change even if no change is required (ie even if the current mouse mode is equal to
void	set_punch_range (long, long, std::string)
void	set_selection (SelectionList, Operation)
void	set_snap_mode (SnapMode)
	Set the snap mode. m Snap mode (defined in editing_syms.h)
void	set_stationary_playhead (bool)
void	set_toggleaction (std::string, std::string, bool)
void	set_video_timeline_height (int)
void	set_visible_track_count (int)
void	set_zoom_focus (ZoomFocus)
void	show_track_in_display (TimeAxisView, bool)
SnapMode	snap_mode ()
bool	stationary_playhead ()
void	stem_export ()
	Open stem export dialog
void	temporal_zoom_step (bool)
void	toggle_meter_updating ()
void	toggle_ruler_video (bool)
void	toggle_xjadeo_proc (int)
void	undo (unsigned int)
	Undo some transactions. n Number of transactions to undo.
void	update_grid ()
double	visible_canvas_height ()

∅ ArdourUI:MarkerSelection

C‡: MarkerSelection

is-a: ArdourUI:ArdourMarkerList

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

Inherited from ArdourUI:ArdourMarkerList

Constructor
ℂ	ArdourUI.ArdourMarkerList ()
Methods
ArdourMarker	back ()
bool	empty ()
ArdourMarker	front ()
LuaIter	iter ()
...	push_back (--lua--)
void	reverse ()
unsigned long	size ()
LuaTable	table ()
void	unique ()

∁ ArdourUI:RegionSelection

C‡: RegionSelection

Class to represent list of selected regions.

Methods
long	end_sample ()
unsigned long	n_midi_regions ()
RegionList	regionlist ()
long	start ()

∅ ArdourUI:RegionView

C‡: RegionView

is-a: ArdourUI:TimeAxisViewItem

Base class for items that may appear upon a TimeAxisView.

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

∁ ArdourUI:RouteTimeAxisView

C‡: RouteTimeAxisView

is-a: ArdourUI:RouteUI

Base class for objects with auto-disconnection. trackable must be inherited when objects shall automatically invalidate slots referring to them on destruction. A slot built from a member function of a trackable derived type installs a callback that is invoked when the trackable object is destroyed or overwritten.

add_destroy_notify_callback() and remove_destroy_notify_callback() can be used to manually install and remove callbacks when notification of the object dying is needed.

notify_callbacks() invokes and removes all previously installed callbacks and can therefore be used to disconnect from all signals.

Note that there is no virtual destructor. Don't use trackable* as pointer type for managing your data or the destructors of your derived types won't be called when deleting your objects.

 signal

Cast
StripableTimeAxisView	to_stripabletimeaxisview ()
TimeAxisView	to_timeaxisview ()

∅ ArdourUI:RouteUI

C‡: RouteUI

is-a: ArdourUI:Selectable

add_destroy_notify_callback() and remove_destroy_notify_callback() can be used to manually install and remove callbacks when notification of the object dying is needed.

notify_callbacks() invokes and removes all previously installed callbacks and can therefore be used to disconnect from all signals.

Note that there is no virtual destructor. Don't use trackable* as pointer type for managing your data or the destructors of your derived types won't be called when deleting your objects.

 signal

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

∅ ArdourUI:Selectable

C‡: Selectable

add_destroy_notify_callback() and remove_destroy_notify_callback() can be used to manually install and remove callbacks when notification of the object dying is needed.

notify_callbacks() invokes and removes all previously installed callbacks and can therefore be used to disconnect from all signals.

Note that there is no virtual destructor. Don't use trackable* as pointer type for managing your data or the destructors of your derived types won't be called when deleting your objects.

 signal

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

∁ ArdourUI:Selection

C‡: Selection

The Selection class holds lists of selected items (tracks, regions, etc. etc.).

Methods
void	clear ()
	Clear everything from the Selection
void	clear_all ()
bool	empty (bool)
	check if all selections are empty internal_selection also check object internals (e.g midi notes, automation points), when false only check objects. Returns true if nothing is selected.
Data Members
ArdourUI:MarkerSelection	markers
ArdourUI:RegionSelection	regions
ArdourUI:TimeSelection	time
ArdourUI:TrackSelection	tracks

∁ ArdourUI:SelectionList

C‡: std::list<Selectable* >

Constructor
ℂ	ArdourUI.SelectionList ()
Methods
Selectable	back ()
bool	empty ()
Selectable	front ()
LuaIter	iter ()
...	push_back (--lua--)
void	reverse ()
unsigned long	size ()
LuaTable	table ()
void	unique ()

∅ ArdourUI:StripableTimeAxisView

C‡: StripableTimeAxisView

is-a: ArdourUI:TimeAxisView

Abstract base class for time-axis views (horizontal editor 'strips')

This class provides the basic LHS controls and display methods. This should be extended to create functional time-axis based views.

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

Inherited from ArdourUI:TimeAxisView

Methods
unsigned int	current_height ()
unsigned int	effective_height ()
	Returns effective height (taking children into account) in canvas units, or 0 if this TimeAxisView has not yet been shown
int	order ()
	Returns index of this TimeAxisView within its parent
void	set_height (unsigned int, TrackHeightMode)
double	y_position ()
	Returns y position, or -1 if hidden

∁ ArdourUI:TimeAxisView

C‡: TimeAxisView

is-a: ArdourUI:AxisView

Abstract base class for time-axis views (horizontal editor 'strips')

This class provides the basic LHS controls and display methods. This should be extended to create functional time-axis based views.

Methods
unsigned int	current_height ()
unsigned int	effective_height ()
	Returns effective height (taking children into account) in canvas units, or 0 if this TimeAxisView has not yet been shown
int	order ()
	Returns index of this TimeAxisView within its parent
void	set_height (unsigned int, TrackHeightMode)
double	y_position ()
	Returns y position, or -1 if hidden

∅ ArdourUI:TimeAxisViewItem

C‡: TimeAxisViewItem

is-a: ArdourUI:Selectable

Base class for items that may appear upon a TimeAxisView.

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

∁ ArdourUI:TimeSelection

C‡: TimeSelection

is-a: ARDOUR:AudioRangeList

Methods
long	end_sample ()
long	length ()
long	start ()

Inherited from ARDOUR:AudioRangeList

Constructor
ℂ	ARDOUR.AudioRangeList ()
Methods
AudioRange	back ()
bool	empty ()
AudioRange	front ()
LuaIter	iter ()
void	reverse ()
unsigned long	size ()
LuaTable	table ()

∅ ArdourUI:TrackSelection

C‡: TrackSelection

is-a: ArdourUI:TrackViewList

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

Inherited from ArdourUI:TrackViewList

Methods
bool	contains (TimeAxisView)
RouteList	routelist ()
Cast
TrackViewStdList	to_tav_list ()

∁ ArdourUI:TrackViewList

C‡: TrackViewList

Methods
bool	contains (TimeAxisView)
RouteList	routelist ()
Cast
TrackViewStdList	to_tav_list ()

∁ ArdourUI:TrackViewStdList

C‡: std::list<TimeAxisView* >

Constructor
ℂ	ArdourUI.TrackViewStdList ()
Methods
TimeAxisView	back ()
bool	empty ()
TimeAxisView	front ()
LuaIter	iter ()
void	reverse ()
unsigned long	size ()
LuaTable	table ()

∁ ArdourUI:UIConfiguration

C‡: UIConfiguration

Base class for objects with saveable and undoable state

Methods
unsigned int	get_action_table_columns ()
bool	get_all_floating_windows_are_dialogs ()
bool	get_allow_non_quarter_pulse ()
bool	get_autoplay_files ()
bool	get_autoscroll_editor ()
bool	get_blink_alert_indicators ()
bool	get_blink_rec_arm ()
bool	get_boxy_buttons ()
bool	get_buggy_gradients ()
bool	get_cairo_image_surface ()
unsigned long	get_clock_display_limit ()
std::string	get_color_file ()
bool	get_color_regions_using_track_color ()
std::string	get_default_bindings ()
bool	get_default_narrow_ms ()
bool	get_draggable_playhead ()
float	get_draggable_playhead_speed ()
bool	get_editor_stereo_only_meters ()
float	get_extra_ui_extents_time ()
bool	get_flat_buttons ()
bool	get_floating_monitor_section ()
bool	get_follow_edits ()
int	get_font_scale ()
bool	get_grid_follows_internal ()
bool	get_hiding_groups_deactivates_groups ()
std::string	get_icon_set ()
std::string	get_keyboard_layout ()
std::string	get_keyboard_layout_name ()
bool	get_link_region_and_track_selection ()
unsigned int	get_lock_gui_after_seconds ()
unsigned int	get_max_inline_controls ()
int	get_max_plugin_chart ()
int	get_max_plugin_recent ()
float	get_meter_hold ()
MeterLineUp	get_meter_line_up_din ()
MeterLineUp	get_meter_line_up_level ()
float	get_meter_peak ()
bool	get_meter_style_led ()
VUMeterStandard	get_meter_vu_standard ()
std::string	get_mixer_strip_visibility ()
bool	get_name_new_markers ()
bool	get_never_display_periodic_midi ()
bool	get_new_automation_points_on_lane ()
bool	get_no_new_session_dialog ()
bool	get_only_copy_imported_files ()
bool	get_open_gui_after_adding_plugin ()
bool	get_prefer_inline_over_gui ()
bool	get_preview_video_frame_on_drag ()
ClockDeltaMode	get_primary_clock_delta_mode ()
int	get_recent_session_sort ()
bool	get_rubberbanding_snaps_to_grid ()
unsigned int	get_ruler_granularity ()
bool	get_rulers_follow_grid ()
bool	get_save_export_analysis_image ()
bool	get_save_export_mixer_screenshot ()
ScreenSaverMode	get_screen_saver_mode ()
ClockDeltaMode	get_secondary_clock_delta_mode ()
bool	get_show_editor_meter ()
bool	get_show_grids_ruler ()
bool	get_show_inline_display_by_default ()
bool	get_show_mini_timeline ()
bool	get_show_name_highlight ()
bool	get_show_plugin_scan_window ()
bool	get_show_region_gain ()
bool	get_show_region_name ()
bool	get_show_region_xrun_markers ()
bool	get_show_secondary_clock ()
bool	get_show_snapped_cursor ()
bool	get_show_toolbar_latency ()
bool	get_show_toolbar_monitor_info ()
bool	get_show_toolbar_monitoring ()
bool	get_show_toolbar_recpunch ()
bool	get_show_toolbar_selclock ()
bool	get_show_track_meters ()
bool	get_show_waveform_clipping ()
bool	get_show_waveforms ()
bool	get_show_waveforms_while_recording ()
bool	get_show_zoom_tools ()
unsigned int	get_snap_threshold ()
bool	get_snap_to_grid ()
bool	get_snap_to_marks ()
bool	get_snap_to_region_end ()
bool	get_snap_to_region_start ()
bool	get_snap_to_region_sync ()
bool	get_sound_midi_notes ()
std::string	get_stripable_color_palette ()
bool	get_super_rapid_clock_update ()
int	get_time_axis_name_ellipsize_mode ()
float	get_timeline_item_gradient_depth ()
bool	get_transients_follow_front ()
std::string	get_ui_font_family ()
std::string	get_ui_rc_file ()
bool	get_update_editor_during_summary_drag ()
bool	get_use_double_click_to_zoom_to_selection ()
bool	get_use_mouse_position_as_zoom_focus_on_scroll ()
bool	get_use_note_bars_for_velocity ()
bool	get_use_note_color_for_velocity ()
bool	get_use_time_rulers_to_zoom_with_vertical_drag ()
bool	get_use_tooltips ()
bool	get_use_wm_visibility ()
unsigned int	get_vertical_region_gap ()
std::string	get_vkeybd_layout ()
unsigned long	get_waveform_cache_size ()
double	get_waveform_clip_level ()
float	get_waveform_gradient_depth ()
WaveformScale	get_waveform_scale ()
WaveformShape	get_waveform_shape ()
bool	get_widget_prelight ()
bool	set_action_table_columns (unsigned int)
bool	set_all_floating_windows_are_dialogs (bool)
bool	set_allow_non_quarter_pulse (bool)
bool	set_autoplay_files (bool)
bool	set_autoscroll_editor (bool)
bool	set_blink_alert_indicators (bool)
bool	set_blink_rec_arm (bool)
bool	set_boxy_buttons (bool)
bool	set_buggy_gradients (bool)
bool	set_cairo_image_surface (bool)
bool	set_clock_display_limit (unsigned long)
bool	set_color_file (std::string)
bool	set_color_regions_using_track_color (bool)
bool	set_default_bindings (std::string)
bool	set_default_narrow_ms (bool)
bool	set_draggable_playhead (bool)
bool	set_draggable_playhead_speed (float)
bool	set_editor_stereo_only_meters (bool)
bool	set_extra_ui_extents_time (float)
bool	set_flat_buttons (bool)
bool	set_floating_monitor_section (bool)
bool	set_follow_edits (bool)
bool	set_font_scale (int)
bool	set_grid_follows_internal (bool)
bool	set_hiding_groups_deactivates_groups (bool)
bool	set_icon_set (std::string)
bool	set_keyboard_layout (std::string)
bool	set_keyboard_layout_name (std::string)
bool	set_link_region_and_track_selection (bool)
bool	set_lock_gui_after_seconds (unsigned int)
bool	set_max_inline_controls (unsigned int)
bool	set_max_plugin_chart (int)
bool	set_max_plugin_recent (int)
bool	set_meter_hold (float)
bool	set_meter_line_up_din (MeterLineUp)
bool	set_meter_line_up_level (MeterLineUp)
bool	set_meter_peak (float)
bool	set_meter_style_led (bool)
bool	set_meter_vu_standard (VUMeterStandard)
bool	set_mixer_strip_visibility (std::string)
bool	set_name_new_markers (bool)
bool	set_never_display_periodic_midi (bool)
bool	set_new_automation_points_on_lane (bool)
bool	set_no_new_session_dialog (bool)
bool	set_only_copy_imported_files (bool)
bool	set_open_gui_after_adding_plugin (bool)
bool	set_prefer_inline_over_gui (bool)
bool	set_preview_video_frame_on_drag (bool)
bool	set_primary_clock_delta_mode (ClockDeltaMode)
bool	set_recent_session_sort (int)
bool	set_rubberbanding_snaps_to_grid (bool)
bool	set_ruler_granularity (unsigned int)
bool	set_rulers_follow_grid (bool)
bool	set_save_export_analysis_image (bool)
bool	set_save_export_mixer_screenshot (bool)
bool	set_screen_saver_mode (ScreenSaverMode)
bool	set_secondary_clock_delta_mode (ClockDeltaMode)
bool	set_show_editor_meter (bool)
bool	set_show_grids_ruler (bool)
bool	set_show_inline_display_by_default (bool)
bool	set_show_mini_timeline (bool)
bool	set_show_name_highlight (bool)
bool	set_show_plugin_scan_window (bool)
bool	set_show_region_gain (bool)
bool	set_show_region_name (bool)
bool	set_show_region_xrun_markers (bool)
bool	set_show_secondary_clock (bool)
bool	set_show_snapped_cursor (bool)
bool	set_show_toolbar_latency (bool)
bool	set_show_toolbar_monitor_info (bool)
bool	set_show_toolbar_monitoring (bool)
bool	set_show_toolbar_recpunch (bool)
bool	set_show_toolbar_selclock (bool)
bool	set_show_track_meters (bool)
bool	set_show_waveform_clipping (bool)
bool	set_show_waveforms (bool)
bool	set_show_waveforms_while_recording (bool)
bool	set_show_zoom_tools (bool)
bool	set_snap_threshold (unsigned int)
bool	set_snap_to_grid (bool)
bool	set_snap_to_marks (bool)
bool	set_snap_to_region_end (bool)
bool	set_snap_to_region_start (bool)
bool	set_snap_to_region_sync (bool)
bool	set_sound_midi_notes (bool)
bool	set_stripable_color_palette (std::string)
bool	set_super_rapid_clock_update (bool)
bool	set_time_axis_name_ellipsize_mode (int)
bool	set_timeline_item_gradient_depth (float)
bool	set_transients_follow_front (bool)
bool	set_ui_font_family (std::string)
bool	set_ui_rc_file (std::string)
bool	set_update_editor_during_summary_drag (bool)
bool	set_use_double_click_to_zoom_to_selection (bool)
bool	set_use_mouse_position_as_zoom_focus_on_scroll (bool)
bool	set_use_note_bars_for_velocity (bool)
bool	set_use_note_color_for_velocity (bool)
bool	set_use_time_rulers_to_zoom_with_vertical_drag (bool)
bool	set_use_tooltips (bool)
bool	set_use_wm_visibility (bool)
bool	set_vertical_region_gap (unsigned int)
bool	set_vkeybd_layout (std::string)
bool	set_waveform_cache_size (unsigned long)
bool	set_waveform_clip_level (double)
bool	set_waveform_gradient_depth (float)
bool	set_waveform_scale (WaveformScale)
bool	set_waveform_shape (WaveformShape)
bool	set_widget_prelight (bool)
Properties
unsigned int	action_table_columns
bool	all_floating_windows_are_dialogs
bool	allow_non_quarter_pulse
bool	autoplay_files
bool	autoscroll_editor
bool	blink_alert_indicators
bool	blink_rec_arm
bool	boxy_buttons
bool	buggy_gradients
bool	cairo_image_surface
unsigned long	clock_display_limit
std::string	color_file
bool	color_regions_using_track_color
std::string	default_bindings
bool	default_narrow_ms
bool	draggable_playhead
float	draggable_playhead_speed
bool	editor_stereo_only_meters
float	extra_ui_extents_time
bool	flat_buttons
bool	floating_monitor_section
bool	follow_edits
int	font_scale
bool	grid_follows_internal
bool	hiding_groups_deactivates_groups
std::string	icon_set
std::string	keyboard_layout
std::string	keyboard_layout_name
bool	link_region_and_track_selection
unsigned int	lock_gui_after_seconds
unsigned int	max_inline_controls
int	max_plugin_chart
int	max_plugin_recent
float	meter_hold
ARDOUR.MeterLineUp	meter_line_up_din
ARDOUR.MeterLineUp	meter_line_up_level
float	meter_peak
bool	meter_style_led
ARDOUR.VUMeterStandard	meter_vu_standard
std::string	mixer_strip_visibility
bool	name_new_markers
bool	never_display_periodic_midi
bool	new_automation_points_on_lane
bool	no_new_session_dialog
bool	only_copy_imported_files
bool	open_gui_after_adding_plugin
bool	prefer_inline_over_gui
bool	preview_video_frame_on_drag
ARDOUR.ClockDeltaMode	primary_clock_delta_mode
int	recent_session_sort
bool	rubberbanding_snaps_to_grid
unsigned int	ruler_granularity
bool	rulers_follow_grid
bool	save_export_analysis_image
bool	save_export_mixer_screenshot
ARDOUR.ScreenSaverMode	screen_saver_mode
ARDOUR.ClockDeltaMode	secondary_clock_delta_mode
bool	show_editor_meter
bool	show_grids_ruler
bool	show_inline_display_by_default
bool	show_mini_timeline
bool	show_name_highlight
bool	show_plugin_scan_window
bool	show_region_gain
bool	show_region_name
bool	show_region_xrun_markers
bool	show_secondary_clock
bool	show_snapped_cursor
bool	show_toolbar_latency
bool	show_toolbar_monitor_info
bool	show_toolbar_monitoring
bool	show_toolbar_recpunch
bool	show_toolbar_selclock
bool	show_track_meters
bool	show_waveform_clipping
bool	show_waveforms
bool	show_waveforms_while_recording
bool	show_zoom_tools
unsigned int	snap_threshold
bool	snap_to_grid
bool	snap_to_marks
bool	snap_to_region_end
bool	snap_to_region_start
bool	snap_to_region_sync
bool	sound_midi_notes
std::string	stripable_color_palette
bool	super_rapid_clock_update
int	time_axis_name_ellipsize_mode
float	timeline_item_gradient_depth
bool	transients_follow_front
std::string	ui_font_family
std::string	ui_rc_file
bool	update_editor_during_summary_drag
bool	use_double_click_to_zoom_to_selection
bool	use_mouse_position_as_zoom_focus_on_scroll
bool	use_note_bars_for_velocity
bool	use_note_color_for_velocity
bool	use_time_rulers_to_zoom_with_vertical_drag
bool	use_tooltips
bool	use_wm_visibility
unsigned int	vertical_region_gap
std::string	vkeybd_layout
unsigned long	waveform_cache_size
double	waveform_clip_level
float	waveform_gradient_depth
ARDOUR.WaveformScale	waveform_scale
ARDOUR.WaveformShape	waveform_shape
bool	widget_prelight

⋯ C:ByteArray

C‡: unsigned char*

Methods
LuaMetaTable	array ()
LuaTable	get_table ()
unsigned char*	offset (unsigned int)
void	set_table (LuaTable {unsigned char})

∁ C:ByteVector

C‡: std::vector<unsigned char >

Constructor
ℂ	C.ByteVector ()
ℂ	C.ByteVector ()
Methods
LuaTable	add (LuaTable {unsigned char})
unsigned char	at (unsigned long)
void	clear ()
bool	empty ()
LuaIter	iter ()
void	push_back (unsigned char)
unsigned long	size ()
LuaTable	table ()
...	to_array (--lua--)

⋯ C:DoubleArray

C‡: double*

Methods
LuaMetaTable	array ()
LuaTable	get_table ()
DoubleArray	offset (unsigned int)
void	set_table (LuaTable {double})

∁ C:DoubleVector

C‡: std::vector<double >

Constructor
ℂ	C.DoubleVector ()
ℂ	C.DoubleVector ()
Methods
LuaTable	add (LuaTable {double})
double	at (unsigned long)
void	clear ()
bool	empty ()
LuaIter	iter ()
void	push_back (double)
unsigned long	size ()
LuaTable	table ()
...	to_array (--lua--)

⋯ C:FloatArray

C‡: float*

Methods
LuaMetaTable	array ()
LuaTable	get_table ()
FloatArray	offset (unsigned int)
void	set_table (LuaTable {float})

∁ C:FloatArrayVector

C‡: std::vector<float* >

Constructor
ℂ	C.FloatArrayVector ()
ℂ	C.FloatArrayVector ()
Methods
LuaTable	add (LuaTable {FloatArray})
FloatArray	at (unsigned long)
void	clear ()
bool	empty ()
LuaIter	iter ()
void	push_back (FloatArray)
unsigned long	size ()
LuaTable	table ()
...	to_array (--lua--)

∁ C:FloatVector

C‡: std::vector<float >

Constructor
ℂ	C.FloatVector ()
ℂ	C.FloatVector ()
Methods
LuaTable	add (LuaTable {float})
float	at (unsigned long)
void	clear ()
bool	empty ()
LuaIter	iter ()
void	push_back (float)
unsigned long	size ()
LuaTable	table ()
...	to_array (--lua--)

∁ C:Int64List

C‡: std::list<long >

Constructor
ℂ	C.Int64List ()
Methods
LuaTable	add (LuaTable {long})
long	back ()
bool	empty ()
long	front ()
LuaIter	iter ()
void	push_back (long)
void	reverse ()
unsigned long	size ()
LuaTable	table ()
void	unique ()

⋯ C:IntArray

C‡: int*

Methods
LuaMetaTable	array ()
LuaTable	get_table ()
IntArray	offset (unsigned int)
void	set_table (LuaTable {int})

∁ C:StringList

C‡: std::list<std::string >

Constructor
ℂ	C.StringList ()
Methods
LuaTable	add (LuaTable {std::string})
std::string	back ()
bool	empty ()
std::string	front ()
LuaIter	iter ()
void	push_back (std::string)
void	reverse ()
unsigned long	size ()
LuaTable	table ()
void	unique ()

∁ C:StringVector

C‡: std::vector<std::string >

Constructor
ℂ	C.StringVector ()
ℂ	C.StringVector ()
Methods
LuaTable	add (LuaTable {std::string})
std::string	at (unsigned long)
void	clear ()
bool	empty ()
LuaIter	iter ()
void	push_back (std::string)
unsigned long	size ()
LuaTable	table ()
...	to_array (--lua--)

∁ Cairo:Context

C‡: Cairo::Context

Context is the main class used to draw in cairomm. It contains the current state of the rendering device, including coordinates of yet to be drawn shapes.

In the simplest case, create a Context with its target Surface, set its drawing options (line width, color, etc), create shapes with methods like move_to() and line_to(), and then draw the shapes to the Surface using methods such as stroke() or fill().

Context is a reference-counted object that should be used via Cairo::RefPtr.

Methods
void	arc (double, double, double, double, double)
	Adds a circular arc of the given radius to the current path. The arc is centered at (xc, yc), begins at angle1 and proceeds in the direction of increasing angles to end at angle2. If angle2 is less than angle1 it will be progressively increased by 2M_PI until it is greater than angle1.* If there is a current point, an initial line segment will be added to the path to connect the current point to the beginning of the arc. If this initial line is undesired, it can be avoided by calling begin_new_sub_path() before calling arc(). Angles are measured in radians. An angle of 0 is in the direction of the positive X axis (in user-space). An angle of M_PI/2.0 radians (90 degrees) is in the direction of the positive Y axis (in user-space). Angles increase in the direction from the positive X axis toward the positive Y axis. So with the default transformation matrix, angles increase in a clockwise direction. ( To convert from degrees to radians, use degrees * (M_PI / 180.0). ) This function gives the arc in the direction of increasing angles; see arc_negative() to get the arc in the direction of decreasing angles. The arc is circular in user-space. To achieve an elliptical arc, you can scale the current transformation matrix by different amounts in the X and Y directions. For example, to draw an ellipse in the box given by x, y, width, height: context->save(); context->translate(x, y); context->scale(width / 2.0, height / 2.0); context->arc(0.0, 0.0, 1.0, 0.0, 2 * M_PI); context->restore(); xc X position of the center of the arc yc Y position of the center of the arc radius the radius of the arc angle1 the start angle, in radians angle2 the end angle, in radians
void	arc_negative (double, double, double, double, double)
	Adds a circular arc of the given radius to the current path. The arc is centered at (xc, yc), begins at angle1 and proceeds in the direction of decreasing angles to end at angle2. If angle2 is greater than angle1 it will be progressively decreased by 2M_PI until it is greater than angle1.* See arc() for more details. This function differs only in the direction of the arc between the two angles. xc X position of the center of the arc yc Y position of the center of the arc radius the radius of the arc angle1 the start angle, in radians angle2 the end angle, in radians
void	begin_new_path ()
	Clears the current path. After this call there will be no current point.
void	begin_new_sub_path ()
	Begin a new subpath. Note that the existing path is not affected. After this call there will be no current point. In many cases, this call is not needed since new subpaths are frequently started with move_to(). A call to begin_new_sub_path() is particularly useful when beginning a new subpath with one of the arc() calls. This makes things easier as it is no longer necessary to manually compute the arc's initial coordinates for a call to move_to(). 1.2
void	clip ()
	Establishes a new clip region by intersecting the current clip region with the current Path as it would be filled by fill() and according to the current fill rule. After clip(), the current path will be cleared from the cairo Context. The current clip region affects all drawing operations by effectively masking out any changes to the surface that are outside the current clip region. Calling clip() can only make the clip region smaller, never larger. But the current clip is part of the graphics state, so a temporary restriction of the clip region can be achieved by calling clip() within a save()/restore() pair. The only other means of increasing the size of the clip region is reset_clip(). set_fill_rule()
void	clip_preserve ()
	Establishes a new clip region by intersecting the current clip region with the current path as it would be filled by fill() and according to the current fill rule. Unlike clip(), clip_preserve preserves the path within the cairo Context. clip() set_fill_rule()
void	close_path ()
	Adds a line segment to the path from the current point to the beginning of the current subpath, (the most recent point passed to move_to()), and closes this subpath. After this call the current point will be at the joined endpoint of the sub-path. The behavior of close_path() is distinct from simply calling line_to() with the equivalent coordinate in the case of stroking. When a closed subpath is stroked, there are no caps on the ends of the subpath. Instead, there is a line join connecting the final and initial segments of the subpath. If there is no current point before the call to close_path(), this function will have no effect.
void	curve_to (double, double, double, double, double, double)
	Adds a cubic Bezier spline to the path from the current point to position (x3, y3) in user-space coordinates, using (x1, y1) and (x2, y2) as the control points. After this call the current point will be (x3, y3). If there is no current point before the call to curve_to() this function will behave as if preceded by a call to move_to(x1, y1). x1 the X coordinate of the first control point y1 the Y coordinate of the first control point x2 the X coordinate of the second control point y2 the Y coordinate of the second control point x3 the X coordinate of the end of the curve y3 the Y coordinate of the end of the curve
void	fill ()
	A drawing operator that fills the current path according to the current fill rule, (each sub-path is implicitly closed before being filled). After fill(), the current path will be cleared from the cairo context. set_fill_rule() fill_preserve()
void	fill_preserve ()
	A drawing operator that fills the current path according to the current fill rule, (each sub-path is implicitly closed before being filled). Unlike fill(), fill_preserve() preserves the path within the cairo Context. set_fill_rule() fill().
void	line_to (double, double)
	Adds a line to the path from the current point to position (x, y) in user-space coordinates. After this call the current point will be (x, y). If there is no current point before the call to line_to() this function will behave as move_to(x, y). x the X coordinate of the end of the new line y the Y coordinate of the end of the new line
void	move_to (double, double)
	If the current subpath is not empty, begin a new subpath. After this call the current point will be (x, y). x the X coordinate of the new position y the Y coordinate of the new position
void	paint ()
	A drawing operator that paints the current source everywhere within the current clip region.
void	paint_with_alpha (double)
	A drawing operator that paints the current source everywhere within the current clip region using a mask of constant alpha value alpha. The effect is similar to paint(), but the drawing is faded out using the alpha value. alpha an alpha value, between 0 (transparent) and 1 (opaque)
void	rectangle (double, double, double, double)
	Adds a closed-subpath rectangle of the given size to the current path at position (x, y) in user-space coordinates. This function is logically equivalent to: context->move_to(x, y); context->rel_line_to(width, 0); context->rel_line_to(0, height); context->rel_line_to(-width, 0); context->close_path(); x the X coordinate of the top left corner of the rectangle y the Y coordinate to the top left corner of the rectangle width the width of the rectangle height the height of the rectangle
void	rel_curve_to (double, double, double, double, double, double)
	Relative-coordinate version of curve_to(). All offsets are relative to the current point. Adds a cubic Bezier spline to the path from the current point to a point offset from the current point by (dx3, dy3), using points offset by (dx1, dy1) and (dx2, dy2) as the control points. After this call the current point will be offset by (dx3, dy3). Given a current point of (x, y), rel_curve_to(dx1, dy1, dx2, dy2, dx3, dy3) is logically equivalent to curve_to(x + dx1, y + dy1, x + dx2, y + dy2, x + dx3, y + dy3). It is an error to call this function with no current point. Doing so will cause this to shutdown with a status of CAIRO_STATUS_NO_CURRENT_POINT. Cairomm will then throw an exception. dx1 the X offset to the first control point dy1 the Y offset to the first control point dx2 the X offset to the second control point dy2 the Y offset to the second control point dx3 the X offset to the end of the curve dy3 the Y offset to the end of the curve
void	rel_line_to (double, double)
	Relative-coordinate version of line_to(). Adds a line to the path from the current point to a point that is offset from the current point by (dx, dy) in user space. After this call the current point will be offset by (dx, dy). Given a current point of (x, y), rel_line_to(dx, dy) is logically equivalent to line_to(x + dx, y + dy). It is an error to call this function with no current point. Doing so will cause this to shutdown with a status of CAIRO_STATUS_NO_CURRENT_POINT. Cairomm will then throw an exception. dx the X offset to the end of the new line dy the Y offset to the end of the new line
void	rel_move_to (double, double)
	If the current subpath is not empty, begin a new subpath. After this call the current point will offset by (x, y). Given a current point of (x, y), rel_move_to(dx, dy) is logically equivalent to move_to(x + dx, y + dy) It is an error to call this function with no current point. Doing so will cause this to shutdown with a status of CAIRO_STATUS_NO_CURRENT_POINT. Cairomm will then throw an exception. dx the X offset dy the Y offset
void	reset_clip ()
	Reset the current clip region to its original, unrestricted state. That is, set the clip region to an infinitely large shape containing the target surface. Equivalently, if infinity is too hard to grasp, one can imagine the clip region being reset to the exact bounds of the target surface. Note that code meant to be reusable should not call reset_clip() as it will cause results unexpected by higher-level code which calls clip(). Consider using save() and restore() around clip() as a more robust means of temporarily restricting the clip region.
void	restore ()
	Restores cr to the state saved by a preceding call to save() and removes that state from the stack of saved states. save()
void	rotate (double)
	Modifies the current transformation matrix (CTM) by rotating the user-space axes by angle radians. The rotation of the axes takes places after any existing transformation of user space. The rotation direction for positive angles is from the positive X axis toward the positive Y axis. angle angle (in radians) by which the user-space axes will be rotated
void	save ()
	Makes a copy of the current state of the Context and saves it on an internal stack of saved states. When restore() is called, it will be restored to the saved state. Multiple calls to save() and restore() can be nested; each call to restore() restores the state from the matching paired save(). It isn't necessary to clear all saved states before a cairo_t is freed. Any saved states will be freed when the Context is destroyed. restore()
void	scale (double, double)
	Modifies the current transformation matrix (CTM) by scaling the X and Y user-space axes by sx and sy respectively. The scaling of the axes takes place after any existing transformation of user space. sx scale factor for the X dimension sy scale factor for the Y dimension
void	set_dash (DoubleVector, double)
	Sets the dash pattern to be used by stroke(). A dash pattern is specified by dashes, an array of positive values. Each value provides the user-space length of altenate "on" and "off" portions of the stroke. The offset specifies an offset into the pattern at which the stroke begins. Each "on" segment will have caps applied as if the segment were a separate sub-path. In particular, it is valid to use an "on" length of 0.0 with Cairo::LINE_CAP_ROUND or Cairo::LINE_CAP_SQUARE in order to distributed dots or squares along a path. Note: The length values are in user-space units as evaluated at the time of stroking. This is not necessarily the same as the user space at the time of set_dash(). If dashes is empty dashing is disabled. If the size of dashes is 1, a symmetric pattern is assumed with alternating on and off portions of the size specified by the single value in dashes. It is invalid for any value in dashes to be negative, or for all values to be 0. If this is the case, an exception will be thrown dashes an array specifying alternate lengths of on and off portions offset an offset into the dash pattern at which the stroke should start
void	set_font_size (double)
	Sets the current font matrix to a scale by a factor of size, replacing any font matrix previously set with set_font_size() or set_font_matrix(). This results in a font size of size user space units. (More precisely, this matrix will result in the font's em-square being a by size square in user space.) If text is drawn without a call to set_font_size(), (nor set_font_matrix() nor set_scaled_font()), the default font size is 10.0. size the new font size, in user space units)
void	set_line_cap (LineCap)
	Sets the current line cap style within the cairo Context. See LineCap for details about how the available line cap styles are drawn. As with the other stroke parameters, the current line cap style is examined by stroke(), stroke_extents(), and stroke_to_path(), but does not have any effect during path construction. The default line cap style is Cairo::LINE_CAP_BUTT. line_cap a line cap style, as a LineCap
void	set_line_join (LineJoin)
	Sets the current line join style within the cairo Context. See LineJoin for details about how the available line join styles are drawn. As with the other stroke parameters, the current line join style is examined by stroke(), stroke_extents(), and stroke_to_path(), but does not have any effect during path construction. The default line join style is Cairo::LINE_JOIN_MITER. line_join a line joint style, as a LineJoin
void	set_line_width (double)
	Sets the current line width within the cairo Context. The line width specifies the diameter of a pen that is circular in user-space, (though device-space pen may be an ellipse in general due to scaling/shear/rotation of the CTM). Note: When the description above refers to user space and CTM it refers to the user space and CTM in effect at the time of the stroking operation, not the user space and CTM in effect at the time of the call to set_line_width(). The simplest usage makes both of these spaces identical. That is, if there is no change to the CTM between a call to set_line_width() and the stroking operation, then one can just pass user-space values to set_line_width() and ignore this note. As with the other stroke parameters, the current line cap style is examined by stroke(), stroke_extents(), and stroke_to_path(), but does not have any effect during path construction. The default line width value is 2.0. width a line width, as a user-space value
void	set_operator (Operator)
	Sets the compositing operator to be used for all drawing operations. See Operator for details on the semantics of each available compositing operator. op a compositing operator, specified as a Operator
void	set_source_rgb (double, double, double)
	Sets the source pattern within the Context to an opaque color. This opaque color will then be used for any subsequent drawing operation until a new source pattern is set. The color components are floating point numbers in the range 0 to 1. If the values passed in are outside that range, they will be clamped. set_source_rgba() set_source() red red component of color green green component of color blue blue component of color
void	set_source_rgba (double, double, double, double)
	Sets the source pattern within the Context to a translucent color. This color will then be used for any subsequent drawing operation until a new source pattern is set. The color and alpha components are floating point numbers in the range 0 to 1. If the values passed in are outside that range, they will be clamped. set_source_rgb() set_source() red red component of color green green component of color blue blue component of color alpha alpha component of color
void	show_text (std::string)
	A drawing operator that generates the shape from a string of UTF-8 characters, rendered according to the current font_face, font_size (font_matrix), and font_options. This function first computes a set of glyphs for the string of text. The first glyph is placed so that its origin is at the current point. The origin of each subsequent glyph is offset from that of the previous glyph by the advance values of the previous glyph. After this call the current point is moved to the origin of where the next glyph would be placed in this same progression. That is, the current point will be at the origin of the final glyph offset by its advance values. This allows for easy display of a single logical string with multiple calls to show_text(). Note: The show_text() function call is part of what the cairo designers call the "toy" text API. It is convenient for short demos and simple programs, but it is not expected to be adequate for serious text-using applications. See show_glyphs() for the "real" text display API in cairo. utf8 a string containing text encoded in UTF-8
void	stroke ()
	A drawing operator that strokes the current Path according to the current line width, line join, line cap, and dash settings. After stroke(), the current Path will be cleared from the cairo Context. set_line_width() set_line_join() set_line_cap() set_dash() stroke_preserve(). Note: Degenerate segments and sub-paths are treated specially and provide a useful result. These can result in two different situations: 1. Zero-length "on" segments set in set_dash(). If the cap style is Cairo::LINE_CAP_ROUND or Cairo::LINE_CAP_SQUARE then these segments will be drawn as circular dots or squares respectively. In the case of Cairo::LINE_CAP_SQUARE, the orientation of the squares is determined by the direction of the underlying path. 2. A sub-path created by move_to() followed by either a close_path() or one or more calls to line_to() to the same coordinate as the move_to(). If the cap style is Cairo::LINE_CAP_ROUND then these sub-paths will be drawn as circular dots. Note that in the case of Cairo::LINE_CAP_SQUARE a degenerate sub-path will not be drawn at all, (since the correct orientation is indeterminate). In no case will a cap style of Cairo::LINE_CAP_BUTT cause anything to be drawn in the case of either degenerate segments or sub-paths.
void	stroke_preserve ()
	A drawing operator that strokes the current Path according to the current line width, line join, line cap, and dash settings. Unlike stroke(), stroke_preserve() preserves the Path within the cairo Context. set_line_width() set_line_join() set_line_cap() set_dash() stroke_preserve().
void	translate (double, double)
	Modifies the current transformation matrix (CTM) by translating the user-space origin by (tx, ty). This offset is interpreted as a user-space coordinate according to the CTM in place before the new call to translate. In other words, the translation of the user-space origin takes place after any existing transformation. tx amount to translate in the X direction ty amount to translate in the Y direction
void	unset_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
Context	context ()
	Returns a context object to perform operations on the surface
int	get_height ()
	Gets the height of the ImageSurface in pixels
int	get_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.
int	get_width ()
	Gets the width of the ImageSurface in pixels
void	set_as_source (Context, int, int)
	Set this surface as source for another context. This allows to draw this surface

∁ Cairo:PangoLayout

C‡: LuaCairo::PangoLayout

Constructor
ℂ	Cairo.PangoLayout (Context, std::string)
Methods
Alignment	get_alignment ()
	Gets the alignment for the layout: how partial lines are positioned within the horizontal space available. Returns The alignment.
EllipsizeMode	get_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::string	get_text ()
	Gets the text in the layout. The returned text should not be freed or modified. Returns The text in the layout.
WrapMode	get_wrap ()
	Gets the wrap mode for the layout. Use is_wrapped() to query whether any paragraphs were actually wrapped. Returns Active wrap mode.
bool	is_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.
bool	is_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.
void	layout_cairo_path (Context)
void	set_alignment (Alignment)
	Sets the alignment for the layout: how partial lines are positioned within the horizontal space available. alignment The alignment.
void	set_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.
void	set_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.
void	set_text (std::string)
	Set the text of the layout. text The text for the layout.
void	set_width (float)
	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.
void	set_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.
void	show_in_cairo_context (Context)
	Draws a Layout in the specified Cairo context. The top-left corner of the Layout will be drawn at the current point of the cairo context. context A Cairo context.

∁ Evoral:Beats

C‡: Temporal::Beats

Musical time in beats.

Constructor
ℂ	Evoral.Beats (double)
Methods
double	to_double ()

↠ Evoral:Control

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

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

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

Methods
bool	isnil ()
ControlList	list ()

∁ Evoral:ControlEvent

C‡: Evoral::ControlEvent

A single event (time-stamped value) for a control

Data Members
double	value
double	when

↠ Evoral:ControlList

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

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

Methods
void	add (double, double, bool, bool)
	Add an event to this list. This method is intended to write automation in realtime. If the transport is stopped, guard-points will be added regardless of parameter with_guards. when absolute time in samples value parameter value with_guards if true, add guard-points with_initial if true, add an initial point if the list is empty
void	clear (double, double)
	Remove all events in the given time range from this list. start start of range (inclusive) in audio samples end end of range (inclusive) in audio samples
void	clear_list ()
bool	editor_add (double, double, bool)
	Add an event to this list. This method is intended for making manual changes from the GUI. An event will only be created if no other event exists at the given time. when absolute time in samples value parameter value with_guards if true, add guard-points Returns true if an event was added.
double	eval (double)
	Queries the event value at the given time (takes a read-lock, not safe while writing automation). where absolute time in samples Returns parameter value
EventList	events ()
	Returns the list of events
bool	in_write_pass ()
	Returns true if transport is running and this list is in write mode
InterpolationStyle	interpolation ()
	query interpolation style of the automation data Returns Interpolation Style
bool	isnil ()
LuaTable(double, ...)	rt_safe_eval (double, bool&)
	Realtime safe version of eval(). This may fail if a read-lock cannot be taken. where absolute time in samples ok boolean reference if returned value is valid Returns parameter value
bool	set_interpolation (InterpolationStyle)
	Sets the interpolation style of the automation data. This will fail when asking for Logarithmic scale and min,max crosses 0 or Exponential scale with min != 0. is interpolation style Returns true if style change was successful
unsigned long	size ()
void	thin (double)
	Thin the number of events in this list. The thinning factor corresponds to the area of a triangle computed between three points in the list (time-difference * value-difference). If the area is large, it indicates significant non-linearity between the points. Time is measured in samples, value is usually normalized to 0..1. During automation recording we thin the recorded points using this value. If a point is sufficiently co-linear with its neighbours (as defined by the area of the triangle formed by three of them), we will not include it in the list. The larger the value, the more points are excluded, so this effectively measures the amount of thinning to be done. thinning_factor area-size (default: 20)
void	truncate_end (double)
	Remove all events after the given time from this list. last_coordinate time in audio samples of the last event to keep
void	truncate_start (double)
	Remove all events up to to the given time from this list. overall_length overall length in audio samples
Cast
AutomationList	to_automationlist ()

↠ Evoral:ControlSet

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

Methods
bool	isnil ()

∁ Evoral:Event

C‡: Evoral::Event<long>

Methods
unsigned char*	buffer ()
unsigned char	channel ()
void	clear ()
void	set_buffer (unsigned int, unsigned char*, bool)
void	set_channel (unsigned char)
void	set_type (unsigned char)
unsigned int	size ()
long	time ()
unsigned char	type ()

↠ Evoral:NotePtr

C‡: boost::shared_ptr< Evoral::Note<Temporal::Beats> >, boost::weak_ptr< Evoral::Note<Temporal::Beats> >

Methods
unsigned char	channel ()
bool	isnil ()
Beats	length ()
unsigned char	note ()
unsigned char	off_velocity ()
Beats	time ()
unsigned char	velocity ()

∁ Evoral:Parameter

C‡: Evoral::Parameter

ID of a [play|record|automate]able parameter.

A parameter is defined by (type, id, channel). Type is an integer which can be used in any way by the application (e.g. cast to a custom enum, map to/from a URI, etc). ID is type specific (e.g. MIDI controller #).

This class defines a < operator which is a strict weak ordering, so Parameter may be stored in a std::set, used as a std::map key, etc.

Constructor
ℂ	Evoral.Parameter (unsigned int, unsigned char, unsigned int)
Methods
unsigned char	channel ()
unsigned int	id ()
unsigned int	type ()

∁ Evoral:ParameterDescriptor

C‡: Evoral::ParameterDescriptor

Description of the value range of a parameter or control.

Constructor
ℂ	Evoral.ParameterDescriptor ()
Data Members
bool	logarithmic
	True for log-scale parameters
float	lower
	Minimum value (in Hz, for frequencies)
float	normal
	Default value
bool	toggled
	True iff parameter is boolean
float	upper
	Maximum value (in Hz, for frequencies)

∁ Evoral:Range

C‡: Evoral::Range<long>

Constructor
ℂ	Evoral.Range (long, long)
Data Members
long	from
long	to

↠ Evoral:Sequence

C‡: boost::shared_ptr< Evoral::Sequence<Temporal::Beats> >, boost::weak_ptr< Evoral::Sequence<Temporal::Beats> >

is-a: Evoral:ControlSet

Methods
bool	isnil ()

∁ LuaDialog:Dialog

C‡: LuaDialog::Dialog

Constructor
ℂ	LuaDialog.Dialog (std::string, Lua-Function)
Methods
...	run (--lua--)

∁ LuaDialog:Message

C‡: LuaDialog::Message

Constructor
ℂ	LuaDialog.Message (std::string, std::string, MessageType, ButtonType)
Methods
int	run ()

∁ LuaDialog:ProgressWindow

C‡: LuaDialog::ProgressWindow

Synchronous GUI-thread Progress dialog

This shows a modal progress dialog with an optional "Cancel" button. Since it runs in the UI thread the script needs to regularly call progress(), as well as close the dialog, as needed.

Constructor
ℂ	LuaDialog.ProgressWindow (std::string, bool)
Methods
bool	canceled ()
void	done ()
	Close and hide the dialog. This is required to be at the end, since the dialog is modal and prevents other UI operations while visible.
bool	progress (float, std::string)
	Report progress and update GUI. prog progress in range 0..1 show a bar, values outside this range show a pulsing dialog. text optional text to show on the progress-bar Returns true if cancel was clicked, false otherwise

∁ LuaSignal:Set

C‡: std::bitset<49ul>

Constructor
ℂ	LuaSignal.Set ()
Methods
LuaTable	add (49ul)
bool	any ()
unsigned long	count ()
bool	none ()
Set	reset ()
Set	set (unsigned long, bool)
unsigned long	size ()
LuaTable	table ()
bool	test (unsigned long)

ℕ PBD

Methods
bool	open_uri (std::string)
bool	open_uri (std::string)

∁ PBD:Command

C‡: Command

is-a: PBD:StatefulDestructible

Base class for Undo/Redo commands and changesets

Methods
std::string	name ()
void	set_name (std::string)

Inherited from PBD:Stateful

Methods
void	clear_changes ()
	Forget about any changes to this object's properties
ID	id ()
OwnedPropertyList	properties ()

∅ PBD:Configuration

C‡: PBD::Configuration

is-a: PBD:Stateful

Base class for objects with saveable and undoable state

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

Inherited from PBD:Stateful

Methods
void	clear_changes ()
	Forget about any changes to this object's properties
ID	id ()
OwnedPropertyList	properties ()

↠ PBD:Controllable

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

is-a: PBD:StatefulDestructiblePtr

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

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

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

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

We express Controllable values in one of three ways: 1. `user' --- as presented to the user (e.g. dB, Hz, etc.) 2. `interface' --- as used in some cases for the UI representation (in order to make controls behave logarithmically). 3. `internal' --- as passed to a processor, track, plugin, or whatever.

Note that in some cases user and internal may be the same (and interface different) e.g. frequency, which is presented to the user and passed to the processor in linear terms, but which needs log scaling in the interface.

In other cases, user and interface may be the same (and internal different) e.g. gain, which is presented to the user in log terms (dB) but passed to the processor as a linear quantity.

Methods
double	get_value ()
	Get `internal' value Returns raw value as used for the plugin/processor control port
bool	isnil ()
std::string	name ()

Inherited from PBD:StatefulPtr

Methods
void	clear_changes ()
	Forget about any changes to this object's properties
ID	id ()
OwnedPropertyList	properties ()

∁ PBD:ID

C‡: PBD::ID

a unique ID to identify objects numerically

Constructor
ℂ	PBD.ID (std::string)
Methods
std::string	to_s ()

∁ PBD:IdVector

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

Constructor
ℂ	PBD.IdVector ()
ℂ	PBD.IdVector ()
Methods
LuaTable	add (LuaTable {ID})
ID	at (unsigned long)
void	clear ()
bool	empty ()
LuaIter	iter ()
void	push_back (ID)
unsigned long	size ()
LuaTable	table ()
...	to_array (--lua--)

∁ PBD:RingBuffer8

C‡: PBD::RingBufferNPT<unsigned char>

Constructor
ℂ	PBD.RingBuffer8 (unsigned long)
Methods
void	increment_read_ptr (unsigned long)
void	increment_write_ptr (unsigned long)
unsigned long	read (unsigned char*, unsigned long)
unsigned long	read_space ()
void	reset ()
unsigned long	write (unsigned char*, unsigned long)
unsigned long	write_one (unsigned char)
unsigned long	write_space ()

∁ PBD:RingBufferF

C‡: PBD::RingBufferNPT<float>

Constructor
ℂ	PBD.RingBufferF (unsigned long)
Methods
void	increment_read_ptr (unsigned long)
void	increment_write_ptr (unsigned long)
unsigned long	read (FloatArray, unsigned long)
unsigned long	read_space ()
void	reset ()
unsigned long	write (FloatArray, unsigned long)
unsigned long	write_one (float)
unsigned long	write_space ()

∁ PBD:RingBufferI

C‡: PBD::RingBufferNPT<int>

Constructor
ℂ	PBD.RingBufferI (unsigned long)
Methods
void	increment_read_ptr (unsigned long)
void	increment_write_ptr (unsigned long)
unsigned long	read (IntArray, unsigned long)
unsigned long	read_space ()
void	reset ()
unsigned long	write (IntArray, unsigned long)
unsigned long	write_one (int)
unsigned long	write_space ()

∁ PBD:Stateful

C‡: PBD::Stateful

Base class for objects with saveable and undoable state

Methods
void	clear_changes ()
	Forget about any changes to this object's properties
ID	id ()
OwnedPropertyList	properties ()

∅ PBD:StatefulDestructible

C‡: PBD::StatefulDestructible

is-a: PBD:Stateful

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

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

Inherited from PBD:Stateful

Methods
void	clear_changes ()
	Forget about any changes to this object's properties
ID	id ()
OwnedPropertyList	properties ()

↠ PBD:StatefulDestructiblePtr

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

is-a: PBD:StatefulPtr

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

Methods
bool	isnil ()

Inherited from PBD:StatefulPtr

Methods
void	clear_changes ()
	Forget about any changes to this object's properties
ID	id ()
OwnedPropertyList	properties ()

∁ PBD:StatefulDiffCommand

C‡: PBD::StatefulDiffCommand

is-a: PBD:Command

A Command which stores its action as the differences between the before and after state of a Stateful object.

Methods
bool	empty ()
void	undo ()

Inherited from PBD:Command

Methods
std::string	name ()
void	set_name (std::string)

Inherited from PBD:Stateful

Methods
void	clear_changes ()
	Forget about any changes to this object's properties
ID	id ()
OwnedPropertyList	properties ()

↠ PBD:StatefulPtr

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

Base class for objects with saveable and undoable state

Methods
void	clear_changes ()
	Forget about any changes to this object's properties
ID	id ()
bool	isnil ()
OwnedPropertyList	properties ()

∁ PBD:XMLNode

C‡: XMLNode

Methods
std::string	name ()

∁ Timecode:BBT_TIME

C‡: Timecode::BBT_Time

Bar, Beat, Tick Time (i.e. Tempo-Based Time)

Constructor
ℂ	Timecode.BBT_TIME (unsigned int, unsigned int, unsigned int)
Data Members
int	bars
int	beats
int	ticks

∁ Timecode:Time

C‡: Timecode::Time

Constructor
ℂ	Timecode.Time (double)
Data Members
bool	drop
	Whether this Time uses dropframe Timecode
unsigned int	frames
	Timecode frames (not audio frames)
unsigned int	hours
unsigned int	minutes
bool	negative
double	rate
	Frame rate of this Time
unsigned int	seconds
unsigned int	subframes
	Typically unused

∁ Vamp:Plugin

C‡: Vamp::Plugin

is-a: Vamp:PluginBase

Vamp::Plugin is a base class for plugin instance classes that provide feature extraction from audio or related data.

In most cases, the input will be audio and the output will be a stream of derived data at a lower sampling resolution than the input.

Note that this class inherits several abstract methods from PluginBase. These must be implemented by the subclass.

PLUGIN LIFECYCLE

Feature extraction plugins are managed differently from real-time plugins (such as VST effects). The main difference is that the parameters for a feature extraction plugin are configured before the plugin is used, and do not change during use.

1. Host constructs the plugin, passing it the input sample rate. The plugin may do basic initialisation, but should not do anything computationally expensive at this point. You must make sure your plugin is cheap to construct, otherwise you'll seriously affect the startup performance of almost all hosts. If you have serious initialisation to do, the proper place is in initialise() (step 5).

2. Host may query the plugin's available outputs.

3. Host queries programs and parameter descriptors, and may set some or all of them. Parameters that are not explicitly set should take their default values as specified in the parameter descriptor. When a program is set, the parameter values may change and the host will re-query them to check.

4. Host queries the preferred step size, block size and number of channels. These may all vary depending on the parameter values. (Note however that you cannot make the number of distinct outputs dependent on parameter values.)

5. Plugin is properly initialised with a call to initialise. This fixes the step size, block size, and number of channels, as well as all of the parameter and program settings. If the values passed in to initialise do not match the plugin's advertised preferred values from step 4, the plugin may refuse to initialise and return false (although if possible it should accept the new values). Any computationally expensive setup code should take place here.

6. Host finally checks the number of values, resolution, extents etc per output (which may vary depending on the number of channels, step size and block size as well as the parameter values).

7. Host will repeatedly call the process method to pass in blocks of input data. This method may return features extracted from that data (if the plugin is causal).

8. Host will call getRemainingFeatures exactly once, after all the input data has been processed. This may return any non-causal or leftover features.

9. At any point after initialise was called, the host may optionally call the reset method and restart processing. (This does not mean it can change the parameters, which are fixed from initialise until destruction.)

A plugin does not need to handle the case where setParameter or selectProgram is called after initialise has been called. It's the host's responsibility not to do that. Similarly, the plugin may safely assume that initialise is called no more than once.

Methods
InputDomain	getInputDomain ()
	Get the plugin's required input domain. If this is TimeDomain, the samples provided to the process() function (below) will be in the time domain, as for a traditional audio processing plugin. If this is FrequencyDomain, the host will carry out a windowed FFT of size equal to the negotiated block size on the data before passing the frequency bin data in to process(). The input data for the FFT will be rotated so as to place the origin in the centre of the block. The plugin does not get to choose the window type -- the host will either let the user do so, or will use a Hanning window.
unsigned long	getMaxChannelCount ()
	Get the maximum supported number of input channels.
unsigned long	getMinChannelCount ()
	Get the minimum supported number of input channels.
OutputList	getOutputDescriptors ()
	Get the outputs of this plugin. An output's index in this list is used as its numeric index when looking it up in the FeatureSet returned from the process() call.
unsigned long	getPreferredBlockSize ()
	Get the preferred block size (window size -- the number of sample frames passed in each block to the process() function). This should be called before initialise(). A plugin that can handle any block size may return 0. The final block size will be set in the initialise() call.
unsigned long	getPreferredStepSize ()
	Get the preferred step size (window increment -- the distance in sample frames between the start frames of consecutive blocks passed to the process() function) for the plugin. This should be called before initialise(). A plugin may return 0 if it has no particular interest in the step size. In this case, the host should make the step size equal to the block size if the plugin is accepting input in the time domain. If the plugin is accepting input in the frequency domain, the host may use any step size. The final step size will be set in the initialise() call.
FeatureSet	getRemainingFeatures ()
	After all blocks have been processed, calculate and return any remaining features derived from the complete input.
std::string	getType ()
	Used to distinguish between Vamp::Plugin and other potential sibling subclasses of PluginBase. Do not reimplement this function in your subclass.
bool	initialise (unsigned long, unsigned long, unsigned long)
	Initialise a plugin to prepare it for use with the given number of input channels, step size (window increment, in sample frames) and block size (window size, in sample frames). The input sample rate should have been already specified at construction time. Return true for successful initialisation, false if the number of input channels, step size and/or block size cannot be supported.
void	reset ()
	Reset the plugin after use, to prepare it for another clean run. Not called for the first initialisation (i.e. initialise must also do a reset).

Inherited from Vamp:PluginBase

Methods
std::string	getCopyright ()
	Get the copyright statement or licensing summary for the plugin. This can be an informative text, without the same presentation constraints as mentioned for getMaker above.
std::string	getCurrentProgram ()
	Get the current program.
std::string	getDescription ()
	Get a human-readable description for the plugin, typically a line of text that may optionally be displayed in addition to the plugin's "name". May be empty if the name has said it all already. Example: "Detect and count zero crossing points"
std::string	getIdentifier ()
	Get the computer-usable name of the plugin. This should be reasonably short and contain no whitespace or punctuation characters. It may only contain the characters [a-zA-Z0-9_-]. This is the authoritative way for a program to identify a plugin within a given library. This text may be visible to the user, but it should not be the main text used to identify a plugin to the user (that will be the name, below). Example: "zero_crossings"
std::string	getMaker ()
	Get the name of the author or vendor of the plugin in human-readable form. This should be a short identifying text, as it may be used to label plugins from the same source in a menu or similar.
std::string	getName ()
	Get a human-readable name or title of the plugin. This should be brief and self-contained, as it may be used to identify the plugin to the user in isolation (i.e. without also showing the plugin's "identifier"). Example: "Zero Crossings"
float	getParameter (std::string)
	Get the value of a named parameter. The argument is the identifier field from that parameter's descriptor.
ParameterList	getParameterDescriptors ()
	Get the controllable parameters of this plugin.
int	getPluginVersion ()
	Get the version number of the plugin.
StringVector	getPrograms ()
	Get the program settings available in this plugin. A program is a named shorthand for a set of parameter values; changing the program may cause the plugin to alter the values of its published parameters (and/or non-public internal processing parameters). The host should re-read the plugin's parameter values after setting a new program. The programs must have unique names.
void	selectProgram (std::string)
	Select a program. (If the given program name is not one of the available programs, do nothing.)
void	setParameter (std::string, float)
	Set a named parameter. The first argument is the identifier field from that parameter's descriptor.

∁ Vamp:Plugin:Feature

C‡: Vamp::Plugin::Feature

Data Members
Vamp:RealTime	duration
	Duration of the output feature. This is mandatory if the output has VariableSampleRate or FixedSampleRate and hasDuration is true, and unused otherwise.
bool	hasDuration
	True if an output feature has a specified duration. This is optional if the output has VariableSampleRate or FixedSampleRate, and and unused if the output has OneSamplePerStep.
bool	hasTimestamp
	True if an output feature has its own timestamp. This is mandatory if the output has VariableSampleRate, optional if the output has FixedSampleRate, and unused if the output has OneSamplePerStep.
std::string	label
	Label for the sample of this feature.
Vamp:RealTime	timestamp
	Timestamp of the output feature. This is mandatory if the output has VariableSampleRate or if the output has FixedSampleRate and hasTimestamp is true, and unused otherwise.
C:FloatVector	values
	Results for a single sample of this feature. If the output hasFixedBinCount, there must be the same number of values as the output's binCount count.

∁ Vamp:Plugin:FeatureList

C‡: std::vector<Vamp::Plugin::Feature >

Constructor
ℂ	Vamp.Plugin.FeatureList ()
ℂ	Vamp.Plugin.FeatureList ()
Methods
LuaTable	add (LuaTable {Feature})
Feature	at (unsigned long)
void	clear ()
bool	empty ()
LuaIter	iter ()
void	push_back (Feature)
unsigned long	size ()
LuaTable	table ()
...	to_array (--lua--)

∁ Vamp:Plugin:FeatureSet

C‡: std::map<int, std::vector<Vamp::Plugin::Feature > > > >

Constructor
ℂ	Vamp.Plugin.FeatureSet ()
Methods
LuaTable	add (LuaTable {Feature})
...	at (--lua--)
void	clear ()
unsigned long	count (int)
bool	empty ()
LuaIter	iter ()
unsigned long	size ()
LuaTable	table ()

∁ Vamp:Plugin:OutputDescriptor

C‡: Vamp::Plugin::OutputDescriptor

Data Members
unsigned long	binCount
	The number of values per result of the output. Undefined if hasFixedBinCount is false. If this is zero, the output is point data (i.e. only the time of each output is of interest, the value list will be empty).
C:StringVector	binNames
	The (human-readable) names of each of the bins, if appropriate. This is always optional.
std::string	description
	A human-readable short text describing the output. May be empty if the name has said it all already. Example: "The number of zero crossing points per processing block"
bool	hasDuration
	True if the returned results for this output are known to have a duration field.
bool	hasFixedBinCount
	True if the output has the same number of values per sample for every output sample. Outputs for which this is false are unlikely to be very useful in a general-purpose host.
bool	hasKnownExtents
	True if the results in each output bin fall within a fixed numeric range (minimum and maximum values). Undefined if binCount is zero.
std::string	identifier
	The name of the output, in computer-usable form. Should be reasonably short and without whitespace or punctuation, using the characters [a-zA-Z0-9_-] only. Example: "zero_crossing_count"
bool	isQuantized
	True if the output values are quantized to a particular resolution. Undefined if binCount is zero.
float	maxValue
	Maximum value of the results in the output. Undefined if hasKnownExtents is false or binCount is zero.
float	minValue
	Minimum value of the results in the output. Undefined if hasKnownExtents is false or binCount is zero.
float	quantizeStep
	Quantization resolution of the output values (e.g. 1.0 if they are all integers). Undefined if isQuantized is false or binCount is zero.
float	sampleRate
	Sample rate of the output results, as samples per second. Undefined if sampleType is OneSamplePerStep. If sampleType is VariableSampleRate and this value is non-zero, then it may be used to calculate a resolution for the output (i.e. the "duration" of each sample, in time, will be 1/sampleRate seconds). It's recommended to set this to zero if that behaviour is not desired.
Vamp.Plugin.OutputDescriptor.SampleType	sampleType
	Positioning in time of the output results.
std::string	unit
	The unit of the output, in human-readable form.

∁ Vamp:Plugin:OutputList

C‡: std::vector<Vamp::Plugin::OutputDescriptor >

Constructor
ℂ	Vamp.Plugin.OutputList ()
ℂ	Vamp.Plugin.OutputList ()
Methods
LuaTable	add (LuaTable {OutputDescriptor})
OutputDescriptor	at (unsigned long)
void	clear ()
bool	empty ()
LuaIter	iter ()
void	push_back (OutputDescriptor)
unsigned long	size ()
LuaTable	table ()
...	to_array (--lua--)

∁ Vamp:PluginBase

C‡: Vamp::PluginBase

A base class for plugins with optional configurable parameters, programs, etc. The Vamp::Plugin is derived from this, and individual Vamp plugins should derive from that.

This class does not provide the necessary interfaces to instantiate or run a plugin. It only specifies an interface for retrieving those controls that the host may wish to show to the user for editing. It could meaningfully be subclassed by real-time plugins or other sorts of plugin as well as Vamp plugins.

Methods
std::string	getCopyright ()
	Get the copyright statement or licensing summary for the plugin. This can be an informative text, without the same presentation constraints as mentioned for getMaker above.
std::string	getCurrentProgram ()
	Get the current program.
std::string	getDescription ()
	Get a human-readable description for the plugin, typically a line of text that may optionally be displayed in addition to the plugin's "name". May be empty if the name has said it all already. Example: "Detect and count zero crossing points"
std::string	getIdentifier ()
	Get the computer-usable name of the plugin. This should be reasonably short and contain no whitespace or punctuation characters. It may only contain the characters [a-zA-Z0-9_-]. This is the authoritative way for a program to identify a plugin within a given library. This text may be visible to the user, but it should not be the main text used to identify a plugin to the user (that will be the name, below). Example: "zero_crossings"
std::string	getMaker ()
	Get the name of the author or vendor of the plugin in human-readable form. This should be a short identifying text, as it may be used to label plugins from the same source in a menu or similar.
std::string	getName ()
	Get a human-readable name or title of the plugin. This should be brief and self-contained, as it may be used to identify the plugin to the user in isolation (i.e. without also showing the plugin's "identifier"). Example: "Zero Crossings"
float	getParameter (std::string)
	Get the value of a named parameter. The argument is the identifier field from that parameter's descriptor.
ParameterList	getParameterDescriptors ()
	Get the controllable parameters of this plugin.
int	getPluginVersion ()
	Get the version number of the plugin.
StringVector	getPrograms ()
	Get the program settings available in this plugin. A program is a named shorthand for a set of parameter values; changing the program may cause the plugin to alter the values of its published parameters (and/or non-public internal processing parameters). The host should re-read the plugin's parameter values after setting a new program. The programs must have unique names.
std::string	getType ()
	Get the type of plugin. This is to be implemented by the immediate subclass, not by actual plugins. Do not attempt to implement this in plugin code.
void	selectProgram (std::string)
	Select a program. (If the given program name is not one of the available programs, do nothing.)
void	setParameter (std::string, float)
	Set a named parameter. The first argument is the identifier field from that parameter's descriptor.

∁ Vamp:PluginBase:ParameterDescriptor

C‡: Vamp::PluginBase::ParameterDescriptor

Data Members
float	defaultValue
	The default value of the parameter. The plugin should ensure that parameters have this value on initialisation (i.e. the host is not required to explicitly set parameters if it wants to use their default values).
std::string	description
	A human-readable short text describing the parameter. May be empty if the name has said it all already.
std::string	identifier
	The name of the parameter, in computer-usable form. Should be reasonably short, and may only contain the characters [a-zA-Z0-9_-].
bool	isQuantized
	True if the parameter values are quantized to a particular resolution.
float	maxValue
	The maximum value of the parameter.
float	minValue
	The minimum value of the parameter.
std::string	name
	The human-readable name of the parameter.
float	quantizeStep
	Quantization resolution of the parameter values (e.g. 1.0 if they are all integers). Undefined if isQuantized is false.
std::string	unit
	The unit of the parameter, in human-readable form.
C:StringVector	valueNames
	Names for the quantized values. If isQuantized is true, this may either be empty or contain one string for each of the quantize steps from minValue up to maxValue inclusive. Undefined if isQuantized is false. If these names are provided, they should be shown to the user in preference to the values themselves. The user may never see the actual numeric values unless they are also encoded in the names.

∁ Vamp:PluginBase:ParameterList

C‡: std::vector<Vamp::PluginBase::ParameterDescriptor >

Constructor
ℂ	Vamp.PluginBase.ParameterList ()
ℂ	Vamp.PluginBase.ParameterList ()
Methods
LuaTable	add (LuaTable {ParameterDescriptor})
ParameterDescriptor	at (unsigned long)
void	clear ()
bool	empty ()
LuaIter	iter ()
void	push_back (ParameterDescriptor)
unsigned long	size ()
LuaTable	table ()
...	to_array (--lua--)

∁ Vamp:RealTime

C‡: Vamp::RealTime

RealTime represents time values to nanosecond precision with accurate arithmetic and frame-rate conversion functions.

Constructor
ℂ	Vamp.RealTime (int, int)
Methods
RealTime	frame2RealTime (long, unsigned int)
int	msec ()
long	realTime2Frame (RealTime, unsigned int)
std::string	toString ()
	Return a human-readable debug-type string to full precision (probably not a format to show to a user directly)
int	usec ()
Data Members
int	nsec
int	sec

ℕ os

Methods
int	execute (std::string)
LuaTable	forkexec ()

Enum/Constants

∈ PBD.Controllable.GroupControlDisposition

PBD.GroupControlDisposition.InverseGroup
PBD.GroupControlDisposition.NoGroup
PBD.GroupControlDisposition.UseGroup

∈ Timecode.TimecodeFormat

Timecode.TimecodeFormat.TC23976
Timecode.TimecodeFormat.TC24
Timecode.TimecodeFormat.TC24976
Timecode.TimecodeFormat.TC25
Timecode.TimecodeFormat.TC2997
Timecode.TimecodeFormat.TC2997DF
Timecode.TimecodeFormat.TC2997000
Timecode.TimecodeFormat.TC2997000DF
Timecode.TimecodeFormat.TC30
Timecode.TimecodeFormat.TC5994
Timecode.TimecodeFormat.TC60

∈ Evoral.ControlList.InterpolationStyle

Evoral.InterpolationStyle.Discrete
Evoral.InterpolationStyle.Linear
Evoral.InterpolationStyle.Curved

∈ Evoral.EventType

Evoral.EventType.NO_EVENT
Evoral.EventType.MIDI_EVENT
Evoral.EventType.LIVE_MIDI_EVENT

∈ Vamp.Plugin.InputDomain

Vamp.Plugin.InputDomain.TimeDomain
Vamp.Plugin.InputDomain.FrequencyDomain

∈ Vamp.Plugin.OutputDescriptor.SampleType

Vamp.Plugin.OutputDescriptor.SampleType.OneSamplePerStep
Vamp.Plugin.OutputDescriptor.SampleType.FixedSampleRate
Vamp.Plugin.OutputDescriptor.SampleType.VariableSampleRate

∈ ARDOUR.ChanMapping

ARDOUR.ChanMapping.Invalid

∈ PBD.PropertyDescriptor<long>*

ARDOUR.Properties.Start
ARDOUR.Properties.Length
ARDOUR.Properties.Position

∈ ARDOUR.PresentationInfo

ARDOUR.PresentationInfo.max_order

∈ ARDOUR.PluginType

ARDOUR.PluginType.AudioUnit
ARDOUR.PluginType.LADSPA
ARDOUR.PluginType.LV2
ARDOUR.PluginType.Windows_VST
ARDOUR.PluginType.LXVST
ARDOUR.PluginType.MacVST
ARDOUR.PluginType.Lua
ARDOUR.PluginType.VST3

∈ ARDOUR.PresentationInfo.Flag

ARDOUR.PresentationInfo.Flag.AudioTrack
ARDOUR.PresentationInfo.Flag.MidiTrack
ARDOUR.PresentationInfo.Flag.AudioBus
ARDOUR.PresentationInfo.Flag.MidiBus
ARDOUR.PresentationInfo.Flag.VCA
ARDOUR.PresentationInfo.Flag.MasterOut
ARDOUR.PresentationInfo.Flag.MonitorOut
ARDOUR.PresentationInfo.Flag.Auditioner
ARDOUR.PresentationInfo.Flag.Hidden
ARDOUR.PresentationInfo.Flag.GroupOrderSet
ARDOUR.PresentationInfo.Flag.StatusMask

∈ ARDOUR.AutoState

ARDOUR.AutoState.Off
ARDOUR.AutoState.Write
ARDOUR.AutoState.Touch
ARDOUR.AutoState.Play
ARDOUR.AutoState.Latch

∈ ARDOUR.AutomationType

ARDOUR.AutomationType.GainAutomation
ARDOUR.AutomationType.BusSendLevel
ARDOUR.AutomationType.PluginAutomation
ARDOUR.AutomationType.SoloAutomation
ARDOUR.AutomationType.SoloIsolateAutomation
ARDOUR.AutomationType.SoloSafeAutomation
ARDOUR.AutomationType.MuteAutomation
ARDOUR.AutomationType.RecEnableAutomation
ARDOUR.AutomationType.RecSafeAutomation
ARDOUR.AutomationType.TrimAutomation
ARDOUR.AutomationType.PhaseAutomation
ARDOUR.AutomationType.MidiCCAutomation
ARDOUR.AutomationType.MidiPgmChangeAutomation
ARDOUR.AutomationType.MidiPitchBenderAutomation
ARDOUR.AutomationType.MidiChannelPressureAutomation
ARDOUR.AutomationType.MidiNotePressureAutomation
ARDOUR.AutomationType.MidiSystemExclusiveAutomation

∈ ARDOUR.SrcQuality

ARDOUR.SrcQuality.SrcBest

∈ ARDOUR.MeterType

ARDOUR.MeterType.MeterMaxSignal
ARDOUR.MeterType.MeterMaxPeak
ARDOUR.MeterType.MeterPeak
ARDOUR.MeterType.MeterKrms
ARDOUR.MeterType.MeterK20
ARDOUR.MeterType.MeterK14
ARDOUR.MeterType.MeterIEC1DIN
ARDOUR.MeterType.MeterIEC1NOR
ARDOUR.MeterType.MeterIEC2BBC
ARDOUR.MeterType.MeterIEC2EBU
ARDOUR.MeterType.MeterVU
ARDOUR.MeterType.MeterK12
ARDOUR.MeterType.MeterPeak0dB
ARDOUR.MeterType.MeterMCP

∈ ARDOUR.MeterPoint

ARDOUR.MeterPoint.MeterInput
ARDOUR.MeterPoint.MeterPreFader
ARDOUR.MeterPoint.MeterPostFader
ARDOUR.MeterPoint.MeterOutput
ARDOUR.MeterPoint.MeterCustom

∈ ARDOUR.Placement

ARDOUR.Placement.PreFader
ARDOUR.Placement.PostFader

∈ ARDOUR.MonitorChoice

ARDOUR.MonitorChoice.MonitorAuto
ARDOUR.MonitorChoice.MonitorInput
ARDOUR.MonitorChoice.MonitorDisk
ARDOUR.MonitorChoice.MonitorCue

∈ ARDOUR.NoteMode

ARDOUR.NoteMode.Sustained
ARDOUR.NoteMode.Percussive

∈ ARDOUR.PortFlags

ARDOUR.PortFlags.IsInput
ARDOUR.PortFlags.IsOutput
ARDOUR.PortFlags.IsPhysical
ARDOUR.PortFlags.CanMonitor
ARDOUR.PortFlags.IsTerminal

∈ ARDOUR.MidiPortFlags

ARDOUR.MidiPortFlags.MidiPortMusic
ARDOUR.MidiPortFlags.MidiPortControl
ARDOUR.MidiPortFlags.MidiPortSelection
ARDOUR.MidiPortFlags.MidiPortVirtual

∈ ARDOUR.PlaylistDisposition

ARDOUR.PlaylistDisposition.CopyPlaylist
ARDOUR.PlaylistDisposition.NewPlaylist
ARDOUR.PlaylistDisposition.SharePlaylist

∈ ARDOUR.MidiTrackNameSource

ARDOUR.MidiTrackNameSource.SMFTrackNumber
ARDOUR.MidiTrackNameSource.SMFTrackName
ARDOUR.MidiTrackNameSource.SMFInstrumentName

∈ ARDOUR.MidiTempoMapDisposition

ARDOUR.MidiTempoMapDisposition.SMFTempoIgnore
ARDOUR.MidiTempoMapDisposition.SMFTempoUse

∈ ARDOUR.RegionEquivalence

ARDOUR.RegionEquivalence.Exact
ARDOUR.RegionEquivalence.Enclosed
ARDOUR.RegionEquivalence.Overlap
ARDOUR.RegionEquivalence.LayerTime

∈ ARDOUR.RegionPoint

ARDOUR.RegionPoint.Start
ARDOUR.RegionPoint.End
ARDOUR.RegionPoint.SyncPoint

∈ ARDOUR.PositionLockStyle

ARDOUR.TempoSection.PositionLockStyle.AudioTime
ARDOUR.TempoSection.PositionLockStyle.MusicTime

∈ ARDOUR.TempoSection.Type

ARDOUR.TempoSection.Type.Ramp
ARDOUR.TempoSection.Type.Constant

∈ ARDOUR.TrackMode

ARDOUR.TrackMode.Normal
ARDOUR.TrackMode.NonLayered

∈ ARDOUR.TransportRequestSource

ARDOUR.TransportRequestSource.TRS_Engine
ARDOUR.TransportRequestSource.TRS_UI

∈ ARDOUR.LocateTransportDisposition

ARDOUR.LocateTransportDisposition.MustRoll
ARDOUR.LocateTransportDisposition.MustStop
ARDOUR.LocateTransportDisposition.RollIfAppropriate

∈ ARDOUR.SampleFormat

ARDOUR.SampleFormat.Float
ARDOUR.SampleFormat.Int24
ARDOUR.SampleFormat.Int16

∈ ARDOUR.HeaderFormat

ARDOUR.HeaderFormat.BWF
ARDOUR.HeaderFormat.WAVE
ARDOUR.HeaderFormat.WAVE64
ARDOUR.HeaderFormat.CAF
ARDOUR.HeaderFormat.AIFF
ARDOUR.HeaderFormat.iXML
ARDOUR.HeaderFormat.RF64
ARDOUR.HeaderFormat.RF64_WAV
ARDOUR.HeaderFormat.MBWF
ARDOUR.HeaderFormat.FLAC

∈ ARDOUR.InsertMergePolicy

ARDOUR.InsertMergePolicy.Reject
ARDOUR.InsertMergePolicy.Relax
ARDOUR.InsertMergePolicy.Replace
ARDOUR.InsertMergePolicy.TruncateExisting
ARDOUR.InsertMergePolicy.TruncateAddition
ARDOUR.InsertMergePolicy.Extend

∈ ARDOUR.AFLPosition

ARDOUR.AFLPosition.AFLFromBeforeProcessors
ARDOUR.AFLPosition.AFLFromAfterProcessors

∈ ARDOUR.PFLPosition

ARDOUR.PFLPosition.PFLFromBeforeProcessors
ARDOUR.PFLPosition.PFLFromAfterProcessors

∈ ARDOUR.AutoReturnTarget

ARDOUR.AutoReturnTarget.LastLocate
ARDOUR.AutoReturnTarget.RangeSelectionStart
ARDOUR.AutoReturnTarget.Loop
ARDOUR.AutoReturnTarget.RegionSelectionStart

∈ ARDOUR.FadeShape

ARDOUR.FadeShape.FadeLinear
ARDOUR.FadeShape.FadeFast
ARDOUR.FadeShape.FadeSlow
ARDOUR.FadeShape.FadeConstantPower
ARDOUR.FadeShape.FadeSymmetric

∈ ARDOUR.LoopFadeChoice

ARDOUR.LoopFadeChoice.NoLoopFade
ARDOUR.LoopFadeChoice.EndLoopFade
ARDOUR.LoopFadeChoice.BothLoopFade
ARDOUR.LoopFadeChoice.XFadeLoop

∈ ARDOUR.DenormalModel

ARDOUR.DenormalModel.DenormalNone
ARDOUR.DenormalModel.DenormalFTZ
ARDOUR.DenormalModel.DenormalDAZ
ARDOUR.DenormalModel.DenormalFTZDAZ

∈ ARDOUR.BufferingPreset

ARDOUR.BufferingPreset.Small
ARDOUR.BufferingPreset.Medium
ARDOUR.BufferingPreset.Large
ARDOUR.BufferingPreset.Custom

∈ ARDOUR.EditMode

ARDOUR.EditMode.Slide
ARDOUR.EditMode.Splice
ARDOUR.EditMode.Ripple
ARDOUR.EditMode.Lock

∈ ARDOUR.AutoConnectOption

ARDOUR.AutoConnectOption.ManualConnect
ARDOUR.AutoConnectOption.AutoConnectPhysical
ARDOUR.AutoConnectOption.AutoConnectMaster

∈ ARDOUR.LayerModel

ARDOUR.LayerModel.LaterHigher
ARDOUR.LayerModel.Manual

∈ ARDOUR.ListenPosition

ARDOUR.ListenPosition.AfterFaderListen
ARDOUR.ListenPosition.PreFaderListen

∈ ARDOUR.MonitorModel

ARDOUR.MonitorModel.HardwareMonitoring
ARDOUR.MonitorModel.SoftwareMonitoring
ARDOUR.MonitorModel.ExternalMonitoring

∈ ARDOUR.RegionSelectionAfterSplit

ARDOUR.RegionSelectionAfterSplit.None
ARDOUR.RegionSelectionAfterSplit.NewlyCreatedLeft
ARDOUR.RegionSelectionAfterSplit.NewlyCreatedRight
ARDOUR.RegionSelectionAfterSplit.NewlyCreatedBoth
ARDOUR.RegionSelectionAfterSplit.Existing
ARDOUR.RegionSelectionAfterSplit.ExistingNewlyCreatedLeft
ARDOUR.RegionSelectionAfterSplit.ExistingNewlyCreatedRight
ARDOUR.RegionSelectionAfterSplit.ExistingNewlyCreatedBoth

∈ ARDOUR.RangeSelectionAfterSplit

ARDOUR.RangeSelectionAfterSplit.ClearSel
ARDOUR.RangeSelectionAfterSplit.PreserveSel
ARDOUR.RangeSelectionAfterSplit.ForceSel

∈ ARDOUR.ShuttleBehaviour

ARDOUR.ShuttleBehaviour.Sprung
ARDOUR.ShuttleBehaviour.Wheel

∈ ARDOUR.ScreenSaverMode

ARDOUR.ScreenSaverMode.InhibitNever
ARDOUR.ScreenSaverMode.InhibitWhileRecording
ARDOUR.ScreenSaverMode.InhibitAlways

∈ ARDOUR.ClockDeltaMode

ARDOUR.ClockDeltaMode.NoDelta
ARDOUR.ClockDeltaMode.DeltaEditPoint
ARDOUR.ClockDeltaMode.DeltaOriginMarker

∈ ARDOUR.WaveformScale

ARDOUR.WaveformScale.Linear
ARDOUR.WaveformScale.Logarithmic

∈ ARDOUR.WaveformShape

ARDOUR.WaveformShape.Traditional
ARDOUR.WaveformShape.Rectified

∈ ARDOUR.MeterLineUp

ARDOUR.MeterLineUp.MeteringLineUp24
ARDOUR.MeterLineUp.MeteringLineUp20
ARDOUR.MeterLineUp.MeteringLineUp18
ARDOUR.MeterLineUp.MeteringLineUp15

∈ ARDOUR.VUMeterStandard

ARDOUR.VUMeterStandard.MeteringVUfrench
ARDOUR.VUMeterStandard.MeteringVUamerican
ARDOUR.VUMeterStandard.MeteringVUstandard
ARDOUR.VUMeterStandard.MeteringVUeight

∈ ARDOUR.ShuttleUnits

ARDOUR.ShuttleUnits.Percentage
ARDOUR.ShuttleUnits.Semitones

∈ ARDOUR.SyncSource

ARDOUR.SyncSource.Engine
ARDOUR.SyncSource.MTC
ARDOUR.SyncSource.MIDIClock
ARDOUR.SyncSource.LTC

∈ ARDOUR.TracksAutoNamingRule

ARDOUR.TracksAutoNamingRule.UseDefaultNames
ARDOUR.TracksAutoNamingRule.NameAfterDriver

∈ ARDOUR.Session.RecordState

ARDOUR.Session.RecordState.Disabled
ARDOUR.Session.RecordState.Enabled
ARDOUR.Session.RecordState.Recording

∈ ARDOUR.Location.Flags

ARDOUR.LocationFlags.IsMark
ARDOUR.LocationFlags.IsAutoPunch
ARDOUR.LocationFlags.IsAutoLoop
ARDOUR.LocationFlags.IsHidden
ARDOUR.LocationFlags.IsCDMarker
ARDOUR.LocationFlags.IsRangeMarker
ARDOUR.LocationFlags.IsSessionRange
ARDOUR.LocationFlags.IsSkip
ARDOUR.LocationFlags.IsSkipping

∈ Glib.FileTest

ARDOUR.LuaAPI.FileTest.IsRegular
ARDOUR.LuaAPI.FileTest.IsSymlink
ARDOUR.LuaAPI.FileTest.IsDir
ARDOUR.LuaAPI.FileTest.IsExecutable
ARDOUR.LuaAPI.FileTest.Exists

∈ ARDOUR.DSP.Biquad.Type

ARDOUR.DSP.BiquadType.LowPass
ARDOUR.DSP.BiquadType.HighPass
ARDOUR.DSP.BiquadType.BandPassSkirt
ARDOUR.DSP.BiquadType.BandPass0dB
ARDOUR.DSP.BiquadType.Notch
ARDOUR.DSP.BiquadType.AllPass
ARDOUR.DSP.BiquadType.Peaking
ARDOUR.DSP.BiquadType.LowShelf
ARDOUR.DSP.BiquadType.HighShelf

∈ ARDOUR.DSP.Generator.Type

ARDOUR.DSP.NoiseType.UniformWhiteNoise
ARDOUR.DSP.NoiseType.GaussianWhiteNoise
ARDOUR.DSP.NoiseType.PinkNoise

∈ ARDOUR.DSP.LTC_TV_STANDARD

ARDOUR.DSP.LTC_TV_STANDARD.LTC_TV_525_60
ARDOUR.DSP.LTC_TV_STANDARD.LTC_TV_625_50
ARDOUR.DSP.LTC_TV_STANDARD.LTC_TV_1125_60
ARDOUR.DSP.LTC_TV_STANDARD.LTC_TV_FILM_24

∈ ARDOUR.DSP.Convolver.IRChannelConfig

ARDOUR.DSP.IRChannelConfig.Mono
ARDOUR.DSP.IRChannelConfig.MonoToStereo
ARDOUR.DSP.IRChannelConfig.Stereo

∈ Cairo.LineCap

Cairo.LineCap.Butt
Cairo.LineCap.Round
Cairo.LineCap.Square

∈ Cairo.LineJoin

Cairo.LineJoin.Miter
Cairo.LineJoin.Round
Cairo.LineJoin.Bevel

∈ Cairo.Operator

Cairo.Operator.Clear
Cairo.Operator.Source
Cairo.Operator.Over
Cairo.Operator.Add

∈ Cairo.Format

Cairo.Format.ARGB32
Cairo.Format.RGB24

∈ Pango.EllipsizeMode

Cairo.EllipsizeMode.None
Cairo.EllipsizeMode.Start
Cairo.EllipsizeMode.Middle
Cairo.EllipsizeMode.End

∈ Pango.Alignment

Cairo.Alignment.Left
Cairo.Alignment.Center
Cairo.Alignment.Right

∈ Pango.WrapMode

Cairo.WrapMode.Word
Cairo.WrapMode.Char
Cairo.WrapMode.WordChar

∈ LuaDialog.Message.MessageType

LuaDialog.MessageType.Info
LuaDialog.MessageType.Warning
LuaDialog.MessageType.Question
LuaDialog.MessageType.Error

∈ LuaDialog.Message.ButtonType

LuaDialog.ButtonType.OK
LuaDialog.ButtonType.Close
LuaDialog.ButtonType.Cancel
LuaDialog.ButtonType.Yes_No
LuaDialog.ButtonType.OK_Cancel

∈ LuaDialog.Response

LuaDialog.Response.OK
LuaDialog.Response.Cancel
LuaDialog.Response.Close
LuaDialog.Response.Yes
LuaDialog.Response.No
LuaDialog.Response.None

∈ RouteDialogs.InsertAt

ArdourUI.InsertAt.BeforeSelection
ArdourUI.InsertAt.AfterSelection
ArdourUI.InsertAt.First
ArdourUI.InsertAt.Last

∈ ArdourMarker.Type

ArdourUI.MarkerType.Mark
ArdourUI.MarkerType.Tempo
ArdourUI.MarkerType.Meter
ArdourUI.MarkerType.SessionStart
ArdourUI.MarkerType.SessionEnd
ArdourUI.MarkerType.RangeStart
ArdourUI.MarkerType.RangeEnd
ArdourUI.MarkerType.LoopStart
ArdourUI.MarkerType.LoopEnd
ArdourUI.MarkerType.PunchIn
ArdourUI.MarkerType.PunchOut

∈ Selection.Operation

ArdourUI.SelectionOp.Toggle
ArdourUI.SelectionOp.Set
ArdourUI.SelectionOp.Extend
ArdourUI.SelectionOp.Add

∈ TimeAxisView.TrackHeightMode

ArdourUI.TrackHeightMode.OnlySelf
ArdourUI.TrackHeightMode.TotalHeight
ArdourUI.TrackHeightMode.HeightPerLane,

∈ Editing.GridType

Editing.GridTypeNone
Editing.GridTypeBar
Editing.GridTypeBeat
Editing.GridTypeBeatDiv2
Editing.GridTypeBeatDiv4
Editing.GridTypeBeatDiv8
Editing.GridTypeBeatDiv16
Editing.GridTypeBeatDiv32
Editing.GridTypeBeatDiv3
Editing.GridTypeBeatDiv6
Editing.GridTypeBeatDiv12
Editing.GridTypeBeatDiv24
Editing.GridTypeBeatDiv5
Editing.GridTypeBeatDiv10
Editing.GridTypeBeatDiv20
Editing.GridTypeBeatDiv7
Editing.GridTypeBeatDiv14
Editing.GridTypeBeatDiv28
Editing.GridTypeTimecode
Editing.GridTypeMinSec
Editing.GridTypeCDFrame

∈ Editing.SnapMode

Editing.SnapOff
Editing.SnapNormal
Editing.SnapMagnetic

∈ Editing.MouseMode

Editing.MouseObject
Editing.MouseRange
Editing.MouseCut
Editing.MouseTimeFX
Editing.MouseAudition
Editing.MouseDraw
Editing.MouseContent

∈ Editing.ZoomFocus

Editing.ZoomFocusLeft
Editing.ZoomFocusRight
Editing.ZoomFocusCenter
Editing.ZoomFocusPlayhead
Editing.ZoomFocusMouse
Editing.ZoomFocusEdit

∈ Editing.DisplayControl

Editing.FollowPlayhead
Editing.ShowMeasures
Editing.ShowWaveforms
Editing.ShowWaveformsRecording

∈ Editing.ImportMode

Editing.ImportAsRegion
Editing.ImportToTrack
Editing.ImportAsTrack

∈ Editing.ImportPosition

Editing.ImportAtTimestamp
Editing.ImportAtEditPoint
Editing.ImportAtPlayhead
Editing.ImportAtStart

∈ Editing.ImportDisposition

Editing.ImportDistinctFiles
Editing.ImportMergeFiles
Editing.ImportSerializeFiles
Editing.ImportDistinctChannels

∈ LuaSignal.LuaSignal

LuaSignal.ConfigChanged
LuaSignal.EngineRunning
LuaSignal.EngineStopped
LuaSignal.EngineHalted
LuaSignal.EngineDeviceListChanged
LuaSignal.BufferSizeChanged
LuaSignal.SampleRateChanged
LuaSignal.FeedbackDetected
LuaSignal.SuccessfulGraphSort
LuaSignal.StartTimeChanged
LuaSignal.EndTimeChanged
LuaSignal.Exported
LuaSignal.Change
LuaSignal.SessionConfigChanged
LuaSignal.TransportStateChange
LuaSignal.DirtyChanged
LuaSignal.StateSaved
LuaSignal.Xrun
LuaSignal.TransportLooped
LuaSignal.SoloActive
LuaSignal.SoloChanged
LuaSignal.IsolatedChanged
LuaSignal.MonitorChanged
LuaSignal.RecordStateChanged
LuaSignal.RecordArmStateChanged
LuaSignal.AudioLoopLocationChanged
LuaSignal.AudioPunchLocationChanged
LuaSignal.LocationsModified
LuaSignal.AuditionActive
LuaSignal.BundleAddedOrRemoved
LuaSignal.PositionChanged
LuaSignal.Located
LuaSignal.RoutesReconnected
LuaSignal.RouteAdded
LuaSignal.RouteGroupPropertyChanged
LuaSignal.RouteAddedToRouteGroup
LuaSignal.RouteRemovedFromRouteGroup
LuaSignal.StepEditStatusChange
LuaSignal.RouteGroupAdded
LuaSignal.RouteGroupRemoved
LuaSignal.RouteGroupsReordered
LuaSignal.PluginListChanged
LuaSignal.PluginStatusChanged
LuaSignal.DiskOverrun
LuaSignal.DiskUnderrun
LuaSignal.RegionPropertyChanged
LuaSignal.LuaTimerS
LuaSignal.LuaTimerDS
LuaSignal.SetSession

Class Index

ARDOUR
ARDOUR:Amp
ARDOUR:AsyncMIDIPort
ARDOUR:AudioBackend
ARDOUR:AudioBackendInfo
ARDOUR:AudioBuffer
ARDOUR:AudioEngine
ARDOUR:AudioPlaylist
ARDOUR:AudioPort
ARDOUR:AudioPortMeters
ARDOUR:AudioRange
ARDOUR:AudioRangeList
ARDOUR:AudioRegion
ARDOUR:AudioRom
ARDOUR:AudioSource
ARDOUR:AudioTrack
ARDOUR:AudioTrackList
ARDOUR:Automatable
ARDOUR:AutomatableSequence
ARDOUR:AutomationControl
ARDOUR:AutomationList
ARDOUR:BackendVector
ARDOUR:BeatsSamplesConverter
ARDOUR:BufferSet
ARDOUR:ChanCount
ARDOUR:ChanMapping
ARDOUR:ControlList
ARDOUR:ControlListPtr
ARDOUR.DSP
ARDOUR:DSP:Biquad
ARDOUR:DSP:Convolution
ARDOUR:DSP:Convolver
ARDOUR:DSP:DspShm
ARDOUR:DSP:FFTSpectrum
ARDOUR:DSP:Generator
ARDOUR:DSP:IRSettings
ARDOUR:DSP:LTCReader
ARDOUR:DSP:LowPass
ARDOUR:DataType
ARDOUR:DelayLine
ARDOUR:Delivery
ARDOUR:DeviceStatus
ARDOUR:DeviceStatusVector
ARDOUR:DiskIOProcessor
ARDOUR:DiskReader
ARDOUR:DiskWriter
ARDOUR:DoubleBeatsSamplesConverter
ARDOUR:EventList
ARDOUR:FileSource
ARDOUR:FluidSynth
ARDOUR:GainControl
ARDOUR:IO
ARDOUR:IOProcessor
ARDOUR:InterThreadInfo
ARDOUR:InternalReturn
ARDOUR:InternalSend
ARDOUR:LatencyRange
ARDOUR:Latent
ARDOUR:Location
ARDOUR:LocationList
ARDOUR:Locations
ARDOUR.LuaAPI
ARDOUR:LuaAPI:Rubberband
ARDOUR:LuaAPI:Vamp
ARDOUR:LuaOSC:Address
ARDOUR:LuaProc
ARDOUR:LuaTableRef
ARDOUR:MIDIPortMeters
ARDOUR:Meter
ARDOUR:MeterSection
ARDOUR:MetricSection
ARDOUR:MidiBuffer
ARDOUR:MidiModel
ARDOUR:MidiModel:DiffCommand
ARDOUR:MidiModel:NoteDiffCommand
ARDOUR:MidiPlaylist
ARDOUR:MidiPort
ARDOUR:MidiRegion
ARDOUR:MidiSource
ARDOUR:MidiTrack
ARDOUR:MidiTrackList
ARDOUR:MonitorProcessor
ARDOUR:MusicSample
ARDOUR:MuteControl
ARDOUR:NotePtrList
ARDOUR:OwnedPropertyList
ARDOUR:PDC
ARDOUR:PannerShell
ARDOUR:ParameterDescriptor
ARDOUR:PeakMeter
ARDOUR:PhaseControl
ARDOUR:Playlist
ARDOUR:PlaylistList
ARDOUR:Plugin
ARDOUR:Plugin:IOPortDescription
ARDOUR:PluginControl
ARDOUR:PluginInfo
ARDOUR:PluginInfoList
ARDOUR:PluginInsert
ARDOUR.PluginType
ARDOUR:PolarityProcessor
ARDOUR:Port
ARDOUR:PortEngine
ARDOUR:PortList
ARDOUR:PortManager
ARDOUR:PortSet
ARDOUR:PresentationInfo
ARDOUR:PresetRecord
ARDOUR:PresetVector
ARDOUR:Processor
ARDOUR:ProcessorList
ARDOUR:ProcessorVector
ARDOUR:Progress
ARDOUR:Properties:BoolProperty
ARDOUR:Properties:FloatProperty
ARDOUR:Properties:SampleposProperty
ARDOUR:PropertyChange
ARDOUR:PropertyList
ARDOUR:RCConfiguration
ARDOUR:RawMidiParser
ARDOUR:ReadOnlyControl
ARDOUR:Readable
ARDOUR:ReadableList
ARDOUR:Region
ARDOUR:RegionFactory
ARDOUR:RegionList
ARDOUR:RegionListPtr
ARDOUR:RegionMap
ARDOUR:RegionVector
ARDOUR:Return
ARDOUR:Route
ARDOUR:Route:ProcessorStreams
ARDOUR:RouteGroup
ARDOUR:RouteGroupList
ARDOUR:RouteList
ARDOUR:RouteListPtr
ARDOUR:Send
ARDOUR:Session
ARDOUR:SessionConfiguration
ARDOUR:SessionObject
ARDOUR:SessionObjectPtr
ARDOUR:SessionPlaylists
ARDOUR:SideChain
ARDOUR:Slavable
ARDOUR:SlavableAutomationControl
ARDOUR:SoloControl
ARDOUR:SoloIsolateControl
ARDOUR:SoloSafeControl
ARDOUR:Source
ARDOUR:SourceList
ARDOUR:Stripable
ARDOUR:StripableList
ARDOUR:Tempo
ARDOUR:TempoMap
ARDOUR:TempoSection
ARDOUR:Track
ARDOUR:UnknownProcessor
ARDOUR:VCA
ARDOUR:VCAList
ARDOUR:VCAManager
ARDOUR:VCAVector
ARDOUR:WeakAudioSourceList
ARDOUR:WeakRouteList
ARDOUR:WeakSourceList
ARDOUR:XrunPositions
ArdourUI
ArdourUI:ArdourMarker
ArdourUI:ArdourMarkerList
ArdourUI:AxisView
ArdourUI:Editor
ArdourUI:MarkerSelection
ArdourUI:RegionSelection
ArdourUI:RegionView
ArdourUI:RouteTimeAxisView
ArdourUI:RouteUI
ArdourUI:Selectable
ArdourUI:Selection
ArdourUI:SelectionList
ArdourUI:StripableTimeAxisView
ArdourUI:TimeAxisView
ArdourUI:TimeAxisViewItem
ArdourUI:TimeSelection
ArdourUI:TrackSelection
ArdourUI:TrackViewList
ArdourUI:TrackViewStdList
ArdourUI:UIConfiguration
C:ByteArray
C:ByteVector
C:DoubleArray
C:DoubleVector
C:FloatArray
C:FloatArrayVector
C:FloatVector
C:Int64List
C:IntArray
C:StringList
C:StringVector
Cairo:Context
Cairo:ImageSurface
Cairo:PangoLayout
Evoral:Beats
Evoral:Control
Evoral:ControlEvent
Evoral:ControlList
Evoral:ControlSet
Evoral:Event
Evoral:NotePtr
Evoral:Parameter
Evoral:ParameterDescriptor
Evoral:Range
Evoral:Sequence
LuaDialog:Dialog
LuaDialog:Message
LuaDialog:ProgressWindow
LuaSignal:Set
PBD
PBD:Command
PBD:Configuration
PBD:Controllable
PBD:ID
PBD:IdVector
PBD:RingBuffer8
PBD:RingBufferF
PBD:RingBufferI
PBD:Stateful
PBD:StatefulDestructible
PBD:StatefulDestructiblePtr
PBD:StatefulDiffCommand
PBD:StatefulPtr
PBD:XMLNode
Timecode:BBT_TIME
Timecode:Time
Vamp:Plugin
Vamp:Plugin:Feature
Vamp:Plugin:FeatureList
Vamp:Plugin:FeatureSet
Vamp:Plugin:OutputDescriptor
Vamp:Plugin:OutputList
Vamp:PluginBase
Vamp:PluginBase:ParameterDescriptor
Vamp:PluginBase:ParameterList
Vamp:RealTime
os