X-Git-Url: http://shamusworld.gotdns.org/cgi-bin/gitweb.cgi?a=blobdiff_plain;f=include%2Fclass-reference.html;h=0a3c47719ced3de9d0afdc9125a8387dbd38321c;hb=a9518e1f3e8e0f359443963037c987e4f67158e8;hp=3bdba04d9689001a4092337994a9871908a5a02a;hpb=7be4f507991a0b87174a0e78831a4e7e9e96bcbe;p=ardour-manual
diff --git a/include/class-reference.html b/include/class-reference.html
index 3bdba04..0a3c477 100644
--- a/include/class-reference.html
+++ b/include/class-reference.html
@@ -32,10 +32,10 @@ Operations are performed on objects. One gets a reference to an object and then
e.g obj = Session:route_by_name("Audio") obj:set_name("Guitar")
.
-Lua automatically follows C++ class inheritance. e.g one can directly call all SessionObject and Route methods on Track object. However lua does not automatically promote objects. A Route object which just happens to be a Track needs to be explicily cast to a Track. Methods for casts are provided with each class. Note that the cast may fail and return a nil reference. +Lua automatically follows C++ class inheritance. e.g one can directly call all SessionObject and Route methods on Track object. However lua does not automatically promote objects. A Route object which just happens to be a Track needs to be explicitly cast to a Track. Methods for casts are provided with each class. Note that the cast may fail and return a nil reference.
-Likewise multiple inheritance is a non-trivial issue in lua. To avoid performance penalties involved with lookups, explicit casts are required in this case. One example is ARDOUR:SessionObject which is-a StatefulDestructible which inhertis from both Stateful and Destructible. +Likewise multiple inheritance is a non-trivial issue in Lua. To avoid performance penalties involved with lookups, explicit casts are required in this case. One example is ARDOUR:SessionObject which is-a StatefulDestructible which inherits from both Stateful and Destructible.
Object lifetimes are managed by the Session. Most Objects cannot be directly created, but one asks the Session to create or destroy them. This is mainly due to realtime constrains: @@ -43,7 +43,7 @@ you cannot simply remove a track that is currently processing audio. There are v
-Since lua functions are closures, C++ methods that pass arguments by reference cannot be used as-is. +Since Lua functions are closures, C++ methods that pass arguments by reference cannot be used as-is. All parameters passed to a C++ method which uses references are returned as Lua Table. If the C++ method also returns a value it is prefixed. Two parameters are returned: the value and a Lua Table holding the parameters.
@@ -95,12 +95,12 @@ print (rv, ref[1], ref[2])
Libardour makes extensive use of reference counted boost::shared_ptr
to manage lifetimes.
-The Lua bindings provide a complete abstration of this. There are no pointers in lua.
-For example a ARDOUR:Route is a pointer in C++, but lua functions operate on it like it was a class instance.
+The Lua bindings provide a complete abstraction of this. There are no pointers in Lua.
+For example a ARDOUR:Route is a pointer in C++, but Lua functions operate on it like it was a class instance.
-shared_ptr
are reference counted. Once assigned to a lua variable, the C++ object will be kept and remains valid.
-It is good practice to assign references to lua local
variables or reset the variable to nil
to drop the ref.
+shared_ptr
are reference counted. Once assigned to a Lua variable, the C++ object will be kept and remains valid.
+It is good practice to assign references to Lua local
variables or reset the variable to nil
to drop the ref.
All pointer classes have a isnil ()
method. This is for two cases:
@@ -110,51 +110,74 @@ may not be able to find the given plugin and hence cannot create an object.
The second case if for boost::weak_ptr
. As opposed to boost::shared_ptr
weak-pointers are not reference counted.
The object may vanish at any time.
-If lua code calls a method on a nil object, the interpreter will raise an exception and the script will not continue.
+If Lua code calls a method on a nil object, the interpreter will raise an exception and the script will not continue.
This is not unlike a = nil a:test()
which results in en error "attempt to index a nil value".
-From the lua side of things there is no distinction between weak and shared pointers. They behave identically. -Below they're inidicated in orange and have an arrow to indicate the pointer type. -Pointer Classes cannot be created in lua scripts. It always requires a call to C++ to create the Object and obtain a reference to it. +From the Lua side of things there is no distinction between weak and shared pointers. They behave identically. +Below they're indicated in orange and have an arrow to indicate the pointer type. +Pointer Classes cannot be created in Lua scripts. It always requires a call to C++ to create the Object and obtain a reference to it.
Methods | ||
---|---|---|
RCConfiguration | config () | |
std::string | user_cache_directory (std::string) | |
Returns the path to the directory used to store user specific caches (e.g. plugin indices, blacklist/whitelist) it defaults to XDG_CACHE_HOME | ||
std::string | user_config_directory (int) | |
user_config_directory() exists IF version was negative.
Returns the path to the directory used to store user specific configuration files for the given |
C‡: boost::shared_ptr< ARDOUR::Amp >, boost::weak_ptr< ARDOUR::Amp >
is-a: ARDOUR:Processor
-Applies a declick operation to all audio inputs, passing the same number of audio outputs, and passing through any other types unchanged.
Gain Stage (Fader, Trim).
Methods | ||
---|---|---|
float | apply_gain (AudioBuffer&, long, long, float, float, long) | |
GainControl | gain_control () | |
bool | isnil () | |
bool | sameinstance (Amp) |
Methods | ||
---|---|---|
void | activate () | |
bool | active () | |
long | capture_offset () | |
void | deactivate () | |
std::string | display_name () | |
bool | display_to_user () | |
ChanCount | input_streams () | |
ChanCount | output_streams () | |
long | input_latency () | |
ChanCount | input_streams () | |
long | output_latency () | |
ChanCount | output_streams () | |
long | playback_offset () | |
long | signal_latency () | |
Cast | ||
Amp | to_amp () | |
Automatable | to_automatable () | |
DelayLine | to_delayline () | |
DiskIOProcessor | to_diskioprocessor () | |
DiskReader | to_diskreader () | |
DiskWriter | to_diskwriter () | |
PluginInsert | to_insert () | |
InternalSend | to_internalsend () | |
IOProcessor | to_ioprocessor () | |
Latent | to_latent () | |
PeakMeter | to_meter () | |
MonitorProcessor | to_monitorprocessor () | |
PeakMeter | to_peakmeter () | |
PluginInsert | to_plugininsert () | |
PolarityProcessor | to_polarityprocessor () | |
Send | to_send () | |
SideChain | to_sidechain () | |
UnknownProcessor | to_unknownprocessor () |
Methods | ||
---|---|---|
std::string | name () | |
Stateful | to_stateful () | |
StatefulDestructible | to_statefuldestructible () |
C‡: boost::shared_ptr< ARDOUR::AsyncMIDIPort >, boost::weak_ptr< ARDOUR::AsyncMIDIPort >
+is-a: ARDOUR:MidiPort
+ +Methods | ||
---|---|---|
bool | isnil () | |
int | write (unsigned char*, unsigned long, unsigned int) |
Methods | ||
---|---|---|
MidiBuffer | get_midi_buffer (unsigned int) | |
bool | input_active () | |
void | set_input_active (bool) | |
Cast | ||
AsyncMIDIPort | to_asyncmidiport () |
Methods | ||
---|---|---|
int | connect (std::string) | |
bool | connected () | |
Returns true if this port is connected to anything | ||
bool | connected_to (std::string) | |
Returns true if this port is connected to o, otherwise false. | ||
int | disconnect (std::string) | |
int | disconnect_all () | |
PortFlags | flags () | |
Returns flags | ||
LuaTable(...) | get_connected_latency_range (LatencyRange&, bool) | |
std::string | name () | |
Returns Port short name | ||
bool | physically_connected () | |
std::string | pretty_name (bool) | |
Returns Port human readable name | ||
LatencyRange | private_latency_range (bool) | |
LatencyRange | public_latency_range (bool) | |
bool | receives_input () | |
Returns true if this Port receives input, otherwise false | ||
bool | sends_output () | |
Returns true if this Port sends output, otherwise false | ||
Cast | ||
AsyncMIDIPort | to_asyncmidiport () | |
AudioPort | to_audioport () | |
MidiPort | to_midiport () |
C‡: boost::shared_ptr< ARDOUR::AudioBackend >, boost::weak_ptr< ARDOUR::AudioBackend >
@@ -183,21 +253,20 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to CReturns a collection of DeviceStatuses identifying output devices discovered by this backend since the start of the process.
Any of the names in each DeviceStatus may be used to identify a device in other calls to the backend, though any of them may become invalid at any time.
Return the AudioBackendInfo object from which this backend was constructed.
Return the AudioBackendInfo object from which this backend was constructed.
Set the buffer size to be used.
The device is assumed to use a double buffering scheme, so that one buffer's worth of data can be processed by hardware while software works on the other buffer. All known suitable audio APIs support this model (though ALSA allows for alternate numbers of buffers, and CoreAudio doesn't directly expose the concept).
Set the name of the device to be used
Set the name of the device to be used
Returns zero if the backend can successfully use
Should not be used unless the backend returns true from requires_driver_selection()
name | as the driver, non-zero otherwise. |
---|
Returns zero if the backend can successfully use drivername as the driver, non-zero otherwise.
Should not be used unless the backend returns true from requires_driver_selection()
Set the name of the input device to be used if using separate input/output devices.
use_separate_input_and_output_devices()
Set the period size to be used. must be called before starting the backend.
Set the sample rate to be used
Set the sample rate to be used
An optional alternate interface for backends to provide a facility to select separate input and output devices.
If a backend returns true then enumerate_input_devices() and enumerate_output_devices() will be used instead of enumerate_devices() to enumerate devices. Similarly set_input/output_device_name() should be used to set devices instead of set_device_name().
Methods | ||||||
---|---|---|---|---|---|---|
void | apply_gain (float, long) | |||||
Apply a fixed gain factor to the audio buffer
| ||||||
bool | check_silence (unsigned int, unsigned int&) | |||||
check buffer for silence
Returns true if all samples are zero | ||||||
Check buffer for silence
Returns true if all samples are zero | ||||||
FloatArray | data (long) | |||||
void | read_from (FloatArray, long, long, long) | |||||
bool | sameinstance (AudioBuffer) | |||||
void | silence (long, long) | |||||
silence buffer
| ||||||
silence buffer
|
C‡: ARDOUR::AudioEngine
@@ -239,8 +308,11 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to Cname | Full or short name of port |
---|
Returns Corresponding Port or 0.
Returns Corresponding Port or 0.
C‡: boost::shared_ptr< ARDOUR::AudioPlaylist >, boost::weak_ptr< ARDOUR::AudioPlaylist >
@@ -279,7 +352,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to CPlaylist | cut (AudioRangeList&, bool) | |||||
DataType | data_type () | |||||
void | duplicate (Region, long, long, float) | |||||
| ||||||
| ||||||
void | duplicate_range (AudioRange&, float) | |||||
void | duplicate_until (Region, long, long, long) | |||||
| ||||||
| ||||||
bool | empty () | |||||
Region | find_next_region (long, RegionPoint, int) | |||||
long | find_next_region_boundary (long, int) | |||||
long | find_next_transient (long, int) | |||||
ID | get_orig_track_id () | |||||
bool | hidden () | |||||
void | lower_region (Region) | |||||
void | lower_region_to_bottom (Region) | |||||
unsigned int | n_regions () | |||||
RegionListPtr | region_list () | |||||
RegionListPtr | regions_at (long) | |||||
RegionListPtr | regions_touched (long, long) | |||||
Returns regions which have some part within this range. | ||||||
Returns regions which have some part within this range. | ||||||
RegionListPtr | regions_with_end_within (Range) | |||||
RegionListPtr | regions_with_start_within (Range) | |||||
void | remove_region (Region) | |||||
void | split (long) | |||||
void | split_region (Region, MusicFrame) | |||||
bool | set_name (std::string) | |||||
bool | shared () | |||||
void | split_region (Region, MusicSample) | |||||
Region | top_region_at (long) | |||||
Region | top_unmuted_region_at (long) | |||||
void | uncombine (Region) | |||||
bool | used () | |||||
Cast | ||||||
---|---|---|---|---|---|---|
AudioPlaylist | to_audioplaylist () | |||||
MidiPlaylist | to_midiplaylist () |
Methods | ||||
---|---|---|---|---|
std::string | name () |
Methods | ||
---|---|---|
bool | isnil () | |
bool | sameinstance (AudioPort) |
bool | connected () | |||
Returns true if this port is connected to anything | ||||
bool | connected_to (std::string) | |||
Returns true if this port is connected to o, otherwise false. | ||||
Returns true if this port is connected to o, otherwise false. | ||||
int | disconnect (std::string) | |||
int | disconnect_all () | |||
PortFlags | flags () | |||
Returns flags | ||||
LuaTable(...) | get_connected_latency_range (LatencyRange&, bool) | |||
std::string | name () | |||
Returns Port short name | ||||
bool | physically_connected () | |||
std::string | pretty_name (bool) | |||
Returns Port human readable name | ||||
LatencyRange | private_latency_range (bool) | |||
LatencyRange | public_latency_range (bool) | |||
bool | receives_input () | |||
Returns true if this Port receives input, otherwise false | ||||
bool | sends_output () | |||
Returns true if this Port sends output, otherwise false | ||||
Cast | ||||
---|---|---|---|---|
AsyncMIDIPort | to_asyncmidiport () | |||
AudioPort | to_audioport () | |||
MidiPort | to_midiport () |
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
@@ -379,9 +480,9 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to CMethods | ||
---|---|---|
AudioSource | audio_source (unsigned int) | |
bool | fade_in_active () | |
bool | fade_out_active () | |
bool | isnil () | |
double | maximum_amplitude (Progress) | |
Returns the maximum (linear) amplitude of the region, or a -ve number if the Progress object reports that the process was cancelled. | ||
double | rms (Progress) | |
Returns the maximum (rms) signal power of the region, or a -1 if the Progress object reports that the process was cancelled. | ||
bool | sameinstance (AudioRegion) | |
float | scale_amplitude () | |
LuaTable(int, ...) | separate_by_channel (RegionVector&) | |
void | set_fade_in_active (bool) | |
void | set_fade_in_length (long) | |
void | set_fade_in_shape (FadeShape) | |
void | set_fade_out_active (bool) | |
void | set_fade_out_length (long) | |
void | set_fade_out_shape (FadeShape) | |
void | set_scale_amplitude (float) |
How the region parameters play together:
POSITION: first frame of the region along the timeline START: first frame of the region within its source(s) LENGTH: number of frames the region represents
How the region parameters play together:
POSITION: first sample of the region along the timeline START: first sample of the region within its source(s) LENGTH: number of samples the region represents
A gui may need to create a region, then place it in an initial position determined by the user. When this takes place within one gui operation, we have to reset _last_position to prevent an implied move.
A gui may need to create a region, then place it in an initial position determined by the user. When this takes place within one gui operation, we have to reset _last_position to prevent an implied move.
Note: changing the name of a Region does not constitute an edit
Set the region's sync point.
absolute_pos | Session time. |
---|
Set the region's sync point.
Returns Sync position in session time
Methods | ||
---|---|---|
std::string | name () | |
Stateful | to_stateful () | |
StatefulDestructible | to_statefuldestructible () |
C‡: boost::shared_ptr< ARDOUR::AudioRom >, boost::weak_ptr< ARDOUR::AudioRom >
+is-a: ARDOUR:Readable
+ +Methods | ||
---|---|---|
bool | isnil () | |
AudioRom | new_rom (FloatArray, unsigned long) |
Methods | ||
---|---|---|
ReadableList | load (Session&, std::string) | |
unsigned int | n_channels () | |
long | read (FloatArray, long, long, int) | |
long | readable_length () |
C‡: boost::shared_ptr< ARDOUR::AudioSource >, boost::weak_ptr< ARDOUR::AudioSource >
is-a: ARDOUR:Source
@@ -485,7 +618,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to CA named object associated with a Session. Objects derived from this class are expected to be destroyed before the session calls drop_references().
Methods | ||
---|---|---|
std::string | captured_for () | |
std::string | captured_for () | |
bool | empty () | |
bool | isnil () | |
bool | isnil () | |
long | read (FloatArray, long, long, int) | |
long | readable_length () | |
long | readable_length () | |
bool | sameinstance (AudioSource) | |
bool | sameinstance (AudioSource) | |
float | sample_rate () | |
Cast | ||
Readable | to_readable () | |
Methods | ||
std::string | ancestor_name () | |
bool | can_be_analysed () | |
bool | destructive () | |
XrunPositions | captured_xruns () | |
bool | has_been_analysed () | |
long | natural_position () | |
long | timeline_position () | |
bool | writable () | |
Cast | ||
AudioSource | to_audiosource () | |
FileSource | to_filesource () | |
MidiSource | to_midisource () |
Methods | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
std::string | name () |
Methods | ||
---|---|---|
bool | isnil () | |
bool | sameinstance (AudioTrack) |
Methods | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
Region | bounce (InterThreadInfo&) | |||||||||||
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) | |||||||||||
Bounce the given range to a new audio region.
Returns a new audio region (or nil in case of error) | ||||||||||||
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, 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. | ||||||||||||
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. | ||||||||||||
bool | can_record () | |||||||||||
int | find_and_use_playlist (DataType, ID) | |||||||||||
Playlist | playlist () | |||||||||||
bool | set_name (std::string) | |||||||||||
int | use_copy_playlist () | |||||||||||
int | use_new_playlist (DataType) | |||||||||||
int | use_playlist (DataType, Playlist) | |||||||||||
Cast | ||||||||||||
AudioTrack | to_audio_track () | |||||||||||
MidiTrack | to_midi_track () |
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. | ||||||||||
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) | |||||||||
Amp | amp () | |||||||||
std::string | comment () | |||||||||
bool | customize_plugin_insert (Processor, unsigned int, ChanCount, ChanCount) | |||||||||
enable custom plugin-insert configuration
Returns true if successful | ||||||||||
enable custom plugin-insert configuration
Returns true if successful | ||||||||||
DataType | data_type () | |||||||||
IO | input () | |||||||||
Delivery | main_outs () | |||||||||
the signal processorat at end of the processing chain which produces output | ||||||||||
PannerShell | panner_shell () | |||||||||
PeakMeter | peak_meter () | |||||||||
************************************************************* Pure interface begins here************************************************************* | ||||||||||
long | playback_latency (bool) | |||||||||
int | remove_processor (Processor, ProcessorStreams, bool) | |||||||||
remove plugin/processor
Returns 0 on success | ||||||||||
remove plugin/processor
Returns 0 on success | ||||||||||
int | remove_processors (ProcessorList, ProcessorStreams) | |||||||||
bool | remove_sidechain (Processor) | |||||||||
int | reorder_processors (ProcessorList, ProcessorStreams) | |||||||||
int | replace_processor (Processor, Processor, ProcessorStreams) | |||||||||
replace plugin/processor with another
Returns 0 on success | ||||||||||
replace plugin/processor with another
Returns 0 on success | ||||||||||
bool | reset_plugin_insert (Processor) | |||||||||
reset plugin-insert configuration to default, disable customizations. This is equivalent to calling customize_plugin_insert (proc, 0, unused)
Returns true if successful | ||||||||||
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 () | |||||||||
bool | strict_io () | |||||||||
Processor | the_instrument () | |||||||||
Return the first processor that accepts has at least one MIDI input and at least one audio output. In the vast majority of cases, this will be "the instrument". This does not preclude other MIDI->audio processors later in the processing chain, but that would be a special case not covered by this utility function. | ||||||||||
Amp | trim () | |||||||||
Cast | ||||||||||
Automatable | to_automatable () | |||||||||
Track | to_track () |
Methods | ||
---|---|---|
AutomationControl | comp_enable_control () | |
AutomationControl | comp_makeup_control () | |
AutomationControl | comp_mode_control () | |
AutomationControl | comp_enable_controllable () | |
AutomationControl | comp_makeup_controllable () | |
AutomationControl | comp_mode_controllable () | |
std::string | comp_mode_name (unsigned int) | |
AutomationControl | comp_redux_control () | |
AutomationControl | comp_speed_control () | |
ReadOnlyControl | comp_redux_controllable () | |
AutomationControl | comp_speed_controllable () | |
std::string | comp_speed_name (unsigned int) | |
AutomationControl | comp_threshold_control () | |
AutomationControl | comp_threshold_controllable () | |
unsigned int | eq_band_cnt () | |
std::string | eq_band_name (unsigned int) | |
AutomationControl | eq_enable_control () | |
AutomationControl | eq_freq_control (unsigned int) | |
AutomationControl | eq_gain_control (unsigned int) | |
AutomationControl | eq_hpf_control () | |
AutomationControl | eq_q_control (unsigned int) | |
AutomationControl | eq_shape_control (unsigned int) | |
AutomationControl | eq_enable_controllable () | |
AutomationControl | eq_freq_controllable (unsigned int) | |
AutomationControl | eq_gain_controllable (unsigned int) | |
AutomationControl | eq_q_controllable (unsigned int) | |
AutomationControl | eq_shape_controllable (unsigned int) | |
AutomationControl | filter_enable_controllable (bool) | |
AutomationControl | filter_freq_controllable (bool) | |
AutomationControl | filter_slope_controllable (bool) | |
GainControl | gain_control () | |
bool | is_auditioner () | |
bool | is_hidden () | |
bool | is_master () | |
bool | is_monitor () | |
bool | is_private_route () | |
bool | is_selected () | |
AutomationControl | master_send_enable_control () | |
AutomationControl | master_send_enable_controllable () | |
MonitorProcessor | monitor_control () | |
MuteControl | mute_control () | |
AutomationControl | pan_azimuth_control () | |
PresentationInfo | presentation_info_ptr () | |
AutomationControl | rec_enable_control () | |
AutomationControl | rec_safe_control () | |
AutomationControl | send_enable_control (unsigned int) | |
AutomationControl | send_level_control (unsigned int) | |
AutomationControl | send_enable_controllable (unsigned int) | |
AutomationControl | send_level_controllable (unsigned int) | |
std::string | send_name (unsigned int) | |
AutomationControl | send_pan_azimuth_controllable (unsigned int) | |
AutomationControl | send_pan_azimuth_enable_controllable (unsigned int) | |
void | set_presentation_order (unsigned int) | |
bool | slaved () | |
bool | slaved_to (VCA) | |
SoloControl | solo_control () | |
SoloIsolateControl | solo_isolate_control () | |
SoloSafeControl | solo_safe_control () | |
GainControl | trim_control () | |
Cast | ||
Automatable | to_automatable () | |
Route | to_route () | |
Slavable | to_slavable () | |
VCA | to_vca () |
Methods | ||
---|---|---|
std::string | name () | |
ℂ | ARDOUR.AudioTrackList () | |
Methods | ||
LuaTable | add (LuaTable {AudioTrack}) | |
AudioTrack | back () | |
AudioTrack | back () | |
bool | empty () | |
AudioTrack | front () | |
AudioTrack | front () | |
LuaIter | iter () | |
void | push_back (AudioTrack) | |
void | reverse () | |
Methods | ||
AutomationControl | automation_control (Parameter, bool) | |
bool | isnil () | |
bool | sameinstance (Automatable) | |
Cast | ||
Slavable | to_slavable () |
C‡: boost::shared_ptr< ARDOUR::AutomatableSequence<Evoral::Beats> >, boost::weak_ptr< ARDOUR::AutomatableSequence<Evoral::Beats> >
+C‡: boost::shared_ptr< ARDOUR::AutomatableSequence<Temporal::Beats> >, boost::weak_ptr< ARDOUR::AutomatableSequence<Temporal::Beats> >
is-a: ARDOUR:Automatable
Methods | ||
---|---|---|
bool | isnil () | |
bool | sameinstance (AutomatableSequence) | |
Cast | ||
Sequence | to_sequence () | |
Sequence | to_sequence () |
Methods | ||
---|---|---|
AutomationControl | automation_control (Parameter, bool) | |
Cast | ||
Slavable | to_slavable () |
C‡: boost::shared_ptr< ARDOUR::AutomationControl >, boost::weak_ptr< ARDOUR::AutomationControl >
@@ -707,20 +857,23 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to CGet the current effective `user' value based on automation state
Get `internal' value
Returns raw value as used for the plugin/processor control port
Get and Set `internal' value
All derived classes must implement this.
Basic derived classes will ignore
group_override, | but more sophisticated children, notably those that proxy the value setting logic via an object that is aware of group relationships between this control and others, will find it useful. |
---|
Set `internal' value
All derived classes must implement this.
Basic derived classes will ignore group_override but more sophisticated children, notably those that proxy the value setting logic via an object that is aware of group relationships between this control and others, will find it useful.
C‡: boost::shared_ptr< ARDOUR::AutomationList >, boost::weak_ptr< ARDOUR::AutomationList >
+is-a: Evoral:ControlList
AutomationList is a stateful wrapper around Evoral::ControlList. It includes session-specifics (such as automation state), control logic (e.g. touch, signals) and acts as proxy to the underlying ControlList which holds the actual data.
XMLNode | get_state () | |
bool | isnil () | |
Command | memento_command (XMLNode, XMLNode) | |
bool | sameinstance (AutomationList) | |
bool | touch_enabled () | |
bool | touching () | |
bool | writing () | |
Stateful | to_stateful () | |
StatefulDestructible | to_statefuldestructible () |
Methods | ||
---|---|---|
void | add (double, double, bool, bool) | |
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 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) | |
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(). This may fail if a read-lock cannot be taken.
Returns parameter value | ||
bool | set_interpolation (InterpolationStyle) | |
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) | |
Remove all events after the given time from this list.
| ||
void | truncate_start (double) | |
Remove all events up to to the given time from this list.
| ||
Cast | ||
AutomationList | to_automationlist () |
C‡: std::vector<ARDOUR::AudioBackendInfo const* >
@@ -766,16 +951,29 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to CC‡: ARDOUR::BeatsSamplesConverter
+ +Converter between quarter-note beats and samples. Takes distances in quarter-note beats or samples from some origin (supplied to the constructor in samples), and converts them to the opposite unit, taking tempo changes into account.
Constructor | ||
---|---|---|
ℂ | ARDOUR.BeatsSamplesConverter (TempoMap, long) | |
Methods | ||
Beats | from (long) | |
Convert B time to A time (A from B) | ||
long | to (Beats) | |
Convert A time to B time (A to B) |
C‡: ARDOUR::BufferSet
A set of buffers of various types.
These are mainly accessed from Session and passed around as scratch buffers (eg as parameters to run() methods) to do in-place signal processing.
There are two types of counts associated with a BufferSet - available, and the 'use count'. Available is the actual number of allocated buffers (and so is the maximum acceptable value for the use counts).
The use counts are how things determine the form of their input and inform others the form of their output (eg what they did to the BufferSet). Setting the use counts is realtime safe.
Methods | ||
---|---|---|
ChanCount | available () | |
ChanCount | count () | |
AudioBuffer | get_audio (unsigned long) | |
MidiBuffer | get_midi (unsigned long) | |
bool | sameinstance (BufferSet) |
C‡: ARDOUR::ChanCount
@@ -784,10 +982,10 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to CConstructor | ||||||
---|---|---|---|---|---|---|
ℂ | ARDOUR.ChanCount (DataType, unsigned int) | |||||
Convenience constructor for making single-typed streams (mono, stereo, midi, etc)
| ||||||
Convenience constructor for making single-typed streams (mono, stereo, midi, etc)
| ||||||
Methods | ||||||
unsigned int | get (DataType) | |||||
query channel count for given type
Returns channel count for given type | ||||||
query channel count for given type
Returns channel count for given type | ||||||
unsigned int | n_audio () | |||||
query number of audio channels Returns number of audio channels | ||||||
unsigned int | n_midi () | |||||
void | reset () | |||||
zero count of all data types | ||||||
void | set (DataType, unsigned int) | |||||
set channel count for given type
| ||||||
set channel count for given type
| ||||||
void | set_audio (unsigned int) | |||||
set number of audio channels
| ||||||
void | set_midi (unsigned int) | |||||
set number of audio channels
|
C‡: ARDOUR::ChanMapping
@@ -809,12 +1011,12 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to Cget buffer mapping for given data type and pin
from | numeric source id |
---|---|
type | data type |
Returns mapped buffer number (or ChanMapping::Invalid)
get buffer mapping for given data type and pin
Returns mapped buffer number (or ChanMapping::Invalid)
Test if this mapping is monotonic (useful to see if inplace processing is feasible)
Returns true if the map is a strict monotonic set
set buffer mapping for given data type
from | numeric source id |
---|---|
to | buffer |
type | data type |
set buffer mapping for given data type
C‡: std::list<boost::shared_ptr<ARDOUR::AutomationControl> >
@@ -824,9 +1026,9 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to Cnon-linear power-scale meter deflection
power | signal power (dB) |
---|
Returns deflected value
non-linear power-scale meter deflection
Returns deflected value
non-linear power-scale meter deflection
coeff | signal value |
---|
Returns deflected value
non-linear power-scale meter deflection
Returns deflected value
lua wrapper to memset()
matrix multiply multiply every sample of `data' with the corresponding sample at `mult'.
data | multiplicand |
---|---|
mult | multiplicand |
n_samples | number of samples in data and mmult |
matrix multiply multiply every sample of `data' with the corresponding sample at `mult'.
C‡: ARDOUR::DSP::Biquad
@@ -881,19 +1083,58 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to CConstructor | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
ℂ | ARDOUR.DSP.Biquad (double) | |||||||||
Instantiate Biquad Filter
| ||||||||||
Instantiate Biquad Filter
| ||||||||||
Methods | ||||||||||
void | compute (Type, double, double, double) | |||||||||
setup filter, compute coefficients
| ||||||||||
setup filter, compute coefficients
| ||||||||||
void | configure (double, double, double, double, double) | |||||||||
setup filter, set coefficients directly | ||||||||||
float | dB_at_freq (float) | |||||||||
filter transfer function (filter response for spectrum visualization)
Returns gain at given frequency in dB (clamped to -120..+120) | ||||||||||
filter transfer function (filter response for spectrum visualization)
Returns gain at given frequency in dB (clamped to -120..+120) | ||||||||||
void | reset () | |||||||||
reset filter state | ||||||||||
void | run (FloatArray, unsigned int) | |||||||||
process audio data
| ||||||||||
process audio data
|
C‡: ARDOUR::DSP::Convolution
+ +Constructor | ||
---|---|---|
ℂ | ARDOUR.DSP.Convolution (Session&, unsigned int, unsigned int) | |
Methods | ||
bool | add_impdata (unsigned int, unsigned int, Readable, float, unsigned int, long, long, unsigned int) | |
unsigned int | latency () | |
unsigned int | n_inputs () | |
unsigned int | n_outputs () | |
bool | ready () | |
void | restart () | |
void | run (BufferSet&, ChanMapping, ChanMapping, unsigned int, long) |
C‡: ARDOUR::DSP::Convolver
+is-a: ARDOUR:DSP:Convolution
+ +Constructor | ||
---|---|---|
ℂ | ARDOUR.DSP.Convolver (Session&, std::string, IRChannelConfig, IRSettings) | |
Methods | ||
void | run_mono (FloatArray, unsigned int) | |
void | run_stereo (FloatArray, FloatArray, unsigned int) |
Constructor | ||
---|---|---|
ℂ | ARDOUR.DSP.Convolution (Session&, unsigned int, unsigned int) | |
Methods | ||
bool | add_impdata (unsigned int, unsigned int, Readable, float, unsigned int, long, long, unsigned int) | |
unsigned int | latency () | |
unsigned int | n_inputs () | |
unsigned int | n_outputs () | |
bool | ready () | |
void | restart () | |
void | run (BufferSet&, ChanMapping, ChanMapping, unsigned int, long) |
C‡: ARDOUR::DSP::DspShm
@@ -903,17 +1144,17 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C[re] allocate memory in host's memory space
s | size, total number of float or integer elements to store. |
---|
[re] allocate memory in host's memory space
atomically read integer at offset
This involves a memory barrier. This call is intended for buffers which are shared with another instance.
off | offset in shared memory region |
---|
Returns value at offset
atomically read integer at offset
This involves a memory barrier. This call is intended for buffers which are shared with another instance.
Returns value at offset
atomically set integer at offset
This involves a memory barrier. This call is intended for buffers which are shared with another instance.
off | offset in shared memory region |
---|---|
val | value to set |
atomically set integer at offset
This involves a memory barrier. This call is intended for buffers which are shared with another instance.
clear memory (set to zero)
access memory as float array
off | offset in shared memory region |
---|
Returns float[]
access memory as float array
Returns float[]
access memory as integer array
off | offset in shared memory region |
---|
Returns int_32_t[]
access memory as integer array
Returns int_32_t[]
C‡: ARDOUR::DSP::FFTSpectrum
@@ -926,9 +1167,44 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to Cprocess current data in buffer
query
b | the frequency bin 0 .. window_size / 2 |
---|---|
norm | gain factor (set equal to for 1/f normalization) |
Returns signal power at given bin (in dBFS)
query
Returns signal power at given bin (in dBFS)
C‡: ARDOUR::DSP::Generator
+ +Constructor | ||
---|---|---|
ℂ | ARDOUR.DSP.Generator () | |
Methods | ||
void | run (FloatArray, unsigned int) | |
void | set_type (Type) |
C‡: ARDOUR::DSP::Convolver::IRSettings
+ +Constructor | ||
---|---|---|
ℂ | ARDOUR.DSP.IRSettings () | |
Methods | ||
unsigned int | get_channel_delay (unsigned int) | |
float | get_channel_gain (unsigned int) | |
void | set_channel_delay (unsigned int, unsigned int) | |
void | set_channel_gain (unsigned int, float) | |
Data Members | ||
float | gain | |
unsigned int | pre_delay |
C‡: ARDOUR::LTCReader
+ +Constructor | ||
---|---|---|
ℂ | ARDOUR.DSP.LTCReader (int, LTC_TV_STANDARD) | |
Methods | ||
LuaTable(long, ...) | read (unsigned int&, unsigned int&, unsigned int&, unsigned int&) | |
void | write (FloatArray, long, long) |
C‡: ARDOUR::DSP::LowPass
@@ -936,16 +1212,16 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to CConstructor | ||||||||
---|---|---|---|---|---|---|---|---|
ℂ | ARDOUR.DSP.LowPass (double, float) | |||||||
instantiate a LPF
| ||||||||
instantiate a LPF
| ||||||||
Methods | ||||||||
void | ctrl (FloatArray, float, unsigned int) | |||||||
filter control data This is useful for parameter smoothing.
| ||||||||
filter control data This is useful for parameter smoothing.
| ||||||||
void | proc (FloatArray, unsigned int) | |||||||
process audio data
| ||||||||
process audio data
| ||||||||
void | reset () | |||||||
reset filter state | ||||||||
void | set_cutoff (float) | |||||||
update filter cut-off frequency
| ||||||||
update filter cut-off frequency
|
C‡: ARDOUR::DataType
@@ -964,16 +1240,68 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to CInverse of the from-string constructor
C‡: boost::shared_ptr< ARDOUR::DelayLine >, boost::weak_ptr< ARDOUR::DelayLine >
+is-a: ARDOUR:Processor
+ +Meters peaks on the input and stores them for access.
Methods | ||
---|---|---|
long | delay () | |
bool | isnil () |
Methods | ||
---|---|---|
void | activate () | |
bool | active () | |
long | capture_offset () | |
void | deactivate () | |
std::string | display_name () | |
bool | display_to_user () | |
long | input_latency () | |
ChanCount | input_streams () | |
long | output_latency () | |
ChanCount | output_streams () | |
long | playback_offset () | |
long | signal_latency () | |
Cast | ||
Amp | to_amp () | |
Automatable | to_automatable () | |
DelayLine | to_delayline () | |
DiskIOProcessor | to_diskioprocessor () | |
DiskReader | to_diskreader () | |
DiskWriter | to_diskwriter () | |
PluginInsert | to_insert () | |
InternalSend | to_internalsend () | |
IOProcessor | to_ioprocessor () | |
Latent | to_latent () | |
PeakMeter | to_meter () | |
MonitorProcessor | to_monitorprocessor () | |
PeakMeter | to_peakmeter () | |
PluginInsert | to_plugininsert () | |
PolarityProcessor | to_polarityprocessor () | |
Send | to_send () | |
SideChain | to_sidechain () | |
UnknownProcessor | to_unknownprocessor () |
Methods | ||
---|---|---|
std::string | name () | |
Cast | ||
Stateful | to_stateful () | |
StatefulDestructible | to_statefuldestructible () |
C‡: boost::shared_ptr< ARDOUR::Delivery >, boost::weak_ptr< ARDOUR::Delivery >
is-a: ARDOUR:IOProcessor
-A mixer strip element (Processor) with 1 or 2 IO elements.
A mixer strip element (Processor) with 1 or 2 IO elements.
Methods | ||
---|---|---|
bool | isnil () | |
PannerShell | panner_shell () | |
bool | sameinstance (Delivery) |
Methods | ||
---|---|---|
void | activate () | |
bool | active () | |
long | capture_offset () | |
void | deactivate () | |
std::string | display_name () | |
bool | display_to_user () | |
ChanCount | input_streams () | |
ChanCount | output_streams () | |
long | input_latency () | |
ChanCount | input_streams () | |
long | output_latency () | |
ChanCount | output_streams () | |
long | playback_offset () | |
long | signal_latency () | |
Cast | ||
Amp | to_amp () | |
Automatable | to_automatable () | |
DelayLine | to_delayline () | |
DiskIOProcessor | to_diskioprocessor () | |
DiskReader | to_diskreader () | |
DiskWriter | to_diskwriter () | |
PluginInsert | to_insert () | |
InternalSend | to_internalsend () | |
IOProcessor | to_ioprocessor () | |
Latent | to_latent () | |
PeakMeter | to_meter () | |
MonitorProcessor | to_monitorprocessor () | |
PeakMeter | to_peakmeter () | |
PluginInsert | to_plugininsert () | |
PolarityProcessor | to_polarityprocessor () | |
Send | to_send () | |
SideChain | to_sidechain () | |
UnknownProcessor | to_unknownprocessor () |
Methods | ||
---|---|---|
std::string | name () | |
Cast | ||
Stateful | to_stateful () | |
StatefulDestructible | to_statefuldestructible () |
C‡: ARDOUR::AudioBackend::DeviceStatus
+ +used to list device names along with whether or not they are currently available.
Data Members | ||
---|---|---|
bool | available | |
std::string | name |
C‡: std::vector<ARDOUR::AudioBackend::DeviceStatus >
+ +Constructor | ||
---|---|---|
ℂ | ARDOUR.DeviceStatusVector () | |
ℂ | ARDOUR.DeviceStatusVector () | |
Methods | ||
LuaTable | add (LuaTable {DeviceStatus}) | |
DeviceStatus | at (unsigned long) | |
void | clear () | |
bool | empty () | |
LuaIter | iter () | |
void | push_back (DeviceStatus) | |
unsigned long | size () | |
LuaTable | table () | |
... | to_array (--lua--) |
C‡: boost::shared_ptr< ARDOUR::DiskIOProcessor >, boost::weak_ptr< ARDOUR::DiskIOProcessor >
+is-a: ARDOUR:Processor
+ +A mixer strip element - plugin, send, meter, etc
Methods | ||
---|---|---|
bool | isnil () |
Methods | ||
---|---|---|
void | activate () | |
bool | active () | |
long | capture_offset () | |
void | deactivate () | |
std::string | display_name () | |
bool | display_to_user () | |
long | input_latency () | |
ChanCount | input_streams () | |
long | output_latency () | |
ChanCount | output_streams () | |
long | playback_offset () | |
long | signal_latency () | |
Cast | ||
Amp | to_amp () | |
Automatable | to_automatable () | |
DelayLine | to_delayline () | |
DiskIOProcessor | to_diskioprocessor () | |
DiskReader | to_diskreader () | |
DiskWriter | to_diskwriter () | |
PluginInsert | to_insert () | |
InternalSend | to_internalsend () | |
IOProcessor | to_ioprocessor () | |
Latent | to_latent () | |
PeakMeter | to_meter () | |
MonitorProcessor | to_monitorprocessor () | |
PeakMeter | to_peakmeter () | |
PluginInsert | to_plugininsert () | |
PolarityProcessor | to_polarityprocessor () | |
Send | to_send () | |
SideChain | to_sidechain () | |
UnknownProcessor | to_unknownprocessor () |
Methods | ||
---|---|---|
std::string | name () | |
Cast | ||
Stateful | to_stateful () | |
StatefulDestructible | to_statefuldestructible () |
C‡: boost::shared_ptr< ARDOUR::DiskReader >, boost::weak_ptr< ARDOUR::DiskReader >
+is-a: ARDOUR:DiskIOProcessor
+ +A mixer strip element - plugin, send, meter, etc
Methods | ||
---|---|---|
bool | isnil () |
Methods | ||
---|---|---|
void | activate () | |
bool | active () | |
long | capture_offset () | |
void | deactivate () | |
std::string | display_name () | |
bool | display_to_user () | |
long | input_latency () | |
ChanCount | input_streams () | |
long | output_latency () | |
ChanCount | output_streams () | |
long | playback_offset () | |
long | signal_latency () | |
Cast | ||
Amp | to_amp () | |
Automatable | to_automatable () | |
DelayLine | to_delayline () | |
DiskIOProcessor | to_diskioprocessor () | |
DiskReader | to_diskreader () | |
DiskWriter | to_diskwriter () | |
PluginInsert | to_insert () | |
InternalSend | to_internalsend () | |
IOProcessor | to_ioprocessor () | |
Latent | to_latent () | |
PeakMeter | to_meter () | |
MonitorProcessor | to_monitorprocessor () | |
PeakMeter | to_peakmeter () | |
PluginInsert | to_plugininsert () | |
PolarityProcessor | to_polarityprocessor () | |
Send | to_send () | |
SideChain | to_sidechain () | |
UnknownProcessor | to_unknownprocessor () |
Methods | ||
---|---|---|
std::string | name () | |
Cast | ||
Stateful | to_stateful () | |
StatefulDestructible | to_statefuldestructible () |
C‡: boost::shared_ptr< ARDOUR::DiskWriter >, boost::weak_ptr< ARDOUR::DiskWriter >
+is-a: ARDOUR:DiskIOProcessor
+ +A mixer strip element - plugin, send, meter, etc
Methods | ||
---|---|---|
bool | isnil () |
Methods | ||
---|---|---|
void | activate () | |
bool | active () | |
long | capture_offset () | |
void | deactivate () | |
std::string | display_name () | |
bool | display_to_user () | |
long | input_latency () | |
ChanCount | input_streams () | |
long | output_latency () | |
ChanCount | output_streams () | |
long | playback_offset () | |
long | signal_latency () | |
Cast | ||
Amp | to_amp () | |
Automatable | to_automatable () | |
DelayLine | to_delayline () | |
DiskIOProcessor | to_diskioprocessor () | |
DiskReader | to_diskreader () | |
DiskWriter | to_diskwriter () | |
PluginInsert | to_insert () | |
InternalSend | to_internalsend () | |
IOProcessor | to_ioprocessor () | |
Latent | to_latent () | |
PeakMeter | to_meter () | |
MonitorProcessor | to_monitorprocessor () | |
PeakMeter | to_peakmeter () | |
PluginInsert | to_plugininsert () | |
PolarityProcessor | to_polarityprocessor () | |
Send | to_send () | |
SideChain | to_sidechain () | |
UnknownProcessor | to_unknownprocessor () |
Methods | ||
---|---|---|
std::string | name () | |
Cast | ||
Stateful | to_stateful () | |
StatefulDestructible | to_statefuldestructible () |
C‡: ARDOUR::DoubleBeatsSamplesConverter
+ +Converter between quarter-note beats and samples. Takes distances in quarter-note beats or samples from some origin (supplied to the constructor in samples), and converts them to the opposite unit, taking tempo changes into account.
Constructor | ||
---|---|---|
ℂ | ARDOUR.DoubleBeatsSamplesConverter (TempoMap, long) | |
Methods | ||
double | from (long) | |
Convert B time to A time (A from B) | ||
long | to (double) | |
Convert A time to B time (A to B) |
C‡: std::list<Evoral::ControlEvent* >
+ +Constructor | ||
---|---|---|
ℂ | ARDOUR.EventList () | |
Methods | ||
ControlEvent | back () | |
bool | empty () | |
ControlEvent | front () | |
LuaIter | iter () | |
void | reverse () | |
unsigned long | size () | |
LuaTable | table () |
C‡: boost::shared_ptr< ARDOUR::FileSource >, boost::weak_ptr< ARDOUR::FileSource >
+is-a: ARDOUR:Source
+ +A source associated with a file on disk somewhere
Methods | ||
---|---|---|
unsigned short | channel () | |
float | gain () | |
bool | isnil () | |
std::string | origin () | |
std::string | path () | |
std::string | take_id () | |
bool | within_session () |
Methods | ||
---|---|---|
std::string | ancestor_name () | |
bool | can_be_analysed () | |
XrunPositions | captured_xruns () | |
bool | empty () | |
bool | has_been_analysed () | |
long | length (long) | |
long | natural_position () | |
long | timeline_position () | |
long | timestamp () | |
int | use_count () | |
bool | used () | |
bool | writable () | |
Cast | ||
AudioSource | to_audiosource () | |
FileSource | to_filesource () | |
MidiSource | to_midisource () |
Methods | ||
---|---|---|
std::string | name () | |
Stateful | to_stateful () | |
StatefulDestructible | to_statefuldestructible () |
C‡: ARDOUR::AudioBackend::DeviceStatus
- -used to list device names along with whether or not they are currently available.
Data Members | ||
---|---|---|
bool | available | |
std::string | name |
C‡: std::vector<ARDOUR::AudioBackend::DeviceStatus >
- -Constructor | ||
---|---|---|
ℂ | ARDOUR.DeviceStatusVector () | |
ℂ | ARDOUR.DeviceStatusVector () | |
Methods | ||
LuaTable | add (LuaTable {DeviceStatus}) | |
DeviceStatus | at (unsigned long) | |
bool | empty () | |
LuaIter | iter () | |
void | push_back (DeviceStatus) | |
unsigned long | size () | |
LuaTable | table () |
C‡: ARDOUR::FluidSynth
Constructor | ||||
---|---|---|---|---|
ℂ | ARDOUR.FluidSynth (float, int) | |||
instantiate a Synth
| ||||
instantiate a Synth
| ||||
Methods | ||||
bool | load_sf2 (std::string) | |||
bool | midi_event (unsigned char*, unsigned long) |
C‡: boost::shared_ptr< ARDOUR::GainControl >, boost::weak_ptr< ARDOUR::GainControl >
-is-a: ARDOUR:SlavableAutomationControl,
+is-a: ARDOUR:SlavableAutomationControl
A PBD::Controllable with associated automation data (AutomationList)
Methods | ||
---|---|---|
bool | isnil () | |
bool | sameinstance (GainControl) |
Methods | ||||
---|---|---|---|---|
void | add_master (AutomationControl, bool) | |||
void | add_master (AutomationControl) | |||
void | clear_masters () | |||
int | get_boolean_masters () | |||
double | get_masters_value () | |||
Methods | ||||
AutomationList | alist () | |||
AutoState | automation_state () | |||
AutoStyle | automation_style () | |||
ParameterDescriptor | desc () | |||
double | get_value () | |||
Get the current effective `user' value based on automation state | ||||
Get `internal' value Returns raw value as used for the plugin/processor control port | ||||
double | lower () | |||
double | normal () | |||
void | set_automation_state (AutoState) | |||
void | set_automation_style (AutoStyle) | |||
void | set_value (double, GroupControlDisposition) | |||
Get and Set `internal' value All derived classes must implement this. Basic derived classes will ignore
| ||||
Set `internal' value All derived classes must implement this. Basic derived classes will ignore group_override but more sophisticated children, notably those that proxy the value setting logic via an object that is aware of group relationships between this control and others, will find it useful.
| ||||
void | start_touch (double) | |||
void | stop_touch (bool, double) | |||
void | stop_touch (double) | |||
bool | toggled () | |||
double | upper () | |||
bool | writable () | |||
Cast | ||||
Control | to_ctrl () | |||
SlavableAutomationControl | to_slavable () |
C‡: boost::shared_ptr< ARDOUR::IO >, boost::weak_ptr< ARDOUR::IO >
-is-a: ARDOUR:SessionObject
+is-a: ARDOUR:SessionObjectPtr
A collection of ports (all input or all output) with connections.
An IO can contain ports of varying types, making routes/inserts/etc with varied combinations of types (eg MIDI and audio) possible.
Methods | ||||||||
---|---|---|---|---|---|---|---|---|
bool | active () | |||||||
int | add_port (std::string, void*, DataType) | |||||||
Add a port.
| ||||||||
Add a port.
| ||||||||
AudioPort | audio (unsigned int) | |||||||
int | connect (Port, std::string, void*) | |||||||
int | disconnect (Port, std::string, void*) | |||||||
int | disconnect_all (void*) | |||||||
bool | has_port (Port) | |||||||
bool | isnil () | |||||||
long | latency () | |||||||
MidiPort | midi (unsigned int) | |||||||
ChanCount | n_ports () | |||||||
Port | nth (unsigned int) | |||||||
bool | physically_connected () | |||||||
Port | port_by_name (unsigned int) | |||||||
long | public_latency () | |||||||
int | remove_port (Port, void*) | |||||||
bool | sameinstance (IO) |
Methods | ||||||||
---|---|---|---|---|---|---|---|---|
std::string | name () |
Methods | ||
---|---|---|
IO | input () | |
ChanCount | natural_input_streams () | |
ChanCount | natural_output_streams () | |
IO | output () | |
bool | sameinstance (IOProcessor) |
Methods | ||
---|---|---|
void | activate () | |
bool | active () | |
long | capture_offset () | |
void | deactivate () | |
std::string | display_name () | |
bool | display_to_user () | |
ChanCount | input_streams () | |
ChanCount | output_streams () | |
long | input_latency () | |
ChanCount | input_streams () | |
long | output_latency () | |
ChanCount | output_streams () | |
long | playback_offset () | |
long | signal_latency () | |
Cast | ||
Amp | to_amp () | |
Automatable | to_automatable () | |
DelayLine | to_delayline () | |
DiskIOProcessor | to_diskioprocessor () | |
DiskReader | to_diskreader () | |
DiskWriter | to_diskwriter () | |
PluginInsert | to_insert () | |
InternalSend | to_internalsend () | |
IOProcessor | to_ioprocessor () | |
Latent | to_latent () | |
PeakMeter | to_meter () | |
MonitorProcessor | to_monitorprocessor () | |
PeakMeter | to_peakmeter () | |
PluginInsert | to_plugininsert () | |
PolarityProcessor | to_polarityprocessor () | |
Send | to_send () | |
SideChain | to_sidechain () | |
UnknownProcessor | to_unknownprocessor () |
Methods | ||
---|---|---|
std::string | name () | |
bool | done | |
float | progress |
C‡: boost::shared_ptr< ARDOUR::InternalReturn >, boost::weak_ptr< ARDOUR::InternalReturn >
+is-a: ARDOUR:Return
+ +A mixer strip element - plugin, send, meter, etc
Methods | ||
---|---|---|
bool | isnil () |
Methods | ||
---|---|---|
IO | input () | |
ChanCount | natural_input_streams () | |
ChanCount | natural_output_streams () | |
IO | output () |
Methods | ||
---|---|---|
void | activate () | |
bool | active () | |
long | capture_offset () | |
void | deactivate () | |
std::string | display_name () | |
bool | display_to_user () | |
long | input_latency () | |
ChanCount | input_streams () | |
long | output_latency () | |
ChanCount | output_streams () | |
long | playback_offset () | |
long | signal_latency () | |
Cast | ||
Amp | to_amp () | |
Automatable | to_automatable () | |
DelayLine | to_delayline () | |
DiskIOProcessor | to_diskioprocessor () | |
DiskReader | to_diskreader () | |
DiskWriter | to_diskwriter () | |
PluginInsert | to_insert () | |
InternalSend | to_internalsend () | |
IOProcessor | to_ioprocessor () | |
Latent | to_latent () | |
PeakMeter | to_meter () | |
MonitorProcessor | to_monitorprocessor () | |
PeakMeter | to_peakmeter () | |
PluginInsert | to_plugininsert () | |
PolarityProcessor | to_polarityprocessor () | |
Send | to_send () | |
SideChain | to_sidechain () | |
UnknownProcessor | to_unknownprocessor () |
Methods | ||
---|---|---|
std::string | name () | |
Cast | ||
Stateful | to_stateful () | |
StatefulDestructible | to_statefuldestructible () |
C‡: boost::shared_ptr< ARDOUR::InternalSend >, boost::weak_ptr< ARDOUR::InternalSend >
+is-a: ARDOUR:Send
+ +A mixer strip element (Processor) with 1 or 2 IO elements.
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 () |
Methods | ||
---|---|---|
PannerShell | panner_shell () |
Methods | ||
---|---|---|
IO | input () | |
ChanCount | natural_input_streams () | |
ChanCount | natural_output_streams () | |
IO | output () |
Methods | ||
---|---|---|
void | activate () | |
bool | active () | |
long | capture_offset () | |
void | deactivate () | |
bool | display_to_user () | |
long | input_latency () | |
ChanCount | input_streams () | |
long | output_latency () | |
ChanCount | output_streams () | |
long | playback_offset () | |
long | signal_latency () | |
Cast | ||
Amp | to_amp () | |
Automatable | to_automatable () | |
DelayLine | to_delayline () | |
DiskIOProcessor | to_diskioprocessor () | |
DiskReader | to_diskreader () | |
DiskWriter | to_diskwriter () | |
PluginInsert | to_insert () | |
InternalSend | to_internalsend () | |
IOProcessor | to_ioprocessor () | |
Latent | to_latent () | |
PeakMeter | to_meter () | |
MonitorProcessor | to_monitorprocessor () | |
PeakMeter | to_peakmeter () | |
PluginInsert | to_plugininsert () | |
PolarityProcessor | to_polarityprocessor () | |
Send | to_send () | |
SideChain | to_sidechain () | |
UnknownProcessor | to_unknownprocessor () |
Methods | ||
---|---|---|
std::string | name () | |
Cast | ||
Stateful | to_stateful () | |
StatefulDestructible | to_statefuldestructible () |
C‡: ARDOUR::LatencyRange
+ +Constructor | ||
---|---|---|
ℂ | ARDOUR.LatencyRange () | |
Data Members | ||
unsigned int | max | |
unsigned int | min |
C‡: boost::shared_ptr< ARDOUR::Latent >, boost::weak_ptr< ARDOUR::Latent >
+ +Methods | ||
---|---|---|
long | effective_latency () | |
bool | isnil () | |
void | set_user_latency (long) | |
void | unset_user_latency () | |
long | user_latency () |
C‡: ARDOUR::Location
is-a: PBD:StatefulDestructible
@@ -1214,11 +1962,14 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to CSet end position.
force | true to force setting, even if the given new end is before the current start. |
---|---|
allow_beat_recompute | True to recompute BEAT end time from the new given end time. |
s | New end. |
Set end position.
Set location name
Set start position.
s | New start. |
---|---|
force | true to force setting, even if the given new start is after the current end. |
allow_beat_recompute | True to recompute BEAT start time from the new given start time. |
Set start position.
Look for the `marks' (either locations which are marks, or start/end points of range markers) either side of a frame. Note that if frame is exactly on a `mark', that mark will not be considered for returning as before/after.
frame | Frame to look for. |
---|---|
before | Filled in with the position of the last `mark' before `frame' (or max_framepos if none exists) |
after | Filled in with the position of the next `mark' after `frame' (or max_framepos if none exists) |
Look for the `marks' (either locations which are marks, or start/end points of range markers) either side of a sample. Note that if sample is exactly on a `mark', that mark will not be considered for returning as before/after.
Methods | ||||||||
---|---|---|---|---|---|---|---|---|
std::string | ascii_dtostr (double) | |||||||
... | build_filename (--lua--) | |||||||
Creates a filename from a series of elements using the correct separator for filenames. No attempt is made to force the resulting filename to be an absolute path. If the first element is a relative path, the result will be a relative path. | ||||||||
... | color_to_rgba (--lua--) | |||||||
A convenience function to expand RGBA parameters from an integer convert a Canvas::Color (uint32_t 0xRRGGBBAA) into double RGBA values which can be passed as parameters to Cairo::Context::set_source_rgba Example: local r, g, b, a = ARDOUR.LuaAPI.color_to_rgba (0x88aa44ff) cairo_ctx:set_source_rgba (ARDOUR.LuaAPI.color_to_rgba (0x11336699) Returns 4 parameters: red, green, blue, alpha (in range 0..1) | ||||||||
std::string | file_get_contents (std::string) | |||||||
bool | file_test (std::string, FileTest) | |||||||
LuaTable(float, ...) | get_plugin_insert_param (PluginInsert, unsigned int, bool&) | |||||||
get a plugin control parameter value
Returns value | ||||||||
get a plugin control parameter value
Returns value | ||||||||
LuaTable(float, ...) | get_processor_param (Processor, unsigned int, bool&) | |||||||
get a plugin control parameter value
Returns value | ||||||||
get a plugin control parameter value
Returns value | ||||||||
... | hsla_to_rgba (--lua--) | |||||||
A convenience function for colorspace HSL to RGB conversion. All ranges are 0..1 Example: local r, g, b, a = ARDOUR.LuaAPI.hsla_to_rgba (hue, saturation, luminosity, alpha) Returns 4 parameters: red, green, blue, alpha (in range 0..1) | ||||||||
PluginInfoList | list_plugins () | |||||||
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) | ||||||||
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 | ||||||||
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 | 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 () @@ -1307,16 +2066,34 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C return ac:alist(), ac:to_ctrl():list(), t[2] end Example usage: get the third input parameter of first plugin on the given route (Ardour starts counting at zero). local al, cl, pd = ARDOUR.LuaAPI.plugin_automation (route:nth_plugin (0), 3) Returns 3 parameters: AutomationList, ControlList, ParamaterDescriptor | ||||||||
bool | reset_processor_to_default (Processor) | |||||||
reset a processor to its default values (only works for plugins ) This is a wrapper which looks up the Processor by plugin-insert.
Returns true on success, false when the processor is not a plugin | ||||||||
reset a processor to its default values (only works for plugins ) This is a wrapper which looks up the Processor by plugin-insert.
Returns true on success, false when the processor is not a plugin | ||||||||
... | sample_to_timecode (--lua--) | |||||||
Generic conversion from audio sample count to timecode. (TimecodeType, sample-rate, sample-pos) | ||||||||
void | segfault () | |||||||
Crash Test Dummy | ||||||||
bool | set_plugin_insert_param (PluginInsert, unsigned int, float) | |||||||
set a plugin control-input parameter value This is a wrapper around set_processor_param which looks up the Processor by plugin-insert.
Returns true on success, false on error or out-of-bounds value | ||||||||
set a plugin control-input parameter value This is a wrapper around set_processor_param which looks up the Processor by plugin-insert.
Returns true on success, false on error or out-of-bounds value | ||||||||
bool | set_processor_param (Processor, unsigned int, float) | |||||||
set a plugin control-input parameter value
Returns true on success, false on error or out-of-bounds value | ||||||||
set a plugin control-input parameter value
Returns true on success, false on error or out-of-bounds value | ||||||||
... | timecode_to_sample (--lua--) | |||||||
Generic conversion from timecode to audio sample count. (TimecodeType, sample-rate, hh, mm, ss, ff) | ||||||||
void | usleep (unsigned long) | |||||||
bool | wait_for_process_callback (unsigned long, long) | |||||||
Delay execution until next prcess cycle starts.
Returns true on success, false if timeout was reached or engine was not running |
C‡: ARDOUR::LuaAPI::Rubberband
+ +Constructor | ||
---|---|---|
ℂ | ARDOUR.LuaAPI.Rubberband (AudioRegion, bool) | |
Methods | ||
unsigned int | n_channels () | |
AudioRegion | process (Lua-Function) | |
Readable | readable () | |
long | readable_length () | |
bool | set_mapping (Lua-Function) | |
bool | set_strech_and_pitch (double, double) |
C‡: ARDOUR::LuaAPI::Vamp
@@ -1326,7 +2103,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to Chigh-level abstraction to process a single channel of the given Readable.
If the plugin is not yet initialized, initialize() is called.
if is not nil, it is called with the immediate Vamp::Plugin::Features on every process call.
r | readable |
---|---|
channel | channel to process |
fn | lua callback function |
Returns 0 on success
high-level abstraction to process a single channel of the given Readable.
If the plugin is not yet initialized, initialize() is called.
if fn is not nil, it is called with the immediate Vamp::Plugin::Features on every process call.
Returns 0 on success
initialize the plugin for use with analyze().
This is equivalent to plugin():initialise (1, ssiz, bsiz) and prepares a plugin for analyze. (by preferred step and block sizes are used. if the plugin does not specify them or they're larger than 8K, both are set to 1024)
Manual initialization is only required to set plugin-parameters which depend on prior initialization of the plugin.
vamp:reset () vamp:initialize () @@ -1335,7 +2112,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to CStringVector list_plugins () Plugin plugin () - FeatureSet process (FloatArrayVector, RealTime) + process given array of audio-samples.
This is a lua-binding for vamp:plugin():process ()
d audio-data, the vector must match the configured channel count and hold a complete buffer for every channel as set during plugin():initialise() rt timestamp matching the provided buffer. Returns features extracted from that data (if the plugin is causal)
process given array of audio-samples.
This is a lua-binding for vamp:plugin():process ()
- d
- audio-data, the vector must match the configured channel count and hold a complete buffer for every channel as set during plugin():initialise()
- rt
- timestamp matching the provided buffer.
Returns features extracted from that data (if the plugin is causal)
void reset () @@ -1346,10 +2123,10 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C call plugin():reset() and clear intialization flag
Constructor | ||||
---|---|---|---|---|
ℂ | ARDOUR.LuaOSC.Address (std::string) | |||
Construct a new OSC transmitter object
| ||||
Construct a new OSC transmitter object
| ||||
Methods | ||||
... | send (--lua--) | |||
Transmit an OSC message Path (string) and type (string) must always be given. The number of following args must match the type. Supported types are: 'i': integer (lua number) 'f': float (lua number) 'd': double (lua number) 'h': 64bit integer (lua number) 's': string (lua string) 'c': character (lua string) 'T': boolean (lua bool) -- this is not implicily True, a lua true/false must be given 'F': boolean (lua bool) -- this is not implicily False, a lua true/false must be given
Returns boolean true if successful, false on error. | ||||
Transmit an OSC message Path (string) and type (string) must always be given. The number of following args must match the type. Supported types are: 'i': integer (lua number) 'f': float (lua number) 'd': double (lua number) 'h': 64bit integer (lua number) 's': string (lua string) 'c': character (lua string) 'T': boolean (lua bool) -- this is not implicily True, a lua true/false must be given 'F': boolean (lua bool) -- this is not implicily False, a lua true/false must be given
Returns boolean true if successful, false on error. |
C‡: boost::shared_ptr< ARDOUR::LuaProc >, boost::weak_ptr< ARDOUR::LuaProc >
@@ -1359,7 +2136,6 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to CMethods | ||
---|---|---|
bool | isnil () | |
bool | sameinstance (LuaProc) | |
DspShm | shmem () | |
LuaTableRef | table () |
C‡: 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
@@ -1410,9 +2206,9 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to CC‡: ARDOUR::MeterSection
@@ -1421,15 +2217,23 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to CA section of timeline with a certain Meter.
Methods | ||
---|---|---|
BBT_TIME | bbt () | |
double | beat () | |
void | set_beat (double) | |
void | set_pulse (double) | |
Cast | ||
Meter | to_meter () |
Methods | ||
---|---|---|
bool | initial () | |
bool | is_tempo () | |
double | minute () | |
double | minute_at_sample (long) | |
double | pulse () | |
long | sample () | |
long | sample_at_minute (double) | |
void | set_pulse (double) |
C‡: ARDOUR::MetricSection
@@ -1437,7 +2241,13 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to CA section of timeline with a certain Tempo or Meter.
Methods | ||
---|---|---|
bool | initial () | |
bool | is_tempo () | |
double | minute () | |
double | minute_at_sample (long) | |
double | pulse () | |
long | sample () | |
long | sample_at_minute (double) | |
void | set_pulse (double) |
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.
Clear (eg zero, or empty) buffer
Start a new NoteDiff command.
This has no side-effects on the model or Session, the returned command can be held on to for as long as the caller wishes, or discarded without formality, until apply_command is called and ownership is taken.
Cast | ||
---|---|---|
Sequence | to_sequence () | |
Sequence | to_sequence () |
Methods | ||
---|---|---|
AutomationControl | automation_control (Parameter, bool) | |
Cast | ||
Slavable | to_slavable () |
C‡: ARDOUR::MidiModel::DiffCommand
@@ -1508,8 +2318,8 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to CBase class for Undo/Redo commands and changesets
Methods | ||
---|---|---|
void | add (NotePtr) | |
void | remove (NotePtr) | |
void | add (NotePtr) | |
void | remove (NotePtr) |
Methods | ||
---|---|---|
bool | isnil () | |
bool | sameinstance (MidiPlaylist) | |
void | set_note_mode (NoteMode) |
gap | from the beginning of the region to the next beginning |
---|
gap | from the beginning of the region to the next beginning |
---|---|
end | the first frame that does _not_ contain a duplicated frame |
start | Range start. |
---|---|
end | Range end. |
Returns regions which have some part within this range.
Returns regions which have some part within this range.
Methods | ||
---|---|---|
std::string | name () | |
MidiBuffer | get_midi_buffer (unsigned int) | |
bool | input_active () | |
bool | isnil () | |
bool | sameinstance (MidiPort) | |
void | set_input_active (bool) | |
Cast | ||
AsyncMIDIPort | to_asyncmidiport () |
bool | connected () | |||
Returns true if this port is connected to anything | ||||
bool | connected_to (std::string) | |||
Returns true if this port is connected to o, otherwise false. | ||||
Returns true if this port is connected to o, otherwise false. | ||||
int | disconnect (std::string) | |||
int | disconnect_all () | |||
PortFlags | flags () | |||
Returns flags | ||||
LuaTable(...) | get_connected_latency_range (LatencyRange&, bool) | |||
std::string | name () | |||
Returns Port short name | ||||
bool | physically_connected () | |||
std::string | pretty_name (bool) | |||
Returns Port human readable name | ||||
LatencyRange | private_latency_range (bool) | |||
LatencyRange | public_latency_range (bool) | |||
bool | receives_input () | |||
Returns true if this Port receives input, otherwise false | ||||
bool | sends_output () | |||
Returns true if this Port sends output, otherwise false | ||||
Cast | ||||
---|---|---|---|---|
AsyncMIDIPort | to_asyncmidiport () | |||
AudioPort | to_audioport () | |||
MidiPort | to_midiport () |
How the region parameters play together:
POSITION: first frame of the region along the timeline START: first frame of the region within its source(s) LENGTH: number of frames the region represents
How the region parameters play together:
POSITION: first sample of the region along the timeline START: first sample of the region within its source(s) LENGTH: number of samples the region represents
A gui may need to create a region, then place it in an initial position determined by the user. When this takes place within one gui operation, we have to reset _last_position to prevent an implied move.
A gui may need to create a region, then place it in an initial position determined by the user. When this takes place within one gui operation, we have to reset _last_position to prevent an implied move.
Note: changing the name of a Region does not constitute an edit
Set the region's sync point.
absolute_pos | Session time. |
---|
Set the region's sync point.
Returns Sync position in session time
Methods | ||
---|---|---|
std::string | name () | |
bool | isnil () | |
long | length (long) | |
MidiModel | model () | |
bool | sameinstance (MidiSource) |
Methods | ||
---|---|---|
std::string | ancestor_name () | |
bool | can_be_analysed () | |
bool | destructive () | |
XrunPositions | captured_xruns () | |
bool | has_been_analysed () | |
long | natural_position () | |
long | timeline_position () | |
bool | writable () | |
Cast | ||
AudioSource | to_audiosource () | |
FileSource | to_filesource () | |
MidiSource | to_midisource () |
Methods | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
std::string | name () |
Methods | ||
---|---|---|
bool | isnil () | |
bool | sameinstance (MidiTrack) | |
bool | write_immediate_event (EventType, unsigned long, unsigned char*) |
Methods | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
Region | bounce (InterThreadInfo&) | |||||||||||
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) | |||||||||||
Bounce the given range to a new audio region.
Returns a new audio region (or nil in case of error) | ||||||||||||
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, 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. | ||||||||||||
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. | ||||||||||||
bool | can_record () | |||||||||||
int | find_and_use_playlist (DataType, ID) | |||||||||||
Playlist | playlist () | |||||||||||
bool | set_name (std::string) | |||||||||||
int | use_copy_playlist () | |||||||||||
int | use_new_playlist (DataType) | |||||||||||
int | use_playlist (DataType, Playlist) | |||||||||||
Cast | ||||||||||||
AudioTrack | to_audio_track () | |||||||||||
MidiTrack | to_midi_track () |
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. | ||||||||||
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) | |||||||||
Amp | amp () | |||||||||
std::string | comment () | |||||||||
bool | customize_plugin_insert (Processor, unsigned int, ChanCount, ChanCount) | |||||||||
enable custom plugin-insert configuration
Returns true if successful | ||||||||||
enable custom plugin-insert configuration
Returns true if successful | ||||||||||
DataType | data_type () | |||||||||
IO | input () | |||||||||
Delivery | main_outs () | |||||||||
the signal processorat at end of the processing chain which produces output | ||||||||||
PannerShell | panner_shell () | |||||||||
PeakMeter | peak_meter () | |||||||||
************************************************************* Pure interface begins here************************************************************* | ||||||||||
long | playback_latency (bool) | |||||||||
int | remove_processor (Processor, ProcessorStreams, bool) | |||||||||
remove plugin/processor
Returns 0 on success | ||||||||||
remove plugin/processor
Returns 0 on success | ||||||||||
int | remove_processors (ProcessorList, ProcessorStreams) | |||||||||
bool | remove_sidechain (Processor) | |||||||||
int | reorder_processors (ProcessorList, ProcessorStreams) | |||||||||
int | replace_processor (Processor, Processor, ProcessorStreams) | |||||||||
replace plugin/processor with another
Returns 0 on success | ||||||||||
replace plugin/processor with another
Returns 0 on success | ||||||||||
bool | reset_plugin_insert (Processor) | |||||||||
reset plugin-insert configuration to default, disable customizations. This is equivalent to calling customize_plugin_insert (proc, 0, unused)
Returns true if successful | ||||||||||
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 () | |||||||||
bool | strict_io () | |||||||||
Processor | the_instrument () | |||||||||
Return the first processor that accepts has at least one MIDI input and at least one audio output. In the vast majority of cases, this will be "the instrument". This does not preclude other MIDI->audio processors later in the processing chain, but that would be a special case not covered by this utility function. | ||||||||||
Amp | trim () | |||||||||
Cast | ||||||||||
Automatable | to_automatable () | |||||||||
Track | to_track () |
Methods | ||
---|---|---|
AutomationControl | comp_enable_control () | |
AutomationControl | comp_makeup_control () | |
AutomationControl | comp_mode_control () | |
AutomationControl | comp_enable_controllable () | |
AutomationControl | comp_makeup_controllable () | |
AutomationControl | comp_mode_controllable () | |
std::string | comp_mode_name (unsigned int) | |
AutomationControl | comp_redux_control () | |
AutomationControl | comp_speed_control () | |
ReadOnlyControl | comp_redux_controllable () | |
AutomationControl | comp_speed_controllable () | |
std::string | comp_speed_name (unsigned int) | |
AutomationControl | comp_threshold_control () | |
AutomationControl | comp_threshold_controllable () | |
unsigned int | eq_band_cnt () | |
std::string | eq_band_name (unsigned int) | |
AutomationControl | eq_enable_control () | |
AutomationControl | eq_freq_control (unsigned int) | |
AutomationControl | eq_gain_control (unsigned int) | |
AutomationControl | eq_hpf_control () | |
AutomationControl | eq_q_control (unsigned int) | |
AutomationControl | eq_shape_control (unsigned int) | |
AutomationControl | eq_enable_controllable () | |
AutomationControl | eq_freq_controllable (unsigned int) | |
AutomationControl | eq_gain_controllable (unsigned int) | |
AutomationControl | eq_q_controllable (unsigned int) | |
AutomationControl | eq_shape_controllable (unsigned int) | |
AutomationControl | filter_enable_controllable (bool) | |
AutomationControl | filter_freq_controllable (bool) | |
AutomationControl | filter_slope_controllable (bool) | |
GainControl | gain_control () | |
bool | is_auditioner () | |
bool | is_hidden () | |
bool | is_master () | |
bool | is_monitor () | |
bool | is_private_route () | |
bool | is_selected () | |
AutomationControl | master_send_enable_control () | |
AutomationControl | master_send_enable_controllable () | |
MonitorProcessor | monitor_control () | |
MuteControl | mute_control () | |
AutomationControl | pan_azimuth_control () | |
PresentationInfo | presentation_info_ptr () | |
AutomationControl | rec_enable_control () | |
AutomationControl | rec_safe_control () | |
AutomationControl | send_enable_control (unsigned int) | |
AutomationControl | send_level_control (unsigned int) | |
AutomationControl | send_enable_controllable (unsigned int) | |
AutomationControl | send_level_controllable (unsigned int) | |
std::string | send_name (unsigned int) | |
AutomationControl | send_pan_azimuth_controllable (unsigned int) | |
AutomationControl | send_pan_azimuth_enable_controllable (unsigned int) | |
void | set_presentation_order (unsigned int) | |
bool | slaved () | |
bool | slaved_to (VCA) | |
SoloControl | solo_control () | |
SoloIsolateControl | solo_isolate_control () | |
SoloSafeControl | solo_safe_control () | |
GainControl | trim_control () | |
Cast | ||
Automatable | to_automatable () | |
Route | to_route () | |
Slavable | to_slavable () | |
VCA | to_vca () |
Methods | ||
---|---|---|
std::string | name () | |
ℂ | ARDOUR.MidiTrackList () | |
Methods | ||
LuaTable | add (LuaTable {MidiTrack}) | |
MidiTrack | back () | |
MidiTrack | back () | |
bool | empty () | |
MidiTrack | front () | |
MidiTrack | front () | |
LuaIter | iter () | |
void | push_back (MidiTrack) | |
void | reverse () | |
bool | monitor_active () | |
bool | mono () | |
Controllable | mono_control () | |
bool | sameinstance (MonitorProcessor) | |
void | set_cut (unsigned int, bool) | |
void | set_cut_all (bool) | |
void | set_dim (unsigned int, bool) | |
Methods | ||
void | activate () | |
bool | active () | |
long | capture_offset () | |
void | deactivate () | |
std::string | display_name () | |
bool | display_to_user () | |
ChanCount | input_streams () | |
ChanCount | output_streams () | |
long | input_latency () | |
ChanCount | input_streams () | |
long | output_latency () | |
ChanCount | output_streams () | |
long | playback_offset () | |
long | signal_latency () | |
Cast | ||
Amp | to_amp () | |
Automatable | to_automatable () | |
DelayLine | to_delayline () | |
DiskIOProcessor | to_diskioprocessor () | |
DiskReader | to_diskreader () | |
DiskWriter | to_diskwriter () | |
PluginInsert | to_insert () | |
InternalSend | to_internalsend () | |
IOProcessor | to_ioprocessor () | |
Latent | to_latent () | |
PeakMeter | to_meter () | |
MonitorProcessor | to_monitorprocessor () | |
PeakMeter | to_peakmeter () | |
PluginInsert | to_plugininsert () | |
PolarityProcessor | to_polarityprocessor () | |
Send | to_send () | |
SideChain | to_sidechain () | |
UnknownProcessor | to_unknownprocessor () |
Methods | ||
---|---|---|
std::string | name () | |
Stateful | to_stateful () | |
StatefulDestructible | to_statefuldestructible () |
C‡: ARDOUR::MusicFrame
+C‡: ARDOUR::MusicSample
Constructor | ||
---|---|---|
ℂ | ARDOUR.MusicFrame (long, int) | |
ℂ | ARDOUR.MusicSample (long, int) | |
Methods | ||
void | set (long, int) | |
void | set (long, int) | |
Data Members | ||
int | division | |
long | frame | |
long | sample |
C‡: boost::shared_ptr< ARDOUR::MuteControl >, boost::weak_ptr< ARDOUR::MuteControl >
-is-a: ARDOUR:SlavableAutomationControl,
+is-a: ARDOUR:SlavableAutomationControl
A PBD::Controllable with associated automation data (AutomationList)
bool | isnil () | |
bool | muted () | |
bool | muted_by_self () | |
bool | sameinstance (MuteControl) |
Methods | ||||
---|---|---|---|---|
void | add_master (AutomationControl, bool) | |||
void | add_master (AutomationControl) | |||
void | clear_masters () | |||
int | get_boolean_masters () | |||
double | get_masters_value () | |||
Methods | ||||
AutomationList | alist () | |||
AutoState | automation_state () | |||
AutoStyle | automation_style () | |||
ParameterDescriptor | desc () | |||
double | get_value () | |||
Get the current effective `user' value based on automation state | ||||
Get `internal' value Returns raw value as used for the plugin/processor control port | ||||
double | lower () | |||
double | normal () | |||
void | set_automation_state (AutoState) | |||
void | set_automation_style (AutoStyle) | |||
void | set_value (double, GroupControlDisposition) | |||
Get and Set `internal' value All derived classes must implement this. Basic derived classes will ignore
| ||||
Set `internal' value All derived classes must implement this. Basic derived classes will ignore group_override but more sophisticated children, notably those that proxy the value setting logic via an object that is aware of group relationships between this control and others, will find it useful.
| ||||
void | start_touch (double) | |||
void | stop_touch (bool, double) | |||
void | stop_touch (double) | |||
bool | toggled () | |||
double | upper () | |||
bool | writable () | |||
Cast | ||||
Control | to_ctrl () | |||
SlavableAutomationControl | to_slavable () |
ID | id () | |
OwnedPropertyList | properties () |
C‡: std::list<boost::shared_ptr<Evoral::Note<Temporal::Beats> > > >
+ +Constructor | ||
---|---|---|
ℂ | ARDOUR.NotePtrList () | |
Methods | ||
LuaTable | add (LuaTable {Beats}) | |
NotePtr | back () | |
bool | empty () | |
NotePtr | front () | |
LuaIter | iter () | |
void | push_back (NotePtr) | |
void | reverse () | |
unsigned long | size () | |
LuaTable | table () | |
void | unique () |
C‡: PBD::OwnedPropertyList
is-a: ARDOUR:PropertyList
-A variant of PropertyList that does not delete its property list in its destructor. Objects with their own Properties store them in an OwnedPropertyList to avoid having them deleted at the wrong time.
Persistent Property List
A variant of PropertyList that does not delete its property list in its destructor. Objects with their own Properties store them in an OwnedPropertyList to avoid having them deleted at the wrong time.
This class object is only used indirectly as return-value and function-parameter. It provides no methods by itself.
+C‡: ARDOUR::Latent
+ +Methods | ||
---|---|---|
void | force_zero_latency (bool) | |
bool | zero_latency () |
C‡: boost::shared_ptr< ARDOUR::PannerShell >, boost::weak_ptr< ARDOUR::PannerShell >
-is-a: ARDOUR:SessionObject
+is-a: ARDOUR:SessionObjectPtr
Class to manage panning by instantiating and controlling an appropriate Panner object for a given in/out configuration.
Methods | ||
---|---|---|
bool | bypassed () | |
bool | isnil () | |
bool | sameinstance (PannerShell) | |
void | set_bypassed (bool) |
Methods | ||
---|---|---|
std::string | name () | |
Constructor | ||
ℂ | ARDOUR.ParameterDescriptor () | |
Methods | ||
std::string | midi_note_name (unsigned char) | |
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 | |
bool | logarithmic | |
float | largestep | |
std::string | print_fmt | |
format string for pretty printing | ||
float | smallstep | |
bool | sr_dependent | |
float | step |
Constructor | ||
---|---|---|
ℂ | Evoral.ParameterDescriptor () | |
Data Members | ||
bool | logarithmic | |
True for log-scale parameters | ||
float | lower | |
Minimum value (in Hz, for frequencies) | ||
float | normal | |
Methods | ||
bool | isnil () | |
float | meter_level (unsigned int, MeterType) | |
MeterType | meter_type () | |
void | reset_max () | |
bool | sameinstance (PeakMeter) | |
void | set_type (MeterType) | |
void | set_meter_type (MeterType) |
Methods | ||
---|---|---|
void | activate () | |
bool | active () | |
long | capture_offset () | |
void | deactivate () | |
std::string | display_name () | |
bool | display_to_user () | |
ChanCount | input_streams () | |
ChanCount | output_streams () | |
long | input_latency () | |
ChanCount | input_streams () | |
long | output_latency () | |
ChanCount | output_streams () | |
long | playback_offset () | |
long | signal_latency () | |
Cast | ||
Amp | to_amp () | |
Automatable | to_automatable () | |
DelayLine | to_delayline () | |
DiskIOProcessor | to_diskioprocessor () | |
DiskReader | to_diskreader () | |
DiskWriter | to_diskwriter () | |
PluginInsert | to_insert () | |
InternalSend | to_internalsend () | |
IOProcessor | to_ioprocessor () | |
Latent | to_latent () | |
PeakMeter | to_meter () | |
MonitorProcessor | to_monitorprocessor () | |
PeakMeter | to_peakmeter () | |
PluginInsert | to_plugininsert () | |
PolarityProcessor | to_polarityprocessor () | |
Send | to_send () | |
SideChain | to_sidechain () | |
UnknownProcessor | to_unknownprocessor () |
Methods | ||||||
---|---|---|---|---|---|---|
std::string | name () | |||||
Methods | ||||||
bool | inverted (unsigned int) | |||||
bool | isnil () | |||||
bool | sameinstance (PhaseControl) | |||||
void | set_phase_invert (unsigned int, bool) | |||||
| ||||||
|
Methods | ||||
---|---|---|---|---|
AutomationList | alist () | |||
AutoState | automation_state () | |||
AutoStyle | automation_style () | |||
ParameterDescriptor | desc () | |||
double | get_value () | |||
Get the current effective `user' value based on automation state | ||||
Get `internal' value Returns raw value as used for the plugin/processor control port | ||||
double | lower () | |||
double | normal () | |||
void | set_automation_state (AutoState) | |||
void | set_automation_style (AutoStyle) | |||
void | set_value (double, GroupControlDisposition) | |||
Get and Set `internal' value All derived classes must implement this. Basic derived classes will ignore
| ||||
Set `internal' value All derived classes must implement this. Basic derived classes will ignore group_override but more sophisticated children, notably those that proxy the value setting logic via an object that is aware of group relationships between this control and others, will find it useful.
| ||||
void | start_touch (double) | |||
void | stop_touch (bool, double) | |||
void | stop_touch (double) | |||
bool | toggled () | |||
double | upper () | |||
bool | writable () | |||
Cast | ||||
Control | to_ctrl () | |||
SlavableAutomationControl | to_slavable () |
C‡: boost::shared_ptr< ARDOUR::Playlist >, boost::weak_ptr< ARDOUR::Playlist >
-is-a: ARDOUR:SessionObject
+is-a: ARDOUR:SessionObjectPtr
A named object associated with a Session. Objects derived from this class are expected to be destroyed before the session calls drop_references().
Playlist | cut (AudioRangeList&, bool) | |||||
DataType | data_type () | |||||
void | duplicate (Region, long, long, float) | |||||
| ||||||
| ||||||
void | duplicate_range (AudioRange&, float) | |||||
void | duplicate_until (Region, long, long, long) | |||||
| ||||||
| ||||||
bool | empty () | |||||
Region | find_next_region (long, RegionPoint, int) | |||||
long | find_next_region_boundary (long, int) | |||||
long | find_next_transient (long, int) | |||||
ID | get_orig_track_id () | |||||
bool | hidden () | |||||
bool | isnil () | |||||
void | lower_region (Region) | |||||
void | lower_region_to_bottom (Region) | |||||
RegionListPtr | region_list () | |||||
RegionListPtr | regions_at (long) | |||||
RegionListPtr | regions_touched (long, long) | |||||
Returns regions which have some part within this range. | ||||||
Returns regions which have some part within this range. | ||||||
RegionListPtr | regions_with_end_within (Range) | |||||
RegionListPtr | regions_with_start_within (Range) | |||||
void | remove_region (Region) | |||||
bool | sameinstance (Playlist) | |||||
void | split (long) | |||||
void | split_region (Region, MusicFrame) | |||||
bool | set_name (std::string) | |||||
bool | shared () | |||||
void | split_region (Region, MusicSample) | |||||
Region | top_region_at (long) | |||||
Region | top_unmuted_region_at (long) | |||||
void | uncombine (Region) | |||||
bool | used () | |||||
Cast | ||||||
---|---|---|---|---|---|---|
AudioPlaylist | to_audioplaylist () | |||||
MidiPlaylist | to_midiplaylist () |
Methods | ||
---|---|---|
std::string | name () | |
Stateful | to_stateful () | |
StatefulDestructible | to_statefuldestructible () |
C‡: std::vector<boost::shared_ptr<ARDOUR::Playlist> >
+ +Constructor | ||
---|---|---|
ℂ | ARDOUR.PlaylistList () | |
ℂ | ARDOUR.PlaylistList () | |
Methods | ||
LuaTable | add (LuaTable {Playlist}) | |
Playlist | at (unsigned long) | |
void | clear () | |
bool | empty () | |
LuaIter | iter () | |
void | push_back (Playlist) | |
unsigned long | size () | |
LuaTable | table () | |
... | to_array (--lua--) |
C‡: boost::shared_ptr< ARDOUR::Plugin >, boost::weak_ptr< ARDOUR::Plugin >
is-a: PBD:StatefulDestructiblePtr
@@ -2235,10 +3172,13 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to CMethods | ||
---|---|---|
bool | isnil () | |
bool | sameinstance (PluginControl) |
Methods | ||||
---|---|---|---|---|
AutomationList | alist () | |||
AutoState | automation_state () | |||
AutoStyle | automation_style () | |||
ParameterDescriptor | desc () | |||
double | get_value () | |||
Get the current effective `user' value based on automation state | ||||
Get `internal' value Returns raw value as used for the plugin/processor control port | ||||
double | lower () | |||
double | normal () | |||
void | set_automation_state (AutoState) | |||
void | set_automation_style (AutoStyle) | |||
void | set_value (double, GroupControlDisposition) | |||
Get and Set `internal' value All derived classes must implement this. Basic derived classes will ignore
| ||||
Set `internal' value All derived classes must implement this. Basic derived classes will ignore group_override but more sophisticated children, notably those that proxy the value setting logic via an object that is aware of group relationships between this control and others, will find it useful.
| ||||
void | start_touch (double) | |||
void | stop_touch (bool, double) | |||
void | stop_touch (double) | |||
bool | toggled () | |||
double | upper () | |||
bool | writable () | |||
Cast | ||||
Control | to_ctrl () | |||
SlavableAutomationControl | to_slavable () |
PresetVector | get_presets (bool) | |
bool | is_instrument () | |
bool | isnil () | |
bool | sameinstance (PluginInfo) | |
Data Members | ||
---|---|---|
std::string | category | |
std::string | creator | |
ARDOUR:ChanCount | n_outputs | |
std::string | name | |
std::string | path | |
ARDOUR.PluginType | type | |
ARDOUR.PluginType | type | |
std::string | unique_id |
C‡: std::list<boost::shared_ptr<ARDOUR::PluginInfo> >
+ +Constructor | ||
---|---|---|
ℂ | ARDOUR.PluginInfoList () | |
Methods | ||
LuaTable | add (LuaTable {PluginInfo}) | |
PluginInfo | back () | |
bool | empty () | |
PluginInfo | front () | |
LuaIter | iter () | |
void | push_back (PluginInfo) | |
void | reverse () | |
unsigned long | size () | |
LuaTable | table () | |
void | unique () |
C‡: boost::shared_ptr< ARDOUR::PluginInsert >, boost::weak_ptr< ARDOUR::PluginInsert >
is-a: ARDOUR:Processor
@@ -2331,40 +3291,122 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to CMethods | ||
---|---|---|
void | activate () | |
void | clear_stats () | |
void | deactivate () | |
void | enable (bool) | |
bool | enabled () | |
unsigned int | get_count () | |
LuaTable(bool, ...) | get_stats (unsigned long&, unsigned long&, double&, double&) | |
bool | has_sidechain () | |
ChanMapping | input_map (unsigned int) | |
bool | is_channelstrip () | |
bool | is_instrument () | |
bool | isnil () | |
ChanCount | natural_input_streams () | |
ChanCount | natural_output_streams () | |
ChanMapping | output_map (unsigned int) | |
Plugin | plugin (unsigned int) | |
bool | reset_parameters_to_default () | |
bool | sameinstance (PluginInsert) | |
void | set_input_map (unsigned int, ChanMapping) | |
void | set_output_map (unsigned int, ChanMapping) | |
void | set_thru_map (ChanMapping) | |
long | signal_latency () | |
bool | strict_io_configured () | |
ChanMapping | thru_map () | |
PluginType | type () | |
bool | write_immediate_event (EventType, unsigned long, unsigned char*) |
Methods | ||
---|---|---|
bool | active () | |
long | capture_offset () | |
std::string | display_name () | |
bool | display_to_user () | |
ChanCount | input_streams () | |
ChanCount | output_streams () | |
long | input_latency () | |
ChanCount | input_streams () | |
long | output_latency () | |
ChanCount | output_streams () | |
long | playback_offset () | |
Cast | ||
Amp | to_amp () | |
Automatable | to_automatable () | |
DelayLine | to_delayline () | |
DiskIOProcessor | to_diskioprocessor () | |
DiskReader | to_diskreader () | |
DiskWriter | to_diskwriter () | |
PluginInsert | to_insert () | |
InternalSend | to_internalsend () | |
IOProcessor | to_ioprocessor () | |
Latent | to_latent () | |
PeakMeter | to_meter () | |
MonitorProcessor | to_monitorprocessor () | |
PeakMeter | to_peakmeter () | |
PluginInsert | to_plugininsert () | |
PolarityProcessor | to_polarityprocessor () | |
Send | to_send () | |
SideChain | to_sidechain () | |
UnknownProcessor | to_unknownprocessor () |
Methods | ||
---|---|---|
std::string | name () | |
Cast | ||
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
+ +A mixer strip element - plugin, send, meter, etc
Methods | ||
---|---|---|
bool | isnil () |
Methods | ||
---|---|---|
void | activate () | |
bool | active () | |
long | capture_offset () | |
void | deactivate () | |
std::string | display_name () | |
bool | display_to_user () | |
long | input_latency () | |
ChanCount | input_streams () | |
long | output_latency () | |
ChanCount | output_streams () | |
long | playback_offset () | |
long | signal_latency () | |
Cast | ||
Amp | to_amp () | |
Automatable | to_automatable () | |
DelayLine | to_delayline () | |
DiskIOProcessor | to_diskioprocessor () | |
DiskReader | to_diskreader () | |
DiskWriter | to_diskwriter () | |
PluginInsert | to_insert () | |
InternalSend | to_internalsend () | |
IOProcessor | to_ioprocessor () | |
Latent | to_latent () | |
PeakMeter | to_meter () | |
MonitorProcessor | to_monitorprocessor () | |
PeakMeter | to_peakmeter () | |
PluginInsert | to_plugininsert () | |
PolarityProcessor | to_polarityprocessor () | |
Send | to_send () | |
SideChain | to_sidechain () | |
UnknownProcessor | to_unknownprocessor () |
Methods | ||||
---|---|---|---|---|
std::string | name () | |||
bool | connected () | |||
Returns true if this port is connected to anything | ||||
bool | connected_to (std::string) | |||
Returns true if this port is connected to o, otherwise false. | ||||
Returns true if this port is connected to o, otherwise false. | ||||
int | disconnect (std::string) | |||
int | disconnect_all () | |||
PortFlags | flags () | |||
Returns flags | ||||
LuaTable(...) | get_connected_latency_range (LatencyRange&, bool) | |||
bool | isnil () | |||
std::string | name () | |||
Returns Port short name | ||||
bool | physically_connected () | |||
std::string | pretty_name (bool) | |||
Returns Port human readable name | ||||
LatencyRange | private_latency_range (bool) | |||
LatencyRange | public_latency_range (bool) | |||
bool | receives_input () | |||
Returns true if this Port receives input, otherwise false | ||||
bool | sameinstance (Port) | |||
bool | sends_output () | |||
Returns true if this Port sends output, otherwise false | ||||
Cast | ||||
AsyncMIDIPort | to_asyncmidiport () | |||
AudioPort | to_audioport () | |||
MidiPort | to_midiport () |
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> >
@@ -2410,9 +3457,9 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to Cname | Full or short name of port |
---|
Returns Corresponding Port or 0.
Returns Corresponding Port or 0.
C‡: boost::shared_ptr< ARDOUR::PortSet >, boost::weak_ptr< ARDOUR::PortSet >
@@ -2455,9 +3503,8 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to Cnth port of type t, or nth port if t = NIL
t | data type |
---|---|
index | port index |
nth port of type t, or nth port if t = NIL
C‡: ARDOUR::PresentationInfo
@@ -2467,8 +3514,10 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to CMethods | ||
---|---|---|
unsigned int | color () | |
Flag | flags () | |
unsigned int | order () | |
void | set_color (unsigned int) | |
bool | special (bool) |
Methods | ||
---|---|---|
LuaTable | add (LuaTable {PresetRecord}) | |
PresetRecord | at (unsigned long) | |
void | clear () | |
bool | empty () | |
LuaIter | iter () | |
void | push_back (PresetRecord) | |
unsigned long | size () | |
LuaTable | table () | |
... | to_array (--lua--) |
C‡: boost::shared_ptr< ARDOUR::Processor >, boost::weak_ptr< ARDOUR::Processor >
-is-a: ARDOUR:SessionObject
+is-a: ARDOUR:SessionObjectPtr
A mixer strip element - plugin, send, meter, etc
Methods | ||
---|---|---|
void | activate () | |
bool | active () | |
long | capture_offset () | |
void | deactivate () | |
std::string | display_name () | |
bool | display_to_user () | |
ChanCount | input_streams () | |
long | input_latency () | |
ChanCount | input_streams () | |
bool | isnil () | |
ChanCount | output_streams () | |
bool | sameinstance (Processor) | |
long | output_latency () | |
ChanCount | output_streams () | |
long | playback_offset () | |
long | signal_latency () | |
Cast | ||
Amp | to_amp () | |
Automatable | to_automatable () | |
DelayLine | to_delayline () | |
DiskIOProcessor | to_diskioprocessor () | |
DiskReader | to_diskreader () | |
DiskWriter | to_diskwriter () | |
PluginInsert | to_insert () | |
InternalSend | to_internalsend () | |
IOProcessor | to_ioprocessor () | |
Latent | to_latent () | |
PeakMeter | to_meter () | |
MonitorProcessor | to_monitorprocessor () | |
PeakMeter | to_peakmeter () | |
PluginInsert | to_plugininsert () | |
PolarityProcessor | to_polarityprocessor () | |
Send | to_send () | |
SideChain | to_sidechain () | |
UnknownProcessor | to_unknownprocessor () |
Methods | ||
---|---|---|
std::string | name () | |
ℂ | ARDOUR.ProcessorList () | |
Methods | ||
LuaTable | add (LuaTable {Processor}) | |
Processor | back () | |
Processor | back () | |
bool | empty () | |
Processor | front () | |
Processor | front () | |
LuaIter | iter () | |
void | push_back (Processor) | |
void | reverse () | |
Methods | ||
LuaTable | add (LuaTable {Processor}) | |
Processor | at (unsigned long) | |
void | clear () | |
bool | empty () | |
LuaIter | iter () | |
void | push_back (Processor) | |
unsigned long | size () | |
LuaTable | table () | |
... | to_array (--lua--) |
C‡: ARDOUR::Progress
@@ -2589,7 +3654,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to CC‡: PBD::PropertyDescriptor<float>
This class object is only used indirectly as return-value and function-parameter. It provides no methods by itself.
-C‡: PBD::PropertyDescriptor<long>
This class object is only used indirectly as return-value and function-parameter. It provides no methods by itself.
@@ -2599,29 +3664,572 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to CA list of IDs of Properties that have changed in some situation or other
Methods | ||
---|---|---|
bool | containsBool (BoolProperty) | |
bool | containsFloat (FloatProperty) | |
bool | containsFramePos (FrameposProperty) | |
bool | containsBool (BoolProperty) | |
bool | containsFloat (FloatProperty) | |
bool | containsSamplePos (SampleposProperty) |
C‡: PBD::PropertyList
+ +A list of properties, mapped using their ID
This class object is only used indirectly as return-value and function-parameter. It provides no methods by itself.
+C‡: ARDOUR::RCConfiguration
+is-a: PBD:Configuration
+ +Base class for objects with saveable and undoable state
Methods | ||
---|---|---|
AFLPosition | get_afl_position () | |
bool | get_all_safe () | |
bool | get_allow_special_bus_removal () | |
bool | get_ask_replace_instrument () | |
bool | get_ask_setup_instrument () | |
float | get_audio_capture_buffer_seconds () | |
float | get_audio_playback_buffer_seconds () | |
std::string | get_auditioner_output_left () | |
std::string | get_auditioner_output_right () | |
bool | get_auto_analyse_audio () | |
bool | get_auto_connect_standard_busses () | |
bool | get_auto_input_does_talkback () | |
AutoReturnTarget | get_auto_return_target_list () | |
bool | get_automation_follows_regions () | |
float | get_automation_interval_msecs () | |
double | get_automation_thinning_factor () | |
BufferingPreset | get_buffering_preset () | |
std::string | get_click_emphasis_sound () | |
float | get_click_gain () | |
bool | get_click_record_only () | |
std::string | get_click_sound () | |
bool | get_clicking () | |
bool | get_conceal_lv1_if_lv2_exists () | |
bool | get_conceal_vst2_if_vst3_exists () | |
bool | get_copy_demo_sessions () | |
bool | get_create_xrun_marker () | |
FadeShape | get_default_fade_shape () | |
std::string | get_default_session_parent_dir () | |
DenormalModel | get_denormal_model () | |
bool | get_denormal_protection () | |
bool | get_disable_disarm_during_roll () | |
bool | get_discover_audio_units () | |
bool | get_discover_vst_on_start () | |
unsigned int | get_disk_choice_space_threshold () | |
std::string | get_donate_url () | |
EditMode | get_edit_mode () | |
bool | get_exclusive_solo () | |
float | get_export_preroll () | |
float | get_export_silence_threshold () | |
unsigned int | get_feedback_interval_ms () | |
bool | get_first_midi_bank_is_zero () | |
std::string | get_freesound_download_dir () | |
bool | get_hide_dummy_backend () | |
bool | get_hiding_groups_deactivates_groups () | |
int | get_history_depth () | |
int | get_initial_program_change () | |
AutoConnectOption | get_input_auto_connect () | |
int | get_inter_scene_gap_samples () | |
bool | get_latched_record_enable () | |
LayerModel | get_layer_model () | |
unsigned int | get_limit_n_automatables () | |
bool | get_link_send_and_route_panner () | |
std::string | get_linux_pingback_url () | |
ListenPosition | get_listen_position () | |
bool | get_locate_while_waiting_for_sync () | |
LoopFadeChoice | get_loop_fade_choice () | |
bool | get_loop_is_mode () | |
std::string | get_ltc_output_port () | |
float | get_ltc_output_volume () | |
bool | get_ltc_send_continuously () | |
float | get_max_gain () | |
unsigned int | get_max_recent_sessions () | |
unsigned int | get_max_recent_templates () | |
float | get_max_transport_speed () | |
float | get_meter_falloff () | |
MeterType | get_meter_type_bus () | |
MeterType | get_meter_type_master () | |
MeterType | get_meter_type_track () | |
std::string | get_midi_audition_synth_uri () | |
bool | get_midi_clock_sets_tempo () | |
bool | get_midi_feedback () | |
bool | get_midi_input_follows_selection () | |
float | get_midi_track_buffer_seconds () | |
unsigned int | get_minimum_disk_read_bytes () | |
unsigned int | get_minimum_disk_write_bytes () | |
bool | get_mmc_control () | |
int | get_mmc_receive_device_id () | |
int | get_mmc_send_device_id () | |
std::string | get_monitor_bus_preferred_bundle () | |
MonitorModel | get_monitoring_model () | |
int | get_mtc_qf_speed_tolerance () | |
bool | get_mute_affects_control_outs () | |
bool | get_mute_affects_main_outs () | |
bool | get_mute_affects_post_fader () | |
bool | get_mute_affects_pre_fader () | |
bool | get_new_plugins_active () | |
unsigned int | get_osc_port () | |
std::string | get_osx_pingback_url () | |
AutoConnectOption | get_output_auto_connect () | |
unsigned int | get_periodic_safety_backup_interval () | |
bool | get_periodic_safety_backups () | |
PFLPosition | get_pfl_position () | |
std::string | get_plugin_path_lxvst () | |
std::string | get_plugin_path_vst () | |
std::string | get_plugin_path_vst3 () | |
bool | get_plugins_stop_with_transport () | |
long | get_postroll () | |
long | get_preroll () | |
float | get_preroll_seconds () | |
int | get_processor_usage () | |
bool | get_quieten_at_speed () | |
long | get_range_location_minimum () | |
RangeSelectionAfterSplit | get_range_selection_after_split () | |
bool | get_recording_resets_xrun_count () | |
std::string | get_reference_manual_url () | |
bool | get_region_boundaries_from_onscreen_tracks () | |
bool | get_region_boundaries_from_selected_tracks () | |
RegionEquivalence | get_region_equivalence () | |
RegionSelectionAfterSplit | get_region_selection_after_split () | |
bool | get_replicate_missing_region_channels () | |
bool | get_reset_default_speed_on_stop () | |
bool | get_run_all_transport_masters_always () | |
bool | get_save_history () | |
int | get_saved_history_depth () | |
bool | get_send_ltc () | |
bool | get_send_midi_clock () | |
bool | get_send_mmc () | |
bool | get_send_mtc () | |
bool | get_show_solo_mutes () | |
bool | get_show_video_export_info () | |
bool | get_show_video_server_dialog () | |
ShuttleBehaviour | get_shuttle_behaviour () | |
float | get_shuttle_max_speed () | |
float | get_shuttle_speed_factor () | |
float | get_shuttle_speed_threshold () | |
ShuttleUnits | get_shuttle_units () | |
bool | get_skip_playback () | |
bool | get_solo_control_is_listen_control () | |
float | get_solo_mute_gain () | |
bool | get_solo_mute_override () | |
bool | get_stop_at_session_end () | |
bool | get_stop_recording_on_xrun () | |
bool | get_strict_io () | |
bool | get_timecode_sync_frame_rate () | |
bool | get_trace_midi_input () | |
bool | get_trace_midi_output () | |
TracksAutoNamingRule | get_tracks_auto_naming () | |
float | get_transient_sensitivity () | |
bool | get_transport_masters_just_roll_when_sync_lost () | |
bool | get_try_autostart_engine () | |
std::string | get_tutorial_manual_url () | |
std::string | get_updates_url () | |
bool | get_use_click_emphasis () | |
bool | get_use_lxvst () | |
bool | get_use_macvst () | |
bool | get_use_master_volume () | |
bool | get_use_monitor_bus () | |
bool | get_use_osc () | |
bool | get_use_plugin_own_gui () | |
bool | get_use_tranzport () | |
bool | get_use_windows_vst () | |
bool | get_verbose_plugin_scan () | |
bool | get_verify_remove_last_capture () | |
bool | get_video_advanced_setup () | |
std::string | get_video_server_docroot () | |
std::string | get_video_server_url () | |
int | get_vst_scan_timeout () | |
std::string | get_windows_pingback_url () | |
std::string | get_xjadeo_binary () | |
bool | set_afl_position (AFLPosition) | |
bool | set_all_safe (bool) | |
bool | set_allow_special_bus_removal (bool) | |
bool | set_ask_replace_instrument (bool) | |
bool | set_ask_setup_instrument (bool) | |
bool | set_audio_capture_buffer_seconds (float) | |
bool | set_audio_playback_buffer_seconds (float) | |
bool | set_auditioner_output_left (std::string) | |
bool | set_auditioner_output_right (std::string) | |
bool | set_auto_analyse_audio (bool) | |
bool | set_auto_connect_standard_busses (bool) | |
bool | set_auto_input_does_talkback (bool) | |
bool | set_auto_return_target_list (AutoReturnTarget) | |
bool | set_automation_follows_regions (bool) | |
bool | set_automation_interval_msecs (float) | |
bool | set_automation_thinning_factor (double) | |
bool | set_buffering_preset (BufferingPreset) | |
bool | set_click_emphasis_sound (std::string) | |
bool | set_click_gain (float) | |
bool | set_click_record_only (bool) | |
bool | set_click_sound (std::string) | |
bool | set_clicking (bool) | |
bool | set_conceal_lv1_if_lv2_exists (bool) | |
bool | set_conceal_vst2_if_vst3_exists (bool) | |
bool | set_copy_demo_sessions (bool) | |
bool | set_create_xrun_marker (bool) | |
bool | set_default_fade_shape (FadeShape) | |
bool | set_default_session_parent_dir (std::string) | |
bool | set_denormal_model (DenormalModel) | |
bool | set_denormal_protection (bool) | |
bool | set_disable_disarm_during_roll (bool) | |
bool | set_discover_audio_units (bool) | |
bool | set_discover_vst_on_start (bool) | |
bool | set_disk_choice_space_threshold (unsigned int) | |
bool | set_donate_url (std::string) | |
bool | set_edit_mode (EditMode) | |
bool | set_exclusive_solo (bool) | |
bool | set_export_preroll (float) | |
bool | set_export_silence_threshold (float) | |
bool | set_feedback_interval_ms (unsigned int) | |
bool | set_first_midi_bank_is_zero (bool) | |
bool | set_freesound_download_dir (std::string) | |
bool | set_hide_dummy_backend (bool) | |
bool | set_hiding_groups_deactivates_groups (bool) | |
bool | set_history_depth (int) | |
bool | set_initial_program_change (int) | |
bool | set_input_auto_connect (AutoConnectOption) | |
bool | set_inter_scene_gap_samples (int) | |
bool | set_latched_record_enable (bool) | |
bool | set_layer_model (LayerModel) | |
bool | set_limit_n_automatables (unsigned int) | |
bool | set_link_send_and_route_panner (bool) | |
bool | set_linux_pingback_url (std::string) | |
bool | set_listen_position (ListenPosition) | |
bool | set_locate_while_waiting_for_sync (bool) | |
bool | set_loop_fade_choice (LoopFadeChoice) | |
bool | set_loop_is_mode (bool) | |
bool | set_ltc_output_port (std::string) | |
bool | set_ltc_output_volume (float) | |
bool | set_ltc_send_continuously (bool) | |
bool | set_max_gain (float) | |
bool | set_max_recent_sessions (unsigned int) | |
bool | set_max_recent_templates (unsigned int) | |
bool | set_max_transport_speed (float) | |
bool | set_meter_falloff (float) | |
bool | set_meter_type_bus (MeterType) | |
bool | set_meter_type_master (MeterType) | |
bool | set_meter_type_track (MeterType) | |
bool | set_midi_audition_synth_uri (std::string) | |
bool | set_midi_clock_sets_tempo (bool) | |
bool | set_midi_feedback (bool) | |
bool | set_midi_input_follows_selection (bool) | |
bool | set_midi_track_buffer_seconds (float) | |
bool | set_minimum_disk_read_bytes (unsigned int) | |
bool | set_minimum_disk_write_bytes (unsigned int) | |
bool | set_mmc_control (bool) | |
bool | set_mmc_receive_device_id (int) | |
bool | set_mmc_send_device_id (int) | |
bool | set_monitor_bus_preferred_bundle (std::string) | |
bool | set_monitoring_model (MonitorModel) | |
bool | set_mtc_qf_speed_tolerance (int) | |
bool | set_mute_affects_control_outs (bool) | |
bool | set_mute_affects_main_outs (bool) | |
bool | set_mute_affects_post_fader (bool) | |
bool | set_mute_affects_pre_fader (bool) | |
bool | set_new_plugins_active (bool) | |
bool | set_osc_port (unsigned int) | |
bool | set_osx_pingback_url (std::string) | |
bool | set_output_auto_connect (AutoConnectOption) | |
bool | set_periodic_safety_backup_interval (unsigned int) | |
bool | set_periodic_safety_backups (bool) | |
bool | set_pfl_position (PFLPosition) | |
bool | set_plugin_path_lxvst (std::string) | |
bool | set_plugin_path_vst (std::string) | |
bool | set_plugin_path_vst3 (std::string) | |
bool | set_plugins_stop_with_transport (bool) | |
bool | set_postroll (long) | |
bool | set_preroll (long) | |
bool | set_preroll_seconds (float) | |
bool | set_processor_usage (int) | |
bool | set_quieten_at_speed (bool) | |
bool | set_range_location_minimum (long) | |
bool | set_range_selection_after_split (RangeSelectionAfterSplit) | |
bool | set_recording_resets_xrun_count (bool) | |
bool | set_reference_manual_url (std::string) | |
bool | set_region_boundaries_from_onscreen_tracks (bool) | |
bool | set_region_boundaries_from_selected_tracks (bool) | |
bool | set_region_equivalence (RegionEquivalence) | |
bool | set_region_selection_after_split (RegionSelectionAfterSplit) | |
bool | set_replicate_missing_region_channels (bool) | |
bool | set_reset_default_speed_on_stop (bool) | |
bool | set_run_all_transport_masters_always (bool) | |
bool | set_save_history (bool) | |
bool | set_saved_history_depth (int) | |
bool | set_send_ltc (bool) | |
bool | set_send_midi_clock (bool) | |
bool | set_send_mmc (bool) | |
bool | set_send_mtc (bool) | |
bool | set_show_solo_mutes (bool) | |
bool | set_show_video_export_info (bool) | |
bool | set_show_video_server_dialog (bool) | |
bool | set_shuttle_behaviour (ShuttleBehaviour) | |
bool | set_shuttle_max_speed (float) | |
bool | set_shuttle_speed_factor (float) | |
bool | set_shuttle_speed_threshold (float) | |
bool | set_shuttle_units (ShuttleUnits) | |
bool | set_skip_playback (bool) | |
bool | set_solo_control_is_listen_control (bool) | |
bool | set_solo_mute_gain (float) | |
bool | set_solo_mute_override (bool) | |
bool | set_stop_at_session_end (bool) | |
bool | set_stop_recording_on_xrun (bool) | |
bool | set_strict_io (bool) | |
bool | set_timecode_sync_frame_rate (bool) | |
bool | set_trace_midi_input (bool) | |
bool | set_trace_midi_output (bool) | |
bool | set_tracks_auto_naming (TracksAutoNamingRule) | |
bool | set_transient_sensitivity (float) | |
bool | set_transport_masters_just_roll_when_sync_lost (bool) | |
bool | set_try_autostart_engine (bool) | |
bool | set_tutorial_manual_url (std::string) | |
bool | set_updates_url (std::string) | |
bool | set_use_click_emphasis (bool) | |
bool | set_use_lxvst (bool) | |
bool | set_use_macvst (bool) | |
bool | set_use_master_volume (bool) | |
bool | set_use_monitor_bus (bool) | |
bool | set_use_osc (bool) | |
bool | set_use_plugin_own_gui (bool) | |
bool | set_use_tranzport (bool) | |
bool | set_use_windows_vst (bool) | |
bool | set_verbose_plugin_scan (bool) | |
bool | set_verify_remove_last_capture (bool) | |
bool | set_video_advanced_setup (bool) | |
bool | set_video_server_docroot (std::string) | |
bool | set_video_server_url (std::string) | |
bool | set_vst_scan_timeout (int) | |
bool | set_windows_pingback_url (std::string) | |
bool | set_xjadeo_binary (std::string) | |
Properties | ||
ARDOUR.AFLPosition | afl_position | |
bool | all_safe | |
bool | allow_special_bus_removal | |
bool | ask_replace_instrument | |
bool | ask_setup_instrument | |
float | audio_capture_buffer_seconds | |
float | audio_playback_buffer_seconds | |
std::string | auditioner_output_left | |
std::string | auditioner_output_right | |
bool | auto_analyse_audio | |
bool | auto_connect_standard_busses | |
bool | auto_input_does_talkback | |
ARDOUR.AutoReturnTarget | auto_return_target_list | |
bool | automation_follows_regions | |
float | automation_interval_msecs | |
double | automation_thinning_factor | |
ARDOUR.BufferingPreset | buffering_preset | |
std::string | click_emphasis_sound | |
float | click_gain | |
bool | click_record_only | |
std::string | click_sound | |
bool | clicking | |
bool | conceal_lv1_if_lv2_exists | |
bool | conceal_vst2_if_vst3_exists | |
bool | copy_demo_sessions | |
bool | create_xrun_marker | |
ARDOUR.FadeShape | default_fade_shape | |
std::string | default_session_parent_dir | |
ARDOUR.DenormalModel | denormal_model | |
bool | denormal_protection | |
bool | disable_disarm_during_roll | |
bool | discover_audio_units | |
bool | discover_vst_on_start | |
unsigned int | disk_choice_space_threshold | |
std::string | donate_url | |
ARDOUR.EditMode | edit_mode | |
bool | exclusive_solo | |
float | export_preroll | |
float | export_silence_threshold | |
unsigned int | feedback_interval_ms | |
bool | first_midi_bank_is_zero | |
std::string | freesound_download_dir | |
bool | hide_dummy_backend | |
bool | hiding_groups_deactivates_groups | |
int | history_depth | |
int | initial_program_change | |
ARDOUR.AutoConnectOption | input_auto_connect | |
int | inter_scene_gap_samples | |
bool | latched_record_enable | |
ARDOUR.LayerModel | layer_model | |
unsigned int | limit_n_automatables | |
bool | link_send_and_route_panner | |
std::string | linux_pingback_url | |
ARDOUR.ListenPosition | listen_position | |
bool | locate_while_waiting_for_sync | |
ARDOUR.LoopFadeChoice | loop_fade_choice | |
bool | loop_is_mode | |
std::string | ltc_output_port | |
float | ltc_output_volume | |
bool | ltc_send_continuously | |
float | max_gain | |
unsigned int | max_recent_sessions | |
unsigned int | max_recent_templates | |
float | max_transport_speed | |
float | meter_falloff | |
ARDOUR.MeterType | meter_type_bus | |
ARDOUR.MeterType | meter_type_master | |
ARDOUR.MeterType | meter_type_track | |
std::string | midi_audition_synth_uri | |
bool | midi_clock_sets_tempo | |
bool | midi_feedback | |
bool | midi_input_follows_selection | |
float | midi_track_buffer_seconds | |
unsigned int | minimum_disk_read_bytes | |
unsigned int | minimum_disk_write_bytes | |
bool | mmc_control | |
int | mmc_receive_device_id | |
int | mmc_send_device_id | |
std::string | monitor_bus_preferred_bundle | |
ARDOUR.MonitorModel | monitoring_model | |
int | mtc_qf_speed_tolerance | |
bool | mute_affects_control_outs | |
bool | mute_affects_main_outs | |
bool | mute_affects_post_fader | |
bool | mute_affects_pre_fader | |
bool | new_plugins_active | |
unsigned int | osc_port | |
std::string | osx_pingback_url | |
ARDOUR.AutoConnectOption | output_auto_connect | |
unsigned int | periodic_safety_backup_interval | |
bool | periodic_safety_backups | |
ARDOUR.PFLPosition | pfl_position | |
std::string | plugin_path_lxvst | |
std::string | plugin_path_vst | |
std::string | plugin_path_vst3 | |
bool | plugins_stop_with_transport | |
long | postroll | |
long | preroll | |
float | preroll_seconds | |
int | processor_usage | |
bool | quieten_at_speed | |
long | range_location_minimum | |
ARDOUR.RangeSelectionAfterSplit | range_selection_after_split | |
bool | recording_resets_xrun_count | |
std::string | reference_manual_url | |
bool | region_boundaries_from_onscreen_tracks | |
bool | region_boundaries_from_selected_tracks | |
ARDOUR.RegionEquivalence | region_equivalence | |
ARDOUR.RegionSelectionAfterSplit | region_selection_after_split | |
bool | replicate_missing_region_channels | |
bool | reset_default_speed_on_stop | |
bool | run_all_transport_masters_always | |
bool | save_history | |
int | saved_history_depth | |
bool | send_ltc | |
bool | send_midi_clock | |
bool | send_mmc | |
bool | send_mtc | |
bool | show_solo_mutes | |
bool | show_video_export_info | |
bool | show_video_server_dialog | |
ARDOUR.ShuttleBehaviour | shuttle_behaviour | |
float | shuttle_max_speed | |
float | shuttle_speed_factor | |
float | shuttle_speed_threshold | |
ARDOUR.ShuttleUnits | shuttle_units | |
bool | skip_playback | |
bool | solo_control_is_listen_control | |
float | solo_mute_gain | |
bool | solo_mute_override | |
bool | stop_at_session_end | |
bool | stop_recording_on_xrun | |
bool | strict_io | |
bool | timecode_sync_frame_rate | |
bool | trace_midi_input | |
bool | trace_midi_output | |
ARDOUR.TracksAutoNamingRule | tracks_auto_naming | |
float | transient_sensitivity | |
bool | transport_masters_just_roll_when_sync_lost | |
bool | try_autostart_engine | |
std::string | tutorial_manual_url | |
std::string | updates_url | |
bool | use_click_emphasis | |
bool | use_lxvst | |
bool | use_macvst | |
bool | use_master_volume | |
bool | use_monitor_bus | |
bool | use_osc | |
bool | use_plugin_own_gui | |
bool | use_tranzport | |
bool | use_windows_vst | |
bool | verbose_plugin_scan | |
bool | verify_remove_last_capture | |
bool | video_advanced_setup | |
std::string | video_server_docroot | |
std::string | video_server_url | |
int | vst_scan_timeout | |
std::string | windows_pingback_url | |
std::string | xjadeo_binary |
Methods | ||
---|---|---|
void | clear_changes () | |
Forget about any changes to this object's properties | ||
ID | id () | |
OwnedPropertyList | properties () |
C‡: ARDOUR::RawMidiParser
+ +Constructor | ||
---|---|---|
ℂ | ARDOUR.RawMidiParser () | |
Methods | ||
unsigned long | buffer_size () | |
unsigned char* | midi_buffer () | |
bool | process_byte (unsigned char) | |
void | reset () |
C‡: boost::shared_ptr< ARDOUR::ReadOnlyControl >, boost::weak_ptr< ARDOUR::ReadOnlyControl >
+is-a: PBD:StatefulDestructiblePtr
+ +Methods | ||
---|---|---|
ParameterDescriptor | desc () | |
std::string | describe_parameter () | |
double | get_parameter () | |
bool | isnil () |
C‡: PBD::PropertyList
- -A list of properties, mapped using their ID
This class object is only used indirectly as return-value and function-parameter. It provides no methods by itself.
+Methods | ||
---|---|---|
void | clear_changes () | |
Forget about any changes to this object's properties | ||
ID | id () | |
OwnedPropertyList | properties () |
C‡: boost::shared_ptr< ARDOUR::Readable >, boost::weak_ptr< ARDOUR::Readable >
Methods | ||
---|---|---|
bool | isnil () | |
ReadableList | load (Session&, std::string) | |
unsigned int | n_channels () | |
long | read (FloatArray, long, long, int) | |
long | readable_length () | |
bool | sameinstance (Readable) |
C‡: std::vector<boost::shared_ptr<ARDOUR::Readable> >
+ +Constructor | ||
---|---|---|
ℂ | ARDOUR.ReadableList () | |
ℂ | ARDOUR.ReadableList () | |
Methods | ||
LuaTable | add (LuaTable {Readable}) | |
Readable | at (unsigned long) | |
void | clear () | |
bool | empty () | |
LuaIter | iter () | |
void | push_back (Readable) | |
unsigned long | size () | |
LuaTable | table () | |
... | to_array (--lua--) |
C‡: boost::shared_ptr< ARDOUR::Region >, boost::weak_ptr< ARDOUR::Region >
-is-a: ARDOUR:SessionObject
+is-a: ARDOUR:SessionObjectPtr
A named object associated with a Session. Objects derived from this class are expected to be destroyed before the session calls drop_references().
bool | automatic () | |||
bool | can_move () | |||
bool | captured () | |||
void | captured_xruns (XrunPositions&, bool) | |||
void | clear_sync_position () | |||
Control | control (Parameter, bool) | |||
bool | covers (long) | |||
void | cut_end (long, int) | |||
void | cut_front (long, int) | |||
DataType | data_type () | |||
bool | external () | |||
bool | has_transients () | |||
bool | hidden () | |||
bool | import () | |||
bool | is_compound () | |||
unsigned int | n_channels () | |||
void | nudge_position (long) | |||
bool | opaque () | |||
Playlist | playlist () | |||
long | position () | |||
How the region parameters play together: POSITION: first frame of the region along the timeline START: first frame of the region within its source(s) LENGTH: number of frames the region represents | ||||
How the region parameters play together: POSITION: first sample of the region along the timeline START: first sample of the region within its source(s) LENGTH: number of samples the region represents | ||||
bool | position_locked () | |||
double | quarter_note () | |||
void | raise () | |||
void | raise_to_top () | |||
bool | sameinstance (Region) | |||
void | set_hidden (bool) | |||
void | set_initial_position (long) | |||
A gui may need to create a region, then place it in an initial position determined by the user. When this takes place within one gui operation, we have to reset _last_position to prevent an implied move. | ||||
A gui may need to create a region, then place it in an initial position determined by the user. When this takes place within one gui operation, we have to reset _last_position to prevent an implied move. | ||||
void | set_length (long, int) | |||
void | set_locked (bool) | |||
void | set_muted (bool) | |||
bool | set_name (std::string) | |||
Note: changing the name of a Region does not constitute an edit | ||||
void | set_opaque (bool) | |||
void | set_position (long, int) | |||
void | set_position_locked (bool) | |||
void | set_start (long) | |||
void | set_sync_position (long) | |||
Set the region's sync point.
| ||||
Set the region's sync point.
| ||||
void | set_video_locked (bool) | |||
float | shift () | |||
Source | source (unsigned int) | |||
LuaTable(long, ...) | sync_offset (int&) | |||
long | sync_position () | |||
Returns Sync position in session time | ||||
Int64List | transients () | |||
void | trim_end (long, int) | |||
void | trim_front (long, int) | |||
void | trim_to (long, long, int) | |||
MidiRegion | to_midiregion () | |||
Readable | to_readable () |
Methods | ||
---|---|---|
std::string | name () |
Methods | ||
---|---|---|
Region | clone_region (Region, bool, bool) | |
Region | region_by_id (ID) | |
RegionMap | regions () |
C‡: std::list<boost::shared_ptr<ARDOUR::Region> >
@@ -2713,9 +4329,9 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to CC‡: std::map<PBD::ID, boost::shared_ptr<ARDOUR::Region> > >
+ +Constructor | ||
---|---|---|
ℂ | ARDOUR.RegionMap () | |
Methods | ||
LuaTable | add (LuaTable {Region}) | |
... | at (--lua--) | |
void | clear () | |
unsigned long | count (ID) | |
bool | empty () | |
LuaIter | iter () | |
unsigned long | size () | |
LuaTable | table () |
C‡: std::vector<boost::shared_ptr<ARDOUR::Region> >
+ +Constructor | ||
---|---|---|
ℂ | ARDOUR.RegionVector () | |
ℂ | ARDOUR.RegionVector () | |
Methods | ||
LuaTable | add (LuaTable {Region}) | |
Region | at (unsigned long) | |
void | clear () | |
bool | empty () | |
LuaIter | iter () | |
void | push_back (Region) | |
unsigned long | size () | |
LuaTable | table () | |
... | to_array (--lua--) |
C‡: boost::shared_ptr< ARDOUR::Return >, boost::weak_ptr< ARDOUR::Return >
+is-a: ARDOUR:IOProcessor
+ +A mixer strip element (Processor) with 1 or 2 IO elements.
Methods | ||
---|---|---|
bool | isnil () |
Methods | ||
---|---|---|
IO | input () | |
ChanCount | natural_input_streams () | |
ChanCount | natural_output_streams () | |
IO | output () |
Methods | ||
---|---|---|
void | activate () | |
bool | active () | |
long | capture_offset () | |
void | deactivate () | |
std::string | display_name () | |
bool | display_to_user () | |
long | input_latency () | |
ChanCount | input_streams () | |
long | output_latency () | |
ChanCount | output_streams () | |
long | playback_offset () | |
long | signal_latency () | |
Cast | ||
Amp | to_amp () | |
Automatable | to_automatable () | |
DelayLine | to_delayline () | |
DiskIOProcessor | to_diskioprocessor () | |
DiskReader | to_diskreader () | |
DiskWriter | to_diskwriter () | |
PluginInsert | to_insert () | |
InternalSend | to_internalsend () | |
IOProcessor | to_ioprocessor () | |
Latent | to_latent () | |
PeakMeter | to_meter () | |
MonitorProcessor | to_monitorprocessor () | |
PeakMeter | to_peakmeter () | |
PluginInsert | to_plugininsert () | |
PolarityProcessor | to_polarityprocessor () | |
Send | to_send () | |
SideChain | to_sidechain () | |
UnknownProcessor | to_unknownprocessor () |
Methods | ||
---|---|---|
std::string | name () | |
Cast | ||
Stateful | to_stateful () | |
StatefulDestructible | to_statefuldestructible () |
C‡: boost::shared_ptr< ARDOUR::Route >, boost::weak_ptr< ARDOUR::Route >
is-a: ARDOUR:Stripable
@@ -2745,13 +4455,15 @@ 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. | ||||||||||
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) | |||||||||
Amp | amp () | |||||||||
std::string | comment () | |||||||||
bool | customize_plugin_insert (Processor, unsigned int, ChanCount, ChanCount) | |||||||||
enable custom plugin-insert configuration
Returns true if successful | ||||||||||
enable custom plugin-insert configuration
Returns true if successful | ||||||||||
DataType | data_type () | |||||||||
IO | input () | |||||||||
bool | isnil () | |||||||||
Delivery | main_outs () | |||||||||
PannerShell | panner_shell () | |||||||||
PeakMeter | peak_meter () | |||||||||
************************************************************* Pure interface begins here************************************************************* | ||||||||||
long | playback_latency (bool) | |||||||||
int | remove_processor (Processor, ProcessorStreams, bool) | |||||||||
remove plugin/processor
Returns 0 on success | ||||||||||
remove plugin/processor
Returns 0 on success | ||||||||||
int | remove_processors (ProcessorList, ProcessorStreams) | |||||||||
bool | remove_sidechain (Processor) | |||||||||
int | reorder_processors (ProcessorList, ProcessorStreams) | |||||||||
int | replace_processor (Processor, Processor, ProcessorStreams) | |||||||||
replace plugin/processor with another
Returns 0 on success | ||||||||||
replace plugin/processor with another
Returns 0 on success | ||||||||||
bool | reset_plugin_insert (Processor) | |||||||||
reset plugin-insert configuration to default, disable customizations. This is equivalent to calling customize_plugin_insert (proc, 0, unused)
Returns true if successful | ||||||||||
bool | sameinstance (Route) | |||||||||
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 () | |||||||||
bool | soloed () | |||||||||
bool | strict_io () | |||||||||
Processor | the_instrument () | |||||||||
Return the first processor that accepts has at least one MIDI input and at least one audio output. In the vast majority of cases, this will be "the instrument". This does not preclude other MIDI->audio processors later in the processing chain, but that would be a special case not covered by this utility function. | ||||||||||
Amp | trim () | |||||||||
Cast | ||||||||||
Automatable | to_automatable () | |||||||||
Track | to_track () |
Methods | ||
---|---|---|
AutomationControl | comp_enable_control () | |
AutomationControl | comp_makeup_control () | |
AutomationControl | comp_mode_control () | |
AutomationControl | comp_enable_controllable () | |
AutomationControl | comp_makeup_controllable () | |
AutomationControl | comp_mode_controllable () | |
std::string | comp_mode_name (unsigned int) | |
AutomationControl | comp_redux_control () | |
AutomationControl | comp_speed_control () | |
ReadOnlyControl | comp_redux_controllable () | |
AutomationControl | comp_speed_controllable () | |
std::string | comp_speed_name (unsigned int) | |
AutomationControl | comp_threshold_control () | |
AutomationControl | comp_threshold_controllable () | |
unsigned int | eq_band_cnt () | |
std::string | eq_band_name (unsigned int) | |
AutomationControl | eq_enable_control () | |
AutomationControl | eq_freq_control (unsigned int) | |
AutomationControl | eq_gain_control (unsigned int) | |
AutomationControl | eq_hpf_control () | |
AutomationControl | eq_q_control (unsigned int) | |
AutomationControl | eq_shape_control (unsigned int) | |
AutomationControl | eq_enable_controllable () | |
AutomationControl | eq_freq_controllable (unsigned int) | |
AutomationControl | eq_gain_controllable (unsigned int) | |
AutomationControl | eq_q_controllable (unsigned int) | |
AutomationControl | eq_shape_controllable (unsigned int) | |
AutomationControl | filter_enable_controllable (bool) | |
AutomationControl | filter_freq_controllable (bool) | |
AutomationControl | filter_slope_controllable (bool) | |
GainControl | gain_control () | |
bool | is_auditioner () | |
bool | is_hidden () | |
bool | is_master () | |
bool | is_monitor () | |
bool | is_private_route () | |
bool | is_selected () | |
AutomationControl | master_send_enable_control () | |
AutomationControl | master_send_enable_controllable () | |
MonitorProcessor | monitor_control () | |
MuteControl | mute_control () | |
AutomationControl | pan_azimuth_control () | |
PresentationInfo | presentation_info_ptr () | |
AutomationControl | rec_enable_control () | |
AutomationControl | rec_safe_control () | |
AutomationControl | send_enable_control (unsigned int) | |
AutomationControl | send_level_control (unsigned int) | |
AutomationControl | send_enable_controllable (unsigned int) | |
AutomationControl | send_level_controllable (unsigned int) | |
std::string | send_name (unsigned int) | |
AutomationControl | send_pan_azimuth_controllable (unsigned int) | |
AutomationControl | send_pan_azimuth_enable_controllable (unsigned int) | |
void | set_presentation_order (unsigned int) | |
bool | slaved () | |
bool | slaved_to (VCA) | |
SoloControl | solo_control () | |
SoloIsolateControl | solo_isolate_control () | |
SoloSafeControl | solo_safe_control () | |
GainControl | trim_control () | |
Cast | ||
Automatable | to_automatable () | |
Route | to_route () | |
Slavable | to_slavable () | |
VCA | to_vca () |
Methods | ||
---|---|---|
std::string | name () |
C‡: ARDOUR::RouteGroup
+is-a: ARDOUR:SessionObject
A group identifier for routes.
RouteGroups permit to define properties which are shared among all Routes that use the given identifier.
A route can at most be in one group.
Methods | ||||
---|---|---|---|---|
int | add (Route) | |||
Add a route to a group. Adding a route which is already in the group is allowed; nothing will happen.
| ||||
Add a route to a group. Adding a route which is already in the group is allowed; nothing will happen.
| ||||
void | clear () | |||
void | destroy_subgroup () | |||
bool | empty () | |||
bool | is_solo () | |||
void | make_subgroup (bool, Placement) | |||
int | remove (Route) | |||
unsigned int | rgba () | |||
RouteListPtr | route_list () | |||
void | set_active (bool, void*) | |||
void | set_color (bool) | |||
void | set_mute (bool) | |||
void | set_recenable (bool) | |||
void | set_relative (bool, void*) | |||
void | set_rgba (unsigned int) | |||
set route-group color and notify UI about change | ||||
void | set_route_active (bool) | |||
void | set_select (bool) | |||
void | set_solo (bool) | |||
unsigned long | size () |
Methods | ||
---|---|---|
std::string | name () | |
Cast | ||
Stateful | to_stateful () |
C‡: std::list<ARDOUR::RouteGroup* >
@@ -2916,9 +4649,9 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to CC‡: boost::shared_ptr< ARDOUR::Send >, boost::weak_ptr< ARDOUR::Send >
+is-a: ARDOUR:Delivery
+ +A mixer strip element (Processor) with 1 or 2 IO elements.
Methods | ||
---|---|---|
GainControl | gain_control () | |
long | get_delay_in () | |
long | get_delay_out () | |
bool | is_foldback () | |
bool | isnil () | |
Cast | ||
InternalSend | to_internalsend () |
Methods | ||
---|---|---|
PannerShell | panner_shell () |
Methods | ||
---|---|---|
IO | input () | |
ChanCount | natural_input_streams () | |
ChanCount | natural_output_streams () | |
IO | output () |
Methods | ||
---|---|---|
void | activate () | |
bool | active () | |
long | capture_offset () | |
void | deactivate () | |
std::string | display_name () | |
bool | display_to_user () | |
long | input_latency () | |
ChanCount | input_streams () | |
long | output_latency () | |
ChanCount | output_streams () | |
long | playback_offset () | |
long | signal_latency () | |
Cast | ||
Amp | to_amp () | |
Automatable | to_automatable () | |
DelayLine | to_delayline () | |
DiskIOProcessor | to_diskioprocessor () | |
DiskReader | to_diskreader () | |
DiskWriter | to_diskwriter () | |
PluginInsert | to_insert () | |
InternalSend | to_internalsend () | |
IOProcessor | to_ioprocessor () | |
Latent | to_latent () | |
PeakMeter | to_meter () | |
MonitorProcessor | to_monitorprocessor () | |
PeakMeter | to_peakmeter () | |
PluginInsert | to_plugininsert () | |
PolarityProcessor | to_polarityprocessor () | |
Send | to_send () | |
SideChain | to_sidechain () | |
UnknownProcessor | to_unknownprocessor () |
Methods | ||
---|---|---|
std::string | name () | |
Cast | ||
Stateful | to_stateful () | |
StatefulDestructible | to_statefuldestructible () |
C‡: ARDOUR::Session
@@ -2949,33 +4753,38 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to Cabort an open undo command This must only be called after begin_reversible_command ()
create an StatefulDiffCommand from the given object and add it to the stack.
This function must only be called after begin_reversible_command. Failing to do so may lead to a crash.
sfd | the object to diff |
---|
Returns the allocated StatefulDiffCommand (already added via add_command)
create an StatefulDiffCommand from the given object and add it to the stack.
This function must only be called after begin_reversible_command. Failing to do so may lead to a crash.
Returns the allocated StatefulDiffCommand (already added via add_command)
begin collecting undo information
This call must always be followed by either begin_reversible_command() or commit_reversible_command()
cmd_name | human readable name for the undo operation |
---|
begin collecting undo information
This call must always be followed by either begin_reversible_command() or commit_reversible_command()
finalize an undo command and commit pending transactions
This must only be called after begin_reversible_command ()
cmd | (additional) command to add |
---|
finalize an undo command and commit pending transactions
This must only be called after begin_reversible_command ()
"actual" sample rate of session, set by current audioengine rate, pullup/down etc.
"native" sample rate of session, regardless of current audioengine rate, pullup/down etc
"actual" sample rate of session, set by current audioengine rate, pullup/down etc.
save session
snapshot_name | name of the session (use an empty string for the current name) |
---|---|
pending | save a 'recovery', not full state (default: false) |
switch_to_snapshot | switch to given snapshot after saving (default: false) |
template_only | save a session template (default: false) |
Returns zero on success
save session
Returns zero on success
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.
Returns true if the transport state (TFSM) is rolling. Note: the transport may not yet move if pre-roll or count-in in ongoing.
Returns true if the transport state (TFSM) is stopped
Returns true if the transport state (TFSM) is stopped or stopping
C‡: ARDOUR::SessionConfiguration
@@ -3045,7 +4871,6 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to CC‡: ARDOUR::SessionObject
+ +A named object associated with a Session. Objects derived from this class are expected to be destroyed before the session calls drop_references().
Methods | ||
---|---|---|
std::string | name () | |
Cast | ||
Stateful | to_stateful () |
C‡: boost::shared_ptr< ARDOUR::SessionObject >, boost::weak_ptr< ARDOUR::SessionObject >
A named object associated with a Session. Objects derived from this class are expected to be destroyed before the session calls drop_references().
C‡: boost::shared_ptr< ARDOUR::SessionPlaylists >, boost::weak_ptr< ARDOUR::SessionPlaylists >
+ +Methods | ||
---|---|---|
Playlist | by_id (ID) | |
Playlist | by_name (std::string) | |
PlaylistList | get_unused () | |
PlaylistList | get_used () | |
bool | isnil () | |
unsigned int | n_playlists () | |
PlaylistList | playlists_for_track (Track) | |
Returns list of Playlists that are associated with a track | ||
unsigned int | region_use_count (Region) | |
unsigned int | source_use_count (Source) |
C‡: boost::shared_ptr< ARDOUR::SideChain >, boost::weak_ptr< ARDOUR::SideChain >
is-a: ARDOUR:IOProcessor
-A mixer strip element (Processor) with 1 or 2 IO elements.
A mixer strip element (Processor) with 1 or 2 IO elements.
Methods | ||
---|---|---|
bool | isnil () | |
bool | sameinstance (SideChain) |
Methods | ||
---|---|---|
void | activate () | |
bool | active () | |
long | capture_offset () | |
void | deactivate () | |
std::string | display_name () | |
bool | display_to_user () | |
ChanCount | input_streams () | |
ChanCount | output_streams () | |
long | input_latency () | |
ChanCount | input_streams () | |
long | output_latency () | |
ChanCount | output_streams () | |
long | playback_offset () | |
long | signal_latency () | |
Cast | ||
Amp | to_amp () | |
Automatable | to_automatable () | |
DelayLine | to_delayline () | |
DiskIOProcessor | to_diskioprocessor () | |
DiskReader | to_diskreader () | |
DiskWriter | to_diskwriter () | |
PluginInsert | to_insert () | |
InternalSend | to_internalsend () | |
IOProcessor | to_ioprocessor () | |
Latent | to_latent () | |
PeakMeter | to_meter () | |
MonitorProcessor | to_monitorprocessor () | |
PeakMeter | to_peakmeter () | |
PluginInsert | to_plugininsert () | |
PolarityProcessor | to_polarityprocessor () | |
Send | to_send () | |
SideChain | to_sidechain () | |
UnknownProcessor | to_unknownprocessor () |
Methods | ||
---|---|---|
std::string | name () | |
Stateful | to_stateful () | |
StatefulDestructible | to_statefuldestructible () |
C‡: boost::shared_ptr< ARDOUR::Slavable >, boost::weak_ptr< ARDOUR::Slavable >
+ +Methods | ||
---|---|---|
void | assign (VCA) | |
bool | assigned_to (VCAManager, VCA) | |
recursively test for master assignment to given VCA | ||
bool | isnil () | |
VCAVector | masters (VCAManager) | |
void | unassign (VCA) |
C‡: boost::shared_ptr< ARDOUR::SlavableAutomationControl >, boost::weak_ptr< ARDOUR::SlavableAutomationControl >
is-a: ARDOUR:AutomationControl
A PBD::Controllable with associated automation data (AutomationList)
Methods | ||
---|---|---|
void | add_master (AutomationControl, bool) | |
void | add_master (AutomationControl) | |
void | clear_masters () | |
int | get_boolean_masters () | |
double | get_masters_value () | |
bool | isnil () | |
void | remove_master (AutomationControl) | |
bool | sameinstance (SlavableAutomationControl,) | |
bool | slaved () | |
bool | slaved_to (AutomationControl) |
Get the current effective `user' value based on automation state
Get `internal' value
Returns raw value as used for the plugin/processor control port
Get and Set `internal' value
All derived classes must implement this.
Basic derived classes will ignore
group_override, | but more sophisticated children, notably those that proxy the value setting logic via an object that is aware of group relationships between this control and others, will find it useful. |
---|
Set `internal' value
All derived classes must implement this.
Basic derived classes will ignore group_override but more sophisticated children, notably those that proxy the value setting logic via an object that is aware of group relationships between this control and others, will find it useful.
C‡: boost::shared_ptr< ARDOUR::SoloControl >, boost::weak_ptr< ARDOUR::SoloControl >
-is-a: ARDOUR:SlavableAutomationControl,
+is-a: ARDOUR:SlavableAutomationControl
A PBD::Controllable with associated automation data (AutomationList)
Methods | ||
---|---|---|
bool | can_solo () | |
bool | isnil () | |
bool | sameinstance (SoloControl) | |
bool | self_soloed () | |
bool | soloed () |
Methods | ||||
---|---|---|---|---|
void | add_master (AutomationControl, bool) | |||
void | add_master (AutomationControl) | |||
void | clear_masters () | |||
int | get_boolean_masters () | |||
double | get_masters_value () | |||
Methods | ||||
AutomationList | alist () | |||
AutoState | automation_state () | |||
AutoStyle | automation_style () | |||
ParameterDescriptor | desc () | |||
double | get_value () | |||
Get the current effective `user' value based on automation state | ||||
Get `internal' value Returns raw value as used for the plugin/processor control port | ||||
double | lower () | |||
double | normal () | |||
void | set_automation_state (AutoState) | |||
void | set_automation_style (AutoStyle) | |||
void | set_value (double, GroupControlDisposition) | |||
Get and Set `internal' value All derived classes must implement this. Basic derived classes will ignore
| ||||
Set `internal' value All derived classes must implement this. Basic derived classes will ignore group_override but more sophisticated children, notably those that proxy the value setting logic via an object that is aware of group relationships between this control and others, will find it useful.
| ||||
void | start_touch (double) | |||
void | stop_touch (bool, double) | |||
void | stop_touch (double) | |||
bool | toggled () | |||
double | upper () | |||
bool | writable () | |||
Cast | ||||
Control | to_ctrl () | |||
SlavableAutomationControl | to_slavable () |
C‡: boost::shared_ptr< ARDOUR::SoloIsolateControl >, boost::weak_ptr< ARDOUR::SoloIsolateControl >
-is-a: ARDOUR:SlavableAutomationControl,
+is-a: ARDOUR:SlavableAutomationControl
A PBD::Controllable with associated automation data (AutomationList)
Methods | ||
---|---|---|
bool | isnil () | |
bool | sameinstance (SoloIsolateControl) | |
bool | self_solo_isolated () | |
bool | solo_isolated () |
Methods | ||||
---|---|---|---|---|
void | add_master (AutomationControl, bool) | |||
void | add_master (AutomationControl) | |||
void | clear_masters () | |||
int | get_boolean_masters () | |||
double | get_masters_value () | |||
Methods | ||||
AutomationList | alist () | |||
AutoState | automation_state () | |||
AutoStyle | automation_style () | |||
ParameterDescriptor | desc () | |||
double | get_value () | |||
Get the current effective `user' value based on automation state | ||||
Get `internal' value Returns raw value as used for the plugin/processor control port | ||||
double | lower () | |||
double | normal () | |||
void | set_automation_state (AutoState) | |||
void | set_automation_style (AutoStyle) | |||
void | set_value (double, GroupControlDisposition) | |||
Get and Set `internal' value All derived classes must implement this. Basic derived classes will ignore
| ||||
Set `internal' value All derived classes must implement this. Basic derived classes will ignore group_override but more sophisticated children, notably those that proxy the value setting logic via an object that is aware of group relationships between this control and others, will find it useful.
| ||||
void | start_touch (double) | |||
void | stop_touch (bool, double) | |||
void | stop_touch (double) | |||
bool | toggled () | |||
double | upper () | |||
bool | writable () | |||
Cast | ||||
Control | to_ctrl () | |||
SlavableAutomationControl | to_slavable () |
C‡: boost::shared_ptr< ARDOUR::SoloSafeControl >, boost::weak_ptr< ARDOUR::SoloSafeControl >
-is-a: ARDOUR:SlavableAutomationControl,
+is-a: ARDOUR:SlavableAutomationControl
A PBD::Controllable with associated automation data (AutomationList)
Methods | ||
---|---|---|
bool | isnil () | |
bool | sameinstance (SoloSafeControl) | |
bool | solo_safe () |
Methods | ||||
---|---|---|---|---|
void | add_master (AutomationControl, bool) | |||
void | add_master (AutomationControl) | |||
void | clear_masters () | |||
int | get_boolean_masters () | |||
double | get_masters_value () | |||
Methods | ||||
AutomationList | alist () | |||
AutoState | automation_state () | |||
AutoStyle | automation_style () | |||
ParameterDescriptor | desc () | |||
double | get_value () | |||
Get the current effective `user' value based on automation state | ||||
Get `internal' value Returns raw value as used for the plugin/processor control port | ||||
double | lower () | |||
double | normal () | |||
void | set_automation_state (AutoState) | |||
void | set_automation_style (AutoStyle) | |||
void | set_value (double, GroupControlDisposition) | |||
Get and Set `internal' value All derived classes must implement this. Basic derived classes will ignore
| ||||
Set `internal' value All derived classes must implement this. Basic derived classes will ignore group_override but more sophisticated children, notably those that proxy the value setting logic via an object that is aware of group relationships between this control and others, will find it useful.
| ||||
void | start_touch (double) | |||
void | stop_touch (bool, double) | |||
void | stop_touch (double) | |||
bool | toggled () | |||
double | upper () | |||
bool | writable () | |||
Cast | ||||
Control | to_ctrl () | |||
SlavableAutomationControl | to_slavable () |
C‡: boost::shared_ptr< ARDOUR::Source >, boost::weak_ptr< ARDOUR::Source >
-is-a: ARDOUR:SessionObject
+is-a: ARDOUR:SessionObjectPtr
A named object associated with a Session. Objects derived from this class are expected to be destroyed before the session calls drop_references().
Methods | ||
---|---|---|
std::string | ancestor_name () | |
bool | can_be_analysed () | |
bool | destructive () | |
XrunPositions | captured_xruns () | |
bool | empty () | |
bool | has_been_analysed () | |
bool | isnil () | |
long | length (long) | |
long | natural_position () | |
bool | sameinstance (Source) | |
long | timeline_position () | |
long | timestamp () | |
int | use_count () | |
bool | writable () | |
Cast | ||
AudioSource | to_audiosource () | |
FileSource | to_filesource () | |
MidiSource | to_midisource () |
Methods | ||
---|---|---|
std::string | name () | |
Methods | ||
LuaTable | add (LuaTable {Source}) | |
Source | at (unsigned long) | |
void | clear () | |
bool | empty () | |
LuaIter | iter () | |
void | push_back (Source) | |
unsigned long | size () | |
LuaTable | table () | |
... | to_array (--lua--) |
C‡: boost::shared_ptr< ARDOUR::Stripable >, boost::weak_ptr< ARDOUR::Stripable >
-is-a: ARDOUR:SessionObject
+is-a: ARDOUR:SessionObjectPtr
A named object associated with a Session. Objects derived from this class are expected to be destroyed before the session calls drop_references().
Methods | ||
---|---|---|
AutomationControl | comp_enable_control () | |
AutomationControl | comp_makeup_control () | |
AutomationControl | comp_mode_control () | |
AutomationControl | comp_enable_controllable () | |
AutomationControl | comp_makeup_controllable () | |
AutomationControl | comp_mode_controllable () | |
std::string | comp_mode_name (unsigned int) | |
AutomationControl | comp_redux_control () | |
AutomationControl | comp_speed_control () | |
ReadOnlyControl | comp_redux_controllable () | |
AutomationControl | comp_speed_controllable () | |
std::string | comp_speed_name (unsigned int) | |
AutomationControl | comp_threshold_control () | |
AutomationControl | comp_threshold_controllable () | |
unsigned int | eq_band_cnt () | |
std::string | eq_band_name (unsigned int) | |
AutomationControl | eq_enable_control () | |
AutomationControl | eq_freq_control (unsigned int) | |
AutomationControl | eq_gain_control (unsigned int) | |
AutomationControl | eq_hpf_control () | |
AutomationControl | eq_q_control (unsigned int) | |
AutomationControl | eq_shape_control (unsigned int) | |
AutomationControl | eq_enable_controllable () | |
AutomationControl | eq_freq_controllable (unsigned int) | |
AutomationControl | eq_gain_controllable (unsigned int) | |
AutomationControl | eq_q_controllable (unsigned int) | |
AutomationControl | eq_shape_controllable (unsigned int) | |
AutomationControl | filter_enable_controllable (bool) | |
AutomationControl | filter_freq_controllable (bool) | |
AutomationControl | filter_slope_controllable (bool) | |
GainControl | gain_control () | |
bool | is_auditioner () | |
bool | is_hidden () | |
bool | is_master () | |
bool | is_monitor () | |
bool | is_private_route () | |
bool | is_selected () | |
bool | isnil () | |
AutomationControl | master_send_enable_control () | |
AutomationControl | master_send_enable_controllable () | |
MonitorProcessor | monitor_control () | |
MuteControl | mute_control () | |
AutomationControl | pan_azimuth_control () | |
PresentationInfo | presentation_info_ptr () | |
AutomationControl | rec_enable_control () | |
AutomationControl | rec_safe_control () | |
bool | sameinstance (Stripable) | |
AutomationControl | send_enable_control (unsigned int) | |
AutomationControl | send_level_control (unsigned int) | |
AutomationControl | send_enable_controllable (unsigned int) | |
AutomationControl | send_level_controllable (unsigned int) | |
std::string | send_name (unsigned int) | |
AutomationControl | send_pan_azimuth_controllable (unsigned int) | |
AutomationControl | send_pan_azimuth_enable_controllable (unsigned int) | |
void | set_presentation_order (unsigned int) | |
bool | slaved () | |
bool | slaved_to (VCA) | |
SoloControl | solo_control () | |
SoloIsolateControl | solo_isolate_control () | |
SoloSafeControl | solo_safe_control () | |
GainControl | trim_control () | |
Cast | ||
Automatable | to_automatable () | |
Route | to_route () | |
Slavable | to_slavable () | |
VCA | to_vca () |
Methods | ||
---|---|---|
std::string | name () | |
Stateful | to_stateful () | |
StatefulDestructible | to_statefuldestructible () |
C‡: std::list<boost::shared_ptr<ARDOUR::Stripable> >
+ +Constructor | ||
---|---|---|
ℂ | ARDOUR.StripableList () | |
Methods | ||
Stripable | back () | |
bool | empty () | |
Stripable | front () | |
LuaIter | iter () | |
void | reverse () | |
unsigned long | size () | |
LuaTable | table () |
C‡: ARDOUR::Tempo
Tempo, the speed at which musical time progresses (BPM).
Constructor | ||||||
---|---|---|---|---|---|---|
ℂ | ARDOUR.Tempo (double, double) | |||||
| ||||||
ℂ | ARDOUR.Tempo (double, double, double) | |||||
Methods | ||||||
double | frames_per_note_type (long) | |||||
audio samples per note type. if you want an instantaneous value for this, use TempoMap::frames_per_quarter_note_at() instead.
| ||||||
double | frames_per_quarter_note (long) | |||||
audio samples per quarter note. if you want an instantaneous value for this, use TempoMap::frames_per_quarter_note_at() instead.
| ||||||
double | end_note_types_per_minute () | |||||
double | note_type () | |||||
double | note_types_per_minute () | |||||
double | quarter_notes_per_minute () | |||||
double | samples_per_note_type (long) | |||||
audio samples per note type. if you want an instantaneous value for this, use TempoMap::samples_per_quarter_note_at() instead.
| ||||||
double | samples_per_quarter_note (long) | |||||
audio samples per quarter note. if you want an instantaneous value for this, use TempoMap::samples_per_quarter_note_at() instead.
|
C‡: ARDOUR::TempoMap
@@ -3611,16 +5521,21 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to CTempo Map - mapping of timecode to musical time. convert audio-samples, sample-rate to Bar/Beat/Tick, Meter/Tempo
Methods | ||||
---|---|---|---|---|
MeterSection | add_meter (Meter, double, BBT_TIME, long, PositionLockStyle) | |||
TempoSection | add_tempo (Tempo, double, long, Type, PositionLockStyle) | |||
BBT_TIME | bbt_at_frame (long) | |||
Returns the BBT time corresponding to the supplied frame position.
Returns the BBT time at the frame position . | ||||
double | exact_beat_at_frame (long, int) | |||
double | exact_qn_at_frame (long, int) | |||
MeterSection | add_meter (Meter, BBT_TIME, long, PositionLockStyle) | |||
TempoSection | add_tempo (Tempo, double, long, PositionLockStyle) | |||
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) | |||
Beats | framewalk_to_qn (long, long) | |||
Count the number of beats that are equivalent to distance when going forward, starting at pos. | ||||
MeterSection | meter_section_at_beat (double) | |||
MeterSection | meter_section_at_frame (long) | |||
TempoSection | tempo_section_at_frame (long) | |||
TempoSection | tempo_section_at_frame (long) | |||
MeterSection | meter_section_at_sample (long) | |||
TempoSection | next_tempo_section (TempoSection) | |||
TempoSection | previous_tempo_section (TempoSection) | |||
long | samplepos_plus_qn (long, Beats) | |||
Add some (fractional) Beats to a session sample position, and return the result in samples. pos can be -ve, if required. | ||||
TempoSection | tempo_section_at_sample (long) |
C‡: ARDOUR::TempoSection
@@ -3629,32 +5544,46 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to CA section of timeline with a certain Tempo.
Methods | ||
---|---|---|
bool | active () | |
double | c () | |
bool | clamped () | |
bool | locked_to_meter () | |
Cast | ||
Tempo | to_tempo () |
Methods | ||
---|---|---|
bool | initial () | |
bool | is_tempo () | |
double | minute () | |
double | minute_at_sample (long) | |
double | pulse () | |
long | sample () | |
long | sample_at_minute (double) | |
void | set_pulse (double) |
C‡: boost::shared_ptr< ARDOUR::Track >, boost::weak_ptr< ARDOUR::Track >
is-a: ARDOUR:Route
-A track is an route (bus) with a recordable diskstream and related objects relevant to tracking, playback and editing.
Specifically a track has regions and playlist objects.
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 | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
Region | bounce (InterThreadInfo&) | |||||||||||
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) | |||||||||||
Bounce the given range to a new audio region.
Returns a new audio region (or nil in case of error) | ||||||||||||
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, 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. | ||||||||||||
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. | ||||||||||||
bool | can_record () | |||||||||||
int | find_and_use_playlist (DataType, ID) | |||||||||||
bool | isnil () | |||||||||||
Playlist | playlist () | |||||||||||
bool | sameinstance (Track) | |||||||||||
bool | set_name (std::string) | |||||||||||
int | use_copy_playlist () | |||||||||||
int | use_new_playlist (DataType) | |||||||||||
int | use_playlist (DataType, Playlist) | |||||||||||
Cast | ||||||||||||
AudioTrack | to_audio_track () | |||||||||||
MidiTrack | to_midi_track () |
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. | ||||||||||
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) | |||||||||
Amp | amp () | |||||||||
std::string | comment () | |||||||||
bool | customize_plugin_insert (Processor, unsigned int, ChanCount, ChanCount) | |||||||||
enable custom plugin-insert configuration
Returns true if successful | ||||||||||
enable custom plugin-insert configuration
Returns true if successful | ||||||||||
DataType | data_type () | |||||||||
IO | input () | |||||||||
Delivery | main_outs () | |||||||||
the signal processorat at end of the processing chain which produces output | ||||||||||
PannerShell | panner_shell () | |||||||||
PeakMeter | peak_meter () | |||||||||
************************************************************* Pure interface begins here************************************************************* | ||||||||||
long | playback_latency (bool) | |||||||||
int | remove_processor (Processor, ProcessorStreams, bool) | |||||||||
remove plugin/processor
Returns 0 on success | ||||||||||
remove plugin/processor
Returns 0 on success | ||||||||||
int | remove_processors (ProcessorList, ProcessorStreams) | |||||||||
bool | remove_sidechain (Processor) | |||||||||
int | reorder_processors (ProcessorList, ProcessorStreams) | |||||||||
int | replace_processor (Processor, Processor, ProcessorStreams) | |||||||||
replace plugin/processor with another
Returns 0 on success | ||||||||||
replace plugin/processor with another
Returns 0 on success | ||||||||||
bool | reset_plugin_insert (Processor) | |||||||||
reset plugin-insert configuration to default, disable customizations. This is equivalent to calling customize_plugin_insert (proc, 0, unused)
Returns true if successful | ||||||||||
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 () | |||||||||
bool | strict_io () | |||||||||
Processor | the_instrument () | |||||||||
Return the first processor that accepts has at least one MIDI input and at least one audio output. In the vast majority of cases, this will be "the instrument". This does not preclude other MIDI->audio processors later in the processing chain, but that would be a special case not covered by this utility function. | ||||||||||
Amp | trim () | |||||||||
Cast | ||||||||||
Automatable | to_automatable () | |||||||||
Track | to_track () |
Methods | ||
---|---|---|
AutomationControl | comp_enable_control () | |
AutomationControl | comp_makeup_control () | |
AutomationControl | comp_mode_control () | |
AutomationControl | comp_enable_controllable () | |
AutomationControl | comp_makeup_controllable () | |
AutomationControl | comp_mode_controllable () | |
std::string | comp_mode_name (unsigned int) | |
AutomationControl | comp_redux_control () | |
AutomationControl | comp_speed_control () | |
ReadOnlyControl | comp_redux_controllable () | |
AutomationControl | comp_speed_controllable () | |
std::string | comp_speed_name (unsigned int) | |
AutomationControl | comp_threshold_control () | |
AutomationControl | comp_threshold_controllable () | |
unsigned int | eq_band_cnt () | |
std::string | eq_band_name (unsigned int) | |
AutomationControl | eq_enable_control () | |
AutomationControl | eq_freq_control (unsigned int) | |
AutomationControl | eq_gain_control (unsigned int) | |
AutomationControl | eq_hpf_control () | |
AutomationControl | eq_q_control (unsigned int) | |
AutomationControl | eq_shape_control (unsigned int) | |
AutomationControl | eq_enable_controllable () | |
AutomationControl | eq_freq_controllable (unsigned int) | |
AutomationControl | eq_gain_controllable (unsigned int) | |
AutomationControl | eq_q_controllable (unsigned int) | |
AutomationControl | eq_shape_controllable (unsigned int) | |
AutomationControl | filter_enable_controllable (bool) | |
AutomationControl | filter_freq_controllable (bool) | |
AutomationControl | filter_slope_controllable (bool) | |
GainControl | gain_control () | |
bool | is_auditioner () | |
bool | is_hidden () | |
bool | is_master () | |
bool | is_monitor () | |
bool | is_private_route () | |
bool | is_selected () | |
AutomationControl | master_send_enable_control () | |
AutomationControl | master_send_enable_controllable () | |
MonitorProcessor | monitor_control () | |
MuteControl | mute_control () | |
AutomationControl | pan_azimuth_control () | |
PresentationInfo | presentation_info_ptr () | |
AutomationControl | rec_enable_control () | |
AutomationControl | rec_safe_control () | |
AutomationControl | send_enable_control (unsigned int) | |
AutomationControl | send_level_control (unsigned int) | |
AutomationControl | send_enable_controllable (unsigned int) | |
AutomationControl | send_level_controllable (unsigned int) | |
std::string | send_name (unsigned int) | |
AutomationControl | send_pan_azimuth_controllable (unsigned int) | |
AutomationControl | send_pan_azimuth_enable_controllable (unsigned int) | |
void | set_presentation_order (unsigned int) | |
bool | slaved () | |
bool | slaved_to (VCA) | |
SoloControl | solo_control () | |
SoloIsolateControl | solo_isolate_control () | |
SoloSafeControl | solo_safe_control () | |
GainControl | trim_control () | |
Cast | ||
Automatable | to_automatable () | |
Route | to_route () | |
Slavable | to_slavable () | |
VCA | to_vca () |
Methods | ||
---|---|---|
std::string | name () |
Methods | ||
---|---|---|
bool | isnil () | |
bool | sameinstance (UnknownProcessor) |
Methods | ||
---|---|---|
void | activate () | |
bool | active () | |
long | capture_offset () | |
void | deactivate () | |
std::string | display_name () | |
bool | display_to_user () | |
ChanCount | input_streams () | |
ChanCount | output_streams () | |
long | input_latency () | |
ChanCount | input_streams () | |
long | output_latency () | |
ChanCount | output_streams () | |
long | playback_offset () | |
long | signal_latency () | |
Cast | ||
Amp | to_amp () | |
Automatable | to_automatable () | |
DelayLine | to_delayline () | |
DiskIOProcessor | to_diskioprocessor () | |
DiskReader | to_diskreader () | |
DiskWriter | to_diskwriter () | |
PluginInsert | to_insert () | |
InternalSend | to_internalsend () | |
IOProcessor | to_ioprocessor () | |
Latent | to_latent () | |
PeakMeter | to_meter () | |
MonitorProcessor | to_monitorprocessor () | |
PeakMeter | to_peakmeter () | |
PluginInsert | to_plugininsert () | |
PolarityProcessor | to_polarityprocessor () | |
Send | to_send () | |
SideChain | to_sidechain () | |
UnknownProcessor | to_unknownprocessor () |
Methods | ||
---|---|---|
std::string | name () | |
Cast | ||
Stateful | to_stateful () | |
StatefulDestructible | to_statefuldestructible () |
C‡: boost::shared_ptr< ARDOUR::VCA >, boost::weak_ptr< ARDOUR::VCA >
+is-a: ARDOUR:Stripable
+ +A named object associated with a Session. Objects derived from this class are expected to be destroyed before the session calls drop_references().
Methods | ||
---|---|---|
std::string | full_name () | |
GainControl | gain_control () | |
bool | isnil () | |
MuteControl | mute_control () | |
int | number () | |
SoloControl | solo_control () |
Methods | ||
---|---|---|
AutomationControl | comp_enable_controllable () | |
AutomationControl | comp_makeup_controllable () | |
AutomationControl | comp_mode_controllable () | |
std::string | comp_mode_name (unsigned int) | |
ReadOnlyControl | comp_redux_controllable () | |
AutomationControl | comp_speed_controllable () | |
std::string | comp_speed_name (unsigned int) | |
AutomationControl | comp_threshold_controllable () | |
unsigned int | eq_band_cnt () | |
std::string | eq_band_name (unsigned int) | |
AutomationControl | eq_enable_controllable () | |
AutomationControl | eq_freq_controllable (unsigned int) | |
AutomationControl | eq_gain_controllable (unsigned int) | |
AutomationControl | eq_q_controllable (unsigned int) | |
AutomationControl | eq_shape_controllable (unsigned int) | |
AutomationControl | filter_enable_controllable (bool) | |
AutomationControl | filter_freq_controllable (bool) | |
AutomationControl | filter_slope_controllable (bool) | |
bool | is_auditioner () | |
bool | is_hidden () | |
bool | is_master () | |
bool | is_monitor () | |
bool | is_private_route () | |
bool | is_selected () | |
AutomationControl | master_send_enable_controllable () | |
MonitorProcessor | monitor_control () | |
AutomationControl | pan_azimuth_control () | |
AutomationControl | pan_elevation_control () | |
AutomationControl | pan_frontback_control () | |
AutomationControl | pan_lfe_control () | |
AutomationControl | pan_width_control () | |
PhaseControl | phase_control () | |
PresentationInfo | presentation_info_ptr () | |
AutomationControl | rec_enable_control () | |
AutomationControl | rec_safe_control () | |
AutomationControl | send_enable_controllable (unsigned int) | |
AutomationControl | send_level_controllable (unsigned int) | |
std::string | send_name (unsigned int) | |
AutomationControl | send_pan_azimuth_controllable (unsigned int) | |
AutomationControl | send_pan_azimuth_enable_controllable (unsigned int) | |
void | set_presentation_order (unsigned int) | |
bool | slaved () | |
bool | slaved_to (VCA) | |
SoloIsolateControl | solo_isolate_control () | |
SoloSafeControl | solo_safe_control () | |
GainControl | trim_control () | |
Cast | ||
Automatable | to_automatable () | |
Route | to_route () | |
Slavable | to_slavable () | |
VCA | to_vca () |
Methods | ||
---|---|---|
std::string | name () | |
Stateful | to_stateful () | |
StatefulDestructible | to_statefuldestructible () |
C‡: std::list<boost::shared_ptr<ARDOUR::VCA> >
+ +Constructor | ||
---|---|---|
ℂ | ARDOUR.VCAList () | |
Methods | ||
VCA | back () | |
bool | empty () | |
VCA | front () | |
LuaIter | iter () | |
void | reverse () | |
unsigned long | size () | |
LuaTable | table () |
C‡: ARDOUR::VCAManager
+is-a: PBD:StatefulDestructible
+ +Base class for objects with saveable and undoable state with destruction notification
Methods | ||
---|---|---|
VCAList | create_vca (unsigned int, std::string) | |
unsigned long | n_vcas () | |
void | remove_vca (VCA) | |
VCA | vca_by_name (std::string) | |
VCA | vca_by_number (int) | |
VCAList | vcas () |
Methods | ||
---|---|---|
void | clear_changes () | |
Forget about any changes to this object's properties | ||
ID | id () | |
OwnedPropertyList | properties () |
C‡: std::vector<boost::shared_ptr<ARDOUR::VCA> >
+ +Constructor | ||
---|---|---|
ℂ | ARDOUR.VCAVector () | |
Methods | ||
VCA | at (unsigned long) | |
bool | empty () | |
LuaIter | iter () | |
unsigned long | size () | |
LuaTable | table () |
C‡: std::list<boost::weak_ptr<ARDOUR::AudioSource> >
@@ -3808,9 +5889,9 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to CC‡: 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 | ||
---|---|---|
LuaTable | actionlist () | |
UIConfiguration | config () | |
std::string | http_get (std::string) | |
void | mixer_screenshot (std::string) | |
ProcessorVector | processor_selection () | |
unsigned int | translate_order (InsertAt) |
C‡: ArdourMarker
@@ -3870,12 +5973,11 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to CThis class contains just the public interface of the Editor class, in order to decouple it from the private implementation, so that callers of PublicEditor need not be recompiled if private methods or member variables change.
Methods | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
void | access_action (std::string, std::string) | |||||||||
void | access_action (std::string, std::string) | |||||||||
void | add_location_from_playhead_cursor () | |||||||||
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
| ||||||||||
void | copy_playlists (TimeAxisView) | |||||||||
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 (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 | deselect_all () | |||||||||
LuaTable(...) | do_embed (StringVector, ImportDisposition, ImportMode, long&, PluginInfo) | |||||||||
LuaTable(...) | do_import (StringVector, ImportDisposition, ImportMode, SrcQuality, MidiTrackNameSource, --MISSING (ARDOUR::MidiTempoMapDisposition)--, long&, PluginInfo) | |||||||||
LuaTable(...) | do_import (StringVector, ImportDisposition, ImportMode, SrcQuality, MidiTrackNameSource, MidiTempoMapDisposition, long&, PluginInfo) | |||||||||
Import existing media | ||||||||||
bool | dragging_playhead () | |||||||||
Returns true if the playhead is currently being dragged, otherwise false | ||||||||||
Open export dialog with current selection pre-selected | ||||||||||
LuaTable(Location, ...) | find_location_from_marker (ArdourMarker, bool&) | |||||||||
ArdourMarker | find_marker_from_location_id (ID, bool) | |||||||||
void | fit_selection () | |||||||||
bool | follow_playhead () | |||||||||
Returns true if the editor is following the playhead | ||||||||||
long | get_current_zoom () | |||||||||
Selection | get_cut_buffer () | |||||||||
unsigned int | get_grid_beat_divisions (long) | |||||||||
LuaTable(Beats, ...) | get_grid_type_as_beats (bool&, long) | |||||||||
LuaTable(Beats, ...) | get_grid_type_as_beats (bool&, long) | |||||||||
LuaTable(long, ...) | get_nudge_distance (long, long&) | |||||||||
long | get_paste_offset (long, unsigned int, long) | |||||||||
LuaTable(...) | get_pointer_position (double&, double&) | |||||||||
RouteTimeAxisView | get_route_view_by_route_id (ID) | |||||||||
Selection | get_selection () | |||||||||
LuaTable(bool, ...) | get_selection_extents (long&, long&) | |||||||||
bool | get_smart_mode () | |||||||||
TrackViewList | get_track_views () | |||||||||
StripableTimeAxisView | get_stripable_time_axis_by_id (ID) | |||||||||
TrackViewList | get_track_views () | |||||||||
int | get_videotl_bar_height () | |||||||||
double | get_y_origin () | |||||||||
ZoomFocus | get_zoom_focus () | |||||||||
void | goto_nth_marker (int) | |||||||||
GridType | grid_type () | |||||||||
void | hide_track_in_display (TimeAxisView, bool) | |||||||||
long | leftmost_sample () | |||||||||
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) | |||||||||
void | play_selection () | |||||||||
void | play_with_preroll () | |||||||||
void | redo (unsigned int) | |||||||||
Redo some transactions.
| ||||||||||
Redo some transactions.
| ||||||||||
RegionView | regionview_from_region (Region) | |||||||||
void | remove_last_capture () | |||||||||
void | remove_location_at_playhead_cursor () | |||||||||
void | scroll_tracks_up_line () | |||||||||
bool | scroll_up_one_track (bool) | |||||||||
void | select_all_tracks () | |||||||||
void | select_all_visible_lanes () | |||||||||
void | separate_region_from_selection () | |||||||||
void | set_follow_playhead (bool, bool) | |||||||||
Set whether the editor should follow the playhead.
| ||||||||||
Set whether the editor should follow the playhead.
| ||||||||||
void | set_loop_range (long, long, std::string) | |||||||||
void | set_mouse_mode (MouseMode, bool) | |||||||||
Set the mouse mode (gain, object, range, timefx etc.)
| ||||||||||
Set the mouse mode (gain, object, range, timefx etc.)
| ||||||||||
void | set_punch_range (long, long, std::string) | |||||||||
void | set_selection (SelectionList, Operation) | |||||||||
void | set_show_measures (bool) | |||||||||
void | set_snap_mode (SnapMode) | |||||||||
Set the snap mode.
| ||||||||||
void | set_snap_threshold (double) | |||||||||
Set the snap threshold.
| ||||||||||
Set the snap mode.
| ||||||||||
void | set_stationary_playhead (bool) | |||||||||
void | set_toggleaction (std::string, std::string, bool) | |||||||||
void | set_video_timeline_height (int) | |||||||||
void | set_visible_track_count (int) | |||||||||
void | set_zoom_focus (ZoomFocus) | |||||||||
bool | show_measures () | |||||||||
void | show_track_in_display (TimeAxisView, bool) | |||||||||
SnapMode | snap_mode () | |||||||||
SnapType | snap_type () | |||||||||
bool | stationary_playhead () | |||||||||
void | stem_export () | |||||||||
Open stem export dialog | ||||||||||
void | toggle_ruler_video (bool) | |||||||||
void | toggle_xjadeo_proc (int) | |||||||||
void | undo (unsigned int) | |||||||||
Undo some transactions.
| ||||||||||
Undo some transactions.
| ||||||||||
void | update_grid () | |||||||||
double | visible_canvas_height () |
Class to represent list of selected regions.
Methods | ||||
---|---|---|---|---|
long | end_frame () | |||
long | end_sample () | |||
unsigned long | n_midi_regions () | |||
RegionList | regionlist () | |||
long | start () |
Cast | ||
---|---|---|
StripableTimeAxisView | to_stripabletimeaxisview () | |
TimeAxisView | to_timeaxisview () |
Clear everything from the Selection
check if all selections are empty
internal_selection | also check object internals (e.g midi notes, automation points), when false only check objects. |
---|
Returns true if nothing is selected.
check if all selections are empty
Returns true if nothing is selected.
C‡: StripableTimeAxisView
+is-a: ArdourUI:TimeAxisView
+ +Abstract base class for time-axis views (horizontal editor 'strips')
This class provides the basic LHS controls and display methods. This should be extended to create functional time-axis based views.
This class object is only used indirectly as return-value and function-parameter. It provides no methods by itself.
+Methods | ||
---|---|---|
unsigned int | current_height () | |
unsigned int | effective_height () | |
Returns effective height (taking children into account) in canvas units, or 0 if this TimeAxisView has not yet been shown | ||
int | order () | |
Returns index of this TimeAxisView within its parent | ||
void | set_height (unsigned int, TrackHeightMode) | |
double | y_position () | |
Returns y position, or -1 if hidden |
C‡: TimeAxisView
is-a: ArdourUI:AxisView
Abstract base class for time-axis views (horizontal editor 'strips')
This class provides the basic LHS controls and display methods. This should be extended to create functional time-axis based views.
This class object is only used indirectly as return-value and function-parameter. It provides no methods by itself.
+Methods | ||
---|---|---|
unsigned int | current_height () | |
unsigned int | effective_height () | |
Returns effective height (taking children into account) in canvas units, or 0 if this TimeAxisView has not yet been shown | ||
int | order () | |
Returns index of this TimeAxisView within its parent | ||
void | set_height (unsigned int, TrackHeightMode) | |
double | y_position () | |
Returns y position, or -1 if hidden |
C‡: TimeAxisViewItem
is-a: ArdourUI:Selectable
@@ -4106,18 +6238,18 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to CMethods | ||
---|---|---|
long | end_frame () | |
long | length () | |
long | start () | |
long | end_sample () | |
long | length () | |
long | start () |
Constructor | ||
---|---|---|
ℂ | ARDOUR.AudioRangeList () | |
Methods | ||
AudioRange | back () | |
AudioRange | back () | |
bool | empty () | |
AudioRange | front () | |
AudioRange | front () | |
LuaIter | iter () | |
void | reverse () | |
unsigned long | size () | |
Methods | ||
bool | contains (TimeAxisView) | |
RouteList | routelist () |
Constructor | ||
---|---|---|
ℂ | ArdourUI.TrackViewStdList () | |
Methods | ||
TimeAxisView | back () | |
bool | empty () | |
TimeAxisView | front () | |
LuaIter | iter () | |
void | push_back (TimeAxisView) | |
void | reverse () | |
unsigned long | size () | |
LuaTable | table () | |
void | unique () | |
Cast | ||
TrackViewStdList | to_tav_list () |
C‡: TrackViewList
-is-a: ArdourUI:TrackViewStdList
Methods | ||
---|---|---|
bool | contains (TimeAxisView) | |
RouteList | routelist () | |
Cast | ||
TrackViewStdList | to_tav_list () |
Constructor | ||
---|---|---|
ℂ | ArdourUI.TrackViewStdList () | |
Methods | ||
TimeAxisView | back () | |
bool | empty () | |
TimeAxisView | front () | |
LuaIter | iter () | |
void | push_back (TimeAxisView) | |
void | reverse () | |
unsigned long | size () | |
LuaTable | table () | |
void | unique () |
C‡: std::list<TimeAxisView* >
@@ -4184,11 +6289,341 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to CC‡: UIConfiguration
+ +Base class for objects with saveable and undoable state
Methods | ||
---|---|---|
unsigned int | get_action_table_columns () | |
bool | get_all_floating_windows_are_dialogs () | |
bool | get_allow_non_quarter_pulse () | |
bool | get_autoplay_files () | |
bool | get_autoscroll_editor () | |
bool | get_blink_alert_indicators () | |
bool | get_blink_rec_arm () | |
bool | get_boxy_buttons () | |
bool | get_buggy_gradients () | |
bool | get_cairo_image_surface () | |
unsigned long | get_clock_display_limit () | |
std::string | get_color_file () | |
bool | get_color_regions_using_track_color () | |
std::string | get_default_bindings () | |
bool | get_default_narrow_ms () | |
bool | get_draggable_playhead () | |
float | get_draggable_playhead_speed () | |
bool | get_editor_stereo_only_meters () | |
float | get_extra_ui_extents_time () | |
bool | get_flat_buttons () | |
bool | get_floating_monitor_section () | |
bool | get_follow_edits () | |
int | get_font_scale () | |
bool | get_grid_follows_internal () | |
bool | get_hiding_groups_deactivates_groups () | |
std::string | get_icon_set () | |
std::string | get_keyboard_layout () | |
std::string | get_keyboard_layout_name () | |
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 () | |
float | get_meter_peak () | |
bool | get_meter_style_led () | |
VUMeterStandard | get_meter_vu_standard () | |
std::string | get_mixer_strip_visibility () | |
bool | get_name_new_markers () | |
bool | get_never_display_periodic_midi () | |
bool | get_new_automation_points_on_lane () | |
bool | get_no_new_session_dialog () | |
bool | get_only_copy_imported_files () | |
bool | get_open_gui_after_adding_plugin () | |
bool | get_prefer_inline_over_gui () | |
bool | get_preview_video_frame_on_drag () | |
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 () | |
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_mini_timeline () | |
bool | get_show_name_highlight () | |
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_show_track_meters () | |
bool | get_show_waveform_clipping () | |
bool | get_show_waveforms () | |
bool | get_show_waveforms_while_recording () | |
bool | get_show_zoom_tools () | |
unsigned int | get_snap_threshold () | |
bool | get_snap_to_grid () | |
bool | get_snap_to_marks () | |
bool | get_snap_to_region_end () | |
bool | get_snap_to_region_start () | |
bool | get_snap_to_region_sync () | |
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 () | |
std::string | get_ui_rc_file () | |
bool | get_update_editor_during_summary_drag () | |
bool | get_use_double_click_to_zoom_to_selection () | |
bool | get_use_mouse_position_as_zoom_focus_on_scroll () | |
bool | get_use_note_bars_for_velocity () | |
bool | get_use_note_color_for_velocity () | |
bool | get_use_time_rulers_to_zoom_with_vertical_drag () | |
bool | get_use_tooltips () | |
bool | get_use_wm_visibility () | |
unsigned int | get_vertical_region_gap () | |
std::string | get_vkeybd_layout () | |
unsigned long | get_waveform_cache_size () | |
double | get_waveform_clip_level () | |
float | get_waveform_gradient_depth () | |
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_allow_non_quarter_pulse (bool) | |
bool | set_autoplay_files (bool) | |
bool | set_autoscroll_editor (bool) | |
bool | set_blink_alert_indicators (bool) | |
bool | set_blink_rec_arm (bool) | |
bool | set_boxy_buttons (bool) | |
bool | set_buggy_gradients (bool) | |
bool | set_cairo_image_surface (bool) | |
bool | set_clock_display_limit (unsigned long) | |
bool | set_color_file (std::string) | |
bool | set_color_regions_using_track_color (bool) | |
bool | set_default_bindings (std::string) | |
bool | set_default_narrow_ms (bool) | |
bool | set_draggable_playhead (bool) | |
bool | set_draggable_playhead_speed (float) | |
bool | set_editor_stereo_only_meters (bool) | |
bool | set_extra_ui_extents_time (float) | |
bool | set_flat_buttons (bool) | |
bool | set_floating_monitor_section (bool) | |
bool | set_follow_edits (bool) | |
bool | set_font_scale (int) | |
bool | set_grid_follows_internal (bool) | |
bool | set_hiding_groups_deactivates_groups (bool) | |
bool | set_icon_set (std::string) | |
bool | set_keyboard_layout (std::string) | |
bool | set_keyboard_layout_name (std::string) | |
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_meter_peak (float) | |
bool | set_meter_style_led (bool) | |
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_new_automation_points_on_lane (bool) | |
bool | set_no_new_session_dialog (bool) | |
bool | set_only_copy_imported_files (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 (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 (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_mini_timeline (bool) | |
bool | set_show_name_highlight (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_show_track_meters (bool) | |
bool | set_show_waveform_clipping (bool) | |
bool | set_show_waveforms (bool) | |
bool | set_show_waveforms_while_recording (bool) | |
bool | set_show_zoom_tools (bool) | |
bool | set_snap_threshold (unsigned int) | |
bool | set_snap_to_grid (bool) | |
bool | set_snap_to_marks (bool) | |
bool | set_snap_to_region_end (bool) | |
bool | set_snap_to_region_start (bool) | |
bool | set_snap_to_region_sync (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_ui_rc_file (std::string) | |
bool | set_update_editor_during_summary_drag (bool) | |
bool | set_use_double_click_to_zoom_to_selection (bool) | |
bool | set_use_mouse_position_as_zoom_focus_on_scroll (bool) | |
bool | set_use_note_bars_for_velocity (bool) | |
bool | set_use_note_color_for_velocity (bool) | |
bool | set_use_time_rulers_to_zoom_with_vertical_drag (bool) | |
bool | set_use_tooltips (bool) | |
bool | set_use_wm_visibility (bool) | |
bool | set_vertical_region_gap (unsigned int) | |
bool | set_vkeybd_layout (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 (WaveformScale) | |
bool | set_waveform_shape (WaveformShape) | |
bool | set_widget_prelight (bool) | |
Properties | ||
unsigned int | action_table_columns | |
bool | all_floating_windows_are_dialogs | |
bool | allow_non_quarter_pulse | |
bool | autoplay_files | |
bool | autoscroll_editor | |
bool | blink_alert_indicators | |
bool | blink_rec_arm | |
bool | boxy_buttons | |
bool | buggy_gradients | |
bool | cairo_image_surface | |
unsigned long | clock_display_limit | |
std::string | color_file | |
bool | color_regions_using_track_color | |
std::string | default_bindings | |
bool | default_narrow_ms | |
bool | draggable_playhead | |
float | draggable_playhead_speed | |
bool | editor_stereo_only_meters | |
float | extra_ui_extents_time | |
bool | flat_buttons | |
bool | floating_monitor_section | |
bool | follow_edits | |
int | font_scale | |
bool | grid_follows_internal | |
bool | hiding_groups_deactivates_groups | |
std::string | icon_set | |
std::string | keyboard_layout | |
std::string | keyboard_layout_name | |
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 | |
float | meter_peak | |
bool | meter_style_led | |
ARDOUR.VUMeterStandard | meter_vu_standard | |
std::string | mixer_strip_visibility | |
bool | name_new_markers | |
bool | never_display_periodic_midi | |
bool | new_automation_points_on_lane | |
bool | no_new_session_dialog | |
bool | only_copy_imported_files | |
bool | open_gui_after_adding_plugin | |
bool | prefer_inline_over_gui | |
bool | preview_video_frame_on_drag | |
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 | |
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_mini_timeline | |
bool | show_name_highlight | |
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 | show_track_meters | |
bool | show_waveform_clipping | |
bool | show_waveforms | |
bool | show_waveforms_while_recording | |
bool | show_zoom_tools | |
unsigned int | snap_threshold | |
bool | snap_to_grid | |
bool | snap_to_marks | |
bool | snap_to_region_end | |
bool | snap_to_region_start | |
bool | snap_to_region_sync | |
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 | |
std::string | ui_rc_file | |
bool | update_editor_during_summary_drag | |
bool | use_double_click_to_zoom_to_selection | |
bool | use_mouse_position_as_zoom_focus_on_scroll | |
bool | use_note_bars_for_velocity | |
bool | use_note_color_for_velocity | |
bool | use_time_rulers_to_zoom_with_vertical_drag | |
bool | use_tooltips | |
bool | use_wm_visibility | |
unsigned int | vertical_region_gap | |
std::string | vkeybd_layout | |
unsigned long | waveform_cache_size | |
double | waveform_clip_level | |
float | waveform_gradient_depth | |
ARDOUR.WaveformScale | waveform_scale | |
ARDOUR.WaveformShape | waveform_shape | |
bool | widget_prelight |
C‡: unsigned char*
@@ -4198,9 +6633,36 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to CC‡: std::vector<unsigned char >
+ +Constructor | ||
---|---|---|
ℂ | C.ByteVector () | |
ℂ | C.ByteVector () | |
Methods | ||
LuaTable | add (LuaTable {unsigned char}) | |
unsigned char | at (unsigned long) | |
void | clear () | |
bool | empty () | |
LuaIter | iter () | |
void | push_back (unsigned char) | |
unsigned long | size () | |
LuaTable | table () | |
... | to_array (--lua--) |
C‡: double*
+ +Methods | ||
---|---|---|
LuaMetaTable | array () | |
LuaTable | get_table () | |
DoubleArray | offset (unsigned int) | |
void | set_table (LuaTable {double}) |
C‡: std::vector<double >
@@ -4211,11 +6673,13 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to CC‡: float*
@@ -4225,7 +6689,6 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to CC‡: std::vector<float >
@@ -4254,11 +6719,31 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to CC‡: std::list<long >
+ +Constructor | ||
---|---|---|
ℂ | C.Int64List () | |
Methods | ||
LuaTable | add (LuaTable {long}) | |
long | back () | |
bool | empty () | |
long | front () | |
LuaIter | iter () | |
void | push_back (long) | |
void | reverse () | |
unsigned long | size () | |
LuaTable | table () | |
void | unique () |
C‡: int*
@@ -4268,7 +6753,6 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to CC‡: Cairo::Context
@@ -4316,9 +6802,9 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C context->translate(x, y); context->scale(width / 2.0, height / 2.0); context->arc(0.0, 0.0, 1.0, 0.0, 2 * M_PI); - context->restore();xc | X position of the center of the arc |
---|---|
yc | Y position of the center of the arc |
radius | the radius of the arc |
angle1 | the start angle, in radians |
angle2 | the end angle, in radians |
Adds a circular arc of the given radius to the current path. The arc is centered at (xc, yc), begins at angle1 and proceeds in the direction of decreasing angles to end at angle2. If angle2 is greater than angle1 it will be progressively decreased by 2*M_PI until it is greater than angle1.
See arc() for more details. This function differs only in the direction of the arc between the two angles.
xc | X position of the center of the arc |
---|---|
yc | Y position of the center of the arc |
radius | the radius of the arc |
angle1 | the start angle, in radians |
angle2 | the end angle, in radians |
Adds a circular arc of the given radius to the current path. The arc is centered at (xc, yc), begins at angle1 and proceeds in the direction of decreasing angles to end at angle2. If angle2 is greater than angle1 it will be progressively decreased by 2*M_PI until it is greater than angle1.
See arc() for more details. This function differs only in the direction of the arc between the two angles.
Clears the current path. After this call there will be no current point.
Adds a line segment to the path from the current point to the beginning of the current subpath, (the most recent point passed to move_to()), and closes this subpath. After this call the current point will be at the joined endpoint of the sub-path.
The behavior of close_path() is distinct from simply calling line_to() with the equivalent coordinate in the case of stroking. When a closed subpath is stroked, there are no caps on the ends of the subpath. Instead, there is a line join connecting the final and initial segments of the subpath.
If there is no current point before the call to close_path(), this function will have no effect.
Adds a cubic Bezier spline to the path from the current point to position (x3, y3) in user-space coordinates, using (x1, y1) and (x2, y2) as the control points. After this call the current point will be (x3, y3).
If there is no current point before the call to curve_to() this function will behave as if preceded by a call to move_to(x1, y1).
x1 | the X coordinate of the first control point |
---|---|
y1 | the Y coordinate of the first control point |
x2 | the X coordinate of the second control point |
y2 | the Y coordinate of the second control point |
x3 | the X coordinate of the end of the curve |
y3 | the Y coordinate of the end of the curve |
Adds a cubic Bezier spline to the path from the current point to position (x3, y3) in user-space coordinates, using (x1, y1) and (x2, y2) as the control points. After this call the current point will be (x3, y3).
If there is no current point before the call to curve_to() this function will behave as if preceded by a call to move_to(x1, y1).
A drawing operator that fills the current path according to the current fill rule, (each sub-path is implicitly closed before being filled). After fill(), the current path will be cleared from the cairo context.
set_fill_rule()
fill_preserve()
A drawing operator that fills the current path according to the current fill rule, (each sub-path is implicitly closed before being filled). Unlike fill(), fill_preserve() preserves the path within the cairo Context.
set_fill_rule()
fill().
Adds a line to the path from the current point to position (x, y) in user-space coordinates. After this call the current point will be (x, y).
If there is no current point before the call to line_to() this function will behave as move_to(x, y).
x | the X coordinate of the end of the new line |
---|---|
y | the Y coordinate of the end of the new line |
Adds a line to the path from the current point to position (x, y) in user-space coordinates. After this call the current point will be (x, y).
If there is no current point before the call to line_to() this function will behave as move_to(x, y).
If the current subpath is not empty, begin a new subpath. After this call the current point will be (x, y).
x | the X coordinate of the new position |
---|---|
y | the Y coordinate of the new position |
If the current subpath is not empty, begin a new subpath. After this call the current point will be (x, y).
A drawing operator that paints the current source everywhere within the current clip region.
A drawing operator that paints the current source everywhere within the current clip region using a mask of constant alpha value alpha. The effect is similar to paint(), but the drawing is faded out using the alpha value.
alpha | an alpha value, between 0 (transparent) and 1 (opaque) |
---|
A drawing operator that paints the current source everywhere within the current clip region using a mask of constant alpha value alpha. The effect is similar to paint(), but the drawing is faded out using the alpha value.
Adds a closed-subpath rectangle of the given size to the current path at position (x, y) in user-space coordinates.
This function is logically equivalent to:
context->move_to(x, y); context->rel_line_to(width, 0); context->rel_line_to(0, height); context->rel_line_to(-width, 0); - context->close_path();
x | the X coordinate of the top left corner of the rectangle |
---|---|
y | the Y coordinate to the top left corner of the rectangle |
width | the width of the rectangle |
height | the height of the rectangle |
Relative-coordinate version of curve_to(). All offsets are relative to the current point. Adds a cubic Bezier spline to the path from the current point to a point offset from the current point by (dx3, dy3), using points offset by (dx1, dy1) and (dx2, dy2) as the control points. After this call the current point will be offset by (dx3, dy3).
Given a current point of (x, y),
rel_curve_to(dx1, dy1, dx2, dy2, dx3, dy3)
is logically equivalent to
curve_to(x + dx1, y + dy1, x + dx2, y + dy2, x + dx3, y + dy3).
It is an error to call this function with no current point. Doing so will cause this to shutdown with a status of CAIRO_STATUS_NO_CURRENT_POINT. Cairomm will then throw an exception.
dx1 | the X offset to the first control point |
---|---|
dy1 | the Y offset to the first control point |
dx2 | the X offset to the second control point |
dy2 | the Y offset to the second control point |
dx3 | the X offset to the end of the curve |
dy3 | the Y offset to the end of the curve |
Relative-coordinate version of curve_to(). All offsets are relative to the current point. Adds a cubic Bezier spline to the path from the current point to a point offset from the current point by (dx3, dy3), using points offset by (dx1, dy1) and (dx2, dy2) as the control points. After this call the current point will be offset by (dx3, dy3).
Given a current point of (x, y),
rel_curve_to(dx1, dy1, dx2, dy2, dx3, dy3)
is logically equivalent to
curve_to(x + dx1, y + dy1, x + dx2, y + dy2, x + dx3, y + dy3).
It is an error to call this function with no current point. Doing so will cause this to shutdown with a status of CAIRO_STATUS_NO_CURRENT_POINT. Cairomm will then throw an exception.
Relative-coordinate version of line_to(). Adds a line to the path from the current point to a point that is offset from the current point by (dx, dy) in user space. After this call the current point will be offset by (dx, dy).
Given a current point of (x, y),
rel_line_to(dx, dy)
is logically equivalent to
line_to(x + dx, y + dy).
It is an error to call this function with no current point. Doing so will cause this to shutdown with a status of CAIRO_STATUS_NO_CURRENT_POINT. Cairomm will then throw an exception.
dx | the X offset to the end of the new line |
---|---|
dy | the Y offset to the end of the new line |
Relative-coordinate version of line_to(). Adds a line to the path from the current point to a point that is offset from the current point by (dx, dy) in user space. After this call the current point will be offset by (dx, dy).
Given a current point of (x, y),
rel_line_to(dx, dy)
is logically equivalent to
line_to(x + dx, y + dy).
It is an error to call this function with no current point. Doing so will cause this to shutdown with a status of CAIRO_STATUS_NO_CURRENT_POINT. Cairomm will then throw an exception.
If the current subpath is not empty, begin a new subpath. After this call the current point will offset by (x, y).
Given a current point of (x, y),
rel_move_to(dx, dy)
is logically equivalent to
move_to(x + dx, y + dy)
It is an error to call this function with no current point. Doing so will cause this to shutdown with a status of CAIRO_STATUS_NO_CURRENT_POINT. Cairomm will then throw an exception.
dx | the X offset |
---|---|
dy | the Y offset |
If the current subpath is not empty, begin a new subpath. After this call the current point will offset by (x, y).
Given a current point of (x, y),
rel_move_to(dx, dy)
is logically equivalent to
move_to(x + dx, y + dy)
It is an error to call this function with no current point. Doing so will cause this to shutdown with a status of CAIRO_STATUS_NO_CURRENT_POINT. Cairomm will then throw an exception.
Reset the current clip region to its original, unrestricted state. That is, set the clip region to an infinitely large shape containing the target surface. Equivalently, if infinity is too hard to grasp, one can imagine the clip region being reset to the exact bounds of the target surface.
Note that code meant to be reusable should not call reset_clip() as it will cause results unexpected by higher-level code which calls clip(). Consider using save() and restore() around clip() as a more robust means of temporarily restricting the clip region.
Restores cr to the state saved by a preceding call to save() and removes that state from the stack of saved states.
save()
Modifies the current transformation matrix (CTM) by rotating the user-space axes by angle radians. The rotation of the axes takes places after any existing transformation of user space. The rotation direction for positive angles is from the positive X axis toward the positive Y axis.
angle | angle (in radians) by which the user-space axes will be rotated |
---|
Modifies the current transformation matrix (CTM) by rotating the user-space axes by angle radians. The rotation of the axes takes places after any existing transformation of user space. The rotation direction for positive angles is from the positive X axis toward the positive Y axis.
Makes a copy of the current state of the Context and saves it on an internal stack of saved states. When restore() is called, it will be restored to the saved state. Multiple calls to save() and restore() can be nested; each call to restore() restores the state from the matching paired save().
It isn't necessary to clear all saved states before a cairo_t is freed. Any saved states will be freed when the Context is destroyed.
restore()
Modifies the current transformation matrix (CTM) by scaling the X and Y user-space axes by sx and sy respectively. The scaling of the axes takes place after any existing transformation of user space.
sx | scale factor for the X dimension |
---|---|
sy | scale factor for the Y dimension |
Modifies the current transformation matrix (CTM) by scaling the X and Y user-space axes by sx and sy respectively. The scaling of the axes takes place after any existing transformation of user space.
Sets the dash pattern to be used by stroke(). A dash pattern is specified by dashes, an array of positive values. Each value provides the user-space length of altenate "on" and "off" portions of the stroke. The offset specifies an offset into the pattern at which the stroke begins.
Each "on" segment will have caps applied as if the segment were a separate sub-path. In particular, it is valid to use an "on" length of 0.0 with Cairo::LINE_CAP_ROUND or Cairo::LINE_CAP_SQUARE in order to distributed dots or squares along a path.
Note: The length values are in user-space units as evaluated at the time of stroking. This is not necessarily the same as the user space at the time of set_dash().
If dashes is empty dashing is disabled. If the size of dashes is 1, a symmetric pattern is assumed with alternating on and off portions of the size specified by the single value in dashes.
It is invalid for any value in dashes to be negative, or for all values to be 0. If this is the case, an exception will be thrown
dashes | an array specifying alternate lengths of on and off portions |
---|---|
offset | an offset into the dash pattern at which the stroke should start |
Sets the dash pattern to be used by stroke(). A dash pattern is specified by dashes, an array of positive values. Each value provides the user-space length of altenate "on" and "off" portions of the stroke. The offset specifies an offset into the pattern at which the stroke begins.
Each "on" segment will have caps applied as if the segment were a separate sub-path. In particular, it is valid to use an "on" length of 0.0 with Cairo::LINE_CAP_ROUND or Cairo::LINE_CAP_SQUARE in order to distributed dots or squares along a path.
Note: The length values are in user-space units as evaluated at the time of stroking. This is not necessarily the same as the user space at the time of set_dash().
If dashes is empty dashing is disabled. If the size of dashes is 1, a symmetric pattern is assumed with alternating on and off portions of the size specified by the single value in dashes.
It is invalid for any value in dashes to be negative, or for all values to be 0. If this is the case, an exception will be thrown
Sets the current font matrix to a scale by a factor of size, replacing any font matrix previously set with set_font_size() or set_font_matrix(). This results in a font size of size user space units. (More precisely, this matrix will result in the font's em-square being a by size square in user space.)
If text is drawn without a call to set_font_size(), (nor set_font_matrix() nor set_scaled_font()), the default font size is 10.0.
size | the new font size, in user space units) |
---|
Sets the current font matrix to a scale by a factor of size, replacing any font matrix previously set with set_font_size() or set_font_matrix(). This results in a font size of size user space units. (More precisely, this matrix will result in the font's em-square being a by size square in user space.)
If text is drawn without a call to set_font_size(), (nor set_font_matrix() nor set_scaled_font()), the default font size is 10.0.
Sets the current line cap style within the cairo Context. See LineCap for details about how the available line cap styles are drawn.
As with the other stroke parameters, the current line cap style is examined by stroke(), stroke_extents(), and stroke_to_path(), but does not have any effect during path construction.
The default line cap style is Cairo::LINE_CAP_BUTT.
line_cap | a line cap style, as a LineCap |
---|
Sets the current line cap style within the cairo Context. See LineCap for details about how the available line cap styles are drawn.
As with the other stroke parameters, the current line cap style is examined by stroke(), stroke_extents(), and stroke_to_path(), but does not have any effect during path construction.
The default line cap style is Cairo::LINE_CAP_BUTT.
Sets the current line join style within the cairo Context. See LineJoin for details about how the available line join styles are drawn.
As with the other stroke parameters, the current line join style is examined by stroke(), stroke_extents(), and stroke_to_path(), but does not have any effect during path construction.
The default line join style is Cairo::LINE_JOIN_MITER.
line_join | a line joint style, as a LineJoin |
---|
Sets the current line join style within the cairo Context. See LineJoin for details about how the available line join styles are drawn.
As with the other stroke parameters, the current line join style is examined by stroke(), stroke_extents(), and stroke_to_path(), but does not have any effect during path construction.
The default line join style is Cairo::LINE_JOIN_MITER.
Sets the current line width within the cairo Context. The line width specifies the diameter of a pen that is circular in user-space, (though device-space pen may be an ellipse in general due to scaling/shear/rotation of the CTM).
Note: When the description above refers to user space and CTM it refers to the user space and CTM in effect at the time of the stroking operation, not the user space and CTM in effect at the time of the call to set_line_width(). The simplest usage makes both of these spaces identical. That is, if there is no change to the CTM between a call to set_line_width() and the stroking operation, then one can just pass user-space values to set_line_width() and ignore this note.
As with the other stroke parameters, the current line cap style is examined by stroke(), stroke_extents(), and stroke_to_path(), but does not have any effect during path construction.
The default line width value is 2.0.
width | a line width, as a user-space value |
---|
Sets the current line width within the cairo Context. The line width specifies the diameter of a pen that is circular in user-space, (though device-space pen may be an ellipse in general due to scaling/shear/rotation of the CTM).
Note: When the description above refers to user space and CTM it refers to the user space and CTM in effect at the time of the stroking operation, not the user space and CTM in effect at the time of the call to set_line_width(). The simplest usage makes both of these spaces identical. That is, if there is no change to the CTM between a call to set_line_width() and the stroking operation, then one can just pass user-space values to set_line_width() and ignore this note.
As with the other stroke parameters, the current line cap style is examined by stroke(), stroke_extents(), and stroke_to_path(), but does not have any effect during path construction.
The default line width value is 2.0.
Sets the compositing operator to be used for all drawing operations. See Operator for details on the semantics of each available compositing operator.
op | a compositing operator, specified as a Operator |
---|
Sets the compositing operator to be used for all drawing operations. See Operator for details on the semantics of each available compositing operator.
Sets the source pattern within the Context to an opaque color. This opaque color will then be used for any subsequent drawing operation until a new source pattern is set.
The color components are floating point numbers in the range 0 to 1. If the values passed in are outside that range, they will be clamped.
set_source_rgba()
set_source()
red | red component of color |
---|---|
green | green component of color |
blue | blue component of color |
Sets the source pattern within the Context to an opaque color. This opaque color will then be used for any subsequent drawing operation until a new source pattern is set.
The color components are floating point numbers in the range 0 to 1. If the values passed in are outside that range, they will be clamped.
set_source_rgba()
set_source()
Sets the source pattern within the Context to a translucent color. This color will then be used for any subsequent drawing operation until a new source pattern is set.
The color and alpha components are floating point numbers in the range 0 to 1. If the values passed in are outside that range, they will be clamped.
set_source_rgb()
set_source()
red | red component of color |
---|---|
green | green component of color |
blue | blue component of color |
alpha | alpha component of color |
Sets the source pattern within the Context to a translucent color. This color will then be used for any subsequent drawing operation until a new source pattern is set.
The color and alpha components are floating point numbers in the range 0 to 1. If the values passed in are outside that range, they will be clamped.
set_source_rgb()
set_source()
A drawing operator that generates the shape from a string of UTF-8 characters, rendered according to the current font_face, font_size (font_matrix), and font_options.
This function first computes a set of glyphs for the string of text. The first glyph is placed so that its origin is at the current point. The origin of each subsequent glyph is offset from that of the previous glyph by the advance values of the previous glyph.
After this call the current point is moved to the origin of where the next glyph would be placed in this same progression. That is, the current point will be at the origin of the final glyph offset by its advance values. This allows for easy display of a single logical string with multiple calls to show_text().
Note: The show_text() function call is part of what the cairo designers call the "toy" text API. It is convenient for short demos and simple programs, but it is not expected to be adequate for serious text-using applications. See show_glyphs() for the "real" text display API in cairo.
utf8 | a string containing text encoded in UTF-8 |
---|
A drawing operator that generates the shape from a string of UTF-8 characters, rendered according to the current font_face, font_size (font_matrix), and font_options.
This function first computes a set of glyphs for the string of text. The first glyph is placed so that its origin is at the current point. The origin of each subsequent glyph is offset from that of the previous glyph by the advance values of the previous glyph.
After this call the current point is moved to the origin of where the next glyph would be placed in this same progression. That is, the current point will be at the origin of the final glyph offset by its advance values. This allows for easy display of a single logical string with multiple calls to show_text().
Note: The show_text() function call is part of what the cairo designers call the "toy" text API. It is convenient for short demos and simple programs, but it is not expected to be adequate for serious text-using applications. See show_glyphs() for the "real" text display API in cairo.
A drawing operator that strokes the current Path according to the current line width, line join, line cap, and dash settings. After stroke(), the current Path will be cleared from the cairo Context.
set_line_width()
set_line_join()
set_line_cap()
set_dash()
stroke_preserve().
Note: Degenerate segments and sub-paths are treated specially and provide a useful result. These can result in two different situations:
1. Zero-length "on" segments set in set_dash(). If the cap style is Cairo::LINE_CAP_ROUND or Cairo::LINE_CAP_SQUARE then these segments will be drawn as circular dots or squares respectively. In the case of Cairo::LINE_CAP_SQUARE, the orientation of the squares is determined by the direction of the underlying path.
2. A sub-path created by move_to() followed by either a close_path() or one or more calls to line_to() to the same coordinate as the move_to(). If the cap style is Cairo::LINE_CAP_ROUND then these sub-paths will be drawn as circular dots. Note that in the case of Cairo::LINE_CAP_SQUARE a degenerate sub-path will not be drawn at all, (since the correct orientation is indeterminate).
In no case will a cap style of Cairo::LINE_CAP_BUTT cause anything to be drawn in the case of either degenerate segments or sub-paths.
A drawing operator that strokes the current Path according to the current line width, line join, line cap, and dash settings. Unlike stroke(), stroke_preserve() preserves the Path within the cairo Context.
set_line_width()
set_line_join()
set_line_cap()
set_dash()
stroke_preserve().
Modifies the current transformation matrix (CTM) by translating the user-space origin by (tx, ty). This offset is interpreted as a user-space coordinate according to the CTM in place before the new call to translate. In other words, the translation of the user-space origin takes place after any existing transformation.
tx | amount to translate in the X direction |
---|---|
ty | amount to translate in the Y direction |
Modifies the current transformation matrix (CTM) by translating the user-space origin by (tx, ty). This offset is interpreted as a user-space coordinate according to the CTM in place before the new call to translate. In other words, the translation of the user-space origin takes place after any existing transformation.
This function disables a dash pattern that was set with set_dash()
Gets the width of the ImageSurface in pixels
Set this surface as source for another context. This allows to draw this surface
C‡: LuaCairo::PangoLayout
@@ -4417,6 +6904,8 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to CGets the alignment for the layout: how partial lines are positioned within the horizontal space available.
Returns The alignment.
Gets the type of ellipsization being performed for layout. See set_ellipsize()
Use is_ellipsized() to query whether any paragraphs were actually ellipsized.
Returns The current ellipsization mode for layout.
Queries whether the layout had to wrap any paragraphs.
This returns true if a positive width is set on layout, ellipsization mode of layout is set to Pango::ELLIPSIZE_NONE, and there are paragraphs exceeding the layout width that have to be wrapped.
Returns true if any paragraphs had to be wrapped, false otherwise.
Sets the alignment for the layout: how partial lines are positioned within the horizontal space available.
Sets the type of ellipsization being performed for layout. Depending on the ellipsization mode ellipsize text is removed from the start, middle, or end of text so they fit within the width and height of layout set with set_width() and set_height().
If the layout contains characters such as newlines that force it to be layed out in multiple paragraphs, then whether each paragraph is ellipsized separately or the entire layout is ellipsized as a whole depends on the set height of the layout. See set_height() for details.
ellipsize | The new ellipsization mode for layout. |
---|
Sets the type of ellipsization being performed for layout. Depending on the ellipsization mode ellipsize text is removed from the start, middle, or end of text so they fit within the width and height of layout set with set_width() and set_height().
If the layout contains characters such as newlines that force it to be layed out in multiple paragraphs, then whether each paragraph is ellipsized separately or the entire layout is ellipsized as a whole depends on the set height of the layout. See set_height() for details.
Sets the layout text and attribute list from marked-up text (see markup format). Replaces the current text and attribute list.
markup | Some marked-up text. |
---|
Sets the layout text and attribute list from marked-up text (see markup format). Replaces the current text and attribute list.
Set the text of the layout.
text | The text for the layout. |
---|
Sets the width to which the lines of the Pango::Layout should wrap or ellipsized. The default value is -1: no width set.
width | The desired width in Pango units, or -1 to indicate that no wrapping or ellipsization should be performed. |
---|
Set the text of the layout.
Sets the width to which the lines of the Pango::Layout should wrap or ellipsized. The default value is -1: no width set.
Sets the wrap mode; the wrap mode only has effect if a width is set on the layout with set_width(). To turn off wrapping, set the width to -1.
wrap | The wrap mode. |
---|
Sets the wrap mode; the wrap mode only has effect if a width is set on the layout with set_width(). To turn off wrapping, set the width to -1.
Draws a Layout in the specified Cairo context. The top-left corner of the Layout will be drawn at the current point of the cairo context.
C‡: Evoral::Beats
+C‡: Temporal::Beats
Musical time in beats.
Constructor | ||
---|---|---|
ℂ | Evoral.Beats (double) | |
Create from a real number of beats. | ||
Methods | ||
double | to_double () | |
double | to_double () |
C‡: boost::shared_ptr< Evoral::Control >, boost::weak_ptr< Evoral::Control >
@@ -4461,7 +6952,15 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to CC‡: Evoral::ControlEvent
+ +A single event (time-stamped value) for a control
Data Members | ||
---|---|---|
double | value | |
double | when |
C‡: boost::shared_ptr< Evoral::ControlList >, boost::weak_ptr< Evoral::ControlList >
@@ -4470,26 +6969,34 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to CMethods | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
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
| ||||||||||
double | eval (double) | |||||||||
query value at given time (takes a read-lock, not safe while writing automation)
Returns parameter value | ||||||||||
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) | |||||||||
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 | ||||||||||
bool | sameinstance (ControlList) | |||||||||
void | set_interpolation (InterpolationStyle) | |||||||||
set the interpolation style of the automation data
| ||||||||||
LuaTable(double, ...) | rt_safe_eval (double, bool&) | |||||||||
Realtime safe version of eval(). This may fail if a read-lock cannot be taken.
Returns parameter value | ||||||||||
bool | set_interpolation (InterpolationStyle) | |||||||||
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.
| ||||||||||
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 >
@@ -4497,7 +7004,6 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to CMethods | ||
---|---|---|
bool | isnil () | |
bool | sameinstance (ControlSet) |
C‡: Evoral::Event<long>
@@ -4515,18 +7021,17 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to CC‡: boost::shared_ptr< Evoral::Note<Evoral::Beats> >, boost::weak_ptr< Evoral::Note<Evoral::Beats> >
+C‡: boost::shared_ptr< Evoral::Note<Temporal::Beats> >, boost::weak_ptr< Evoral::Note<Temporal::Beats> >
Methods | ||
---|---|---|
unsigned char | channel () | |
unsigned char | channel () | |
bool | isnil () | |
Beats | length () | |
unsigned char | note () | |
unsigned char | off_velocity () | |
bool | sameinstance (NotePtr) | |
Beats | time () | |
unsigned char | velocity () | |
Beats | length () | |
unsigned char | note () | |
unsigned char | off_velocity () | |
Beats | time () | |
unsigned char | velocity () |
C‡: Evoral::Parameter
@@ -4548,6 +7053,8 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to CTrue for log-scale parameters
Minimum value (in Hz, for frequencies)
C‡: boost::shared_ptr< Evoral::Sequence<Evoral::Beats> >, boost::weak_ptr< Evoral::Sequence<Evoral::Beats> >
+C‡: boost::shared_ptr< Evoral::Sequence<Temporal::Beats> >, boost::weak_ptr< Evoral::Sequence<Temporal::Beats> >
is-a: Evoral:ControlSet
Methods | ||
---|---|---|
bool | isnil () | |
bool | sameinstance (Sequence) |
C‡: LuaDialog::Dialog
+ +Constructor | ||
---|---|---|
ℂ | LuaDialog.Dialog (std::string, Lua-Function) | |
Methods | ||
... | run (--lua--) |
C‡: LuaDialog::Message
+ +Constructor | ||
---|---|---|
ℂ | LuaDialog.Message (std::string, std::string, MessageType, ButtonType) | |
Methods | ||
int | run () |
C‡: LuaDialog::ProgressWindow
+ +Synchronous GUI-thread Progress dialog
This shows a modal progress dialog with an optional "Cancel" button. Since it runs in the UI thread the script needs to regularly call progress(), as well as close the dialog, as needed.
Constructor | ||
---|---|---|
ℂ | LuaDialog.ProgressWindow (std::string, bool) | |
Methods | ||
bool | canceled () | |
void | done () | |
Close and hide the dialog. This is required to be at the end, since the dialog is modal and prevents other UI operations while visible. | ||
bool | progress (float, std::string) | |
Report progress and update GUI.
Returns true if cancel was clicked, false otherwise |
C‡: std::bitset<47ul>
+C‡: std::bitset<49ul>
Constructor | ||
---|---|---|
ℂ | LuaSignal.Set () | |
Methods | ||
LuaTable | add (47ul) | |
bool | any () | |
unsigned long | count () | |
bool | none () | |
Set | reset () | |
Set | set (unsigned long, bool) | |
unsigned long | size () | |
LuaTable | add (49ul) | |
bool | any () | |
unsigned long | count () | |
bool | none () | |
Set | reset () | |
Set | set (unsigned long, bool) | |
unsigned long | size () | |
LuaTable | table () | |
bool | test (unsigned long) | |
bool | test (unsigned long) |
C‡: boost::shared_ptr< PBD::Controllable >, boost::weak_ptr< PBD::Controllable >
is-a: PBD:StatefulDestructiblePtr
-This is a pure virtual class to represent a scalar control.
Note that it contains no storage/state for the controllable thing that it represents. Derived classes must provide set_value()/get_value() methods, which will involve (somehow) an actual location to store the value.
In essence, this is an interface, not a class.
Without overriding upper() and lower(), a derived class will function as a control whose value can range between 0 and 1.0.
This is a pure virtual class to represent a scalar control.
Note that it contains no storage/state for the controllable thing that it represents. Derived classes must provide set_value()/get_value() methods, which will involve (somehow) an actual location to store the value.
In essence, this is an interface, not a class.
Without overriding upper() and lower(), a derived class will function as a control whose value can range between 0 and 1.0.
We express Controllable values in one of three ways: 1. `user' --- as presented to the user (e.g. dB, Hz, etc.) 2. `interface' --- as used in some cases for the UI representation (in order to make controls behave logarithmically). 3. `internal' --- as passed to a processor, track, plugin, or whatever.
Note that in some cases user and internal may be the same (and interface different) e.g. frequency, which is presented to the user and passed to the processor in linear terms, but which needs log scaling in the interface.
In other cases, user and interface may be the same (and internal different) e.g. gain, which is presented to the user in log terms (dB) but passed to the processor as a linear quantity.
Methods | ||
---|---|---|
double | get_value () | |
Get `internal' value Returns raw value as used for the plugin/processor control port | ||
bool | isnil () | |
std::string | name () | |
bool | sameinstance (Controllable) |
Methods | ||
---|---|---|
LuaTable | add (LuaTable {ID}) | |
ID | at (unsigned long) | |
void | clear () | |
bool | empty () | |
LuaIter | iter () | |
void | push_back (ID) | |
unsigned long | size () | |
LuaTable | table () | |
... | to_array (--lua--) |
C‡: PBD::RingBufferNPT<unsigned char>
@@ -4759,7 +7299,6 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to CMethods | ||
---|---|---|
bool | isnil () | |
bool | sameinstance (StatefulDestructible) |
ID | id () | |
bool | isnil () | |
OwnedPropertyList | properties () | |
bool | sameinstance (Stateful) |
C‡: XMLNode
@@ -4821,9 +7359,9 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to CC‡: Timecode::Time
@@ -4835,7 +7373,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to CWhether this Time uses dropframe Timecode
Timecode frames (not audio samples)
Timecode frames (not audio frames)
C‡: std::map<int, std::vector<Vamp::Plugin::Feature > > > >
@@ -4995,11 +7535,13 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to CC‡: Vamp::PluginBase
@@ -5070,11 +7612,13 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to CC‡: Vamp::RealTime
@@ -5094,6 +7638,13 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to CMethods | ||
---|---|---|
int | execute (std::string) | |
LuaTable | forkexec () |