X-Git-Url: http://shamusworld.gotdns.org/cgi-bin/gitweb.cgi?a=blobdiff_plain;f=include%2Fclass-reference.html;h=6d324b8cb7dc2dd6133ea8bf209ad8fa1dd2404e;hb=54bca41fed4d8a2eae3818151273a94022c6511b;hp=ddc7c8b1281b99e1649a45d4fa4f33dd4b47607e;hpb=5a4f23ac499c766d362b0d60d4326dfe45b118a3;p=ardour-manual diff --git a/include/class-reference.html b/include/class-reference.html index ddc7c8b..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,7 +115,7 @@ 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.

@@ -403,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

@@ -567,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 () @@ -579,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*) @@ -598,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

@@ -607,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 () @@ -685,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> >

@@ -700,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 >

@@ -721,7 +727,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C boolwritable () Cast Controlto_ctrl () - SlavableAutomationControl,to_slavable () + SlavableAutomationControlto_slavable ()

Inherited from PBD:Controllable

@@ -808,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.

@@ -1164,14 +1170,14 @@ 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

@@ -1197,7 +1203,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C - +
Methods
voidadd_master (AutomationControl)
boolwritable ()
Cast
Controlto_ctrl ()
SlavableAutomationControl,to_slavable ()
SlavableAutomationControlto_slavable ()

Inherited from PBD:Controllable

@@ -1216,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.

@@ -1561,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--)
@@ -1586,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

@@ -1920,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

@@ -1929,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 () @@ -2078,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)

@@ -2087,7 +2096,7 @@ 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

@@ -2113,7 +2122,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C - +
Methods
voidadd_master (AutomationControl)
boolwritable ()
Cast
Controlto_ctrl ()
SlavableAutomationControl,to_slavable ()
SlavableAutomationControlto_slavable ()

Inherited from PBD:Controllable

@@ -2269,7 +2278,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C - +
boolwritable ()
Cast
Controlto_ctrl ()
SlavableAutomationControl,to_slavable ()
SlavableAutomationControlto_slavable ()

Inherited from PBD:Controllable

@@ -2409,7 +2418,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C - +
boolwritable ()
Cast
Controlto_ctrl ()
SlavableAutomationControl,to_slavable ()
SlavableAutomationControlto_slavable ()

Inherited from PBD:Controllable

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

Base class for objects with saveable and undoable state

- + @@ -2745,11 +2754,11 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C - + - + @@ -2757,16 +2766,16 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C - + - + - + @@ -2777,13 +2786,13 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C - + - + - + @@ -2808,7 +2817,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C - + @@ -2817,10 +2826,10 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C - + - + @@ -2833,7 +2842,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C - + @@ -2846,11 +2855,11 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C - + - + @@ -2858,14 +2867,14 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C - + - + @@ -2886,7 +2895,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C - + @@ -2897,11 +2906,11 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C - + - + @@ -2909,16 +2918,16 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C - + - + - + @@ -2929,13 +2938,13 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C - + - + - + @@ -2960,7 +2969,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C - + @@ -2969,10 +2978,10 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C - + - + @@ -2985,7 +2994,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C - + @@ -2998,11 +3007,11 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C - + - + @@ -3010,14 +3019,14 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C - + - + @@ -3039,7 +3048,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C - + @@ -3050,11 +3059,11 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C - + - + @@ -3062,16 +3071,16 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C - + - + - + @@ -3082,13 +3091,13 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C - + - + - + @@ -3113,7 +3122,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C - + @@ -3122,10 +3131,10 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C - + - + @@ -3138,7 +3147,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C - + @@ -3151,11 +3160,11 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C - + - + @@ -3163,14 +3172,14 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C - + - + @@ -3200,6 +3209,25 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
Methods
--MISSING (ARDOUR::AFLPosition)--get_afl_position ()
AFLPositionget_afl_position ()
boolget_all_safe ()
boolget_allow_special_bus_removal ()
boolget_ask_replace_instrument ()
std::stringget_auditioner_output_right ()
boolget_auto_analyse_audio ()
boolget_auto_connect_standard_busses ()
--MISSING (ARDOUR::AutoReturnTarget)--get_auto_return_target_list ()
AutoReturnTargetget_auto_return_target_list ()
boolget_automation_follows_regions ()
floatget_automation_interval_msecs ()
doubleget_automation_thinning_factor ()
--MISSING (ARDOUR::BufferingPreset)--get_buffering_preset ()
BufferingPresetget_buffering_preset ()
std::stringget_click_emphasis_sound ()
floatget_click_gain ()
boolget_click_record_only ()
boolget_clicking ()
boolget_copy_demo_sessions ()
boolget_create_xrun_marker ()
--MISSING (ARDOUR::FadeShape)--get_default_fade_shape ()
FadeShapeget_default_fade_shape ()
std::stringget_default_session_parent_dir ()
--MISSING (ARDOUR::DenormalModel)--get_denormal_model ()
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 ()
--MISSING (ARDOUR::EditMode)--get_edit_mode ()
EditModeget_edit_mode ()
boolget_exclusive_solo ()
floatget_export_preroll ()
floatget_export_silence_threshold ()
boolget_hiding_groups_deactivates_groups ()
intget_history_depth ()
intget_initial_program_change ()
--MISSING (ARDOUR::AutoConnectOption)--get_input_auto_connect ()
AutoConnectOptionget_input_auto_connect ()
intget_inter_scene_gap_frames ()
boolget_latched_record_enable ()
--MISSING (ARDOUR::LayerModel)--get_layer_model ()
LayerModelget_layer_model ()
boolget_link_send_and_route_panner ()
std::stringget_linux_pingback_url ()
--MISSING (ARDOUR::ListenPosition)--get_listen_position ()
ListenPositionget_listen_position ()
boolget_locate_while_waiting_for_sync ()
boolget_loop_is_mode ()
std::stringget_ltc_output_port ()
intget_mmc_receive_device_id ()
intget_mmc_send_device_id ()
std::stringget_monitor_bus_preferred_bundle ()
--MISSING (ARDOUR::MonitorModel)--get_monitoring_model ()
MonitorModelget_monitoring_model ()
intget_mtc_qf_speed_tolerance ()
boolget_mute_affects_control_outs ()
boolget_mute_affects_main_outs ()
boolget_new_plugins_active ()
unsigned intget_osc_port ()
std::stringget_osx_pingback_url ()
--MISSING (ARDOUR::AutoConnectOption)--get_output_auto_connect ()
AutoConnectOptionget_output_auto_connect ()
unsigned intget_periodic_safety_backup_interval ()
boolget_periodic_safety_backups ()
--MISSING (ARDOUR::PFLPosition)--get_pfl_position ()
PFLPositionget_pfl_position ()
std::stringget_plugin_path_lxvst ()
std::stringget_plugin_path_vst ()
boolget_plugins_stop_with_transport ()
std::stringget_reference_manual_url ()
boolget_region_boundaries_from_onscreen_tracks ()
boolget_region_boundaries_from_selected_tracks ()
--MISSING (ARDOUR::RegionSelectionAfterSplit)--get_region_selection_after_split ()
RegionSelectionAfterSplitget_region_selection_after_split ()
boolget_replicate_missing_region_channels ()
floatget_rf_speed ()
boolget_save_history ()
boolget_show_solo_mutes ()
boolget_show_video_export_info ()
boolget_show_video_server_dialog ()
--MISSING (ARDOUR::ShuttleBehaviour)--get_shuttle_behaviour ()
ShuttleBehaviourget_shuttle_behaviour ()
floatget_shuttle_max_speed ()
floatget_shuttle_speed_factor ()
floatget_shuttle_speed_threshold ()
--MISSING (ARDOUR::ShuttleUnits)--get_shuttle_units ()
ShuttleUnitsget_shuttle_units ()
boolget_skip_playback ()
boolget_solo_control_is_listen_control ()
floatget_solo_mute_gain ()
boolget_stop_at_session_end ()
boolget_stop_recording_on_xrun ()
boolget_strict_io ()
--MISSING (ARDOUR::SyncSource)--get_sync_source ()
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 ()
--MISSING (ARDOUR::TracksAutoNamingRule)--get_tracks_auto_naming ()
TracksAutoNamingRuleget_tracks_auto_naming ()
floatget_transient_sensitivity ()
boolget_try_autostart_engine ()
std::stringget_tutorial_manual_url ()
std::stringget_video_server_url ()
intget_vst_scan_timeout ()
std::stringget_windows_pingback_url ()
boolset_afl_position (--MISSING (ARDOUR::AFLPosition)--)
boolset_afl_position (AFLPosition)
boolset_all_safe (bool)
boolset_allow_special_bus_removal (bool)
boolset_ask_replace_instrument (bool)
boolset_auditioner_output_right (std::string)
boolset_auto_analyse_audio (bool)
boolset_auto_connect_standard_busses (bool)
boolset_auto_return_target_list (--MISSING (ARDOUR::AutoReturnTarget)--)
boolset_auto_return_target_list (AutoReturnTarget)
boolset_automation_follows_regions (bool)
boolset_automation_interval_msecs (float)
boolset_automation_thinning_factor (double)
boolset_buffering_preset (--MISSING (ARDOUR::BufferingPreset)--)
boolset_buffering_preset (BufferingPreset)
boolset_click_emphasis_sound (std::string)
boolset_click_gain (float)
boolset_click_record_only (bool)
boolset_clicking (bool)
boolset_copy_demo_sessions (bool)
boolset_create_xrun_marker (bool)
boolset_default_fade_shape (--MISSING (ARDOUR::FadeShape)--)
boolset_default_fade_shape (FadeShape)
boolset_default_session_parent_dir (std::string)
boolset_denormal_model (--MISSING (ARDOUR::DenormalModel)--)
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 (--MISSING (ARDOUR::EditMode)--)
boolset_edit_mode (EditMode)
boolset_exclusive_solo (bool)
boolset_export_preroll (float)
boolset_export_silence_threshold (float)
boolset_hiding_groups_deactivates_groups (bool)
boolset_history_depth (int)
boolset_initial_program_change (int)
boolset_input_auto_connect (--MISSING (ARDOUR::AutoConnectOption)--)
boolset_input_auto_connect (AutoConnectOption)
boolset_inter_scene_gap_frames (int)
boolset_latched_record_enable (bool)
boolset_layer_model (--MISSING (ARDOUR::LayerModel)--)
boolset_layer_model (LayerModel)
boolset_link_send_and_route_panner (bool)
boolset_linux_pingback_url (std::string)
boolset_listen_position (--MISSING (ARDOUR::ListenPosition)--)
boolset_listen_position (ListenPosition)
boolset_locate_while_waiting_for_sync (bool)
boolset_loop_is_mode (bool)
boolset_ltc_output_port (std::string)
boolset_mmc_receive_device_id (int)
boolset_mmc_send_device_id (int)
boolset_monitor_bus_preferred_bundle (std::string)
boolset_monitoring_model (--MISSING (ARDOUR::MonitorModel)--)
boolset_monitoring_model (MonitorModel)
boolset_mtc_qf_speed_tolerance (int)
boolset_mute_affects_control_outs (bool)
boolset_mute_affects_main_outs (bool)
boolset_new_plugins_active (bool)
boolset_osc_port (unsigned int)
boolset_osx_pingback_url (std::string)
boolset_output_auto_connect (--MISSING (ARDOUR::AutoConnectOption)--)
boolset_output_auto_connect (AutoConnectOption)
boolset_periodic_safety_backup_interval (unsigned int)
boolset_periodic_safety_backups (bool)
boolset_pfl_position (--MISSING (ARDOUR::PFLPosition)--)
boolset_pfl_position (PFLPosition)
boolset_plugin_path_lxvst (std::string)
boolset_plugin_path_vst (std::string)
boolset_plugins_stop_with_transport (bool)
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 (--MISSING (ARDOUR::RegionSelectionAfterSplit)--)
boolset_region_selection_after_split (RegionSelectionAfterSplit)
boolset_replicate_missing_region_channels (bool)
boolset_rf_speed (float)
boolset_save_history (bool)
boolset_show_solo_mutes (bool)
boolset_show_video_export_info (bool)
boolset_show_video_server_dialog (bool)
boolset_shuttle_behaviour (--MISSING (ARDOUR::ShuttleBehaviour)--)
boolset_shuttle_behaviour (ShuttleBehaviour)
boolset_shuttle_max_speed (float)
boolset_shuttle_speed_factor (float)
boolset_shuttle_speed_threshold (float)
boolset_shuttle_units (--MISSING (ARDOUR::ShuttleUnits)--)
boolset_shuttle_units (ShuttleUnits)
boolset_skip_playback (bool)
boolset_solo_control_is_listen_control (bool)
boolset_solo_mute_gain (float)
boolset_stop_at_session_end (bool)
boolset_stop_recording_on_xrun (bool)
boolset_strict_io (bool)
boolset_sync_source (--MISSING (ARDOUR::SyncSource)--)
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 (--MISSING (ARDOUR::TracksAutoNamingRule)--)
boolset_tracks_auto_naming (TracksAutoNamingRule)
boolset_transient_sensitivity (float)
boolset_try_autostart_engine (bool)
boolset_tutorial_manual_url (std::string)
boolset_vst_scan_timeout (int)
boolset_windows_pingback_url (std::string)
Properties
--MISSING (ARDOUR::AFLPosition)--afl_position
ARDOUR.AFLPositionafl_position
boolall_safe
boolallow_special_bus_removal
boolask_replace_instrument
std::stringauditioner_output_right
boolauto_analyse_audio
boolauto_connect_standard_busses
--MISSING (ARDOUR::AutoReturnTarget)--auto_return_target_list
ARDOUR.AutoReturnTargetauto_return_target_list
boolautomation_follows_regions
floatautomation_interval_msecs
doubleautomation_thinning_factor
--MISSING (ARDOUR::BufferingPreset)--buffering_preset
ARDOUR.BufferingPresetbuffering_preset
std::stringclick_emphasis_sound
floatclick_gain
boolclick_record_only
boolclicking
boolcopy_demo_sessions
boolcreate_xrun_marker
--MISSING (ARDOUR::FadeShape)--default_fade_shape
ARDOUR.FadeShapedefault_fade_shape
std::stringdefault_session_parent_dir
--MISSING (ARDOUR::DenormalModel)--denormal_model
ARDOUR.DenormalModeldenormal_model
booldenormal_protection
booldisable_disarm_during_roll
booldiscover_audio_units
booldiscover_vst_on_start
unsigned intdisk_choice_space_threshold
std::stringdonate_url
--MISSING (ARDOUR::EditMode)--edit_mode
ARDOUR.EditModeedit_mode
boolexclusive_solo
floatexport_preroll
floatexport_silence_threshold
boolhiding_groups_deactivates_groups
inthistory_depth
intinitial_program_change
--MISSING (ARDOUR::AutoConnectOption)--input_auto_connect
ARDOUR.AutoConnectOptioninput_auto_connect
intinter_scene_gap_frames
boollatched_record_enable
--MISSING (ARDOUR::LayerModel)--layer_model
ARDOUR.LayerModellayer_model
boollink_send_and_route_panner
std::stringlinux_pingback_url
--MISSING (ARDOUR::ListenPosition)--listen_position
ARDOUR.ListenPositionlisten_position
boollocate_while_waiting_for_sync
boolloop_is_mode
std::stringltc_output_port
intmmc_receive_device_id
intmmc_send_device_id
std::stringmonitor_bus_preferred_bundle
--MISSING (ARDOUR::MonitorModel)--monitoring_model
ARDOUR.MonitorModelmonitoring_model
intmtc_qf_speed_tolerance
boolmute_affects_control_outs
boolmute_affects_main_outs
boolnew_plugins_active
unsigned intosc_port
std::stringosx_pingback_url
--MISSING (ARDOUR::AutoConnectOption)--output_auto_connect
ARDOUR.AutoConnectOptionoutput_auto_connect
unsigned intperiodic_safety_backup_interval
boolperiodic_safety_backups
--MISSING (ARDOUR::PFLPosition)--pfl_position
ARDOUR.PFLPositionpfl_position
std::stringplugin_path_lxvst
std::stringplugin_path_vst
boolplugins_stop_with_transport
std::stringreference_manual_url
boolregion_boundaries_from_onscreen_tracks
boolregion_boundaries_from_selected_tracks
--MISSING (ARDOUR::RegionSelectionAfterSplit)--region_selection_after_split
ARDOUR.RegionSelectionAfterSplitregion_selection_after_split
boolreplicate_missing_region_channels
floatrf_speed
boolsave_history
boolshow_solo_mutes
boolshow_video_export_info
boolshow_video_server_dialog
--MISSING (ARDOUR::ShuttleBehaviour)--shuttle_behaviour
ARDOUR.ShuttleBehaviourshuttle_behaviour
floatshuttle_max_speed
floatshuttle_speed_factor
floatshuttle_speed_threshold
--MISSING (ARDOUR::ShuttleUnits)--shuttle_units
ARDOUR.ShuttleUnitsshuttle_units
boolskip_playback
boolsolo_control_is_listen_control
floatsolo_mute_gain
boolstop_at_session_end
boolstop_recording_on_xrun
boolstrict_io
--MISSING (ARDOUR::SyncSource)--sync_source
ARDOUR.SyncSourcesync_source
booltape_machine_mode
booltimecode_source_2997
booltimecode_source_is_synced
booltimecode_sync_frame_rate
booltrace_midi_input
booltrace_midi_output
--MISSING (ARDOUR::TracksAutoNamingRule)--tracks_auto_naming
ARDOUR.TracksAutoNamingRuletracks_auto_naming
floattransient_sensitivity
booltry_autostart_engine
std::stringtutorial_manual_url
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 >

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

@@ -3398,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

@@ -3407,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 () @@ -3658,7 +3703,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C booltransport_rolling () doubletransport_speed () StringListunknown_processors () - VCAManagervca_manager () + VCAManagervca_manager () longworst_input_latency () longworst_output_latency () longworst_playback_latency () @@ -3906,7 +3951,16 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C 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

@@ -3937,7 +3991,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C boolwritable () Cast Controlto_ctrl () - SlavableAutomationControl,to_slavable () + SlavableAutomationControlto_slavable ()

Inherited from PBD:Controllable

@@ -3954,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)

@@ -3964,7 +4018,7 @@ 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

@@ -3990,7 +4044,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C - +
Methods
voidadd_master (AutomationControl)
boolwritable ()
Cast
Controlto_ctrl ()
SlavableAutomationControl,to_slavable ()
SlavableAutomationControlto_slavable ()

Inherited from PBD:Controllable

@@ -4007,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)

@@ -4016,7 +4070,7 @@ 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

@@ -4042,7 +4096,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C - +
Methods
voidadd_master (AutomationControl)
boolwritable ()
Cast
Controlto_ctrl ()
SlavableAutomationControl,to_slavable ()
SlavableAutomationControlto_slavable ()

Inherited from PBD:Controllable

@@ -4059,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)

@@ -4067,7 +4121,7 @@ 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

@@ -4093,7 +4147,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C - +
Methods
voidadd_master (AutomationControl)
boolwritable ()
Cast
Controlto_ctrl ()
SlavableAutomationControl,to_slavable ()
SlavableAutomationControlto_slavable ()

Inherited from PBD:Controllable

@@ -4168,7 +4222,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C - + @@ -4259,11 +4313,11 @@ 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 ()
- + - - + + @@ -4353,6 +4407,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C +
Methods
MeterSectionadd_meter (Meter, BBT_TIME, long, PositionLockStyle)
TempoSectionadd_tempo (Tempo, double, 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

@@ -4362,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 () @@ -4474,7 +4529,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 () @@ -4545,6 +4600,10 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C

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 ()
@@ -4607,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

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

@@ -6077,6 +6137,9 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
  • ARDOUR.MidiTrackNameSource.SMFTrackNumber
  • ARDOUR.MidiTrackNameSource.SMFTrackName
  • ARDOUR.MidiTrackNameSource.SMFInstrumentName
    • + +

    ∈ ARDOUR.MidiTempoMapDisposition

    + @@ -6129,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

    +

    ∈ RouteDialogs.InsertAt

    +

    ∈ ArdourMarker.Type

    - + -
    Ardour 5.11  -  Wed, 16 Aug 2017 20:56:47 +0200
    +
    Ardour 5.12  -  Sat, 16 Sep 2017 16:18:16 +0200