X-Git-Url: http://shamusworld.gotdns.org/cgi-bin/gitweb.cgi?a=blobdiff_plain;f=include%2Fclass-reference.html;h=0a3c47719ced3de9d0afdc9125a8387dbd38321c;hb=0be5223f840432647ebaf541d904887ee0d74830;hp=75ff7d856f552f6f0dc08a0ac3f72de3f38d2f5d;hpb=94085e0ed8465b25f39c69f35c55544a9f3286d8;p=ardour-manual diff --git a/include/class-reference.html b/include/class-reference.html index 75ff7d8..0a3c477 100644 --- a/include/class-reference.html +++ b/include/class-reference.html @@ -165,6 +165,7 @@ Pointer Classes cannot be created in Lua scripts. It always requires a call to C
Returns true if this port is connected to o, otherwise false.
Returns flags
Returns Port short name
C‡: boost::shared_ptr< ARDOUR::AudioPlaylist >, boost::weak_ptr< ARDOUR::AudioPlaylist >
@@ -380,6 +387,7 @@ Pointer Classes cannot be created in Lua scripts. It always requires a call to CReturns true if this port is connected to o, otherwise false.
Returns flags
Returns Port short name
C‡: 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
@@ -494,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, 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) | |
reset plugin-insert configuration to default, disable customizations. This is equivalent to calling customize_plugin_insert (proc, 0, unused)
Returns true if successful | ||
void | set_active (bool, void*) | |
void | set_comment (std::string, void*) | |
void | set_meter_point (MeterPoint, bool) | |
void | set_meter_point (MeterPoint) | |
bool | set_strict_io (bool) | |
long | signal_latency () | |
bool | soloed () |
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* >
@@ -1051,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 () | ||||||||||||||||||||||||||||||||||||||||
DiskReader | to_diskreader () | ||||||||||||||||||||||||||||||||||||||||
DiskWriter | to_diskwriter () | ||||||||||||||||||||||||||||||||||||||||
PluginInsert | to_insert () | ||||||||||||||||||||||||||||||||||||||||
InternalSend | to_internalsend () | ||||||||||||||||||||||||||||||||||||||||
IOProcessor | to_ioprocessor () | ||||||||||||||||||||||||||||||||||||||||
Latent | to_latent () | ||||||||||||||||||||||||||||||||||||||||
PeakMeter | to_meter () |
Methods | ||
---|---|---|
bool | allow_feedback () | |
std::string | display_name () | |
bool | feeds (Route) | |
bool | isnil () | |
void | set_allow_feedback (bool) | |
bool | set_name (std::string) | |
Route | source_route () | |
Route | target_route () |
Methods | ||
---|---|---|
GainControl | gain_control () | |
long | get_delay_in () | |
long | get_delay_out () | |
bool | is_foldback () | |
Cast | ||
InternalSend | to_internalsend () |
bool | active () | ||||||||||||||||||||||||||||||||||||||||
long | capture_offset () | ||||||||||||||||||||||||||||||||||||||||
void | deactivate () | ||||||||||||||||||||||||||||||||||||||||
std::string | display_name () | ||||||||||||||||||||||||||||||||||||||||
bool | display_to_user () | ||||||||||||||||||||||||||||||||||||||||
long | input_latency () | ||||||||||||||||||||||||||||||||||||||||
ChanCount | input_streams () | ||||||||||||||||||||||||||||||||||||||||
DiskReader | to_diskreader () | ||||||||||||||||||||||||||||||||||||||||
DiskWriter | to_diskwriter () | ||||||||||||||||||||||||||||||||||||||||
PluginInsert | to_insert () | ||||||||||||||||||||||||||||||||||||||||
InternalSend | to_internalsend () | ||||||||||||||||||||||||||||||||||||||||
IOProcessor | to_ioprocessor () | ||||||||||||||||||||||||||||||||||||||||
Latent | to_latent () | ||||||||||||||||||||||||||||||||||||||||
PeakMeter | to_meter () | ||||||||||||||||||||||||||||||||||||||||
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 () @@ -2014,6 +2069,8 @@ Pointer Classes cannot be created in Lua scripts. It always requires a call to C |
C‡: ARDOUR::LuaAPI::Rubberband
@@ -2122,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
@@ -2183,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.
Returns true if this port is connected to o, otherwise false.
Returns flags
Returns Port short name
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, 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) | |
reset plugin-insert configuration to default, disable customizations. This is equivalent to calling customize_plugin_insert (proc, 0, unused)
Returns true if successful | ||
void | set_active (bool, void*) | |
void | set_comment (std::string, void*) | |
void | set_meter_point (MeterPoint, bool) | |
void | set_meter_point (MeterPoint) | |
bool | set_strict_io (bool) | |
long | signal_latency () | |
bool | soloed () | |
DiskReader | to_diskreader () | |
DiskWriter | to_diskwriter () | |
PluginInsert | to_insert () | |
InternalSend | to_internalsend () | |
IOProcessor | to_ioprocessor () | |
Latent | to_latent () | |
PeakMeter | to_meter () | |
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 |
DiskReader | to_diskreader () | |
DiskWriter | to_diskwriter () | |
PluginInsert | to_insert () | |
InternalSend | to_internalsend () | |
IOProcessor | to_ioprocessor () | |
Latent | to_latent () | |
PeakMeter | to_meter () | |
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 |
DiskReader | to_diskreader () | |
DiskWriter | to_diskwriter () | |
PluginInsert | to_insert () | |
InternalSend | to_internalsend () | |
IOProcessor | to_ioprocessor () | |
Latent | to_latent () | |
PeakMeter | to_meter () | |
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
@@ -3288,6 +3394,7 @@ Pointer Classes cannot be created in Lua scripts. It always requires a call to CReturns true if this port is connected to o, otherwise false.
Returns flags
C‡: ARDOUR::PortEngine
-PortEngine is an abstract base class that defines the functionality required by Ardour.
A Port is basically an endpoint for a datastream (which can either be continuous, like audio, or event-based, like MIDI). Ports have buffers associated with them into which data can be written (if they are output ports) and from which data can be read (if they input ports). Ports can be connected together so that data written to an output port can be read from an input port. These connections can be 1:1, 1:N OR N:1.
Ports may be associated with software only, or with hardware. Hardware related ports are often referred to as physical, and correspond to some relevant physical entity on a hardware device, such as an audio jack or a MIDI connector. Physical ports may be potentially asked to monitor their inputs, though some implementations may not support this.
Most physical ports will also be considered "terminal", which means that data delivered there or read from there will go to or comes from a system outside of the PortEngine implementation's control (e.g. the analog domain for audio, or external MIDI devices for MIDI). Non-physical ports can also be considered "terminal". For example, the output port of a software synthesizer is a terminal port, because the data contained in its buffer does not and cannot be considered to come from any other port - it is synthesized by its owner.
Ports also have latency associated with them. Each port has a playback latency and a capture latency:
capture latency: how long since the data read from the buffer of a port arrived at at a terminal port. The data will have come from the "outside world" if the terminal port is also physical, or will have been synthesized by the entity that owns the terminal port.
playback latency: how long until the data written to the buffer of port will reach a terminal port.
For more detailed questions about the PortEngine API, consult the JACK API documentation, on which this entire object is based.
This class object is only used indirectly as return-value and function-parameter. It provides no methods by itself.
C‡: std::list<boost::shared_ptr<ARDOUR::Port> >
@@ -3379,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 >
@@ -3476,6 +3585,7 @@ Pointer Classes cannot be created in Lua scripts. It always requires a call to CMethods | ||
---|---|---|
bool | active () | |
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) | |
reset plugin-insert configuration to default, disable customizations. This is equivalent to calling customize_plugin_insert (proc, 0, unused)
Returns true if successful | ||
void | set_active (bool, void*) | |
void | set_comment (std::string, void*) | |
void | set_meter_point (MeterPoint, bool) | |
void | set_meter_point (MeterPoint) | |
bool | set_name (std::string) | |
bool | set_strict_io (bool) | |
long | signal_latency () |
Methods | ||
---|---|---|
GainControl | gain_control () | |
long | get_delay_in () | |
long | get_delay_out () | |
bool | is_foldback () | |
bool | isnil () | |
Cast | ||
InternalSend | to_internalsend () |
DiskReader | to_diskreader () | |
DiskWriter | to_diskwriter () | |
PluginInsert | to_insert () | |
InternalSend | to_internalsend () | |
IOProcessor | to_ioprocessor () | |
Latent | to_latent () | |
PeakMeter | to_meter () | |
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) | |
int | add_master_bus (ChanCount) | |
StatefulDiffCommand | add_stateful_diff_command (StatefulDestructiblePtr) | |
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 () | |
Route | monitor_out () | |
std::string | name () | |
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) | |
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 () | |
DiskReader | to_diskreader () | |
DiskWriter | to_diskwriter () | |
PluginInsert | to_insert () | |
InternalSend | to_internalsend () | |
IOProcessor | to_ioprocessor () | |
Latent | to_latent () | |
PeakMeter | to_meter () | |
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, 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) | |
reset plugin-insert configuration to default, disable customizations. This is equivalent to calling customize_plugin_insert (proc, 0, unused)
Returns true if successful | ||
void | set_active (bool, void*) | |
void | set_comment (std::string, void*) | |
void | set_meter_point (MeterPoint, bool) | |
void | set_meter_point (MeterPoint) | |
bool | set_strict_io (bool) | |
long | signal_latency () | |
bool | soloed () | |
DiskReader | to_diskreader () | |
DiskWriter | to_diskwriter () | |
PluginInsert | to_insert () | |
InternalSend | to_internalsend () | |
IOProcessor | to_ioprocessor () | |
Latent | to_latent () | |
PeakMeter | to_meter () | |
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--) |
Methods | ||
---|---|---|
void | access_action (std::string, std::string) | |
void | add_location_from_playhead_cursor () | |
void | add_location_mark (long) | |
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 () | |
--MISSING (ARDOUR::MeterLineUp)-- | get_meter_line_up_din () | |
--MISSING (ARDOUR::MeterLineUp)-- | get_meter_line_up_level () | |
MeterLineUp | get_meter_line_up_din () | |
MeterLineUp | get_meter_line_up_level () | |
float | get_meter_peak () | |
bool | get_meter_style_led () | |
--MISSING (ARDOUR::VUMeterStandard)-- | get_meter_vu_standard () | |
VUMeterStandard | get_meter_vu_standard () | |
std::string | get_mixer_strip_visibility () | |
bool | get_name_new_markers () | |
bool | get_never_display_periodic_midi () | |
bool | get_open_gui_after_adding_plugin () | |
bool | get_prefer_inline_over_gui () | |
bool | get_preview_video_frame_on_drag () | |
--MISSING (ARDOUR::ClockDeltaMode)-- | get_primary_clock_delta_mode () | |
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 () | |
--MISSING (ARDOUR::ScreenSaverMode)-- | get_screen_saver_mode () | |
--MISSING (ARDOUR::ClockDeltaMode)-- | get_secondary_clock_delta_mode () | |
ScreenSaverMode | get_screen_saver_mode () | |
ClockDeltaMode | get_secondary_clock_delta_mode () | |
bool | get_show_editor_meter () | |
bool | get_show_grids_ruler () | |
bool | get_show_inline_display_by_default () | |
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 () | |
unsigned long | get_waveform_cache_size () | |
double | get_waveform_clip_level () | |
float | get_waveform_gradient_depth () | |
--MISSING (ARDOUR::WaveformScale)-- | get_waveform_scale () | |
--MISSING (ARDOUR::WaveformShape)-- | get_waveform_shape () | |
WaveformScale | get_waveform_scale () | |
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 (--MISSING (ARDOUR::MeterLineUp)--) | |
bool | set_meter_line_up_level (--MISSING (ARDOUR::MeterLineUp)--) | |
bool | set_meter_line_up_din (MeterLineUp) | |
bool | set_meter_line_up_level (MeterLineUp) | |
bool | set_meter_peak (float) | |
bool | set_meter_style_led (bool) | |
bool | set_meter_vu_standard (--MISSING (ARDOUR::VUMeterStandard)--) | |
bool | set_meter_vu_standard (VUMeterStandard) | |
bool | set_mixer_strip_visibility (std::string) | |
bool | set_name_new_markers (bool) | |
bool | set_never_display_periodic_midi (bool) | |
bool | set_open_gui_after_adding_plugin (bool) | |
bool | set_prefer_inline_over_gui (bool) | |
bool | set_preview_video_frame_on_drag (bool) | |
bool | set_primary_clock_delta_mode (--MISSING (ARDOUR::ClockDeltaMode)--) | |
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_screen_saver_mode (--MISSING (ARDOUR::ScreenSaverMode)--) | |
bool | set_secondary_clock_delta_mode (--MISSING (ARDOUR::ClockDeltaMode)--) | |
bool | set_screen_saver_mode (ScreenSaverMode) | |
bool | set_secondary_clock_delta_mode (ClockDeltaMode) | |
bool | set_show_editor_meter (bool) | |
bool | set_show_grids_ruler (bool) | |
bool | set_show_inline_display_by_default (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_cache_size (unsigned long) | |
bool | set_waveform_clip_level (double) | |
bool | set_waveform_gradient_depth (float) | |
bool | set_waveform_scale (--MISSING (ARDOUR::WaveformScale)--) | |
bool | set_waveform_shape (--MISSING (ARDOUR::WaveformShape)--) | |
bool | set_waveform_scale (WaveformScale) | |
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 | |
--MISSING (ARDOUR::MeterLineUp)-- | meter_line_up_din | |
--MISSING (ARDOUR::MeterLineUp)-- | meter_line_up_level | |
ARDOUR.MeterLineUp | meter_line_up_din | |
ARDOUR.MeterLineUp | meter_line_up_level | |
float | meter_peak | |
bool | meter_style_led | |
--MISSING (ARDOUR::VUMeterStandard)-- | meter_vu_standard | |
ARDOUR.VUMeterStandard | meter_vu_standard | |
std::string | mixer_strip_visibility | |
bool | name_new_markers | |
bool | never_display_periodic_midi | |
bool | open_gui_after_adding_plugin | |
bool | prefer_inline_over_gui | |
bool | preview_video_frame_on_drag | |
--MISSING (ARDOUR::ClockDeltaMode)-- | primary_clock_delta_mode | |
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 | |
--MISSING (ARDOUR::ScreenSaverMode)-- | screen_saver_mode | |
--MISSING (ARDOUR::ClockDeltaMode)-- | secondary_clock_delta_mode | |
ARDOUR.ScreenSaverMode | screen_saver_mode | |
ARDOUR.ClockDeltaMode | secondary_clock_delta_mode | |
bool | show_editor_meter | |
bool | show_grids_ruler | |
bool | show_inline_display_by_default | |
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 | |
unsigned long | waveform_cache_size | |
double | waveform_clip_level | |
float | waveform_gradient_depth | |
--MISSING (ARDOUR::WaveformScale)-- | waveform_scale | |
--MISSING (ARDOUR::WaveformShape)-- | waveform_shape | |
ARDOUR.WaveformScale | waveform_scale | |
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 >
@@ -7481,6 +7672,12 @@ Pointer Classes cannot be created in Lua scripts. It always requires a call to C