X-Git-Url: http://shamusworld.gotdns.org/cgi-bin/gitweb.cgi?a=blobdiff_plain;f=include%2Fclass-reference.html;h=6d324b8cb7dc2dd6133ea8bf209ad8fa1dd2404e;hb=bdabd959ccc29a7eddeccfd7922425101b3f9ef7;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])
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.
Methods | ||
---|---|---|
RCConfiguration | config () |
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 CReturns the maximum (rms) signal power of the region, or a -1 if the Progress object reports that the process was cancelled.
enable custom plugin-insert configuration
Returns true if successful
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
************************************************************* Pure interface begins here*************************************************************
remove plugin/processor
Returns 0 on success
remove plugin/processor
Returns 0 on success
replace plugin/processor with another
Returns 0 on success
replace plugin/processor with another
Returns 0 on success
reset plugin-insert configuration to default, disable customizations.
This is equivalent to calling
customize_plugin_insert (proc, 0, unused)
Returns true if successful
Methods | ||
---|---|---|
AutomationControl | automation_control (Parameter, bool) | |
bool | isnil () | |
Cast | ||
Slavable | to_slavable () |
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 CMethods | ||
---|---|---|
AutomationControl | automation_control (Parameter, bool) | |
Cast | ||
Slavable | to_slavable () |
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 CGet the current effective `user' value based on automation state
Get and Set `internal' value
All derived classes must implement this.
Basic derived classes will ignore
void | clear (double, double) | |
remove all automation events between the given time range
| ||
void | clear_list () | |
double | eval (double) | |
double | eval (double) | |
query value at given time (takes a read-lock, not safe while writing automation)
Returns parameter value | ||
EventList | events () | |
bool | in_write_pass () | |
InterpolationStyle | interpolation () | |
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
Returns parameter value | ||
void | set_interpolation (InterpolationStyle) | |
set the interpolation style of the automation data
| ||
bool | set_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.
Returns true if style change was successful | ||
void | thin (double) | |
Thin the number of events in this list. The thinning factor corresponds to the area of a triangle computed between three points in the list (time-difference * value-difference). If the area is large, it indicates significant non-linearity between the points. Time is measured in samples, value is usually normalized to 0..1. During automation recording we thin the recorded points using this value. If a point is sufficiently co-linear with its neighbours (as defined by the area of the triangle formed by three of them), we will not include it in the list. The larger the value, the more points are excluded, so this effectively measures the amount of thinning to be done.
| ||
void | truncate_end (double) |
Methods | ||
---|---|---|
ChanCount | count () |
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 | ||
---|---|---|
bool | isnil () |
Methods | ||
---|---|---|
void | add_master (AutomationControl, bool) | |
void | add_master (AutomationControl) | |
void | clear_masters () | |
int | get_boolean_masters () | |
double | get_masters_value () | |
Methods | ||
AutomationList | alist () | |
AutoState | automation_state () | |
AutoStyle | automation_style () | |
double | get_value () | |
Get the current effective `user' value based on automation state | ||
void | set_automation_state (AutoState) | |
void | set_automation_style (AutoStyle) | |
void | set_value (double, GroupControlDisposition) | |
Get and Set `internal' value All derived classes must implement this. Basic derived classes will ignore
| ||
void | start_touch (double) | |
void | stop_touch (bool, double) | |
void | stop_touch (double) | |
bool | writable () | |
Cast | ||
Control | to_ctrl () | |
SlavableAutomationControl | to_slavable () |
Methods | ||
---|---|---|
bool | active () | |
void | resize (unsigned long) | |
Reallocate the buffer used internally to handle at least size_t units of data. The buffer is not silent after this operation. the capacity argument passed to the constructor must have been non-zero. | ||
void | silence (long, long) | |
Clear (eg zero, or empty) buffer | ||
Clear (e.g. zero, or empty) buffer | ||
unsigned long | size () | |
... | table (--lua--) |
Methods | ||
---|---|---|
AutomationControl | automation_control (Parameter, bool) | |
Cast | ||
Slavable | to_slavable () |
C‡: ARDOUR::MidiModel::DiffCommand
@@ -1915,6 +1928,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to CC‡: 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)
bool | muted () | |
bool | muted_by_self () |
Methods | ||
---|---|---|
void | add_master (AutomationControl, bool) | |
void | add_master (AutomationControl) | |
void | clear_masters () | |
int | get_boolean_masters () | |
double | get_masters_value () | |
Methods | ||
AutomationList | alist () | |
AutoState | automation_state () | |
AutoStyle | automation_style () | |
double | get_value () | |
Get the current effective `user' value based on automation state | ||
void | set_automation_state (AutoState) | |
void | set_automation_style (AutoStyle) | |
void | set_value (double, GroupControlDisposition) | |
Get and Set `internal' value All derived classes must implement this. Basic derived classes will ignore
| ||
void | start_touch (double) | |
void | stop_touch (bool, double) | |
void | stop_touch (double) | |
bool | writable () | |
Cast | ||
Control | to_ctrl () | |
SlavableAutomationControl | to_slavable () |
std::string | midi_note_name (unsigned char, bool) | |
Data Members | ||
---|---|---|
std::string | label | |
bool | logarithmic |
Constructor | ||
---|---|---|
ℂ | Evoral.ParameterDescriptor () | |
Data Members | ||
bool | logarithmic | |
True for log-scale parameters | ||
float | lower | |
Minimum value (in Hz, for frequencies) | ||
float | normal | |
Methods | ||
AutomationList | alist () | |
AutoState | automation_state () | |
AutoStyle | automation_style () | |
double | get_value () | |
Get the current effective `user' value based on automation state | ||
void | set_automation_state (AutoState) | |
void | set_automation_style (AutoStyle) | |
void | set_value (double, GroupControlDisposition) | |
Get and Set `internal' value All derived classes must implement this. Basic derived classes will ignore
| ||
void | start_touch (double) | |
void | stop_touch (bool, double) | |
void | stop_touch (double) | |
bool | writable () | |
Cast | ||
Control | to_ctrl () | |
SlavableAutomationControl | to_slavable () |
Methods | ||
---|---|---|
AutomationList | alist () | |
AutoState | automation_state () | |
AutoStyle | automation_style () | |
double | get_value () | |
Get the current effective `user' value based on automation state | ||
void | set_automation_state (AutoState) | |
void | set_automation_style (AutoStyle) | |
void | set_value (double, GroupControlDisposition) | |
Get and Set `internal' value All derived classes must implement this. Basic derived classes will ignore
| ||
void | start_touch (double) | |
void | stop_touch (bool, double) | |
void | stop_touch (double) | |
bool | writable () | |
Cast | ||
Control | to_ctrl () | |
SlavableAutomationControl | to_slavable () |
Methods | ||
---|---|---|
unsigned int | color () | |
Flag | flags () | |
unsigned int | order () | |
void | set_color (unsigned int) | |
bool | special (bool) |
Methods | ||
---|---|---|
AFLPosition | get_afl_position () | |
bool | get_all_safe () | |
bool | get_allow_special_bus_removal () | |
bool | get_ask_replace_instrument () | |
bool | get_ask_setup_instrument () | |
float | get_audio_capture_buffer_seconds () | |
float | get_audio_playback_buffer_seconds () | |
std::string | get_auditioner_output_left () | |
std::string | get_auditioner_output_right () | |
bool | get_auto_analyse_audio () | |
bool | get_auto_connect_standard_busses () | |
AutoReturnTarget | get_auto_return_target_list () | |
bool | get_automation_follows_regions () | |
float | get_automation_interval_msecs () | |
double | get_automation_thinning_factor () | |
BufferingPreset | get_buffering_preset () | |
std::string | get_click_emphasis_sound () | |
float | get_click_gain () | |
bool | get_click_record_only () | |
std::string | get_click_sound () | |
bool | get_clicking () | |
bool | get_copy_demo_sessions () | |
bool | get_create_xrun_marker () | |
FadeShape | get_default_fade_shape () | |
std::string | get_default_session_parent_dir () | |
DenormalModel | get_denormal_model () | |
bool | get_denormal_protection () | |
bool | get_disable_disarm_during_roll () | |
bool | get_discover_audio_units () | |
bool | get_discover_vst_on_start () | |
unsigned int | get_disk_choice_space_threshold () | |
std::string | get_donate_url () | |
EditMode | get_edit_mode () | |
bool | get_exclusive_solo () | |
float | get_export_preroll () | |
float | get_export_silence_threshold () | |
unsigned int | get_feedback_interval_ms () | |
bool | get_first_midi_bank_is_zero () | |
std::string | get_freesound_download_dir () | |
bool | get_hide_dummy_backend () | |
bool | get_hiding_groups_deactivates_groups () | |
int | get_history_depth () | |
int | get_initial_program_change () | |
AutoConnectOption | get_input_auto_connect () | |
int | get_inter_scene_gap_frames () | |
bool | get_latched_record_enable () | |
LayerModel | get_layer_model () | |
bool | get_link_send_and_route_panner () | |
std::string | get_linux_pingback_url () | |
ListenPosition | get_listen_position () | |
bool | get_locate_while_waiting_for_sync () | |
bool | get_loop_is_mode () | |
std::string | get_ltc_output_port () | |
float | get_ltc_output_volume () | |
bool | get_ltc_send_continuously () | |
std::string | get_ltc_source_port () | |
float | get_max_gain () | |
unsigned int | get_max_recent_sessions () | |
unsigned int | get_max_recent_templates () | |
float | get_meter_falloff () | |
MeterType | get_meter_type_bus () | |
MeterType | get_meter_type_master () | |
MeterType | get_meter_type_track () | |
std::string | get_midi_audition_synth_uri () | |
bool | get_midi_feedback () | |
bool | get_midi_input_follows_selection () | |
float | get_midi_readahead () | |
float | get_midi_track_buffer_seconds () | |
unsigned int | get_minimum_disk_read_bytes () | |
unsigned int | get_minimum_disk_write_bytes () | |
bool | get_mmc_control () | |
int | get_mmc_receive_device_id () | |
int | get_mmc_send_device_id () | |
std::string | get_monitor_bus_preferred_bundle () | |
MonitorModel | get_monitoring_model () | |
int | get_mtc_qf_speed_tolerance () | |
bool | get_mute_affects_control_outs () | |
bool | get_mute_affects_main_outs () | |
bool | get_mute_affects_post_fader () | |
bool | get_mute_affects_pre_fader () | |
bool | get_new_plugins_active () | |
unsigned int | get_osc_port () | |
std::string | get_osx_pingback_url () | |
AutoConnectOption | get_output_auto_connect () | |
unsigned int | get_periodic_safety_backup_interval () | |
bool | get_periodic_safety_backups () | |
PFLPosition | get_pfl_position () | |
std::string | get_plugin_path_lxvst () | |
std::string | get_plugin_path_vst () | |
bool | get_plugins_stop_with_transport () | |
long | get_postroll () | |
long | get_preroll () | |
float | get_preroll_seconds () | |
int | get_processor_usage () | |
bool | get_quieten_at_speed () | |
long | get_range_location_minimum () | |
std::string | get_reference_manual_url () | |
bool | get_region_boundaries_from_onscreen_tracks () | |
bool | get_region_boundaries_from_selected_tracks () | |
RegionSelectionAfterSplit | get_region_selection_after_split () | |
bool | get_replicate_missing_region_channels () | |
float | get_rf_speed () | |
bool | get_save_history () | |
int | get_saved_history_depth () | |
bool | get_seamless_loop () | |
bool | get_send_ltc () | |
bool | get_send_midi_clock () | |
bool | get_send_mmc () | |
bool | get_send_mtc () | |
bool | get_show_solo_mutes () | |
bool | get_show_video_export_info () | |
bool | get_show_video_server_dialog () | |
ShuttleBehaviour | get_shuttle_behaviour () | |
float | get_shuttle_max_speed () | |
float | get_shuttle_speed_factor () | |
float | get_shuttle_speed_threshold () | |
ShuttleUnits | get_shuttle_units () | |
bool | get_skip_playback () | |
bool | get_solo_control_is_listen_control () | |
float | get_solo_mute_gain () | |
bool | get_solo_mute_override () | |
bool | get_stop_at_session_end () | |
bool | get_stop_recording_on_xrun () | |
bool | get_strict_io () | |
SyncSource | get_sync_source () | |
bool | get_tape_machine_mode () | |
bool | get_timecode_source_2997 () | |
bool | get_timecode_source_is_synced () | |
bool | get_timecode_sync_frame_rate () | |
bool | get_trace_midi_input () | |
bool | get_trace_midi_output () | |
TracksAutoNamingRule | get_tracks_auto_naming () | |
float | get_transient_sensitivity () | |
bool | get_try_autostart_engine () | |
std::string | get_tutorial_manual_url () | |
std::string | get_updates_url () | |
bool | get_use_click_emphasis () | |
bool | get_use_lxvst () | |
bool | get_use_macvst () | |
bool | get_use_monitor_bus () | |
bool | get_use_osc () | |
bool | get_use_overlap_equivalency () | |
bool | get_use_plugin_own_gui () | |
bool | get_use_tranzport () | |
bool | get_use_windows_vst () | |
bool | get_verbose_plugin_scan () | |
bool | get_verify_remove_last_capture () | |
bool | get_video_advanced_setup () | |
std::string | get_video_server_docroot () | |
std::string | get_video_server_url () | |
int | get_vst_scan_timeout () | |
std::string | get_windows_pingback_url () | |
bool | set_afl_position (AFLPosition) | |
bool | set_all_safe (bool) | |
bool | set_allow_special_bus_removal (bool) | |
bool | set_ask_replace_instrument (bool) | |
bool | set_ask_setup_instrument (bool) | |
bool | set_audio_capture_buffer_seconds (float) | |
bool | set_audio_playback_buffer_seconds (float) | |
bool | set_auditioner_output_left (std::string) | |
bool | set_auditioner_output_right (std::string) | |
bool | set_auto_analyse_audio (bool) | |
bool | set_auto_connect_standard_busses (bool) | |
bool | set_auto_return_target_list (AutoReturnTarget) | |
bool | set_automation_follows_regions (bool) | |
bool | set_automation_interval_msecs (float) | |
bool | set_automation_thinning_factor (double) | |
bool | set_buffering_preset (BufferingPreset) | |
bool | set_click_emphasis_sound (std::string) | |
bool | set_click_gain (float) | |
bool | set_click_record_only (bool) | |
bool | set_click_sound (std::string) | |
bool | set_clicking (bool) | |
bool | set_copy_demo_sessions (bool) | |
bool | set_create_xrun_marker (bool) | |
bool | set_default_fade_shape (FadeShape) | |
bool | set_default_session_parent_dir (std::string) | |
bool | set_denormal_model (DenormalModel) | |
bool | set_denormal_protection (bool) | |
bool | set_disable_disarm_during_roll (bool) | |
bool | set_discover_audio_units (bool) | |
bool | set_discover_vst_on_start (bool) | |
bool | set_disk_choice_space_threshold (unsigned int) | |
bool | set_donate_url (std::string) | |
bool | set_edit_mode (EditMode) | |
bool | set_exclusive_solo (bool) | |
bool | set_export_preroll (float) | |
bool | set_export_silence_threshold (float) | |
bool | set_feedback_interval_ms (unsigned int) | |
bool | set_first_midi_bank_is_zero (bool) | |
bool | set_freesound_download_dir (std::string) | |
bool | set_hide_dummy_backend (bool) | |
bool | set_hiding_groups_deactivates_groups (bool) | |
bool | set_history_depth (int) | |
bool | set_initial_program_change (int) | |
bool | set_input_auto_connect (AutoConnectOption) | |
bool | set_inter_scene_gap_frames (int) | |
bool | set_latched_record_enable (bool) | |
bool | set_layer_model (LayerModel) | |
bool | set_link_send_and_route_panner (bool) | |
bool | set_linux_pingback_url (std::string) | |
bool | set_listen_position (ListenPosition) | |
bool | set_locate_while_waiting_for_sync (bool) | |
bool | set_loop_is_mode (bool) | |
bool | set_ltc_output_port (std::string) | |
bool | set_ltc_output_volume (float) | |
bool | set_ltc_send_continuously (bool) | |
bool | set_ltc_source_port (std::string) | |
bool | set_max_gain (float) | |
bool | set_max_recent_sessions (unsigned int) | |
bool | set_max_recent_templates (unsigned int) | |
bool | set_meter_falloff (float) | |
bool | set_meter_type_bus (MeterType) | |
bool | set_meter_type_master (MeterType) | |
bool | set_meter_type_track (MeterType) | |
bool | set_midi_audition_synth_uri (std::string) | |
bool | set_midi_feedback (bool) | |
bool | set_midi_input_follows_selection (bool) | |
bool | set_midi_readahead (float) | |
bool | set_midi_track_buffer_seconds (float) | |
bool | set_minimum_disk_read_bytes (unsigned int) | |
bool | set_minimum_disk_write_bytes (unsigned int) | |
bool | set_mmc_control (bool) | |
bool | set_mmc_receive_device_id (int) | |
bool | set_mmc_send_device_id (int) | |
bool | set_monitor_bus_preferred_bundle (std::string) | |
bool | set_monitoring_model (MonitorModel) | |
bool | set_mtc_qf_speed_tolerance (int) | |
bool | set_mute_affects_control_outs (bool) | |
bool | set_mute_affects_main_outs (bool) | |
bool | set_mute_affects_post_fader (bool) | |
bool | set_mute_affects_pre_fader (bool) | |
bool | set_new_plugins_active (bool) | |
bool | set_osc_port (unsigned int) | |
bool | set_osx_pingback_url (std::string) | |
bool | set_output_auto_connect (AutoConnectOption) | |
bool | set_periodic_safety_backup_interval (unsigned int) | |
bool | set_periodic_safety_backups (bool) | |
bool | set_pfl_position (PFLPosition) | |
bool | set_plugin_path_lxvst (std::string) | |
bool | set_plugin_path_vst (std::string) | |
bool | set_plugins_stop_with_transport (bool) | |
bool | set_postroll (long) | |
bool | set_preroll (long) | |
bool | set_preroll_seconds (float) | |
bool | set_processor_usage (int) | |
bool | set_quieten_at_speed (bool) | |
bool | set_range_location_minimum (long) | |
bool | set_reference_manual_url (std::string) | |
bool | set_region_boundaries_from_onscreen_tracks (bool) | |
bool | set_region_boundaries_from_selected_tracks (bool) | |
bool | set_region_selection_after_split (RegionSelectionAfterSplit) | |
bool | set_replicate_missing_region_channels (bool) | |
bool | set_rf_speed (float) | |
bool | set_save_history (bool) | |
bool | set_saved_history_depth (int) | |
bool | set_seamless_loop (bool) | |
bool | set_send_ltc (bool) | |
bool | set_send_midi_clock (bool) | |
bool | set_send_mmc (bool) | |
bool | set_send_mtc (bool) | |
bool | set_show_solo_mutes (bool) | |
bool | set_show_video_export_info (bool) | |
bool | set_show_video_server_dialog (bool) | |
bool | set_shuttle_behaviour (ShuttleBehaviour) | |
bool | set_shuttle_max_speed (float) | |
bool | set_shuttle_speed_factor (float) | |
bool | set_shuttle_speed_threshold (float) | |
bool | set_shuttle_units (ShuttleUnits) | |
bool | set_skip_playback (bool) | |
bool | set_solo_control_is_listen_control (bool) | |
bool | set_solo_mute_gain (float) | |
bool | set_solo_mute_override (bool) | |
bool | set_stop_at_session_end (bool) | |
bool | set_stop_recording_on_xrun (bool) | |
bool | set_strict_io (bool) | |
bool | set_sync_source (SyncSource) | |
bool | set_tape_machine_mode (bool) | |
bool | set_timecode_source_2997 (bool) | |
bool | set_timecode_source_is_synced (bool) | |
bool | set_timecode_sync_frame_rate (bool) | |
bool | set_trace_midi_input (bool) | |
bool | set_trace_midi_output (bool) | |
bool | set_tracks_auto_naming (TracksAutoNamingRule) | |
bool | set_transient_sensitivity (float) | |
bool | set_try_autostart_engine (bool) | |
bool | set_tutorial_manual_url (std::string) | |
bool | set_updates_url (std::string) | |
bool | set_use_click_emphasis (bool) | |
bool | set_use_lxvst (bool) | |
bool | set_use_macvst (bool) | |
bool | set_use_monitor_bus (bool) | |
bool | set_use_osc (bool) | |
bool | set_use_overlap_equivalency (bool) | |
bool | set_use_plugin_own_gui (bool) | |
bool | set_use_tranzport (bool) | |
bool | set_use_windows_vst (bool) | |
bool | set_verbose_plugin_scan (bool) | |
bool | set_verify_remove_last_capture (bool) | |
bool | set_video_advanced_setup (bool) | |
bool | set_video_server_docroot (std::string) | |
bool | set_video_server_url (std::string) | |
bool | set_vst_scan_timeout (int) | |
bool | set_windows_pingback_url (std::string) | |
Properties | ||
ARDOUR.AFLPosition | afl_position | |
bool | all_safe | |
bool | allow_special_bus_removal | |
bool | ask_replace_instrument | |
bool | ask_setup_instrument | |
float | audio_capture_buffer_seconds | |
float | audio_playback_buffer_seconds | |
std::string | auditioner_output_left | |
std::string | auditioner_output_right | |
bool | auto_analyse_audio | |
bool | auto_connect_standard_busses | |
ARDOUR.AutoReturnTarget | auto_return_target_list | |
bool | automation_follows_regions | |
float | automation_interval_msecs | |
double | automation_thinning_factor | |
ARDOUR.BufferingPreset | buffering_preset | |
std::string | click_emphasis_sound | |
float | click_gain | |
bool | click_record_only | |
std::string | click_sound | |
bool | clicking | |
bool | copy_demo_sessions | |
bool | create_xrun_marker | |
ARDOUR.FadeShape | default_fade_shape | |
std::string | default_session_parent_dir | |
ARDOUR.DenormalModel | denormal_model | |
bool | denormal_protection | |
bool | disable_disarm_during_roll | |
bool | discover_audio_units | |
bool | discover_vst_on_start | |
unsigned int | disk_choice_space_threshold | |
std::string | donate_url | |
ARDOUR.EditMode | edit_mode | |
bool | exclusive_solo | |
float | export_preroll | |
float | export_silence_threshold | |
unsigned int | feedback_interval_ms | |
bool | first_midi_bank_is_zero | |
std::string | freesound_download_dir | |
bool | hide_dummy_backend | |
bool | hiding_groups_deactivates_groups | |
int | history_depth | |
int | initial_program_change | |
ARDOUR.AutoConnectOption | input_auto_connect | |
int | inter_scene_gap_frames | |
bool | latched_record_enable | |
ARDOUR.LayerModel | layer_model | |
bool | link_send_and_route_panner | |
std::string | linux_pingback_url | |
ARDOUR.ListenPosition | listen_position | |
bool | locate_while_waiting_for_sync | |
bool | loop_is_mode | |
std::string | ltc_output_port | |
float | ltc_output_volume | |
bool | ltc_send_continuously | |
std::string | ltc_source_port | |
float | max_gain | |
unsigned int | max_recent_sessions | |
unsigned int | max_recent_templates | |
float | meter_falloff | |
ARDOUR.MeterType | meter_type_bus | |
ARDOUR.MeterType | meter_type_master | |
ARDOUR.MeterType | meter_type_track | |
std::string | midi_audition_synth_uri | |
bool | midi_feedback | |
bool | midi_input_follows_selection | |
float | midi_readahead | |
float | midi_track_buffer_seconds | |
unsigned int | minimum_disk_read_bytes | |
unsigned int | minimum_disk_write_bytes | |
bool | mmc_control | |
int | mmc_receive_device_id | |
int | mmc_send_device_id | |
std::string | monitor_bus_preferred_bundle | |
ARDOUR.MonitorModel | monitoring_model | |
int | mtc_qf_speed_tolerance | |
bool | mute_affects_control_outs | |
bool | mute_affects_main_outs | |
bool | mute_affects_post_fader | |
bool | mute_affects_pre_fader | |
bool | new_plugins_active | |
unsigned int | osc_port | |
std::string | osx_pingback_url | |
ARDOUR.AutoConnectOption | output_auto_connect | |
unsigned int | periodic_safety_backup_interval | |
bool | periodic_safety_backups | |
ARDOUR.PFLPosition | pfl_position | |
std::string | plugin_path_lxvst | |
std::string | plugin_path_vst | |
bool | plugins_stop_with_transport | |
long | postroll | |
long | preroll | |
float | preroll_seconds | |
int | processor_usage | |
bool | quieten_at_speed | |
long | range_location_minimum | |
std::string | reference_manual_url | |
bool | region_boundaries_from_onscreen_tracks | |
bool | region_boundaries_from_selected_tracks | |
ARDOUR.RegionSelectionAfterSplit | region_selection_after_split | |
bool | replicate_missing_region_channels | |
float | rf_speed | |
bool | save_history | |
int | saved_history_depth | |
bool | seamless_loop | |
bool | send_ltc | |
bool | send_midi_clock | |
bool | send_mmc | |
bool | send_mtc | |
bool | show_solo_mutes | |
bool | show_video_export_info | |
bool | show_video_server_dialog | |
ARDOUR.ShuttleBehaviour | shuttle_behaviour | |
float | shuttle_max_speed | |
float | shuttle_speed_factor | |
float | shuttle_speed_threshold | |
ARDOUR.ShuttleUnits | shuttle_units | |
bool | skip_playback | |
bool | solo_control_is_listen_control | |
float | solo_mute_gain | |
bool | solo_mute_override | |
bool | stop_at_session_end | |
bool | stop_recording_on_xrun | |
bool | strict_io | |
ARDOUR.SyncSource | sync_source | |
bool | tape_machine_mode | |
bool | timecode_source_2997 | |
bool | timecode_source_is_synced | |
bool | timecode_sync_frame_rate | |
bool | trace_midi_input | |
bool | trace_midi_output | |
ARDOUR.TracksAutoNamingRule | tracks_auto_naming | |
float | transient_sensitivity | |
bool | try_autostart_engine | |
std::string | tutorial_manual_url | |
std::string | updates_url | |
bool | use_click_emphasis | |
bool | use_lxvst | |
bool | use_macvst | |
bool | use_monitor_bus | |
bool | use_osc | |
bool | use_overlap_equivalency | |
bool | use_plugin_own_gui | |
bool | use_tranzport | |
bool | use_windows_vst | |
bool | verbose_plugin_scan | |
bool | verify_remove_last_capture | |
bool | video_advanced_setup | |
std::string | video_server_docroot | |
std::string | video_server_url | |
int | vst_scan_timeout | |
std::string | windows_pingback_url |
Methods | ||
---|---|---|
void | clear_changes () | |
Forget about any changes to this object's properties | ||
ID | id () | |
OwnedPropertyList | properties () |
C‡: boost::shared_ptr< ARDOUR::ReadOnlyControl >, boost::weak_ptr< ARDOUR::ReadOnlyControl >
+is-a: PBD:StatefulDestructiblePtr
+ +Methods | ||
---|---|---|
ParameterDescriptor | desc () | |
std::string | describe_parameter () | |
double | get_parameter () | |
bool | isnil () |
Methods | ||
---|---|---|
void | clear_changes () | |
Forget about any changes to this object's properties | ||
ID | id () | |
OwnedPropertyList | properties () |
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 CMethods | ||
---|---|---|
Region | clone_region (Region, bool, bool) | |
Region | region_by_id (ID) | |
RegionMap | regions () |
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 CC‡: std::map<PBD::ID, boost::shared_ptr<ARDOUR::Region> > >
+ +Constructor | ||
---|---|---|
ℂ | ARDOUR.RegionMap () | |
Methods | ||
LuaTable | add (LuaTable {Region}) | |
... | at (--lua--) | |
void | clear () | |
unsigned long | count (ID) | |
bool | empty () | |
LuaIter | iter () | |
unsigned long | size () | |
LuaTable | table () |
C‡: std::vector<boost::shared_ptr<ARDOUR::Region> >
+ +Constructor | ||
---|---|---|
ℂ | ARDOUR.RegionVector () | |
ℂ | ARDOUR.RegionVector () | |
Methods | ||
LuaTable | add (LuaTable {Region}) | |
Region | at (unsigned long) | |
bool | empty () | |
LuaIter | iter () | |
void | push_back (Region) | |
unsigned long | size () | |
LuaTable | table () |
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 Cbool | actively_recording () | |
void | add_command (Command) | |
void | add_internal_sends (Route, Placement, RouteListPtr) | |
int | add_master_bus (ChanCount) | |
void | add_monitor_section () | |
StatefulDiffCommand | add_stateful_diff_command (StatefulDestructiblePtr) | |
create an StatefulDiffCommand from the given object and add it to the stack. This function must only be called after begin_reversible_command. Failing to do so may lead to a crash.
Returns the allocated StatefulDiffCommand (already added via add_command) | ||
void | begin_reversible_command (std::string) | |
RouteListPtr | get_routes () | |
BufferSet | get_scratch_buffers (ChanCount, bool) | |
BufferSet | get_silent_buffers (ChanCount) | |
StripableList | get_stripables () | |
RouteListPtr | get_tracks () | |
void | goto_end () | |
void | goto_start (bool) | |
std::string | path () | |
Processor | processor_by_id (ID) | |
RecordState | record_status () | |
void | remove_monitor_section () | |
void | remove_route_group (RouteGroup) | |
void | request_locate (long, bool) | |
void | request_play_loop (bool, bool) | |
bool | transport_rolling () | |
double | transport_speed () | |
StringList | unknown_processors () | |
VCAManager | vca_manager () | |
long | worst_input_latency () | |
long | worst_output_latency () | |
long | worst_playback_latency () | |
Stateful | to_stateful () | |
StatefulDestructible | to_statefuldestructible () |
C‡: boost::shared_ptr< ARDOUR::Slavable >, boost::weak_ptr< ARDOUR::Slavable >
+ +Methods | ||
---|---|---|
void | assign (VCA) | |
bool | isnil () | |
void | unassign (VCA) |
C‡: boost::shared_ptr< ARDOUR::SlavableAutomationControl >, boost::weak_ptr< ARDOUR::SlavableAutomationControl >
is-a: ARDOUR:AutomationControl
A PBD::Controllable with associated automation data (AutomationList)
Methods | ||
---|---|---|
void | add_master (AutomationControl, bool) | |
void | add_master (AutomationControl) | |
void | clear_masters () | |
int | get_boolean_masters () | |
double | get_masters_value () | |
Methods | ||
AutomationList | alist () | |
AutoState | automation_state () | |
AutoStyle | automation_style () | |
double | get_value () | |
Get the current effective `user' value based on automation state | ||
void | set_automation_state (AutoState) | |
void | set_automation_style (AutoStyle) | |
void | set_value (double, GroupControlDisposition) | |
Get and Set `internal' value All derived classes must implement this. Basic derived classes will ignore
| ||
void | start_touch (double) | |
void | stop_touch (bool, double) | |
void | stop_touch (double) | |
bool | writable () | |
Cast | ||
Control | to_ctrl () | |
SlavableAutomationControl | to_slavable () |
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)
bool | self_soloed () | |
bool | soloed () |
Methods | ||
---|---|---|
void | add_master (AutomationControl, bool) | |
void | add_master (AutomationControl) | |
void | clear_masters () | |
int | get_boolean_masters () | |
double | get_masters_value () | |
Methods | ||
AutomationList | alist () | |
AutoState | automation_state () | |
AutoStyle | automation_style () | |
double | get_value () | |
Get the current effective `user' value based on automation state | ||
void | set_automation_state (AutoState) | |
void | set_automation_style (AutoStyle) | |
void | set_value (double, GroupControlDisposition) | |
Get and Set `internal' value All derived classes must implement this. Basic derived classes will ignore
| ||
void | start_touch (double) | |
void | stop_touch (bool, double) | |
void | stop_touch (double) | |
bool | writable () | |
Cast | ||
Control | to_ctrl () | |
SlavableAutomationControl | to_slavable () |
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)
bool | self_solo_isolated () | |
bool | solo_isolated () |
Methods | ||
---|---|---|
void | add_master (AutomationControl, bool) | |
void | add_master (AutomationControl) | |
void | clear_masters () | |
int | get_boolean_masters () | |
double | get_masters_value () | |
Methods | ||
AutomationList | alist () | |
AutoState | automation_state () | |
AutoStyle | automation_style () | |
double | get_value () | |
Get the current effective `user' value based on automation state | ||
void | set_automation_state (AutoState) | |
void | set_automation_style (AutoStyle) | |
void | set_value (double, GroupControlDisposition) | |
Get and Set `internal' value All derived classes must implement this. Basic derived classes will ignore
| ||
void | start_touch (double) | |
void | stop_touch (bool, double) | |
void | stop_touch (double) | |
bool | writable () | |
Cast | ||
Control | to_ctrl () | |
SlavableAutomationControl | to_slavable () |
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)
bool | isnil () | |
bool | solo_safe () |
Methods | ||
---|---|---|
void | add_master (AutomationControl, bool) | |
void | add_master (AutomationControl) | |
void | clear_masters () | |
int | get_boolean_masters () | |
double | get_masters_value () | |
Methods | ||
AutomationList | alist () | |
AutoState | automation_state () | |
AutoStyle | automation_style () | |
double | get_value () | |
Get the current effective `user' value based on automation state | ||
void | set_automation_state (AutoState) | |
void | set_automation_style (AutoStyle) | |
void | set_value (double, GroupControlDisposition) | |
Get and Set `internal' value All derived classes must implement this. Basic derived classes will ignore
| ||
void | start_touch (double) | |
void | stop_touch (bool, double) | |
void | stop_touch (double) | |
bool | writable () | |
Cast | ||
Control | to_ctrl () | |
SlavableAutomationControl | to_slavable () |
AutomationControl | comp_makeup_control () | |
AutomationControl | comp_mode_control () | |
std::string | comp_mode_name (unsigned int) | |
--MISSING (boost::shared_ptr<ARDOUR::ReadOnlyControl>)-- | comp_redux_control () | |
ReadOnlyControl | comp_redux_control () | |
AutomationControl | comp_speed_control () | |
std::string | comp_speed_name (unsigned int) | |
AutomationControl | comp_threshold_control () | |
GainControl | trim_control () | |
Cast | ||
---|---|---|
Route | to_route () | |
VCA | to_vca () |
Stateful | to_stateful () | |
StatefulDestructible | to_statefuldestructible () |
C‡: std::list<boost::shared_ptr<ARDOUR::Stripable> >
+ +Constructor | ||
---|---|---|
ℂ | ARDOUR.StripableList () | |
Methods | ||
Stripable | back () | |
bool | empty () | |
Stripable | front () | |
LuaIter | iter () | |
void | reverse () | |
unsigned long | size () | |
LuaTable | table () |
C‡: ARDOUR::Tempo
@@ -3743,12 +4312,12 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to CTempo Map - mapping of timecode to musical time. convert audio-samples, sample-rate to Bar/Beat/Tick, Meter/Tempo
Methods | ||
---|---|---|
MeterSection | add_meter (Meter, double, BBT_TIME, long, PositionLockStyle) | |
TempoSection | add_tempo (Tempo, double, long, PositionLockStyle) | |
MeterSection | add_meter (Meter, BBT_TIME, long, PositionLockStyle) | |
TempoSection | add_tempo (Tempo, double, long, PositionLockStyle) | |
BBT_TIME | bbt_at_frame (long) | |
Returns the BBT time corresponding to the supplied frame position.
Returns the BBT time at the frame position . | ||
double | exact_beat_at_frame (long, int) | |
double | exact_qn_at_frame (long, int) | |
double | exact_beat_at_frame (long, int) | |
double | exact_qn_at_frame (long, int) | |
long | framepos_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. | ||
Beats | framewalk_to_qn (long, long) | |
Amp | trim () | |
Cast | ||
Automatable | to_automatable () | |
Slavable | to_slavable () | |
Track | to_track () |
Stateful | to_stateful () | |
StatefulDestructible | to_statefuldestructible () |
C‡: boost::shared_ptr< ARDOUR::VCA >, boost::weak_ptr< ARDOUR::VCA >
+is-a: ARDOUR:Stripable
+ +A named object associated with a Session. Objects derived from this class are expected to be destroyed before the session calls drop_references().
Methods | ||
---|---|---|
std::string | full_name () | |
GainControl | gain_control () | |
bool | isnil () | |
MuteControl | mute_control () | |
int | number () | |
SoloControl | solo_control () |
Methods | ||
---|---|---|
AutomationControl | comp_enable_control () | |
AutomationControl | comp_makeup_control () | |
AutomationControl | comp_mode_control () | |
std::string | comp_mode_name (unsigned int) | |
ReadOnlyControl | comp_redux_control () | |
AutomationControl | comp_speed_control () | |
std::string | comp_speed_name (unsigned int) | |
AutomationControl | comp_threshold_control () | |
unsigned int | eq_band_cnt () | |
std::string | eq_band_name (unsigned int) | |
AutomationControl | eq_enable_control () | |
AutomationControl | eq_freq_control (unsigned int) | |
AutomationControl | eq_gain_control (unsigned int) | |
AutomationControl | eq_q_control (unsigned int) | |
AutomationControl | eq_shape_control (unsigned int) | |
AutomationControl | filter_enable_controllable (bool) | |
AutomationControl | filter_freq_controllable (bool) | |
AutomationControl | filter_slope_controllable (bool) | |
bool | is_auditioner () | |
bool | is_hidden () | |
bool | is_master () | |
bool | is_monitor () | |
bool | is_selected () | |
AutomationControl | master_send_enable_control () | |
MonitorProcessor | monitor_control () | |
AutomationControl | pan_azimuth_control () | |
AutomationControl | pan_elevation_control () | |
AutomationControl | pan_frontback_control () | |
AutomationControl | pan_lfe_control () | |
AutomationControl | pan_width_control () | |
PhaseControl | phase_control () | |
PresentationInfo | presentation_info_ptr () | |
AutomationControl | rec_enable_control () | |
AutomationControl | rec_safe_control () | |
AutomationControl | send_enable_control (unsigned int) | |
AutomationControl | send_level_control (unsigned int) | |
std::string | send_name (unsigned int) | |
void | set_presentation_order (unsigned int) | |
SoloIsolateControl | solo_isolate_control () | |
SoloSafeControl | solo_safe_control () | |
GainControl | trim_control () | |
Cast | ||
Route | to_route () | |
VCA | to_vca () |
Methods | ||
---|---|---|
std::string | name () | |
Cast | ||
Stateful | to_stateful () | |
StatefulDestructible | to_statefuldestructible () |
C‡: std::list<boost::shared_ptr<ARDOUR::VCA> >
+ +Constructor | ||
---|---|---|
ℂ | ARDOUR.VCAList () | |
Methods | ||
VCA | back () | |
bool | empty () | |
VCA | front () | |
LuaIter | iter () | |
void | reverse () | |
unsigned long | size () | |
LuaTable | table () |
C‡: ARDOUR::VCAManager
+is-a: PBD:StatefulDestructible
+ +Base class for objects with saveable and undoable state with destruction notification
Methods | ||
---|---|---|
int | create_vca (unsigned int, std::string) | |
unsigned long | n_vcas () | |
void | remove_vca (VCA) | |
VCA | vca_by_name (std::string) | |
VCA | vca_by_number (int) | |
VCAList | vcas () |
Methods | ||
---|---|---|
void | clear_changes () | |
Forget about any changes to this object's properties | ||
ID | id () | |
OwnedPropertyList | properties () |
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 CC‡: ArdourMarker
@@ -4028,7 +4707,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to CThis class contains just the public interface of the Editor class, in order to decouple it from the private implementation, so that callers of PublicEditor need not be recompiled if private methods or member variables change.
Methods | ||
---|---|---|
void | access_action (std::string, std::string) | |
void | access_action (std::string, std::string) | |
void | add_location_from_playhead_cursor () | |
TrackViewList | axis_views_from_routes (RouteListPtr) | |
void | center_screen (long) | |
long | current_page_samples () | |
void | deselect_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 | ||
bool | dragging_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&) | |
ArdourMarker | find_marker_from_location_id (ID, bool) | |
void | fit_selection () | |
bool | follow_playhead () | |
Returns true if the editor is following the playhead | ||
long | get_current_zoom () | |
LuaTable(long, ...) | get_nudge_distance (long, long&) | |
long | get_paste_offset (long, unsigned int, long) | |
LuaTable(...) | get_pointer_position (double&, double&) | |
RouteTimeAxisView | get_route_view_by_route_id (ID) | |
Selection | get_selection () | |
LuaTable(bool, ...) | get_selection_extents (long&, long&) | |
bool | get_smart_mode () | |
StripableTimeAxisView | get_stripable_time_axis_by_id (ID) | |
TrackViewList | get_track_views () | |
int | get_videotl_bar_height () | |
double | get_y_origin () | |
void | set_snap_threshold (double) | |
Set the snap threshold.
| ||
void | set_stationary_playhead (bool) | |
void | set_toggleaction (std::string, std::string, bool) | |
void | set_video_timeline_height (int) | |
void | set_visible_track_count (int) | |
void | set_zoom_focus (ZoomFocus) | |
bool | show_measures () | |
void | show_track_in_display (TimeAxisView, bool) |
Cast | ||
---|---|---|
StripableTimeAxisView | to_stripabletimeaxisview () | |
TimeAxisView | to_timeaxisview () |
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.
C‡: TimeAxisView
is-a: ArdourUI:AxisView
@@ -4633,17 +5322,17 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to Cremove all automation events between the given time range
query value at given time (takes a read-lock, not safe while writing automation)
Returns parameter value
query interpolation style of the automation data
Returns Interpolation Style
realtime safe version of eval, may fail if read-lock cannot be taken
Returns parameter value
set the interpolation style of the automation data
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.
Returns true if style change was successful
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.
True for log-scale parameters
Minimum value (in Hz, for frequencies)
C‡: std::bitset<47ul>
+C‡: std::bitset<48ul>
Constructor | ||
---|---|---|
ℂ | LuaSignal.Set () | |
Methods | ||
LuaTable | add (47ul) | |
bool | any () | |
unsigned long | count () | |
bool | none () | |
Set | reset () | |
Set | set (unsigned long, bool) | |
unsigned long | size () | |
LuaTable | add (48ul) | |
bool | any () | |
unsigned long | count () | |
bool | none () | |
Set | reset () | |
Set | set (unsigned long, bool) | |
unsigned long | size () | |
LuaTable | table () | |
bool | test (unsigned long) | |
bool | test (unsigned long) |
Methods | ||
---|---|---|
int | execute (std::string) | |
LuaTable | forkexec () |