X-Git-Url: http://shamusworld.gotdns.org/cgi-bin/gitweb.cgi?a=blobdiff_plain;f=include%2Fclass-reference.html;fp=include%2Fclass-reference.html;h=9d8816d5b9bed278b3bb788dd1d05369a72888e0;hb=26510f4a576e5d917580a167c868ad2fbd432ad0;hp=a95712e11147be83b8147f27452fbf6c9bf684fe;hpb=a078261ae12d9a9994719562a15073df8d84255e;p=ardour-manual diff --git a/include/class-reference.html b/include/class-reference.html index a95712e..9d8816d 100644 --- a/include/class-reference.html +++ b/include/class-reference.html @@ -650,9 +650,9 @@ Pointer Classes cannot be created in Lua scripts. It always requires a call to C

Inherited from ARDOUR:Track

- + - + @@ -671,7 +671,7 @@ Pointer Classes cannot be created in Lua scripts. It always requires a call to C
Methods
Regionbounce (InterThreadInfo&)
Regionbounce (InterThreadInfo&, std::string)

bounce track from session start to session end to new region

itt
asynchronous progress report and cancel

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

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

Bounce the given range to a new audio region.

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

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

boolbounceable (Processor, bool)

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

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

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

- + @@ -890,27 +890,31 @@ Pointer Classes cannot be created in Lua scripts. It always requires a call to C
Methods
boolactive ()
intadd_foldback_send (Route)
intadd_foldback_send (Route, bool)
intadd_processor_by_index (Processor, int, ProcessorStreams, bool)

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

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

Returns 0 on success, non-0 on failure.

booladd_sidechain (Processor)
- + - + + - + + + - + - + + - + - +
Methods
voidadd (double, double, bool, bool)

add automation events

when
absolute time in samples
value
parameter value
with_guards
if true, add guard-points
with_initial
if true, add an initial point if the list is empty

Add an event to this list.

This method is intended to write automation in realtime. If the transport is stopped, guard-points will be added regardless of parameter with_guards.

when
absolute time in samples
value
parameter value
with_guards
if true, add guard-points
with_initial
if true, add an initial point if the list is empty
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

Remove all events in the given time range from this list.

start
start of range (inclusive) in audio samples
end
end of range (inclusive) in audio samples
voidclear_list ()
booleditor_add (double, double, bool)

Add an event to this list.

This method is intended for making manual changes from the GUI. An event will only be created if no other event exists at the given time.

when
absolute time in samples
value
parameter value
with_guards
if true, add guard-points

Returns true if an event was added.

doubleeval (double)

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

where
absolute time in samples

Returns parameter value

Queries the event value at the given time (takes a read-lock, not safe while writing automation).

where
absolute time in samples

Returns parameter value

EventListevents ()

Returns the list of events

boolin_write_pass ()

Returns true if transport is running and this list is in write mode

InterpolationStyleinterpolation ()

query interpolation style of the automation data

Returns Interpolation Style

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

Realtime safe version of eval(). This may fail if a read-lock cannot be taken.

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

Returns parameter value

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

Sets the interpolation style of the automation data.

This will fail when asking for Logarithmic scale and min,max crosses 0 or Exponential scale with min != 0.

is
interpolation style

Returns true if style change was successful

unsigned longsize ()
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)

truncate the event list after the given time

last_coordinate
last event to include

Remove all events after the given time from this list.

last_coordinate
time in audio samples of the last event to keep
voidtruncate_start (double)

truncate the event list to the given time

overall_length
overall length

Remove all events up to to the given time from this list.

overall_length
overall length in audio samples

∁ ARDOUR:BackendVector

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

@@ -2021,9 +2025,9 @@ Pointer Classes cannot be created in Lua scripts. It always requires a call to C Processornew_luaproc (Session, std::string)

create a new Lua Processor (Plugin)

s
Session Handle
p
Identifier or Name of the Processor

Returns Processor object (may be nil)

NotePtrnew_noteptr (unsigned char, Beats, Beats, unsigned char, unsigned char) - Processornew_plugin (Session, std::string, PluginType, std::string) + Processornew_plugin (Session, std::string, PluginType, std::string)

create a new Plugin Instance

s
Session Handle
id
Plugin Name, ID or URI
type
Plugin Type
preset
name of plugin-preset to load, leave empty "" to not load any preset after instantiation

Returns Processor or nil

- PluginInfonew_plugin_info (std::string, PluginType) + PluginInfonew_plugin_info (std::string, PluginType)

search a Plugin

id
Plugin Name, ID or URI
type
Plugin Type

Returns PluginInfo or nil if not found

Processornil_proc () NotePtrListnote_list (MidiModel) @@ -2048,6 +2052,8 @@ Pointer Classes cannot be created in Lua scripts. It always requires a call to C ...timecode_to_sample (--lua--)

Generic conversion from timecode to audio sample count. (TimecodeType, sample-rate, hh, mm, ss, ff)

voidusleep (unsigned long) + boolwait_for_process_callback (unsigned long, long) +

Delay execution until next prcess cycle starts.

n_cycles
process-cycles to wait for. 0: means wait until next cycle-start, otherwise skip given number of cycles.
timeout_ms
wait at most this many milliseconds

Returns true on success, false if timeout was reached or engine was not running

∁ ARDOUR:LuaAPI:Rubberband

C‡: ARDOUR::LuaAPI::Rubberband

@@ -2210,7 +2216,7 @@ Pointer Classes cannot be created in Lua scripts. It always requires a call to C Methods voidcopy (MidiBuffer) boolempty () - boolpush_back (long, unsigned long, unsigned char*) + boolpush_back (long, EventType, unsigned long, unsigned char*) boolpush_event (Event) 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.

@@ -2530,13 +2536,14 @@ Pointer Classes cannot be created in Lua scripts. It always requires a call to C +
Methods
boolisnil ()
boolwrite_immediate_event (EventType, unsigned long, unsigned char*)

Inherited from ARDOUR:Track

- + - + @@ -2555,7 +2562,7 @@ Pointer Classes cannot be created in Lua scripts. It always requires a call to C
Methods
Regionbounce (InterThreadInfo&)
Regionbounce (InterThreadInfo&, std::string)

bounce track from session start to session end to new region

itt
asynchronous progress report and cancel

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

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

Bounce the given range to a new audio region.

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

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

boolbounceable (Processor, bool)

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

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

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

- + @@ -3198,7 +3205,7 @@ Pointer Classes cannot be created in Lua scripts. It always requires a call to C - +
Methods
boolactive ()
intadd_foldback_send (Route)
intadd_foldback_send (Route, bool)
intadd_processor_by_index (Processor, int, ProcessorStreams, bool)

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

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

Returns 0 on success, non-0 on failure.

booladd_sidechain (Processor)
ARDOUR:ChanCountn_outputs
std::stringname
std::stringpath
ARDOUR.PluginTypetype
ARDOUR.PluginTypetype
std::stringunique_id

∁ ARDOUR:PluginInfoList

@@ -3247,7 +3254,8 @@ Pointer Classes cannot be created in Lua scripts. It always requires a call to C voidset_output_map (unsigned int, ChanMapping) longsignal_latency () boolstrict_io_configured () - PluginTypetype () + PluginTypetype () + boolwrite_immediate_event (EventType, unsigned long, unsigned char*)

Inherited from ARDOUR:Processor

@@ -3289,6 +3297,12 @@ Pointer Classes cannot be created in Lua scripts. It always requires a call to C
Statefulto_stateful ()
StatefulDestructibleto_statefuldestructible ()
+

ℕ ARDOUR.PluginType

+
+ + + +
Methods
std::stringname (PluginType, bool)

↠ ARDOUR:PolarityProcessor

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

is-a: ARDOUR:Processor

@@ -3629,6 +3643,7 @@ Pointer Classes cannot be created in Lua scripts. It always requires a call to C std::stringget_click_sound () boolget_clicking () boolget_conceal_lv1_if_lv2_exists () + boolget_conceal_vst2_if_vst3_exists () boolget_copy_demo_sessions () boolget_create_xrun_marker () FadeShapeget_default_fade_shape () @@ -3699,6 +3714,7 @@ Pointer Classes cannot be created in Lua scripts. It always requires a call to C PFLPositionget_pfl_position () std::stringget_plugin_path_lxvst () std::stringget_plugin_path_vst () + std::stringget_plugin_path_vst3 () boolget_plugins_stop_with_transport () longget_postroll () longget_preroll () @@ -3748,6 +3764,7 @@ Pointer Classes cannot be created in Lua scripts. It always requires a call to C boolget_use_click_emphasis () boolget_use_lxvst () boolget_use_macvst () + boolget_use_master_volume () boolget_use_monitor_bus () boolget_use_osc () boolget_use_plugin_own_gui () @@ -3784,6 +3801,7 @@ Pointer Classes cannot be created in Lua scripts. It always requires a call to C boolset_click_sound (std::string) boolset_clicking (bool) boolset_conceal_lv1_if_lv2_exists (bool) + boolset_conceal_vst2_if_vst3_exists (bool) boolset_copy_demo_sessions (bool) boolset_create_xrun_marker (bool) boolset_default_fade_shape (FadeShape) @@ -3854,6 +3872,7 @@ Pointer Classes cannot be created in Lua scripts. It always requires a call to C boolset_pfl_position (PFLPosition) boolset_plugin_path_lxvst (std::string) boolset_plugin_path_vst (std::string) + boolset_plugin_path_vst3 (std::string) boolset_plugins_stop_with_transport (bool) boolset_postroll (long) boolset_preroll (long) @@ -3903,6 +3922,7 @@ Pointer Classes cannot be created in Lua scripts. It always requires a call to C boolset_use_click_emphasis (bool) boolset_use_lxvst (bool) boolset_use_macvst (bool) + boolset_use_master_volume (bool) boolset_use_monitor_bus (bool) boolset_use_osc (bool) boolset_use_plugin_own_gui (bool) @@ -3940,6 +3960,7 @@ Pointer Classes cannot be created in Lua scripts. It always requires a call to C std::stringclick_sound boolclicking boolconceal_lv1_if_lv2_exists + boolconceal_vst2_if_vst3_exists boolcopy_demo_sessions boolcreate_xrun_marker ARDOUR.FadeShapedefault_fade_shape @@ -4010,6 +4031,7 @@ Pointer Classes cannot be created in Lua scripts. It always requires a call to C ARDOUR.PFLPositionpfl_position std::stringplugin_path_lxvst std::stringplugin_path_vst + std::stringplugin_path_vst3 boolplugins_stop_with_transport longpostroll longpreroll @@ -4059,6 +4081,7 @@ Pointer Classes cannot be created in Lua scripts. It always requires a call to C booluse_click_emphasis booluse_lxvst booluse_macvst + booluse_master_volume booluse_monitor_bus booluse_osc booluse_plugin_own_gui @@ -4368,7 +4391,7 @@ Pointer Classes cannot be created in Lua scripts. It always requires a call to C - + @@ -4666,6 +4689,7 @@ Pointer Classes cannot be created in Lua scripts. It always requires a call to C + @@ -4684,6 +4708,7 @@ Pointer Classes cannot be created in Lua scripts. It always requires a call to C + @@ -4753,8 +4778,16 @@ Pointer Classes cannot be created in Lua scripts. It always requires a call to C + + + + + + + + @@ -5425,7 +5458,7 @@ Pointer Classes cannot be created in Lua scripts. It always requires a call to C - + @@ -5472,9 +5505,9 @@ Pointer Classes cannot be created in Lua scripts. It always requires a call to C

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

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

Methods
boolactive ()
intadd_foldback_send (Route)
intadd_foldback_send (Route, bool)
intadd_processor_by_index (Processor, int, ProcessorStreams, bool)

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

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

Returns 0 on success, non-0 on failure.

booladd_sidechain (Processor)
voidabort_reversible_command ()

abort an open undo command This must only be called after begin_reversible_command ()

boolactively_recording ()
doubleactual_speed ()
voidadd_command (Command)
voidadd_internal_send (Route, Processor, Route)
voidadd_internal_sends (Route, Placement, RouteListPtr)
longcurrent_start_sample ()
voiddisable_record (bool, bool)
AudioEngineengine ()
doubleengine_speed ()
boolexport_track_state (RouteListPtr, std::string)
unsigned intget_block_size ()
boolget_play_loop ()
doubletimecode_frames_per_second ()
...timecode_to_sample_lua (--lua--)
booltransport_rolling ()

Returns true if the the transport is actively (audible) rolling. playback speed is not zero, and count-in as well as latency-preroll is complete, and _transport_sample changes every process cycle.

longtransport_sample ()
doubletransport_speed ()
booltransport_state_rolling ()

Returns true if the transport state (TFSM) is rolling. Note: the transport may not yet move if pre-roll or count-in in ongoing.

booltransport_stopped ()

Returns true if the transport state (TFSM) is stopped

booltransport_stopped_or_stopping ()

Returns true if the transport state (TFSM) is stopped or stopping

booltransport_will_roll_forwards ()
StringListunknown_processors ()
VCAManagervca_manager ()
longworst_input_latency ()
Methods
MeterSectionadd_meter (Meter, BBT_TIME, long, PositionLockStyle)
TempoSectionadd_tempo (Tempo, double, long, PositionLockStyle)
BBT_TIMEbbt_at_sample (long)
BBT_TIMEbbt_at_sample (long)

Returns the BBT time corresponding to the supplied sample position.

sample
the position in audio samples.

Returns the BBT time at the sample position .

doubleexact_beat_at_sample (long, int)
doubleexact_qn_at_sample (long, int)
- + - + @@ -5494,7 +5527,7 @@ Pointer Classes cannot be created in Lua scripts. It always requires a call to C
Methods
Regionbounce (InterThreadInfo&)
Regionbounce (InterThreadInfo&, std::string)

bounce track from session start to session end to new region

itt
asynchronous progress report and cancel

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

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

Bounce the given range to a new audio region.

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

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

boolbounceable (Processor, bool)

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

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

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

- + @@ -6122,9 +6155,9 @@ Pointer Classes cannot be created in Lua scripts. It always requires a call to C
Methods
boolactive ()
intadd_foldback_send (Route)
intadd_foldback_send (Route, bool)
intadd_processor_by_index (Processor, int, ProcessorStreams, bool)

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

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

Returns 0 on success, non-0 on failure.

booladd_sidechain (Processor)
- - - + + +
Methods
longend_sample ()
longlength ()
longstart ()
longend_sample ()
longlength ()
longstart ()

Inherited from ARDOUR:AudioRangeList

@@ -6214,6 +6247,8 @@ Pointer Classes cannot be created in Lua scripts. It always requires a call to C + + @@ -6248,6 +6283,7 @@ Pointer Classes cannot be created in Lua scripts. It always requires a call to C + @@ -6265,6 +6301,7 @@ Pointer Classes cannot be created in Lua scripts. It always requires a call to C + @@ -6283,7 +6320,7 @@ Pointer Classes cannot be created in Lua scripts. It always requires a call to C - + @@ -6316,6 +6353,8 @@ Pointer Classes cannot be created in Lua scripts. It always requires a call to C + + @@ -6350,6 +6389,7 @@ Pointer Classes cannot be created in Lua scripts. It always requires a call to C + @@ -6367,6 +6407,7 @@ Pointer Classes cannot be created in Lua scripts. It always requires a call to C + @@ -6385,7 +6426,7 @@ Pointer Classes cannot be created in Lua scripts. It always requires a call to C - + @@ -6419,6 +6460,8 @@ Pointer Classes cannot be created in Lua scripts. It always requires a call to C + + @@ -6453,6 +6496,7 @@ Pointer Classes cannot be created in Lua scripts. It always requires a call to C + @@ -6470,6 +6514,7 @@ Pointer Classes cannot be created in Lua scripts. It always requires a call to C + @@ -6488,7 +6533,7 @@ Pointer Classes cannot be created in Lua scripts. It always requires a call to C - +
boolget_link_region_and_track_selection ()
unsigned intget_lock_gui_after_seconds ()
unsigned intget_max_inline_controls ()
intget_max_plugin_chart ()
intget_max_plugin_recent ()
floatget_meter_hold ()
MeterLineUpget_meter_line_up_din ()
MeterLineUpget_meter_line_up_level ()
boolget_show_secondary_clock ()
boolget_show_snapped_cursor ()
boolget_show_toolbar_latency ()
boolget_show_toolbar_monitor_info ()
boolget_show_toolbar_monitoring ()
boolget_show_toolbar_recpunch ()
boolget_show_toolbar_selclock ()
boolget_sound_midi_notes ()
std::stringget_stripable_color_palette ()
boolget_super_rapid_clock_update ()
intget_time_axis_name_ellipsize_mode ()
floatget_timeline_item_gradient_depth ()
boolget_transients_follow_front ()
std::stringget_ui_font_family ()
doubleget_waveform_clip_level ()
floatget_waveform_gradient_depth ()
WaveformScaleget_waveform_scale ()
--MISSING (ARDOUR::WaveformShape)--get_waveform_shape ()
WaveformShapeget_waveform_shape ()
boolget_widget_prelight ()
boolset_action_table_columns (unsigned int)
boolset_all_floating_windows_are_dialogs (bool)
boolset_link_region_and_track_selection (bool)
boolset_lock_gui_after_seconds (unsigned int)
boolset_max_inline_controls (unsigned int)
boolset_max_plugin_chart (int)
boolset_max_plugin_recent (int)
boolset_meter_hold (float)
boolset_meter_line_up_din (MeterLineUp)
boolset_meter_line_up_level (MeterLineUp)
boolset_show_secondary_clock (bool)
boolset_show_snapped_cursor (bool)
boolset_show_toolbar_latency (bool)
boolset_show_toolbar_monitor_info (bool)
boolset_show_toolbar_monitoring (bool)
boolset_show_toolbar_recpunch (bool)
boolset_show_toolbar_selclock (bool)
boolset_sound_midi_notes (bool)
boolset_stripable_color_palette (std::string)
boolset_super_rapid_clock_update (bool)
boolset_time_axis_name_ellipsize_mode (int)
boolset_timeline_item_gradient_depth (float)
boolset_transients_follow_front (bool)
boolset_ui_font_family (std::string)
boolset_waveform_clip_level (double)
boolset_waveform_gradient_depth (float)
boolset_waveform_scale (WaveformScale)
boolset_waveform_shape (--MISSING (ARDOUR::WaveformShape)--)
boolset_waveform_shape (WaveformShape)
boolset_widget_prelight (bool)
Properties
unsigned intaction_table_columns
boollink_region_and_track_selection
unsigned intlock_gui_after_seconds
unsigned intmax_inline_controls
intmax_plugin_chart
intmax_plugin_recent
floatmeter_hold
ARDOUR.MeterLineUpmeter_line_up_din
ARDOUR.MeterLineUpmeter_line_up_level
boolshow_secondary_clock
boolshow_snapped_cursor
boolshow_toolbar_latency
boolshow_toolbar_monitor_info
boolshow_toolbar_monitoring
boolshow_toolbar_recpunch
boolshow_toolbar_selclock
boolsound_midi_notes
std::stringstripable_color_palette
boolsuper_rapid_clock_update
inttime_axis_name_ellipsize_mode
floattimeline_item_gradient_depth
booltransients_follow_front
std::stringui_font_family
doublewaveform_clip_level
floatwaveform_gradient_depth
ARDOUR.WaveformScalewaveform_scale
--MISSING (ARDOUR::WaveformShape)--waveform_shape
ARDOUR.WaveformShapewaveform_shape
boolwidget_prelight

⋯ C:ByteArray

@@ -6835,28 +6880,32 @@ Pointer Classes cannot be created in Lua scripts. It always requires a call to C - + - + + - + + + - + - + + - + - +
Methods
voidadd (double, double, bool, bool)

add automation events

when
absolute time in samples
value
parameter value
with_guards
if true, add guard-points
with_initial
if true, add an initial point if the list is empty

Add an event to this list.

This method is intended to write automation in realtime. If the transport is stopped, guard-points will be added regardless of parameter with_guards.

when
absolute time in samples
value
parameter value
with_guards
if true, add guard-points
with_initial
if true, add an initial point if the list is empty
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

Remove all events in the given time range from this list.

start
start of range (inclusive) in audio samples
end
end of range (inclusive) in audio samples
voidclear_list ()
booleditor_add (double, double, bool)

Add an event to this list.

This method is intended for making manual changes from the GUI. An event will only be created if no other event exists at the given time.

when
absolute time in samples
value
parameter value
with_guards
if true, add guard-points

Returns true if an event was added.

doubleeval (double)

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

where
absolute time in samples

Returns parameter value

Queries the event value at the given time (takes a read-lock, not safe while writing automation).

where
absolute time in samples

Returns parameter value

EventListevents ()

Returns the list of events

boolin_write_pass ()

Returns true if transport is running and this list is in write mode

InterpolationStyleinterpolation ()

query interpolation style of the automation data

Returns Interpolation Style

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

Realtime safe version of eval(). This may fail if a read-lock cannot be taken.

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

Returns parameter value

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

Sets the interpolation style of the automation data.

This will fail when asking for Logarithmic scale and min,max crosses 0 or Exponential scale with min != 0.

is
interpolation style

Returns true if style change was successful

unsigned longsize ()
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)

truncate the event list after the given time

last_coordinate
last event to include

Remove all events after the given time from this list.

last_coordinate
time in audio samples of the last event to keep
voidtruncate_start (double)

truncate the event list to the given time

overall_length
overall length

Remove all events up to to the given time from this list.

overall_length
overall length in audio samples

↠ Evoral:ControlSet

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

@@ -7532,6 +7581,12 @@ Pointer Classes cannot be created in Lua scripts. It always requires a call to C
  • Evoral.InterpolationStyle.Linear
  • Evoral.InterpolationStyle.Curved
    • +

    ∈ Evoral.EventType

    +

    ∈ Vamp.Plugin.InputDomain

    ∈ ARDOUR.PresentationInfo.Flag

    +

    ∈ ARDOUR.WaveformShape

    +

    ∈ ARDOUR.MeterLineUp

    - + -
    Ardour 6.0  -  Sat, 23 May 2020 02:12:46 +0200
    +
    Ardour 6.4  -  Sat, 21 Nov 2020 19:19:48 +0100