diff --git a/include/class-reference.html b/include/class-reference.html index 72a3e785..7f8b9768 100644 --- a/include/class-reference.html +++ b/include/class-reference.html @@ -175,6 +175,7 @@

Inherited from ARDOUR:Processor

PolarityProcessorto_polarityprocessor () Sendto_send () SideChainto_sidechain () + SurroundSendto_surroundsend () UnknownProcessorto_unknownprocessor ()

Inherited from ARDOUR:SessionObjectPtr

@@ -641,7 +642,7 @@

Inherited from ARDOUR:Track

Methods Regionbounce (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)

- Regionbounce_range (long, long, InterThreadInfo&, Processor, bool, std::string) + Regionbounce_range (long, long, InterThreadInfo&, Processor, bool, std::string, bool)

Bounce the given range to a new audio region.

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

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

boolbounceable (Processor, bool)

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

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

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

@@ -667,10 +668,12 @@

Inherited from ARDOUR:Route

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

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

Returns 0 on success, non-0 on failure.

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

enable custom plugin-insert configuration

proc
Processor to customize
count
number of plugin instances to use (if zero, reset to default)
outs
output port customization
sinks
input pins for variable-I/O plugins

Returns true if successful

DataTypedata_type () + Stripablefirst_selected_stripable () IOinput () Deliverymain_outs ()

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

@@ -695,6 +698,8 @@

Inherited from ARDOUR:Route

replace plugin/processor with another

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

Returns 0 on success

boolreset_plugin_insert (Processor)

reset plugin-insert configuration to default, disable customizations.

This is equivalent to calling 

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

Returns true if successful

+ voidselect_next_stripable (bool, bool) + voidselect_prev_stripable (bool, bool) voidset_active (bool, void*) voidset_comment (std::string, void*) voidset_meter_point (MeterPoint) @@ -702,6 +707,8 @@

Inherited from ARDOUR:Route

longsignal_latency () boolsoloed () boolstrict_io () + SurroundReturnsurround_return () + SurroundSendsurround_send () Processorthe_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.

Amptrim () @@ -711,22 +718,8 @@

Inherited from ARDOUR:Route

Inherited from ARDOUR:Stripable

- - - - - - - - - - - - - - @@ -734,6 +727,9 @@

Inherited from ARDOUR:Stripable

+ + + @@ -772,6 +768,14 @@

Inherited from ARDOUR:SessionObjectPtr

Methods
AutomationControlcomp_enable_controllable ()
AutomationControlcomp_makeup_controllable ()
AutomationControlcomp_mode_controllable ()
ReadOnlyControlcomp_redux_controllable ()
AutomationControlcomp_speed_controllable ()
AutomationControlcomp_threshold_controllable ()
unsigned inteq_band_cnt ()
std::stringeq_band_name (unsigned int)
AutomationControleq_enable_controllable ()
AutomationControleq_freq_controllable (unsigned int)
AutomationControleq_gain_controllable (unsigned int)
AutomationControleq_q_controllable (unsigned int)
AutomationControleq_shape_controllable (unsigned int)
AutomationControlfilter_enable_controllable (bool)
AutomationControlfilter_freq_controllable (bool)
AutomationControlfilter_slope_controllable (bool)
GainControlgain_control ()
boolis_auditioner ()
boolis_hidden ()
boolis_monitor ()
boolis_private_route ()
boolis_selected ()
boolis_surround_master ()
AutomationControlmapped_control (WellKnownCtrl, unsigned int)
ReadOnlyControlmapped_output (WellKnownData)
AutomationControlmaster_send_enable_controllable ()
MonitorProcessormonitor_control ()
MuteControlmute_control ()
Statefulto_stateful ()
StatefulDestructibleto_statefuldestructible ()
+

Inherited from PBD:Stateful

+ + + + + + +
Methods
voidclear_changes ()

Forget about any changes to this object's properties

IDid ()
OwnedPropertyListproperties ()

∁ ARDOUR:AudioTrackList

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

@@ -1339,6 +1343,7 @@

Inherited from ARDOUR:Processor

PolarityProcessorto_polarityprocessor () Sendto_send () SideChainto_sidechain () + SurroundSendto_surroundsend () UnknownProcessorto_unknownprocessor ()

Inherited from ARDOUR:SessionObjectPtr

@@ -1400,6 +1405,7 @@

Inherited from ARDOUR:Processor

PolarityProcessorto_polarityprocessor () Sendto_send () SideChainto_sidechain () + SurroundSendto_surroundsend () UnknownProcessorto_unknownprocessor ()

Inherited from ARDOUR:SessionObjectPtr

@@ -1480,6 +1486,7 @@

Inherited from ARDOUR:Processor

PolarityProcessorto_polarityprocessor () Sendto_send () SideChainto_sidechain () + SurroundSendto_surroundsend () UnknownProcessorto_unknownprocessor ()

Inherited from ARDOUR:SessionObjectPtr

@@ -1532,6 +1539,7 @@

Inherited from ARDOUR:Processor

PolarityProcessorto_polarityprocessor () Sendto_send () SideChainto_sidechain () + SurroundSendto_surroundsend () UnknownProcessorto_unknownprocessor ()

Inherited from ARDOUR:SessionObjectPtr

@@ -1584,6 +1592,7 @@

Inherited from ARDOUR:Processor

PolarityProcessorto_polarityprocessor () Sendto_send () SideChainto_sidechain () + SurroundSendto_surroundsend () UnknownProcessorto_unknownprocessor ()

Inherited from ARDOUR:SessionObjectPtr

@@ -1808,6 +1817,7 @@

Inherited from ARDOUR:Processor

PolarityProcessorto_polarityprocessor () Sendto_send () SideChainto_sidechain () + SurroundSendto_surroundsend () UnknownProcessorto_unknownprocessor ()

Inherited from ARDOUR:SessionObjectPtr

@@ -1878,6 +1888,7 @@

Inherited from ARDOUR:Processor

PolarityProcessorto_polarityprocessor () Sendto_send () SideChainto_sidechain () + SurroundSendto_surroundsend () UnknownProcessorto_unknownprocessor ()

Inherited from ARDOUR:SessionObjectPtr

@@ -1960,6 +1971,7 @@

Inherited from ARDOUR:Processor

PolarityProcessorto_polarityprocessor () Sendto_send () SideChainto_sidechain () + SurroundSendto_surroundsend () UnknownProcessorto_unknownprocessor ()

Inherited from ARDOUR:SessionObjectPtr

@@ -2674,7 +2686,7 @@

Inherited from ARDOUR:Track

Methods Regionbounce (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)

- Regionbounce_range (long, long, InterThreadInfo&, Processor, bool, std::string) + Regionbounce_range (long, long, InterThreadInfo&, Processor, bool, std::string, bool)

Bounce the given range to a new audio region.

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

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

boolbounceable (Processor, bool)

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

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

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

@@ -2700,10 +2712,12 @@

Inherited from ARDOUR:Route

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

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

Returns 0 on success, non-0 on failure.

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

enable custom plugin-insert configuration

proc
Processor to customize
count
number of plugin instances to use (if zero, reset to default)
outs
output port customization
sinks
input pins for variable-I/O plugins

Returns true if successful

DataTypedata_type () + Stripablefirst_selected_stripable () IOinput () Deliverymain_outs ()

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

@@ -2728,6 +2742,8 @@

Inherited from ARDOUR:Route

replace plugin/processor with another

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

Returns 0 on success

boolreset_plugin_insert (Processor)

reset plugin-insert configuration to default, disable customizations.

This is equivalent to calling 

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

Returns true if successful

+ voidselect_next_stripable (bool, bool) + voidselect_prev_stripable (bool, bool) voidset_active (bool, void*) voidset_comment (std::string, void*) voidset_meter_point (MeterPoint) @@ -2735,6 +2751,8 @@

Inherited from ARDOUR:Route

longsignal_latency () boolsoloed () boolstrict_io () + SurroundReturnsurround_return () + SurroundSendsurround_send () Processorthe_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.

Amptrim () @@ -2744,22 +2762,8 @@

Inherited from ARDOUR:Route

Inherited from ARDOUR:Stripable

- - - - - - - - - - - - - - @@ -2767,6 +2771,9 @@

Inherited from ARDOUR:Stripable

+ + + @@ -2805,6 +2812,14 @@

Inherited from ARDOUR:SessionObjectPtr

Methods
AutomationControlcomp_enable_controllable ()
AutomationControlcomp_makeup_controllable ()
AutomationControlcomp_mode_controllable ()
ReadOnlyControlcomp_redux_controllable ()
AutomationControlcomp_speed_controllable ()
AutomationControlcomp_threshold_controllable ()
unsigned inteq_band_cnt ()
std::stringeq_band_name (unsigned int)
AutomationControleq_enable_controllable ()
AutomationControleq_freq_controllable (unsigned int)
AutomationControleq_gain_controllable (unsigned int)
AutomationControleq_q_controllable (unsigned int)
AutomationControleq_shape_controllable (unsigned int)
AutomationControlfilter_enable_controllable (bool)
AutomationControlfilter_freq_controllable (bool)
AutomationControlfilter_slope_controllable (bool)
GainControlgain_control ()
boolis_auditioner ()
boolis_hidden ()
boolis_monitor ()
boolis_private_route ()
boolis_selected ()
boolis_surround_master ()
AutomationControlmapped_control (WellKnownCtrl, unsigned int)
ReadOnlyControlmapped_output (WellKnownData)
AutomationControlmaster_send_enable_controllable ()
MonitorProcessormonitor_control ()
MuteControlmute_control ()
Statefulto_stateful ()
StatefulDestructibleto_statefuldestructible ()
+

Inherited from PBD:Stateful

+ + + + + + +
Methods
voidclear_changes ()

Forget about any changes to this object's properties

IDid ()
OwnedPropertyListproperties ()

∁ ARDOUR:MidiTrackList

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

@@ -2969,6 +2984,7 @@

Inherited from ARDOUR:Processor

PolarityProcessorto_polarityprocessor () Sendto_send () SideChainto_sidechain () + SurroundSendto_surroundsend () UnknownProcessorto_unknownprocessor ()

Inherited from ARDOUR:SessionObjectPtr

@@ -3197,6 +3213,7 @@

Inherited from ARDOUR:Processor

PolarityProcessorto_polarityprocessor () Sendto_send () SideChainto_sidechain () + SurroundSendto_surroundsend () UnknownProcessorto_unknownprocessor ()

Inherited from ARDOUR:SessionObjectPtr

@@ -3542,6 +3559,7 @@

Inherited from ARDOUR:Processor

PolarityProcessorto_polarityprocessor () Sendto_send () SideChainto_sidechain () + SurroundSendto_surroundsend () UnknownProcessorto_unknownprocessor ()

Inherited from ARDOUR:SessionObjectPtr

@@ -3600,6 +3618,7 @@

Inherited from ARDOUR:Processor

PolarityProcessorto_polarityprocessor () Sendto_send () SideChainto_sidechain () + SurroundSendto_surroundsend () UnknownProcessorto_unknownprocessor ()

Inherited from ARDOUR:SessionObjectPtr

@@ -3792,6 +3811,7 @@

& PolarityProcessorto_polarityprocessor () Sendto_send () SideChainto_sidechain () + SurroundSendto_surroundsend () UnknownProcessorto_unknownprocessor ()

Inherited from ARDOUR:SessionObjectPtr

@@ -3980,6 +4000,7 @@

∁boolget_mute_affects_main_outs () boolget_mute_affects_post_fader () boolget_mute_affects_pre_fader () + boolget_mute_affects_surround_sends () boolget_new_plugins_active () unsigned intget_osc_port () AutoConnectOptionget_output_auto_connect () @@ -4153,6 +4174,7 @@

∁boolset_mute_affects_main_outs (bool) boolset_mute_affects_post_fader (bool) boolset_mute_affects_pre_fader (bool) + boolset_mute_affects_surround_sends (bool) boolset_new_plugins_active (bool) boolset_osc_port (unsigned int) boolset_output_auto_connect (AutoConnectOption) @@ -4327,6 +4349,7 @@

∁boolmute_affects_main_outs boolmute_affects_post_fader boolmute_affects_pre_fader + boolmute_affects_surround_sends boolnew_plugins_active unsigned intosc_port ARDOUR.AutoConnectOptionoutput_auto_connect @@ -4687,6 +4710,7 @@

Inherited from ARDOUR:Processor

PolarityProcessorto_polarityprocessor () Sendto_send () SideChainto_sidechain () + SurroundSendto_surroundsend () UnknownProcessorto_unknownprocessor ()

Inherited from ARDOUR:SessionObjectPtr

@@ -4699,9 +4723,9 @@

Inherited from ARDOUR:SessionObjectPtr

↠ ARDOUR:Route

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

-

is-a: ARDOUR:Stripable

+

is-a: ARDOUR:Stripable, PBD:Stateful

-

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

+

Base class for objects with saveable and undoable state

@@ -4712,10 +4736,12 @@

&Rarr

+ + @@ -4741,6 +4767,8 @@

&Rarr

+ + @@ -4749,6 +4777,8 @@

&Rarr

+ + @@ -4758,22 +4788,8 @@

&Rarr

Inherited from ARDOUR:Stripable

Methods
boolactive ()

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

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

Returns 0 on success, non-0 on failure.

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

enable custom plugin-insert configuration

proc
Processor to customize
count
number of plugin instances to use (if zero, reset to default)
outs
output port customization
sinks
input pins for variable-I/O plugins

Returns true if successful

DataTypedata_type ()
Stripablefirst_selected_stripable ()
IOinput ()
boolisnil ()
Deliverymain_outs ()

replace plugin/processor with another

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

Returns 0 on success

boolreset_plugin_insert (Processor)

reset plugin-insert configuration to default, disable customizations.

This is equivalent to calling 

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

Returns true if successful

voidselect_next_stripable (bool, bool)
voidselect_prev_stripable (bool, bool)
voidset_active (bool, void*)
voidset_comment (std::string, void*)
voidset_meter_point (MeterPoint)
longsignal_latency ()
boolsoloed ()
boolstrict_io ()
SurroundReturnsurround_return ()
SurroundSendsurround_send ()
Processorthe_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.

Amptrim ()
- - - - - - - - - - - - - - @@ -4781,6 +4797,9 @@

Inherited from ARDOUR:Stripable

+ + + @@ -4819,6 +4838,14 @@

Inherited from ARDOUR:SessionObjectPtr

Methods
AutomationControlcomp_enable_controllable ()
AutomationControlcomp_makeup_controllable ()
AutomationControlcomp_mode_controllable ()
ReadOnlyControlcomp_redux_controllable ()
AutomationControlcomp_speed_controllable ()
AutomationControlcomp_threshold_controllable ()
unsigned inteq_band_cnt ()
std::stringeq_band_name (unsigned int)
AutomationControleq_enable_controllable ()
AutomationControleq_freq_controllable (unsigned int)
AutomationControleq_gain_controllable (unsigned int)
AutomationControleq_q_controllable (unsigned int)
AutomationControleq_shape_controllable (unsigned int)
AutomationControlfilter_enable_controllable (bool)
AutomationControlfilter_freq_controllable (bool)
AutomationControlfilter_slope_controllable (bool)
GainControlgain_control ()
boolis_auditioner ()
boolis_hidden ()
boolis_monitor ()
boolis_private_route ()
boolis_selected ()
boolis_surround_master ()
AutomationControlmapped_control (WellKnownCtrl, unsigned int)
ReadOnlyControlmapped_output (WellKnownData)
AutomationControlmaster_send_enable_controllable ()
MonitorProcessormonitor_control ()
MuteControlmute_control ()
Statefulto_stateful ()
StatefulDestructibleto_statefuldestructible ()
+

Inherited from PBD:Stateful

+ + + + + + +
Methods
voidclear_changes ()

Forget about any changes to this object's properties

IDid ()
OwnedPropertyListproperties ()

∁ ARDOUR:Route:ProcessorStreams

C‡: ARDOUR::Route::ProcessorStreams

@@ -4988,6 +5015,7 @@

Inherited from ARDOUR:Processor

PolarityProcessorto_polarityprocessor () Sendto_send () SideChainto_sidechain () + SurroundSendto_surroundsend () UnknownProcessorto_unknownprocessor ()

Inherited from ARDOUR:SessionObjectPtr

@@ -5097,6 +5125,7 @@

∁  intsave_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

voidscripts_changed () + Routeselection () boolsession_range_is_free () voidset_control (AutomationControl, double, GroupControlDisposition) voidset_controls (ControlListPtr, double, GroupControlDisposition) @@ -5188,6 +5217,7 @@

&comp boolget_triggerbox_overrides_disk_monitoring () boolget_use_monitor_fades () boolget_use_region_fades () + boolget_use_surround_master () boolget_use_transport_fades () boolget_use_video_file_fps () boolget_use_video_sync () @@ -5243,6 +5273,7 @@

&comp boolset_triggerbox_overrides_disk_monitoring (bool) boolset_use_monitor_fades (bool) boolset_use_region_fades (bool) + boolset_use_surround_master (bool) boolset_use_transport_fades (bool) boolset_use_video_file_fps (bool) boolset_use_video_sync (bool) @@ -5299,6 +5330,7 @@

&comp booltriggerbox_overrides_disk_monitoring booluse_monitor_fades booluse_region_fades + booluse_surround_master booluse_transport_fades booluse_video_file_fps booluse_video_sync @@ -5403,6 +5435,7 @@

Inherited from ARDOUR:Processor

PolarityProcessorto_polarityprocessor () Sendto_send () SideChainto_sidechain () + SurroundSendto_surroundsend () UnknownProcessorto_unknownprocessor ()

Inherited from ARDOUR:SessionObjectPtr

@@ -5743,22 +5776,8 @@

&

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

- - - - - - - - - - - - - - @@ -5766,7 +5785,10 @@

&

+ + + @@ -5820,6 +5842,141 @@

∁

Methods
AutomationControlcomp_enable_controllable ()
AutomationControlcomp_makeup_controllable ()
AutomationControlcomp_mode_controllable ()
ReadOnlyControlcomp_redux_controllable ()
AutomationControlcomp_speed_controllable ()
AutomationControlcomp_threshold_controllable ()
unsigned inteq_band_cnt ()
std::stringeq_band_name (unsigned int)
AutomationControleq_enable_controllable ()
AutomationControleq_freq_controllable (unsigned int)
AutomationControleq_gain_controllable (unsigned int)
AutomationControleq_q_controllable (unsigned int)
AutomationControleq_shape_controllable (unsigned int)
AutomationControlfilter_enable_controllable (bool)
AutomationControlfilter_freq_controllable (bool)
AutomationControlfilter_slope_controllable (bool)
GainControlgain_control ()
boolis_auditioner ()
boolis_hidden ()
boolis_monitor ()
boolis_private_route ()
boolis_selected ()
boolis_surround_master ()
boolisnil ()
AutomationControlmapped_control (WellKnownCtrl, unsigned int)
ReadOnlyControlmapped_output (WellKnownData)
AutomationControlmaster_send_enable_controllable ()
MonitorProcessormonitor_control ()
MuteControlmute_control ()
unsigned longsize ()
LuaTabletable ()
+

↠ ARDOUR:SurroundPannable

+

C‡: std::shared_ptr< ARDOUR::SurroundPannable >, std::weak_ptr< ARDOUR::SurroundPannable >

+

is-a: ARDOUR:Automatable

+
+

Base class for objects with saveable and undoable state

+ + + + + + + + + +
Methods
boolisnil ()
Data Members
ARDOUR:AutomationControlname
ARDOUR:AutomationControlname
ARDOUR:AutomationControlname
ARDOUR:AutomationControlname
ARDOUR:AutomationControlname
+

Inherited from ARDOUR:Automatable

+ + + + + + + +
Methods
ParameterListall_automatable_params ()

API for Lua binding

AutomationControlautomation_control (Parameter, bool)
Cast
Slavableto_slavable ()
+

↠ ARDOUR:SurroundReturn

+

C‡: std::shared_ptr< ARDOUR::SurroundReturn >, std::weak_ptr< ARDOUR::SurroundReturn >

+

is-a: ARDOUR:Processor

+
+

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

+ + + +
Methods
boolisnil ()
+

Inherited from ARDOUR:Processor

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Methods
voidactivate ()
boolactive ()
longcapture_offset ()
voiddeactivate ()
std::stringdisplay_name ()
booldisplay_to_user ()
longinput_latency ()
ChanCountinput_streams ()
longoutput_latency ()
ChanCountoutput_streams ()
longplayback_offset ()
longsignal_latency ()
Cast
Ampto_amp ()
Automatableto_automatable ()
DelayLineto_delayline ()
DiskIOProcessorto_diskioprocessor ()
DiskReaderto_diskreader ()
DiskWriterto_diskwriter ()
PluginInsertto_insert ()
InternalSendto_internalsend ()
IOProcessorto_ioprocessor ()
Latentto_latent ()
PeakMeterto_meter ()
MonitorProcessorto_monitorprocessor ()
PeakMeterto_peakmeter ()
PluginInsertto_plugininsert ()
PolarityProcessorto_polarityprocessor ()
Sendto_send ()
SideChainto_sidechain ()
SurroundSendto_surroundsend ()
UnknownProcessorto_unknownprocessor ()
+

Inherited from ARDOUR:SessionObjectPtr

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

↠ ARDOUR:SurroundSend

+

C‡: std::shared_ptr< ARDOUR::SurroundSend >, std::weak_ptr< ARDOUR::SurroundSend >

+

is-a: ARDOUR:Processor

+
+

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

+ + + + + + + + +
Methods
GainControlgain_control ()
longget_delay_in ()
longget_delay_out ()
boolisnil ()
GainControln_pannables ()
SurroundPannablepannable (unsigned long)
+

Inherited from ARDOUR:Processor

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Methods
voidactivate ()
boolactive ()
longcapture_offset ()
voiddeactivate ()
std::stringdisplay_name ()
booldisplay_to_user ()
longinput_latency ()
ChanCountinput_streams ()
longoutput_latency ()
ChanCountoutput_streams ()
longplayback_offset ()
longsignal_latency ()
Cast
Ampto_amp ()
Automatableto_automatable ()
DelayLineto_delayline ()
DiskIOProcessorto_diskioprocessor ()
DiskReaderto_diskreader ()
DiskWriterto_diskwriter ()
PluginInsertto_insert ()
InternalSendto_internalsend ()
IOProcessorto_ioprocessor ()
Latentto_latent ()
PeakMeterto_meter ()
MonitorProcessorto_monitorprocessor ()
PeakMeterto_peakmeter ()
PluginInsertto_plugininsert ()
PolarityProcessorto_polarityprocessor ()
Sendto_send ()
SideChainto_sidechain ()
SurroundSendto_surroundsend ()
UnknownProcessorto_unknownprocessor ()
+

Inherited from ARDOUR:SessionObjectPtr

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

∁ ARDOUR:TimelineRange

C‡: ARDOUR::TimelineRange

@@ -5864,7 +6021,7 @@

&Rarr Methods Regionbounce (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)

- Regionbounce_range (long, long, InterThreadInfo&, Processor, bool, std::string) + Regionbounce_range (long, long, InterThreadInfo&, Processor, bool, std::string, bool)

Bounce the given range to a new audio region.

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

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

boolbounceable (Processor, bool)

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

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

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

@@ -5891,10 +6048,12 @@

Inherited from ARDOUR:Route

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

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

Returns 0 on success, non-0 on failure.

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

enable custom plugin-insert configuration

proc
Processor to customize
count
number of plugin instances to use (if zero, reset to default)
outs
output port customization
sinks
input pins for variable-I/O plugins

Returns true if successful

DataTypedata_type () + Stripablefirst_selected_stripable () IOinput () Deliverymain_outs ()

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

@@ -5919,6 +6078,8 @@

Inherited from ARDOUR:Route

replace plugin/processor with another

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

Returns 0 on success

boolreset_plugin_insert (Processor)

reset plugin-insert configuration to default, disable customizations.

This is equivalent to calling 

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

Returns true if successful

+ voidselect_next_stripable (bool, bool) + voidselect_prev_stripable (bool, bool) voidset_active (bool, void*) voidset_comment (std::string, void*) voidset_meter_point (MeterPoint) @@ -5926,6 +6087,8 @@

Inherited from ARDOUR:Route

longsignal_latency () boolsoloed () boolstrict_io () + SurroundReturnsurround_return () + SurroundSendsurround_send () Processorthe_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.

Amptrim () @@ -5935,22 +6098,8 @@

Inherited from ARDOUR:Route

Inherited from ARDOUR:Stripable

- - - - - - - - - - - - - - @@ -5958,6 +6107,9 @@

Inherited from ARDOUR:Stripable

+ + + @@ -5996,6 +6148,14 @@

Inherited from ARDOUR:SessionObjectPtr

Methods
AutomationControlcomp_enable_controllable ()
AutomationControlcomp_makeup_controllable ()
AutomationControlcomp_mode_controllable ()
ReadOnlyControlcomp_redux_controllable ()
AutomationControlcomp_speed_controllable ()
AutomationControlcomp_threshold_controllable ()
unsigned inteq_band_cnt ()
std::stringeq_band_name (unsigned int)
AutomationControleq_enable_controllable ()
AutomationControleq_freq_controllable (unsigned int)
AutomationControleq_gain_controllable (unsigned int)
AutomationControleq_q_controllable (unsigned int)
AutomationControleq_shape_controllable (unsigned int)
AutomationControlfilter_enable_controllable (bool)
AutomationControlfilter_freq_controllable (bool)
AutomationControlfilter_slope_controllable (bool)
GainControlgain_control ()
boolis_auditioner ()
boolis_hidden ()
boolis_monitor ()
boolis_private_route ()
boolis_selected ()
boolis_surround_master ()
AutomationControlmapped_control (WellKnownCtrl, unsigned int)
ReadOnlyControlmapped_output (WellKnownData)
AutomationControlmaster_send_enable_controllable ()
MonitorProcessormonitor_control ()
MuteControlmute_control ()
Statefulto_stateful ()
StatefulDestructibleto_statefuldestructible ()
+

Inherited from PBD:Stateful

+ + + + + + +
Methods
voidclear_changes ()

Forget about any changes to this object's properties

IDid ()
OwnedPropertyListproperties ()

↠ ARDOUR:UnknownProcessor

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

is-a: ARDOUR:Processor

@@ -6038,6 +6198,7 @@

Inherited from ARDOUR:Processor

PolarityProcessorto_polarityprocessor () Sendto_send () SideChainto_sidechain () + SurroundSendto_surroundsend () UnknownProcessorto_unknownprocessor ()

Inherited from ARDOUR:SessionObjectPtr

@@ -6089,28 +6250,17 @@

↠<

Inherited from ARDOUR:Stripable

- - - - - - - - - - - - - - + + + @@ -6320,6 +6470,7 @@

∁&nbs

+ @@ -6687,6 +6838,7 @@

∁

+ @@ -6705,7 +6857,9 @@

∁

+ + @@ -6729,7 +6883,6 @@

∁

- @@ -6827,6 +6980,7 @@

∁

+ @@ -6845,7 +6999,9 @@

∁

+ + @@ -6869,7 +7025,6 @@

∁

- @@ -6968,6 +7123,7 @@

∁

+ @@ -6986,7 +7142,9 @@

∁

+ + @@ -7010,7 +7168,6 @@

∁

- @@ -8672,6 +8829,56 @@

∈&nb
  • ARDOUR.CueBehavior.FollowCues
  • ARDOUR.CueBehavior.ImplicitlyIgnoreCues
    • +

    ∈ ARDOUR.WellKnownCtrl

    +
      +
    • ARDOUR.WellKnownCtrl.EQ_Enable
      • +
    • ARDOUR.WellKnownCtrl.EQ_BandGain
      • +
    • ARDOUR.WellKnownCtrl.EQ_BandFreq
      • +
    • ARDOUR.WellKnownCtrl.EQ_BandQ
      • +
    • ARDOUR.WellKnownCtrl.EQ_BandShape
      • +
    • ARDOUR.WellKnownCtrl.HPF_Enable
      • +
    • ARDOUR.WellKnownCtrl.HPF_Freq
      • +
    • ARDOUR.WellKnownCtrl.HPF_Slope
      • +
    • ARDOUR.WellKnownCtrl.LPF_Enable
      • +
    • ARDOUR.WellKnownCtrl.LPF_Freq
      • +
    • ARDOUR.WellKnownCtrl.LPF_Slope
      • +
    • ARDOUR.WellKnownCtrl.TapeDrive_Drive
      • +
    • ARDOUR.WellKnownCtrl.TapeDrive_Mode
      • +
    • ARDOUR.WellKnownCtrl.Comp_Enable
      • +
    • ARDOUR.WellKnownCtrl.Comp_Mode
      • +
    • ARDOUR.WellKnownCtrl.Comp_Threshold
      • +
    • ARDOUR.WellKnownCtrl.Comp_Makeup
      • +
    • ARDOUR.WellKnownCtrl.Comp_Ratio
      • +
    • ARDOUR.WellKnownCtrl.Comp_Attack
      • +
    • ARDOUR.WellKnownCtrl.Comp_Release
      • +
    • ARDOUR.WellKnownCtrl.Comp_KeyFilterFreq
      • +
    • ARDOUR.WellKnownCtrl.Gate_Enable
      • +
    • ARDOUR.WellKnownCtrl.Gate_Mode
      • +
    • ARDOUR.WellKnownCtrl.Gate_Threshold
      • +
    • ARDOUR.WellKnownCtrl.Gate_Ratio
      • +
    • ARDOUR.WellKnownCtrl.Gate_Knee
      • +
    • ARDOUR.WellKnownCtrl.Gate_Depth
      • +
    • ARDOUR.WellKnownCtrl.Gate_Hysteresis
      • +
    • ARDOUR.WellKnownCtrl.Gate_Hold
      • +
    • ARDOUR.WellKnownCtrl.Gate_Attack
      • +
    • ARDOUR.WellKnownCtrl.Gate_Release
      • +
    • ARDOUR.WellKnownCtrl.Gate_KeyListen
      • +
    • ARDOUR.WellKnownCtrl.Gate_KeyFilterEnable
      • +
    • ARDOUR.WellKnownCtrl.Gate_KeyFilterFreq
      • +
    • ARDOUR.WellKnownCtrl.Master_Limiter_Enable
      • +
    +

    ∈ ARDOUR.WellKnownData

    +
      +
    • ARDOUR.WellKnownData.TapeDrive_Saturation
      • +
    • ARDOUR.WellKnownData.Master_PhaseCorrelationMin
      • +
    • ARDOUR.WellKnownData.Master_PhaseCorrelationMax
      • +
    • ARDOUR.WellKnownData.Master_KMeter
      • +
    • ARDOUR.WellKnownData.Master_LimiterRedux
      • +
    • ARDOUR.WellKnownData.Comp_Meter
      • +
    • ARDOUR.WellKnownData.Comp_Redux
      • +
    • ARDOUR.WellKnownData.Gate_Meter
      • +
    • ARDOUR.WellKnownData.Gate_Redux
      • +

    ∈ ARDOUR.SampleFormat

    - + -
    Ardour 8.0  -  Sun, 08 Oct 2023 15:30:11 +0200
    +
    Ardour 8.3  -  Tue, 20 Feb 2024 05:24:13 +0100
    Methods
    AutomationControlcomp_enable_controllable ()
    AutomationControlcomp_makeup_controllable ()
    AutomationControlcomp_mode_controllable ()
    ReadOnlyControlcomp_redux_controllable ()
    AutomationControlcomp_speed_controllable ()
    AutomationControlcomp_threshold_controllable ()
    unsigned inteq_band_cnt ()
    std::stringeq_band_name (unsigned int)
    AutomationControleq_enable_controllable ()
    AutomationControleq_freq_controllable (unsigned int)
    AutomationControleq_gain_controllable (unsigned int)
    AutomationControleq_q_controllable (unsigned int)
    AutomationControleq_shape_controllable (unsigned int)
    AutomationControlfilter_enable_controllable (bool)
    AutomationControlfilter_freq_controllable (bool)
    AutomationControlfilter_slope_controllable (bool)
    boolis_auditioner ()
    boolis_hidden ()
    boolis_master ()
    boolis_monitor ()
    boolis_private_route ()
    boolis_selected ()
    boolis_surround_master ()
    AutomationControlmapped_control (WellKnownCtrl, unsigned int)
    ReadOnlyControlmapped_output (WellKnownData)
    AutomationControlmaster_send_enable_controllable ()
    MonitorProcessormonitor_control ()
    AutomationControlpan_azimuth_control ()
    voidclear_playlist (Playlist)
    voidconsider_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
    Routecurrent_mixer_stripable ()
    MouseModecurrent_mouse_mode ()

    Returns The current mouse mode (gain, object, range, timefx etc.) (defined in editing_syms.h)

    longcurrent_page_samples ()
    boolget_never_display_periodic_midi ()
    boolget_new_automation_points_on_lane ()
    boolget_no_new_session_dialog ()
    boolget_no_strobe ()
    NoteNameDisplayget_note_name_display ()
    AppleNSGLViewModeget_nsgl_view_mode ()
    boolget_one_plugin_window_only ()
    boolget_save_export_analysis_image ()
    boolget_save_export_mixer_screenshot ()
    ScreenSaverModeget_screen_saver_mode ()
    boolget_scroll_velocity_editing ()
    ClockDeltaModeget_secondary_clock_delta_mode ()
    boolget_select_last_drawn_note_only ()
    boolget_sensitize_playhead ()
    boolget_show_editor_meter ()
    boolget_show_grids_ruler ()
    boolget_show_toolbar_recpunch ()
    boolget_show_toolbar_selclock ()
    boolget_show_track_meters ()
    boolget_show_triggers_inline ()
    boolget_show_waveform_clipping ()
    boolget_show_waveforms ()
    boolget_show_waveforms_while_recording ()
    boolset_never_display_periodic_midi (bool)
    boolset_new_automation_points_on_lane (bool)
    boolset_no_new_session_dialog (bool)
    boolset_no_strobe (bool)
    boolset_note_name_display (NoteNameDisplay)
    boolset_nsgl_view_mode (AppleNSGLViewMode)
    boolset_one_plugin_window_only (bool)
    boolset_save_export_analysis_image (bool)
    boolset_save_export_mixer_screenshot (bool)
    boolset_screen_saver_mode (ScreenSaverMode)
    boolset_scroll_velocity_editing (bool)
    boolset_secondary_clock_delta_mode (ClockDeltaMode)
    boolset_select_last_drawn_note_only (bool)
    boolset_sensitize_playhead (bool)
    boolset_show_editor_meter (bool)
    boolset_show_grids_ruler (bool)
    boolset_show_toolbar_recpunch (bool)
    boolset_show_toolbar_selclock (bool)
    boolset_show_track_meters (bool)
    boolset_show_triggers_inline (bool)
    boolset_show_waveform_clipping (bool)
    boolset_show_waveforms (bool)
    boolset_show_waveforms_while_recording (bool)
    boolnever_display_periodic_midi
    boolnew_automation_points_on_lane
    boolno_new_session_dialog
    boolno_strobe
    Editing.NoteNameDisplaynote_name_display
    ARDOUR.AppleNSGLViewModensgl_view_mode
    boolone_plugin_window_only
    boolsave_export_analysis_image
    boolsave_export_mixer_screenshot
    ARDOUR.ScreenSaverModescreen_saver_mode
    boolscroll_velocity_editing
    ARDOUR.ClockDeltaModesecondary_clock_delta_mode
    boolselect_last_drawn_note_only
    boolsensitize_playhead
    boolshow_editor_meter
    boolshow_grids_ruler
    boolshow_toolbar_recpunch
    boolshow_toolbar_selclock
    boolshow_track_meters
    boolshow_triggers_inline
    boolshow_waveform_clipping
    boolshow_waveforms
    boolshow_waveforms_while_recording