X-Git-Url: http://shamusworld.gotdns.org/cgi-bin/gitweb.cgi?a=blobdiff_plain;f=include%2Fclass-reference.html;h=0a3c47719ced3de9d0afdc9125a8387dbd38321c;hb=500fea9a1bb2e8f8b815b11ed26c88e32eb7e139;hp=a95712e11147be83b8147f27452fbf6c9bf684fe;hpb=5b037132435df0c772dd5a0da06e31c019907570;p=ardour-manual diff --git a/include/class-reference.html b/include/class-reference.html index a95712e..0a3c477 100644 --- a/include/class-reference.html +++ b/include/class-reference.html @@ -341,6 +341,7 @@ Pointer Classes cannot be created in Lua scripts. It always requires a call to C
C‡: boost::shared_ptr< ARDOUR::AudioPlaylist >, boost::weak_ptr< ARDOUR::AudioPlaylist >
@@ -386,6 +387,7 @@ Pointer Classes cannot be created in Lua scripts. It always requires a call to CC‡: std::map<std::string, ARDOUR::PortManager::DPM >
+ +Constructor | ||
---|---|---|
ℂ | ARDOUR.AudioPortMeters () | |
Methods | ||
LuaTable | add (std::string, ARDOUR::PortManager::DPM ) | |
... | at (--lua--) | |
void | clear () | |
unsigned long | count (std::string) | |
bool | empty () | |
LuaIter | iter () | |
unsigned long | size () | |
LuaTable | table () |
C‡: ARDOUR::AudioRange
@@ -502,6 +520,7 @@ Pointer Classes cannot be created in Lua scripts. It always requires a call to CMethods | |||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Region | bounce (InterThreadInfo&) | ||||||||||||||||||||||||||||||||||||||||
Region | bounce (InterThreadInfo&, std::string) | ||||||||||||||||||||||||||||||||||||||||
bounce track from session start to session end to new region
Returns a new audio region (or nil in case of error) | |||||||||||||||||||||||||||||||||||||||||
Region | bounce_range (long, long, InterThreadInfo&, Processor, bool) | ||||||||||||||||||||||||||||||||||||||||
Region | bounce_range (long, long, InterThreadInfo&, Processor, bool, std::string) | ||||||||||||||||||||||||||||||||||||||||
Bounce the given range to a new audio region.
Returns a new audio region (or nil in case of error) | |||||||||||||||||||||||||||||||||||||||||
bool | bounceable (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.
Returns true if the track can be bounced, or false otherwise. |
Methods | ||
---|---|---|
bool | active () | |
int | add_foldback_send (Route) | |
int | add_foldback_send (Route, bool) | |
int | add_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.
Returns 0 on success, non-0 on failure. | ||
bool | add_sidechain (Processor) |
Methods | ||
---|---|---|
void | add (double, double, bool, bool) | |
add automation events
| ||
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.
| ||
void | clear (double, double) | |
remove all automation events between the given time range
| ||
Remove all events in the given time range from this list.
| ||
void | clear_list () | |
bool | editor_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.
Returns true if an event was added. | ||
double | eval (double) | |
query value at given time (takes a read-lock, not safe while writing automation)
Returns parameter value | ||
Queries the event value at the given time (takes a read-lock, not safe while writing automation).
Returns parameter value | ||
EventList | events () | |
Returns the list of events | ||
bool | in_write_pass () | |
Returns true if transport is running and this list is in write mode | ||
InterpolationStyle | interpolation () | |
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
Returns parameter value | ||
Realtime safe version of eval(). This may fail if a read-lock cannot be taken.
Returns parameter value | ||
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 | ||
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.
Returns true if style change was successful | ||
unsigned long | size () | |
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) | |
truncate the event list after the given time
| ||
Remove all events after the given time from this list.
| ||
void | truncate_start (double) | |
truncate the event list to the given time
| ||
Remove all events up to to the given time from this list.
| ||
Cast | ||
AutomationList | to_automationlist () |
C‡: std::vector<ARDOUR::AudioBackendInfo const* >
@@ -1060,7 +1086,7 @@ Pointer Classes cannot be created in Lua scripts. It always requires a call to CInstantiate Biquad Filter
setup filter, compute coefficients
setup filter, compute coefficients
setup filter, set coefficients directly
process current data in buffer
query
Returns signal power at given bin (in dBFS)
query
Returns signal power at given bin (in dBFS)
C‡: boost::shared_ptr< ARDOUR::InternalReturn >, boost::weak_ptr< ARDOUR::InternalReturn >
is-a: ARDOUR:Return
-A mixer strip element (Processor) with 1 or 2 IO elements.
A mixer strip element - plugin, send, meter, etc
Methods | |||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
bool | isnil () | ||||||||||||||||||||||||||||||||||||||||
List all installed plugins | |||||||||||||||||||||||||||||||||||||||||
long | monotonic_time () | ||||||||||||||||||||||||||||||||||||||||
Processor | new_luaproc (Session, std::string) | ||||||||||||||||||||||||||||||||||||||||
create a new Lua Processor (Plugin)
Returns Processor object (may be nil) | |||||||||||||||||||||||||||||||||||||||||
create a new Lua Processor (Plugin)
Returns Processor object (may be nil) | |||||||||||||||||||||||||||||||||||||||||
NotePtr | new_noteptr (unsigned char, Beats, Beats, unsigned char, unsigned char) | ||||||||||||||||||||||||||||||||||||||||
Processor | new_plugin (Session, std::string, PluginType, std::string) | ||||||||||||||||||||||||||||||||||||||||
create a new Plugin Instance
Returns Processor or nil | |||||||||||||||||||||||||||||||||||||||||
PluginInfo | new_plugin_info (std::string, PluginType) | ||||||||||||||||||||||||||||||||||||||||
search a Plugin
Returns PluginInfo or nil if not found | |||||||||||||||||||||||||||||||||||||||||
Processor | new_plugin (Session, std::string, PluginType, std::string) | ||||||||||||||||||||||||||||||||||||||||
create a new Plugin Instance
Returns Processor or nil | |||||||||||||||||||||||||||||||||||||||||
PluginInfo | new_plugin_info (std::string, PluginType) | ||||||||||||||||||||||||||||||||||||||||
search a Plugin
Returns PluginInfo or nil if not found | |||||||||||||||||||||||||||||||||||||||||
Processor | nil_proc () | ||||||||||||||||||||||||||||||||||||||||
NotePtrList | note_list (MidiModel) | ||||||||||||||||||||||||||||||||||||||||
std::string | path_get_basename (std::string) | ||||||||||||||||||||||||||||||||||||||||
... | plugin_automation (--lua--) | ||||||||||||||||||||||||||||||||||||||||
A convenience function to get a Automation Lists and ParamaterDescriptor for a given plugin control. This is equivalent to the following lua code function (processor, param_id) local plugininsert = processor:to_insert () @@ -2041,6 +2069,8 @@ Pointer Classes cannot be created in Lua scripts. It always requires a call to C |
C‡: ARDOUR::LuaAPI::Rubberband
@@ -2149,6 +2181,22 @@ Pointer Classes cannot be created in Lua scripts. It always requires a call to CC‡: std::map<std::string, ARDOUR::PortManager::MPM >
+ +Constructor | ||
---|---|---|
ℂ | ARDOUR.MIDIPortMeters () | |
Methods | ||
LuaTable | add (std::string, ARDOUR::PortManager::MPM ) | |
... | at (--lua--) | |
void | clear () | |
unsigned long | count (std::string) | |
bool | empty () | |
LuaIter | iter () | |
unsigned long | size () | |
LuaTable | table () |
C‡: ARDOUR::Meter
@@ -2210,7 +2258,7 @@ Pointer Classes cannot be created in Lua scripts. It always requires a call to CReallocate 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.
Methods | ||
---|---|---|
bool | isnil () | |
bool | write_immediate_event (EventType, unsigned long, unsigned char*) |
Methods | ||
---|---|---|
Region | bounce (InterThreadInfo&) | |
Region | bounce (InterThreadInfo&, std::string) | |
bounce track from session start to session end to new region
Returns a new audio region (or nil in case of error) | ||
Region | bounce_range (long, long, InterThreadInfo&, Processor, bool) | |
Region | bounce_range (long, long, InterThreadInfo&, Processor, bool, std::string) | |
Bounce the given range to a new audio region.
Returns a new audio region (or nil in case of error) | ||
bool | bounceable (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.
Returns true if the track can be bounced, or false otherwise. |
Methods | ||
---|---|---|
bool | active () | |
int | add_foldback_send (Route) | |
int | add_foldback_send (Route, bool) | |
int | add_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.
Returns 0 on success, non-0 on failure. | ||
bool | add_sidechain (Processor) | |
Methods | ||
std::string | midi_note_name (unsigned char, bool) | |
Data Members | ||
unsigned int | display_priority | |
higher is more important http://lv2plug.in/ns/ext/port-props#displayPriority | ||
bool | enumeration | |
bool | inline_ctrl | |
bool | integer_step | |
std::string | label | |
float | largestep | |
std::string | print_fmt | |
format string for pretty printing | ||
float | smallstep | |
bool | sr_dependent | |
float | step |
RegionListPtr | regions_with_end_within (Range) | |
RegionListPtr | regions_with_start_within (Range) | |
void | remove_region (Region) | |
bool | set_name (std::string) | |
bool | shared () | |
void | split_region (Region, MusicSample) | |
Region | top_region_at (long) | |
ARDOUR:ChanCount | n_outputs | |
std::string | name | |
std::string | path | |
ARDOUR.PluginType | type | |
ARDOUR.PluginType | type | |
std::string | unique_id |
Stateful | to_stateful () | |
StatefulDestructible | to_statefuldestructible () |
Methods | ||
---|---|---|
std::string | name (PluginType, bool) |
C‡: boost::shared_ptr< ARDOUR::PolarityProcessor >, boost::weak_ptr< ARDOUR::PolarityProcessor >
is-a: ARDOUR:Processor
@@ -3414,6 +3487,7 @@ Pointer Classes cannot be created in Lua scripts. It always requires a call to CC‡: boost::shared_ptr< ARDOUR::PortSet >, boost::weak_ptr< ARDOUR::PortSet >
@@ -3629,6 +3703,7 @@ Pointer Classes cannot be created in Lua scripts. It always requires a call to CMethods | ||
---|---|---|
bool | active () | |
int | add_foldback_send (Route) | |
int | add_foldback_send (Route, bool) | |
int | add_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.
Returns 0 on success, non-0 on failure. | ||
bool | add_sidechain (Processor) | |
void | abort_reversible_command () | |
abort an open undo command This must only be called after begin_reversible_command () | ||
bool | actively_recording () | |
double | actual_speed () | |
void | add_command (Command) | |
void | add_internal_send (Route, Processor, Route) | |
void | add_internal_sends (Route, Placement, RouteListPtr) | |
long | current_start_sample () | |
void | disable_record (bool, bool) | |
AudioEngine | engine () | |
double | engine_speed () | |
bool | export_track_state (RouteListPtr, std::string) | |
unsigned int | get_block_size () | |
bool | get_play_loop () | |
RouteList | new_audio_route (int, int, RouteGroup, unsigned int, std::string, Flag, unsigned int) | |
AudioTrackList | new_audio_track (int, int, RouteGroup, unsigned int, std::string, unsigned int, TrackMode, bool) | |
RouteList | new_midi_route (RouteGroup, unsigned int, std::string, bool, PluginInfo, PresetRecord, Flag, unsigned int) | |
MidiTrackList | new_midi_track (ChanCount, ChanCount, bool, PluginInfo, PresetRecord, RouteGroup, unsigned int, std::string, unsigned int, TrackMode) | |
MidiTrackList | new_midi_track (ChanCount, ChanCount, bool, PluginInfo, PresetRecord, RouteGroup, unsigned int, std::string, unsigned int, TrackMode, bool) | |
RouteList | new_route_from_template (unsigned int, unsigned int, std::string, std::string, PlaylistDisposition) | |
RouteGroup | new_route_group (std::string) | |
long | nominal_sample_rate () | |
double | timecode_frames_per_second () | |
... | timecode_to_sample_lua (--lua--) | |
bool | transport_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. | ||
long | transport_sample () | |
double | transport_speed () | |
bool | transport_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. | ||
bool | transport_stopped () | |
Returns true if the transport state (TFSM) is stopped | ||
bool | transport_stopped_or_stopping () | |
Returns true if the transport state (TFSM) is stopped or stopping | ||
bool | transport_will_roll_forwards () | |
StringList | unknown_processors () | |
VCAManager | vca_manager () | |
long | worst_input_latency () | |
Methods | ||
std::string | ancestor_name () | |
bool | can_be_analysed () | |
XrunPositions | captured_xruns () | |
bool | empty () | |
bool | has_been_analysed () | |
bool | isnil () | |
Methods | ||
MeterSection | add_meter (Meter, BBT_TIME, long, PositionLockStyle) | |
TempoSection | add_tempo (Tempo, double, long, PositionLockStyle) | |
BBT_TIME | bbt_at_sample (long) | |
BBT_TIME | bbt_at_sample (long) | |
Returns the BBT time corresponding to the supplied sample position.
Returns the BBT time at the sample position . | ||
double | exact_beat_at_sample (long, int) | |
double | exact_qn_at_sample (long, int) |
Methods | ||
---|---|---|
Region | bounce (InterThreadInfo&) | |
Region | bounce (InterThreadInfo&, std::string) | |
bounce track from session start to session end to new region
Returns a new audio region (or nil in case of error) | ||
Region | bounce_range (long, long, InterThreadInfo&, Processor, bool) | |
Region | bounce_range (long, long, InterThreadInfo&, Processor, bool, std::string) | |
Bounce the given range to a new audio region.
Returns a new audio region (or nil in case of error) | ||
bool | bounceable (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.
Returns true if the track can be bounced, or false otherwise. |
Methods | ||
---|---|---|
bool | active () | |
int | add_foldback_send (Route) | |
int | add_foldback_send (Route, bool) | |
int | add_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.
Returns 0 on success, non-0 on failure. | ||
bool | add_sidechain (Processor) | |
unsigned long | size () | |
LuaTable | table () |
C‡: std::vector<long >
+ +Constructor | ||
---|---|---|
ℂ | ARDOUR.XrunPositions () | |
ℂ | ARDOUR.XrunPositions () | |
Methods | ||
LuaTable | add (LuaTable {long}) | |
long | at (unsigned long) | |
void | clear () | |
bool | empty () | |
LuaIter | iter () | |
void | push_back (long) | |
unsigned long | size () | |
LuaTable | table () | |
... | to_array (--lua--) |
TrackViewList | axis_views_from_routes (RouteListPtr) | |
void | center_screen (long) | |
void | clear_playlist (Playlist) | |
void | clear_playlists (TimeAxisView) | |
void | clear_playlists (RouteUI) | |
void | consider_auditioning (Region) | |
Possibly start the audition of a region. If r is 0, or not an AudioRegion any current audition is cancelled. If we are currently auditioning r , the audition will be cancelled. Otherwise an audition of r will start.
| ||
void | copy_playlists (TimeAxisView) | |
void | copy_playlists (RouteUI) | |
MouseMode | current_mouse_mode () | |
Returns The current mouse mode (gain, object, range, timefx etc.) (defined in editing_syms.h) | ||
long | current_page_samples () | |
void | maximise_editing_space () | |
void | maybe_locate_with_edit_preroll (long) | |
void | mouse_add_new_marker (long, bool) | |
void | new_playlists (TimeAxisView) | |
void | new_playlists (RouteUI) | |
void | new_region_from_selection () | |
void | override_visible_track_count () | |
long | pixel_to_sample (double) |
Methods | ||
---|---|---|
long | end_sample () | |
long | length () | |
long | start () | |
long | end_sample () | |
long | length () | |
long | start () |
bool | get_link_region_and_track_selection () | |
unsigned int | get_lock_gui_after_seconds () | |
unsigned int | get_max_inline_controls () | |
int | get_max_plugin_chart () | |
int | get_max_plugin_recent () | |
float | get_meter_hold () | |
MeterLineUp | get_meter_line_up_din () | |
MeterLineUp | get_meter_line_up_level () | |
ClockDeltaMode | get_primary_clock_delta_mode () | |
int | get_recent_session_sort () | |
bool | get_rubberbanding_snaps_to_grid () | |
unsigned int | get_ruler_granularity () | |
bool | get_rulers_follow_grid () | |
bool | get_save_export_analysis_image () | |
bool | get_save_export_mixer_screenshot () | |
bool | get_show_plugin_scan_window () | |
bool | get_show_region_gain () | |
bool | get_show_region_name () | |
bool | get_show_region_xrun_markers () | |
bool | get_show_secondary_clock () | |
bool | get_show_snapped_cursor () | |
bool | get_show_toolbar_latency () | |
bool | get_show_toolbar_monitor_info () | |
bool | get_show_toolbar_monitoring () | |
bool | get_show_toolbar_recpunch () | |
bool | get_show_toolbar_selclock () | |
bool | get_sound_midi_notes () | |
std::string | get_stripable_color_palette () | |
bool | get_super_rapid_clock_update () | |
int | get_time_axis_name_ellipsize_mode () | |
float | get_timeline_item_gradient_depth () | |
bool | get_transients_follow_front () | |
std::string | get_ui_font_family () | |
double | get_waveform_clip_level () | |
float | get_waveform_gradient_depth () | |
WaveformScale | get_waveform_scale () | |
--MISSING (ARDOUR::WaveformShape)-- | get_waveform_shape () | |
WaveformShape | get_waveform_shape () | |
bool | get_widget_prelight () | |
bool | set_action_table_columns (unsigned int) | |
bool | set_all_floating_windows_are_dialogs (bool) | |
bool | set_link_region_and_track_selection (bool) | |
bool | set_lock_gui_after_seconds (unsigned int) | |
bool | set_max_inline_controls (unsigned int) | |
bool | set_max_plugin_chart (int) | |
bool | set_max_plugin_recent (int) | |
bool | set_meter_hold (float) | |
bool | set_meter_line_up_din (MeterLineUp) | |
bool | set_meter_line_up_level (MeterLineUp) | |
bool | set_primary_clock_delta_mode (ClockDeltaMode) | |
bool | set_recent_session_sort (int) | |
bool | set_rubberbanding_snaps_to_grid (bool) | |
bool | set_ruler_granularity (unsigned int) | |
bool | set_rulers_follow_grid (bool) | |
bool | set_save_export_analysis_image (bool) | |
bool | set_save_export_mixer_screenshot (bool) | |
bool | set_show_plugin_scan_window (bool) | |
bool | set_show_region_gain (bool) | |
bool | set_show_region_name (bool) | |
bool | set_show_region_xrun_markers (bool) | |
bool | set_show_secondary_clock (bool) | |
bool | set_show_snapped_cursor (bool) | |
bool | set_show_toolbar_latency (bool) | |
bool | set_show_toolbar_monitor_info (bool) | |
bool | set_show_toolbar_monitoring (bool) | |
bool | set_show_toolbar_recpunch (bool) | |
bool | set_show_toolbar_selclock (bool) | |
bool | set_sound_midi_notes (bool) | |
bool | set_stripable_color_palette (std::string) | |
bool | set_super_rapid_clock_update (bool) | |
bool | set_time_axis_name_ellipsize_mode (int) | |
bool | set_timeline_item_gradient_depth (float) | |
bool | set_transients_follow_front (bool) | |
bool | set_ui_font_family (std::string) | |
bool | set_waveform_clip_level (double) | |
bool | set_waveform_gradient_depth (float) | |
bool | set_waveform_scale (WaveformScale) | |
bool | set_waveform_shape (--MISSING (ARDOUR::WaveformShape)--) | |
bool | set_waveform_shape (WaveformShape) | |
bool | set_widget_prelight (bool) | |
Properties | ||
---|---|---|
unsigned int | action_table_columns | |
bool | link_region_and_track_selection | |
unsigned int | lock_gui_after_seconds | |
unsigned int | max_inline_controls | |
int | max_plugin_chart | |
int | max_plugin_recent | |
float | meter_hold | |
ARDOUR.MeterLineUp | meter_line_up_din | |
ARDOUR.MeterLineUp | meter_line_up_level | |
ARDOUR.ClockDeltaMode | primary_clock_delta_mode | |
int | recent_session_sort | |
bool | rubberbanding_snaps_to_grid | |
unsigned int | ruler_granularity | |
bool | rulers_follow_grid | |
bool | save_export_analysis_image | |
bool | save_export_mixer_screenshot | |
bool | show_plugin_scan_window | |
bool | show_region_gain | |
bool | show_region_name | |
bool | show_region_xrun_markers | |
bool | show_secondary_clock | |
bool | show_snapped_cursor | |
bool | show_toolbar_latency | |
bool | show_toolbar_monitor_info | |
bool | show_toolbar_monitoring | |
bool | show_toolbar_recpunch | |
bool | show_toolbar_selclock | |
bool | sound_midi_notes | |
std::string | stripable_color_palette | |
bool | super_rapid_clock_update | |
int | time_axis_name_ellipsize_mode | |
float | timeline_item_gradient_depth | |
bool | transients_follow_front | |
std::string | ui_font_family | |
double | waveform_clip_level | |
float | waveform_gradient_depth | |
ARDOUR.WaveformScale | waveform_scale | |
--MISSING (ARDOUR::WaveformShape)-- | waveform_shape | |
ARDOUR.WaveformShape | waveform_shape | |
bool | widget_prelight |
Methods | ||
---|---|---|
void | add (double, double, bool, bool) | |
add automation events
| ||
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.
| ||
void | clear (double, double) | |
remove all automation events between the given time range
| ||
Remove all events in the given time range from this list.
| ||
void | clear_list () | |
bool | editor_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.
Returns true if an event was added. | ||
double | eval (double) | |
query value at given time (takes a read-lock, not safe while writing automation)
Returns parameter value | ||
Queries the event value at the given time (takes a read-lock, not safe while writing automation).
Returns parameter value | ||
EventList | events () | |
Returns the list of events | ||
bool | in_write_pass () | |
Returns true if transport is running and this list is in write mode | ||
InterpolationStyle | interpolation () | |
query interpolation style of the automation data Returns Interpolation Style | ||
bool | isnil () | |
LuaTable(double, ...) | rt_safe_eval (double, bool&) | |
realtime safe version of eval, may fail if read-lock cannot be taken
Returns parameter value | ||
Realtime safe version of eval(). This may fail if a read-lock cannot be taken.
Returns parameter value | ||
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 | ||
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.
Returns true if style change was successful | ||
unsigned long | size () | |
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) | |
truncate the event list after the given time
| ||
Remove all events after the given time from this list.
| ||
void | truncate_start (double) | |
truncate the event list to the given time
| ||
Remove all events up to to the given time from this list.
| ||
Cast | ||
AutomationList | to_automationlist () |
C‡: boost::shared_ptr< Evoral::ControlSet >, boost::weak_ptr< Evoral::ControlSet >
@@ -7532,6 +7672,12 @@ Pointer Classes cannot be created in Lua scripts. It always requires a call to C