X-Git-Url: http://shamusworld.gotdns.org/cgi-bin/gitweb.cgi?a=blobdiff_plain;f=include%2Fclass-reference.html;h=6d324b8cb7dc2dd6133ea8bf209ad8fa1dd2404e;hb=54bca41fed4d8a2eae3818151273a94022c6511b;hp=ae1be7d393c8322f67b31ba94e33ab3cc987fcb4;hpb=82a9a26335237c714f9638107174c98e55714c9d;p=ardour-manual diff --git a/include/class-reference.html b/include/class-reference.html index ae1be7d..6d324b8 100644 --- a/include/class-reference.html +++ b/include/class-reference.html @@ -32,10 +32,10 @@ Operations are performed on objects. One gets a reference to an object and then 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 explicily cast to a Track. Methods for casts are provided with each class. Note that the cast may fail and return a nil reference. +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 inhertis from both Stateful and Destructible. +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: @@ -95,7 +95,7 @@ print (rv, ref[1], ref[2])

Pointer Classes

Libardour makes extensive use of reference counted boost::shared_ptr to manage lifetimes. -The Lua bindings provide a complete abstration of this. There are no pointers in lua. +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.

@@ -115,12 +115,18 @@ This is not unlike a = nil a:test() which results in en error "

From the lua side of things there is no distinction between weak and shared pointers. They behave identically. -Below they're inidicated in orange and have an arrow to indicate the pointer type. +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
RCConfigurationconfig ()

↠ ARDOUR:Amp

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

is-a: ARDOUR:Processor

@@ -397,6 +403,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C doublerms (Progress)

Returns the maximum (rms) signal power of the region, or a -1 if the Progress object reports that the process was cancelled.

floatscale_amplitude () + LuaTable(int, ...)separate_by_channel (RegionVector&) voidset_scale_amplitude (float)

Inherited from ARDOUR:Region

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

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

IOinput () Deliverymain_outs () -

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

+

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

boolmuted () ChanCountn_inputs () ChanCountn_outputs () @@ -573,12 +580,12 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C PeakMeterpeak_meter ()

************************************************************* Pure interface begins here*************************************************************

intremove_processor (Processor, ProcessorStreams, bool) -

remove plugin/processor

proc
processor to remove
err
error report (index where removal vailed, channel-count why it failed) may be nil
need_process_lock
if locking is required (set to true, unless called from RT context with lock)

Returns 0 on success

+

remove plugin/processor

proc
processor to remove
err
error report (index where removal failed, 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

intremove_processors (ProcessorList, ProcessorStreams) boolremove_sidechain (Processor) intreorder_processors (ProcessorList, ProcessorStreams) intreplace_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

+

replace plugin/processor with another

old
processor to remove
sub
processor to substitute the old one with
err
error report (index where removal failed, 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

voidset_active (bool, void*) @@ -592,6 +599,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C Amptrim () Cast Automatableto_automatable () + Slavableto_slavable () Trackto_track ()

Inherited from ARDOUR:Stripable

@@ -601,7 +609,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C AutomationControlcomp_makeup_control () AutomationControlcomp_mode_control () std::stringcomp_mode_name (unsigned int) - --MISSING (boost::shared_ptr<ARDOUR::ReadOnlyControl>)--comp_redux_control () + ReadOnlyControlcomp_redux_control () AutomationControlcomp_speed_control () std::stringcomp_speed_name (unsigned int) AutomationControlcomp_threshold_control () @@ -643,6 +651,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C GainControltrim_control () Cast Routeto_route () + VCAto_vca ()

Inherited from ARDOUR:SessionObjectPtr

@@ -678,6 +687,8 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C + +
Methods
AutomationControlautomation_control (Parameter, bool)
boolisnil ()
Cast
Slavableto_slavable ()

↠ ARDOUR:AutomatableSequence

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

@@ -693,6 +704,8 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C + +
Methods
AutomationControlautomation_control (Parameter, bool)
Cast
Slavableto_slavable ()

↠ ARDOUR:AutomationControl

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

@@ -703,19 +716,18 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C Methods AutomationListalist () AutoStateautomation_state () - AutoStyleautomation_style () doubleget_value ()

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

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

Get and Set `internal' value

All derived classes must implement this.

Basic derived classes will ignore

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

Inherited from PBD:Controllable

@@ -756,16 +768,16 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C - + - + - - + + @@ -802,7 +814,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C

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

+

A set of buffers of various types.

These are mainly accessed from Session and passed around as scratch buffers (e.g. 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 (e.g. what they did to the BufferSet). Setting the use counts is realtime safe.

voidclear (double, double)

remove all automation events between the given time range

start
start of range (inclusive) in audio samples
end
end of range (inclusive) in audio samples
voidclear_list ()
doubleeval (double)
doubleeval (double)

query value at given time (takes a read-lock, not safe while writing automation)

where
absolute time in samples

Returns parameter value

EventListevents ()
boolin_write_pass ()
InterpolationStyleinterpolation ()

query interpolation style of the automation data

Returns Interpolation Style

LuaTable(double, ...)rt_safe_eval (double, bool&)
LuaTable(double, ...)rt_safe_eval (double, bool&)

realtime safe version of eval, may fail if read-lock cannot be taken

where
absolute time in samples
ok
boolean reference if returned value is valid

Returns parameter value

voidset_interpolation (InterpolationStyle)

set the interpolation style of the automation data

is
interpolation style
boolset_interpolation (InterpolationStyle)

set 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

voidthin (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)
voidtruncate_end (double)
@@ -1158,17 +1170,17 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
Methods
ChanCountcount ()

↠ ARDOUR:GainControl

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

-

is-a: ARDOUR:SlavableAutomationControl,

+

is-a: ARDOUR:SlavableAutomationControl

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

Methods
boolisnil ()
-

Inherited from ARDOUR:SlavableAutomationControl,

+

Inherited from ARDOUR:SlavableAutomationControl

- + @@ -1181,18 +1193,17 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C - - - + +
Methods
voidadd_master (AutomationControl, bool)
voidadd_master (AutomationControl)
voidclear_masters ()
intget_boolean_masters ()
doubleget_masters_value ()
Methods
AutomationListalist ()
AutoStateautomation_state ()
AutoStyleautomation_style ()
doubleget_value ()

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

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

Get and Set `internal' value

All derived classes must implement this.

Basic derived classes will ignore

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

Inherited from PBD:Controllable

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

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.

+

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 (e.g. MIDI and audio) possible.

@@ -1556,7 +1567,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C - +
Methods
boolactive ()
voidresize (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.

voidsilence (long, long)

Clear (eg zero, or empty) buffer

Clear (e.g. zero, or empty) buffer

unsigned longsize ()
...table (--lua--)
@@ -1581,6 +1592,8 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C + +
Methods
AutomationControlautomation_control (Parameter, bool)
Cast
Slavableto_slavable ()

∅ ARDOUR:MidiModel:DiffCommand

C‡: ARDOUR::MidiModel::DiffCommand

@@ -1915,6 +1928,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C Amptrim () Cast Automatableto_automatable () + Slavableto_slavable () Trackto_track ()

Inherited from ARDOUR:Stripable

@@ -1924,7 +1938,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C AutomationControlcomp_makeup_control () AutomationControlcomp_mode_control () std::stringcomp_mode_name (unsigned int) - --MISSING (boost::shared_ptr<ARDOUR::ReadOnlyControl>)--comp_redux_control () + ReadOnlyControlcomp_redux_control () AutomationControlcomp_speed_control () std::stringcomp_speed_name (unsigned int) AutomationControlcomp_threshold_control () @@ -1966,6 +1980,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C GainControltrim_control () Cast Routeto_route () + VCAto_vca ()

Inherited from ARDOUR:SessionObjectPtr

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

↠ ARDOUR:MuteControl

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

-

is-a: ARDOUR:SlavableAutomationControl,

+

is-a: ARDOUR:SlavableAutomationControl

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

@@ -2081,10 +2096,10 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
boolmuted ()
boolmuted_by_self ()
-

Inherited from ARDOUR:SlavableAutomationControl,

+

Inherited from ARDOUR:SlavableAutomationControl

- + @@ -2097,18 +2112,17 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C - - - + +
Methods
voidadd_master (AutomationControl, bool)
voidadd_master (AutomationControl)
voidclear_masters ()
intget_boolean_masters ()
doubleget_masters_value ()
Methods
AutomationListalist ()
AutoStateautomation_state ()
AutoStyleautomation_style ()
doubleget_value ()

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

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

Get and Set `internal' value

All derived classes must implement this.

Basic derived classes will ignore

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

Inherited from PBD:Controllable

@@ -2178,13 +2192,14 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C -
std::stringmidi_note_name (unsigned char, bool)
Data Members
std::stringlabel
boollogarithmic

Inherited from Evoral:ParameterDescriptor

+ + @@ -2253,18 +2268,17 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C - - - + +
Constructor
ℂEvoral.ParameterDescriptor ()
Data Members
boollogarithmic

True for log-scale parameters

floatlower

Minimum value (in Hz, for frequencies)

floatnormal
Methods
AutomationListalist ()
AutoStateautomation_state ()
AutoStyleautomation_style ()
doubleget_value ()

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

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

Get and Set `internal' value

All derived classes must implement this.

Basic derived classes will ignore

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

Inherited from PBD:Controllable

@@ -2394,18 +2408,17 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C - - - + +
Methods
AutomationListalist ()
AutoStateautomation_state ()
AutoStyleautomation_style ()
doubleget_value ()

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

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

Get and Set `internal' value

All derived classes must implement this.

Basic derived classes will ignore

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

Inherited from PBD:Controllable

@@ -2581,8 +2594,10 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
+ +
Methods
unsigned intcolor ()
Flagflags ()
unsigned intorder ()
voidset_color (unsigned int)
boolspecial (bool)

Inherited from PBD:Stateful

@@ -2721,6 +2736,498 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C

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
AFLPositionget_afl_position ()
boolget_all_safe ()
boolget_allow_special_bus_removal ()
boolget_ask_replace_instrument ()
boolget_ask_setup_instrument ()
floatget_audio_capture_buffer_seconds ()
floatget_audio_playback_buffer_seconds ()
std::stringget_auditioner_output_left ()
std::stringget_auditioner_output_right ()
boolget_auto_analyse_audio ()
boolget_auto_connect_standard_busses ()
AutoReturnTargetget_auto_return_target_list ()
boolget_automation_follows_regions ()
floatget_automation_interval_msecs ()
doubleget_automation_thinning_factor ()
BufferingPresetget_buffering_preset ()
std::stringget_click_emphasis_sound ()
floatget_click_gain ()
boolget_click_record_only ()
std::stringget_click_sound ()
boolget_clicking ()
boolget_copy_demo_sessions ()
boolget_create_xrun_marker ()
FadeShapeget_default_fade_shape ()
std::stringget_default_session_parent_dir ()
DenormalModelget_denormal_model ()
boolget_denormal_protection ()
boolget_disable_disarm_during_roll ()
boolget_discover_audio_units ()
boolget_discover_vst_on_start ()
unsigned intget_disk_choice_space_threshold ()
std::stringget_donate_url ()
EditModeget_edit_mode ()
boolget_exclusive_solo ()
floatget_export_preroll ()
floatget_export_silence_threshold ()
unsigned intget_feedback_interval_ms ()
boolget_first_midi_bank_is_zero ()
std::stringget_freesound_download_dir ()
boolget_hide_dummy_backend ()
boolget_hiding_groups_deactivates_groups ()
intget_history_depth ()
intget_initial_program_change ()
AutoConnectOptionget_input_auto_connect ()
intget_inter_scene_gap_frames ()
boolget_latched_record_enable ()
LayerModelget_layer_model ()
boolget_link_send_and_route_panner ()
std::stringget_linux_pingback_url ()
ListenPositionget_listen_position ()
boolget_locate_while_waiting_for_sync ()
boolget_loop_is_mode ()
std::stringget_ltc_output_port ()
floatget_ltc_output_volume ()
boolget_ltc_send_continuously ()
std::stringget_ltc_source_port ()
floatget_max_gain ()
unsigned intget_max_recent_sessions ()
unsigned intget_max_recent_templates ()
floatget_meter_falloff ()
MeterTypeget_meter_type_bus ()
MeterTypeget_meter_type_master ()
MeterTypeget_meter_type_track ()
std::stringget_midi_audition_synth_uri ()
boolget_midi_feedback ()
boolget_midi_input_follows_selection ()
floatget_midi_readahead ()
floatget_midi_track_buffer_seconds ()
unsigned intget_minimum_disk_read_bytes ()
unsigned intget_minimum_disk_write_bytes ()
boolget_mmc_control ()
intget_mmc_receive_device_id ()
intget_mmc_send_device_id ()
std::stringget_monitor_bus_preferred_bundle ()
MonitorModelget_monitoring_model ()
intget_mtc_qf_speed_tolerance ()
boolget_mute_affects_control_outs ()
boolget_mute_affects_main_outs ()
boolget_mute_affects_post_fader ()
boolget_mute_affects_pre_fader ()
boolget_new_plugins_active ()
unsigned intget_osc_port ()
std::stringget_osx_pingback_url ()
AutoConnectOptionget_output_auto_connect ()
unsigned intget_periodic_safety_backup_interval ()
boolget_periodic_safety_backups ()
PFLPositionget_pfl_position ()
std::stringget_plugin_path_lxvst ()
std::stringget_plugin_path_vst ()
boolget_plugins_stop_with_transport ()
longget_postroll ()
longget_preroll ()
floatget_preroll_seconds ()
intget_processor_usage ()
boolget_quieten_at_speed ()
longget_range_location_minimum ()
std::stringget_reference_manual_url ()
boolget_region_boundaries_from_onscreen_tracks ()
boolget_region_boundaries_from_selected_tracks ()
RegionSelectionAfterSplitget_region_selection_after_split ()
boolget_replicate_missing_region_channels ()
floatget_rf_speed ()
boolget_save_history ()
intget_saved_history_depth ()
boolget_seamless_loop ()
boolget_send_ltc ()
boolget_send_midi_clock ()
boolget_send_mmc ()
boolget_send_mtc ()
boolget_show_solo_mutes ()
boolget_show_video_export_info ()
boolget_show_video_server_dialog ()
ShuttleBehaviourget_shuttle_behaviour ()
floatget_shuttle_max_speed ()
floatget_shuttle_speed_factor ()
floatget_shuttle_speed_threshold ()
ShuttleUnitsget_shuttle_units ()
boolget_skip_playback ()
boolget_solo_control_is_listen_control ()
floatget_solo_mute_gain ()
boolget_solo_mute_override ()
boolget_stop_at_session_end ()
boolget_stop_recording_on_xrun ()
boolget_strict_io ()
SyncSourceget_sync_source ()
boolget_tape_machine_mode ()
boolget_timecode_source_2997 ()
boolget_timecode_source_is_synced ()
boolget_timecode_sync_frame_rate ()
boolget_trace_midi_input ()
boolget_trace_midi_output ()
TracksAutoNamingRuleget_tracks_auto_naming ()
floatget_transient_sensitivity ()
boolget_try_autostart_engine ()
std::stringget_tutorial_manual_url ()
std::stringget_updates_url ()
boolget_use_click_emphasis ()
boolget_use_lxvst ()
boolget_use_macvst ()
boolget_use_monitor_bus ()
boolget_use_osc ()
boolget_use_overlap_equivalency ()
boolget_use_plugin_own_gui ()
boolget_use_tranzport ()
boolget_use_windows_vst ()
boolget_verbose_plugin_scan ()
boolget_verify_remove_last_capture ()
boolget_video_advanced_setup ()
std::stringget_video_server_docroot ()
std::stringget_video_server_url ()
intget_vst_scan_timeout ()
std::stringget_windows_pingback_url ()
boolset_afl_position (AFLPosition)
boolset_all_safe (bool)
boolset_allow_special_bus_removal (bool)
boolset_ask_replace_instrument (bool)
boolset_ask_setup_instrument (bool)
boolset_audio_capture_buffer_seconds (float)
boolset_audio_playback_buffer_seconds (float)
boolset_auditioner_output_left (std::string)
boolset_auditioner_output_right (std::string)
boolset_auto_analyse_audio (bool)
boolset_auto_connect_standard_busses (bool)
boolset_auto_return_target_list (AutoReturnTarget)
boolset_automation_follows_regions (bool)
boolset_automation_interval_msecs (float)
boolset_automation_thinning_factor (double)
boolset_buffering_preset (BufferingPreset)
boolset_click_emphasis_sound (std::string)
boolset_click_gain (float)
boolset_click_record_only (bool)
boolset_click_sound (std::string)
boolset_clicking (bool)
boolset_copy_demo_sessions (bool)
boolset_create_xrun_marker (bool)
boolset_default_fade_shape (FadeShape)
boolset_default_session_parent_dir (std::string)
boolset_denormal_model (DenormalModel)
boolset_denormal_protection (bool)
boolset_disable_disarm_during_roll (bool)
boolset_discover_audio_units (bool)
boolset_discover_vst_on_start (bool)
boolset_disk_choice_space_threshold (unsigned int)
boolset_donate_url (std::string)
boolset_edit_mode (EditMode)
boolset_exclusive_solo (bool)
boolset_export_preroll (float)
boolset_export_silence_threshold (float)
boolset_feedback_interval_ms (unsigned int)
boolset_first_midi_bank_is_zero (bool)
boolset_freesound_download_dir (std::string)
boolset_hide_dummy_backend (bool)
boolset_hiding_groups_deactivates_groups (bool)
boolset_history_depth (int)
boolset_initial_program_change (int)
boolset_input_auto_connect (AutoConnectOption)
boolset_inter_scene_gap_frames (int)
boolset_latched_record_enable (bool)
boolset_layer_model (LayerModel)
boolset_link_send_and_route_panner (bool)
boolset_linux_pingback_url (std::string)
boolset_listen_position (ListenPosition)
boolset_locate_while_waiting_for_sync (bool)
boolset_loop_is_mode (bool)
boolset_ltc_output_port (std::string)
boolset_ltc_output_volume (float)
boolset_ltc_send_continuously (bool)
boolset_ltc_source_port (std::string)
boolset_max_gain (float)
boolset_max_recent_sessions (unsigned int)
boolset_max_recent_templates (unsigned int)
boolset_meter_falloff (float)
boolset_meter_type_bus (MeterType)
boolset_meter_type_master (MeterType)
boolset_meter_type_track (MeterType)
boolset_midi_audition_synth_uri (std::string)
boolset_midi_feedback (bool)
boolset_midi_input_follows_selection (bool)
boolset_midi_readahead (float)
boolset_midi_track_buffer_seconds (float)
boolset_minimum_disk_read_bytes (unsigned int)
boolset_minimum_disk_write_bytes (unsigned int)
boolset_mmc_control (bool)
boolset_mmc_receive_device_id (int)
boolset_mmc_send_device_id (int)
boolset_monitor_bus_preferred_bundle (std::string)
boolset_monitoring_model (MonitorModel)
boolset_mtc_qf_speed_tolerance (int)
boolset_mute_affects_control_outs (bool)
boolset_mute_affects_main_outs (bool)
boolset_mute_affects_post_fader (bool)
boolset_mute_affects_pre_fader (bool)
boolset_new_plugins_active (bool)
boolset_osc_port (unsigned int)
boolset_osx_pingback_url (std::string)
boolset_output_auto_connect (AutoConnectOption)
boolset_periodic_safety_backup_interval (unsigned int)
boolset_periodic_safety_backups (bool)
boolset_pfl_position (PFLPosition)
boolset_plugin_path_lxvst (std::string)
boolset_plugin_path_vst (std::string)
boolset_plugins_stop_with_transport (bool)
boolset_postroll (long)
boolset_preroll (long)
boolset_preroll_seconds (float)
boolset_processor_usage (int)
boolset_quieten_at_speed (bool)
boolset_range_location_minimum (long)
boolset_reference_manual_url (std::string)
boolset_region_boundaries_from_onscreen_tracks (bool)
boolset_region_boundaries_from_selected_tracks (bool)
boolset_region_selection_after_split (RegionSelectionAfterSplit)
boolset_replicate_missing_region_channels (bool)
boolset_rf_speed (float)
boolset_save_history (bool)
boolset_saved_history_depth (int)
boolset_seamless_loop (bool)
boolset_send_ltc (bool)
boolset_send_midi_clock (bool)
boolset_send_mmc (bool)
boolset_send_mtc (bool)
boolset_show_solo_mutes (bool)
boolset_show_video_export_info (bool)
boolset_show_video_server_dialog (bool)
boolset_shuttle_behaviour (ShuttleBehaviour)
boolset_shuttle_max_speed (float)
boolset_shuttle_speed_factor (float)
boolset_shuttle_speed_threshold (float)
boolset_shuttle_units (ShuttleUnits)
boolset_skip_playback (bool)
boolset_solo_control_is_listen_control (bool)
boolset_solo_mute_gain (float)
boolset_solo_mute_override (bool)
boolset_stop_at_session_end (bool)
boolset_stop_recording_on_xrun (bool)
boolset_strict_io (bool)
boolset_sync_source (SyncSource)
boolset_tape_machine_mode (bool)
boolset_timecode_source_2997 (bool)
boolset_timecode_source_is_synced (bool)
boolset_timecode_sync_frame_rate (bool)
boolset_trace_midi_input (bool)
boolset_trace_midi_output (bool)
boolset_tracks_auto_naming (TracksAutoNamingRule)
boolset_transient_sensitivity (float)
boolset_try_autostart_engine (bool)
boolset_tutorial_manual_url (std::string)
boolset_updates_url (std::string)
boolset_use_click_emphasis (bool)
boolset_use_lxvst (bool)
boolset_use_macvst (bool)
boolset_use_monitor_bus (bool)
boolset_use_osc (bool)
boolset_use_overlap_equivalency (bool)
boolset_use_plugin_own_gui (bool)
boolset_use_tranzport (bool)
boolset_use_windows_vst (bool)
boolset_verbose_plugin_scan (bool)
boolset_verify_remove_last_capture (bool)
boolset_video_advanced_setup (bool)
boolset_video_server_docroot (std::string)
boolset_video_server_url (std::string)
boolset_vst_scan_timeout (int)
boolset_windows_pingback_url (std::string)
Properties
ARDOUR.AFLPositionafl_position
boolall_safe
boolallow_special_bus_removal
boolask_replace_instrument
boolask_setup_instrument
floataudio_capture_buffer_seconds
floataudio_playback_buffer_seconds
std::stringauditioner_output_left
std::stringauditioner_output_right
boolauto_analyse_audio
boolauto_connect_standard_busses
ARDOUR.AutoReturnTargetauto_return_target_list
boolautomation_follows_regions
floatautomation_interval_msecs
doubleautomation_thinning_factor
ARDOUR.BufferingPresetbuffering_preset
std::stringclick_emphasis_sound
floatclick_gain
boolclick_record_only
std::stringclick_sound
boolclicking
boolcopy_demo_sessions
boolcreate_xrun_marker
ARDOUR.FadeShapedefault_fade_shape
std::stringdefault_session_parent_dir
ARDOUR.DenormalModeldenormal_model
booldenormal_protection
booldisable_disarm_during_roll
booldiscover_audio_units
booldiscover_vst_on_start
unsigned intdisk_choice_space_threshold
std::stringdonate_url
ARDOUR.EditModeedit_mode
boolexclusive_solo
floatexport_preroll
floatexport_silence_threshold
unsigned intfeedback_interval_ms
boolfirst_midi_bank_is_zero
std::stringfreesound_download_dir
boolhide_dummy_backend
boolhiding_groups_deactivates_groups
inthistory_depth
intinitial_program_change
ARDOUR.AutoConnectOptioninput_auto_connect
intinter_scene_gap_frames
boollatched_record_enable
ARDOUR.LayerModellayer_model
boollink_send_and_route_panner
std::stringlinux_pingback_url
ARDOUR.ListenPositionlisten_position
boollocate_while_waiting_for_sync
boolloop_is_mode
std::stringltc_output_port
floatltc_output_volume
boolltc_send_continuously
std::stringltc_source_port
floatmax_gain
unsigned intmax_recent_sessions
unsigned intmax_recent_templates
floatmeter_falloff
ARDOUR.MeterTypemeter_type_bus
ARDOUR.MeterTypemeter_type_master
ARDOUR.MeterTypemeter_type_track
std::stringmidi_audition_synth_uri
boolmidi_feedback
boolmidi_input_follows_selection
floatmidi_readahead
floatmidi_track_buffer_seconds
unsigned intminimum_disk_read_bytes
unsigned intminimum_disk_write_bytes
boolmmc_control
intmmc_receive_device_id
intmmc_send_device_id
std::stringmonitor_bus_preferred_bundle
ARDOUR.MonitorModelmonitoring_model
intmtc_qf_speed_tolerance
boolmute_affects_control_outs
boolmute_affects_main_outs
boolmute_affects_post_fader
boolmute_affects_pre_fader
boolnew_plugins_active
unsigned intosc_port
std::stringosx_pingback_url
ARDOUR.AutoConnectOptionoutput_auto_connect
unsigned intperiodic_safety_backup_interval
boolperiodic_safety_backups
ARDOUR.PFLPositionpfl_position
std::stringplugin_path_lxvst
std::stringplugin_path_vst
boolplugins_stop_with_transport
longpostroll
longpreroll
floatpreroll_seconds
intprocessor_usage
boolquieten_at_speed
longrange_location_minimum
std::stringreference_manual_url
boolregion_boundaries_from_onscreen_tracks
boolregion_boundaries_from_selected_tracks
ARDOUR.RegionSelectionAfterSplitregion_selection_after_split
boolreplicate_missing_region_channels
floatrf_speed
boolsave_history
intsaved_history_depth
boolseamless_loop
boolsend_ltc
boolsend_midi_clock
boolsend_mmc
boolsend_mtc
boolshow_solo_mutes
boolshow_video_export_info
boolshow_video_server_dialog
ARDOUR.ShuttleBehaviourshuttle_behaviour
floatshuttle_max_speed
floatshuttle_speed_factor
floatshuttle_speed_threshold
ARDOUR.ShuttleUnitsshuttle_units
boolskip_playback
boolsolo_control_is_listen_control
floatsolo_mute_gain
boolsolo_mute_override
boolstop_at_session_end
boolstop_recording_on_xrun
boolstrict_io
ARDOUR.SyncSourcesync_source
booltape_machine_mode
booltimecode_source_2997
booltimecode_source_is_synced
booltimecode_sync_frame_rate
booltrace_midi_input
booltrace_midi_output
ARDOUR.TracksAutoNamingRuletracks_auto_naming
floattransient_sensitivity
booltry_autostart_engine
std::stringtutorial_manual_url
std::stringupdates_url
booluse_click_emphasis
booluse_lxvst
booluse_macvst
booluse_monitor_bus
booluse_osc
booluse_overlap_equivalency
booluse_plugin_own_gui
booluse_tranzport
booluse_windows_vst
boolverbose_plugin_scan
boolverify_remove_last_capture
boolvideo_advanced_setup
std::stringvideo_server_docroot
std::stringvideo_server_url
intvst_scan_timeout
std::stringwindows_pingback_url
+

Inherited from PBD:Stateful

+ + + + + + +
Methods
voidclear_changes ()

Forget about any changes to this object's properties

IDid ()
OwnedPropertyListproperties ()
+

↠ ARDOUR:ReadOnlyControl

+

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

+

is-a: PBD:StatefulDestructiblePtr

+
+ + + + + + +
Methods
ParameterDescriptordesc ()
std::stringdescribe_parameter ()
doubleget_parameter ()
boolisnil ()
+

Inherited from PBD:StatefulPtr

+ + + + + + +
Methods
voidclear_changes ()

Forget about any changes to this object's properties

IDid ()
OwnedPropertyListproperties ()

↠ ARDOUR:Readable

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

@@ -2818,7 +3325,9 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
+ +
Methods
Regionclone_region (Region, bool, bool)
Regionregion_by_id (ID)
RegionMapregions ()

∁ ARDOUR:RegionList

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

@@ -2851,6 +3360,38 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C LuaTabletable () voidunique () +

∁ ARDOUR:RegionMap

+

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

+
+ + + + + + + + + + + + +
Constructor
ℂARDOUR.RegionMap ()
Methods
LuaTableadd (LuaTable {Region})
...at (--lua--)
voidclear ()
unsigned longcount (ID)
boolempty ()
LuaIteriter ()
unsigned longsize ()
LuaTabletable ()
+

∁ ARDOUR:RegionVector

+

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

+
+ + + + + + + + + + + + +
Constructor
ℂARDOUR.RegionVector ()
ℂARDOUR.RegionVector ()
Methods
LuaTableadd (LuaTable {Region})
Regionat (unsigned long)
boolempty ()
LuaIteriter ()
voidpush_back (Region)
unsigned longsize ()
LuaTabletable ()

↠ ARDOUR:Route

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

is-a: ARDOUR:Stripable

@@ -2901,6 +3442,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C Amptrim () Cast Automatableto_automatable () + Slavableto_slavable () Trackto_track ()

Inherited from ARDOUR:Stripable

@@ -2910,7 +3452,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C AutomationControlcomp_makeup_control () AutomationControlcomp_mode_control () std::stringcomp_mode_name (unsigned int) - --MISSING (boost::shared_ptr<ARDOUR::ReadOnlyControl>)--comp_redux_control () + ReadOnlyControlcomp_redux_control () AutomationControlcomp_speed_control () std::stringcomp_speed_name (unsigned int) AutomationControlcomp_threshold_control () @@ -2952,6 +3494,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C GainControltrim_control () Cast Routeto_route () + VCAto_vca ()

Inherited from ARDOUR:SessionObjectPtr

@@ -3077,6 +3620,8 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C + + @@ -3102,6 +3647,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C + @@ -3123,6 +3669,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C + @@ -3156,6 +3703,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C + @@ -3403,14 +3951,23 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
boolactively_recording ()
voidadd_command (Command)
voidadd_internal_sends (Route, Placement, RouteListPtr)
intadd_master_bus (ChanCount)
voidadd_monitor_section ()
StatefulDiffCommandadd_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)

voidbegin_reversible_command (std::string)
RouteListPtrget_routes ()
BufferSetget_scratch_buffers (ChanCount, bool)
BufferSetget_silent_buffers (ChanCount)
StripableListget_stripables ()
RouteListPtrget_tracks ()
voidgoto_end ()
voidgoto_start (bool)
std::stringpath ()
Processorprocessor_by_id (ID)
RecordStaterecord_status ()
voidremove_monitor_section ()
voidremove_route_group (RouteGroup)
voidrequest_locate (long, bool)
voidrequest_play_loop (bool, bool)
booltransport_rolling ()
doubletransport_speed ()
StringListunknown_processors ()
VCAManagervca_manager ()
longworst_input_latency ()
longworst_output_latency ()
longworst_playback_latency ()
Statefulto_stateful ()
StatefulDestructibleto_statefuldestructible ()
-

↠ ARDOUR:SlavableAutomationControl,

+

↠ ARDOUR:Slavable

+

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

+
+ + + + + +
Methods
voidassign (VCA)
boolisnil ()
voidunassign (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)

- + @@ -3424,18 +3981,17 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C - - - + +
Methods
voidadd_master (AutomationControl, bool)
voidadd_master (AutomationControl)
voidclear_masters ()
intget_boolean_masters ()
doubleget_masters_value ()
Methods
AutomationListalist ()
AutoStateautomation_state ()
AutoStyleautomation_style ()
doubleget_value ()

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

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

Get and Set `internal' value

All derived classes must implement this.

Basic derived classes will ignore

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

Inherited from PBD:Controllable

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

↠ ARDOUR:SoloControl

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

-

is-a: ARDOUR:SlavableAutomationControl,

+

is-a: ARDOUR:SlavableAutomationControl

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

@@ -3462,10 +4018,10 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
boolself_soloed ()
boolsoloed ()
-

Inherited from ARDOUR:SlavableAutomationControl,

+

Inherited from ARDOUR:SlavableAutomationControl

- + @@ -3478,18 +4034,17 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C - - - + +
Methods
voidadd_master (AutomationControl, bool)
voidadd_master (AutomationControl)
voidclear_masters ()
intget_boolean_masters ()
doubleget_masters_value ()
Methods
AutomationListalist ()
AutoStateautomation_state ()
AutoStyleautomation_style ()
doubleget_value ()

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

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

Get and Set `internal' value

All derived classes must implement this.

Basic derived classes will ignore

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

Inherited from PBD:Controllable

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

↠ ARDOUR:SoloIsolateControl

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

-

is-a: ARDOUR:SlavableAutomationControl,

+

is-a: ARDOUR:SlavableAutomationControl

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

@@ -3515,10 +4070,10 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
boolself_solo_isolated ()
boolsolo_isolated ()
-

Inherited from ARDOUR:SlavableAutomationControl,

+

Inherited from ARDOUR:SlavableAutomationControl

- + @@ -3531,18 +4086,17 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C - - - + +
Methods
voidadd_master (AutomationControl, bool)
voidadd_master (AutomationControl)
voidclear_masters ()
intget_boolean_masters ()
doubleget_masters_value ()
Methods
AutomationListalist ()
AutoStateautomation_state ()
AutoStyleautomation_style ()
doubleget_value ()

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

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

Get and Set `internal' value

All derived classes must implement this.

Basic derived classes will ignore

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

Inherited from PBD:Controllable

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

↠ ARDOUR:SoloSafeControl

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

-

is-a: ARDOUR:SlavableAutomationControl,

+

is-a: ARDOUR:SlavableAutomationControl

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

@@ -3567,10 +4121,10 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
boolisnil ()
boolsolo_safe ()
-

Inherited from ARDOUR:SlavableAutomationControl,

+

Inherited from ARDOUR:SlavableAutomationControl

- + @@ -3583,18 +4137,17 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C - - - + +
Methods
voidadd_master (AutomationControl, bool)
voidadd_master (AutomationControl)
voidclear_masters ()
intget_boolean_masters ()
doubleget_masters_value ()
Methods
AutomationListalist ()
AutoStateautomation_state ()
AutoStyleautomation_style ()
doubleget_value ()

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

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

Get and Set `internal' value

All derived classes must implement this.

Basic derived classes will ignore

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

Inherited from PBD:Controllable

@@ -3669,7 +4222,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C - + @@ -3712,6 +4265,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C +
AutomationControlcomp_makeup_control ()
AutomationControlcomp_mode_control ()
std::stringcomp_mode_name (unsigned int)
--MISSING (boost::shared_ptr<ARDOUR::ReadOnlyControl>)--comp_redux_control ()
ReadOnlyControlcomp_redux_control ()
AutomationControlcomp_speed_control ()
std::stringcomp_speed_name (unsigned int)
AutomationControlcomp_threshold_control ()
GainControltrim_control ()
Cast
Routeto_route ()
VCAto_vca ()

Inherited from ARDOUR:SessionObjectPtr

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

∁ ARDOUR:StripableList

+

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

+
+ + + + + + + + + + + +
Constructor
ℂARDOUR.StripableList ()
Methods
Stripableback ()
boolempty ()
Stripablefront ()
LuaIteriter ()
voidreverse ()
unsigned longsize ()
LuaTabletable ()

∁ ARDOUR:Tempo

C‡: ARDOUR::Tempo

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

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

- - + + - - + + @@ -3838,6 +4407,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C +
Methods
MeterSectionadd_meter (Meter, double, BBT_TIME, long, PositionLockStyle)
TempoSectionadd_tempo (Tempo, double, long, PositionLockStyle)
MeterSectionadd_meter (Meter, BBT_TIME, long, PositionLockStyle)
TempoSectionadd_tempo (Tempo, double, long, PositionLockStyle)
BBT_TIMEbbt_at_frame (long)

Returns the BBT time corresponding to the supplied frame position.

frame
the position in audio samples.

Returns the BBT time at the frame position .

doubleexact_beat_at_frame (long, int)
doubleexact_qn_at_frame (long, int)
doubleexact_beat_at_frame (long, int)
doubleexact_qn_at_frame (long, int)
longframepos_plus_qn (long, Beats)

Add some (fractional) Beats to a session frame position, and return the result in frames. pos can be -ve, if required.

Beatsframewalk_to_qn (long, long)
Amptrim ()
Cast
Automatableto_automatable ()
Slavableto_slavable ()
Trackto_track ()

Inherited from ARDOUR:Stripable

@@ -3847,7 +4417,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C AutomationControlcomp_makeup_control () AutomationControlcomp_mode_control () std::stringcomp_mode_name (unsigned int) - --MISSING (boost::shared_ptr<ARDOUR::ReadOnlyControl>)--comp_redux_control () + ReadOnlyControlcomp_redux_control () AutomationControlcomp_speed_control () std::stringcomp_speed_name (unsigned int) AutomationControlcomp_threshold_control () @@ -3889,6 +4459,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C GainControltrim_control () Cast Routeto_route () + VCAto_vca ()

Inherited from ARDOUR:SessionObjectPtr

@@ -3937,6 +4508,113 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
Statefulto_stateful ()
StatefulDestructibleto_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::stringfull_name ()
GainControlgain_control ()
boolisnil ()
MuteControlmute_control ()
intnumber ()
SoloControlsolo_control ()
+

Inherited from ARDOUR:Stripable

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Methods
AutomationControlcomp_enable_control ()
AutomationControlcomp_makeup_control ()
AutomationControlcomp_mode_control ()
std::stringcomp_mode_name (unsigned int)
ReadOnlyControlcomp_redux_control ()
AutomationControlcomp_speed_control ()
std::stringcomp_speed_name (unsigned int)
AutomationControlcomp_threshold_control ()
unsigned inteq_band_cnt ()
std::stringeq_band_name (unsigned int)
AutomationControleq_enable_control ()
AutomationControleq_freq_control (unsigned int)
AutomationControleq_gain_control (unsigned int)
AutomationControleq_q_control (unsigned int)
AutomationControleq_shape_control (unsigned int)
AutomationControlfilter_enable_controllable (bool)
AutomationControlfilter_freq_controllable (bool)
AutomationControlfilter_slope_controllable (bool)
boolis_auditioner ()
boolis_hidden ()
boolis_master ()
boolis_monitor ()
boolis_selected ()
AutomationControlmaster_send_enable_control ()
MonitorProcessormonitor_control ()
AutomationControlpan_azimuth_control ()
AutomationControlpan_elevation_control ()
AutomationControlpan_frontback_control ()
AutomationControlpan_lfe_control ()
AutomationControlpan_width_control ()
PhaseControlphase_control ()
PresentationInfopresentation_info_ptr ()
AutomationControlrec_enable_control ()
AutomationControlrec_safe_control ()
AutomationControlsend_enable_control (unsigned int)
AutomationControlsend_level_control (unsigned int)
std::stringsend_name (unsigned int)
voidset_presentation_order (unsigned int)
SoloIsolateControlsolo_isolate_control ()
SoloSafeControlsolo_safe_control ()
GainControltrim_control ()
Cast
Routeto_route ()
VCAto_vca ()
+

Inherited from ARDOUR:SessionObjectPtr

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

∁ ARDOUR:VCAList

+

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

+
+ + + + + + + + + + + +
Constructor
ℂARDOUR.VCAList ()
Methods
VCAback ()
boolempty ()
VCAfront ()
LuaIteriter ()
voidreverse ()
unsigned longsize ()
LuaTabletable ()
+

∁ ARDOUR:VCAManager

+

C‡: ARDOUR::VCAManager

+

is-a: PBD:StatefulDestructible

+
+

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

+ + + + + + + + +
Methods
intcreate_vca (unsigned int, std::string)
unsigned longn_vcas ()
voidremove_vca (VCA)
VCAvca_by_name (std::string)
VCAvca_by_number (int)
VCAListvcas ()
+

Inherited from PBD:Stateful

+ + + + + + +
Methods
voidclear_changes ()

Forget about any changes to this object's properties

IDid ()
OwnedPropertyListproperties ()

∁ ARDOUR:WeakAudioSourceList

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

@@ -3988,6 +4666,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C Methods std::stringhttp_get (std::string) ProcessorVectorprocessor_selection () + unsigned inttranslate_order (InsertAt)

∁ ArdourUI:ArdourMarker

C‡: ArdourMarker

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

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.

- + @@ -4042,7 +4721,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C - + @@ -4055,6 +4734,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C + @@ -4064,10 +4744,10 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C - + @@ -4115,7 +4795,9 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C + + @@ -4177,6 +4859,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C

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
Methods
voidaccess_action (std::string, std::string)
voidaccess_action (std::string, std::string)
voidadd_location_from_playhead_cursor ()
TrackViewListaxis_views_from_routes (RouteListPtr)
voidcenter_screen (long)
longcurrent_page_samples ()
voiddeselect_all ()
LuaTable(...)do_embed (StringVector, ImportDisposition, ImportMode, long&, PluginInfo)
LuaTable(...)do_import (StringVector, ImportDisposition, ImportMode, SrcQuality, MidiTrackNameSource, --MISSING (ARDOUR::MidiTempoMapDisposition)--, long&, PluginInfo)
LuaTable(...)do_import (StringVector, ImportDisposition, ImportMode, SrcQuality, MidiTrackNameSource, MidiTempoMapDisposition, long&, PluginInfo)

Import existing media

booldragging_playhead ()

Returns true if the playhead is currently being dragged, otherwise false

Open export dialog with current selection pre-selected

LuaTable(Location, ...)find_location_from_marker (ArdourMarker, bool&)
ArdourMarkerfind_marker_from_location_id (ID, bool)
voidfit_selection ()
boolfollow_playhead ()

Returns true if the editor is following the playhead

longget_current_zoom ()
LuaTable(long, ...)get_nudge_distance (long, long&)
longget_paste_offset (long, unsigned int, long)
LuaTable(...)get_pointer_position (double&, double&)
RouteTimeAxisViewget_route_view_by_route_id (ID)
Selectionget_selection ()
LuaTable(bool, ...)get_selection_extents (long&, long&)
boolget_smart_mode ()
StripableTimeAxisViewget_stripable_time_axis_by_id (ID)
TrackViewListget_track_views ()
intget_videotl_bar_height ()
doubleget_y_origin ()
voidset_snap_threshold (double)

Set the snap threshold.

t
Snap threshold in `units'.
voidset_stationary_playhead (bool)
voidset_toggleaction (std::string, std::string, bool)
voidset_video_timeline_height (int)
voidset_visible_track_count (int)
voidset_zoom_focus (ZoomFocus)
boolshow_measures ()
voidshow_track_in_display (TimeAxisView, bool)
+
Cast
StripableTimeAxisViewto_stripabletimeaxisview ()
TimeAxisViewto_timeaxisview ()

∅ ArdourUI:RouteUI

@@ -4224,6 +4907,12 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C LuaTabletable () voidunique () +

∅ 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.

∅ ArdourUI:TimeAxisView

C‡: TimeAxisView

is-a: ArdourUI:AxisView

@@ -4633,17 +5322,17 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C voidclear (double, double)

remove all automation events between the given time range

start
start of range (inclusive) in audio samples
end
end of range (inclusive) in audio samples
voidclear_list () - doubleeval (double) + doubleeval (double)

query value at given time (takes a read-lock, not safe while writing automation)

where
absolute time in samples

Returns parameter value

EventListevents () boolin_write_pass () InterpolationStyleinterpolation ()

query interpolation style of the automation data

Returns Interpolation Style

boolisnil () - LuaTable(double, ...)rt_safe_eval (double, bool&) + LuaTable(double, ...)rt_safe_eval (double, bool&)

realtime safe version of eval, may fail if read-lock cannot be taken

where
absolute time in samples
ok
boolean reference if returned value is valid

Returns parameter value

- voidset_interpolation (InterpolationStyle) -

set the interpolation style of the automation data

is
interpolation style
+ boolset_interpolation (InterpolationStyle) +

set 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

voidthin (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)
voidtruncate_end (double) @@ -4706,6 +5395,8 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C Constructor ℂEvoral.ParameterDescriptor () Data Members + boollogarithmic +

True for log-scale parameters

floatlower

Minimum value (in Hz, for frequencies)

floatnormal @@ -4752,21 +5443,21 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C intrun ()

∁ LuaSignal:Set

-

C‡: std::bitset<47ul>

+

C‡: std::bitset<48ul>

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

ℕ PBD

@@ -5266,6 +5957,13 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C intnsec intsec +

ℕ os

+
+ + + + +
Methods
intexecute (std::string)
LuaTableforkexec ()

Enum/Constants

∈ PBD.Controllable.GroupControlDisposition

-

∈ ARDOUR.AutoStyle

-

∈ ARDOUR.AutoState

+

∈ ARDOUR.MidiTempoMapDisposition

+ @@ -5496,6 +6192,107 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
  • ARDOUR.InsertMergePolicy.TruncateAddition
  • ARDOUR.InsertMergePolicy.Extend
    • +

    ∈ ARDOUR.AFLPosition

    + +

    ∈ ARDOUR.PFLPosition

    + +

    ∈ ARDOUR.AutoReturnTarget

    + +

    ∈ ARDOUR.FadeShape

    + +

    ∈ ARDOUR.DenormalModel

    + +

    ∈ ARDOUR.BufferingPreset

    + +

    ∈ ARDOUR.EditMode

    + +

    ∈ ARDOUR.AutoConnectOption

    + +

    ∈ ARDOUR.LayerModel

    + +

    ∈ ARDOUR.ListenPosition

    + +

    ∈ ARDOUR.MonitorModel

    + +

    ∈ ARDOUR.RegionSelectionAfterSplit

    + +

    ∈ ARDOUR.ShuttleBehaviour

    + +

    ∈ ARDOUR.ShuttleUnits

    + +

    ∈ ARDOUR.SyncSource

    + +

    ∈ ARDOUR.TracksAutoNamingRule

    +

    ∈ ARDOUR.Session.RecordState

    -

    ∈ LuaSignal.LuaSignal

    +

    ∈ RouteDialogs.InsertAt

    ∈ ArdourMarker.Type

    +

    ∈ LuaSignal.LuaSignal

    +

    Class Index

    - + -
    Ardour 5.9  -  Mon, 15 May 2017 22:51:18 +0200
    +
    Ardour 5.12  -  Sat, 16 Sep 2017 16:18:16 +0200