X-Git-Url: http://shamusworld.gotdns.org/cgi-bin/gitweb.cgi?a=blobdiff_plain;f=include%2Fclass-reference.html;h=0f42a1ce7d810fe2c76f0ddeeff70f1a7b6346c5;hb=4e3479eea4c28e386b37d5d67232168f4512bd2d;hp=8b7a996c501a72d1af0fe51f064978c01f39651d;hpb=f56f05b33bf5b64f0ad3f47074d1759c96b65156;p=ardour-manual diff --git a/include/class-reference.html b/include/class-reference.html index 8b7a996..0f42a1c 100644 --- a/include/class-reference.html +++ b/include/class-reference.html @@ -139,6 +139,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
************************************************************* Pure interface begins here*************************************************************
remove plugin/processor
Returns 0 on success
replace plugin/processor with another
Returns 0 on success
set buffer mapping for given data type
C‡: std::list<boost::shared_ptr<ARDOUR::AutomationControl> >
+ +Constructor | ||
---|---|---|
ℂ | ARDOUR.ControlList () | |
Methods | ||
LuaTable | add (LuaTable {AutomationControl}) | |
AutomationControl | back () | |
bool | empty () | |
AutomationControl | front () | |
LuaIter | iter () | |
void | push_back (AutomationControl) | |
void | reverse () | |
unsigned long | size () | |
LuaTable | table () | |
void | unique () |
C‡: boost::shared_ptr<std::list<boost::shared_ptr<ARDOUR::AutomationControl> > >
+ +Constructor | ||
---|---|---|
ℂ | ARDOUR.ControlListPtr () | |
Methods | ||
LuaTable | add (LuaTable {AutomationControl}) | |
bool | empty () | |
LuaIter | iter () | |
void | push_back (AutomationControl) | |
void | reverse () | |
unsigned long | size () | |
LuaTable | table () | |
void | unique () |
bool | active () | |
void | deactivate () | |
std::string | display_name () | |
bool | display_to_user () | |
ChanCount | input_streams () | |
ChanCount | output_streams () | |
Cast | ||
---|---|---|
PeakMeter | to_meter () | |
MonitorProcessor | to_monitorprocessor () | |
PeakMeter | to_peakmeter () | |
PluginInsert | to_plugininsert () | |
SideChain | to_sidechain () | |
UnknownProcessor | to_unknownprocessor () |
Constructor | ||
---|---|---|
ℂ | ARDOUR.DeviceStatusVector () | |
ℂ | ARDOUR.DeviceStatusVector () | |
Methods | ||
LuaTable | add (LuaTable {DeviceStatus}) | |
DeviceStatus | at (unsigned long) | |
bool | active () | |
void | deactivate () | |
std::string | display_name () | |
bool | display_to_user () | |
ChanCount | input_streams () | |
ChanCount | output_streams () | |
Cast | ||
PeakMeter | to_meter () | |
MonitorProcessor | to_monitorprocessor () | |
PeakMeter | to_peakmeter () | |
PluginInsert | to_plugininsert () | |
SideChain | to_sidechain () | |
UnknownProcessor | to_unknownprocessor () |
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.
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)
get a plugin control parameter value
Returns value
get a plugin control parameter value
Returns value
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)
create a new Lua Processor (Plugin)
Returns Processor object (may be nil)
************************************************************* Pure interface begins here*************************************************************
remove plugin/processor
Returns 0 on success
replace plugin/processor with another
Returns 0 on success
Constructor | ||
---|---|---|
ℂ | ARDOUR.PresetVector () | |
ℂ | ARDOUR.PresetVector () | |
Methods | ||
LuaTable | add (LuaTable {PresetRecord}) | |
PresetRecord | at (unsigned long) | |
bool | active () | |
void | deactivate () | |
std::string | display_name () | |
bool | display_to_user () | |
ChanCount | input_streams () | |
bool | isnil () | |
ChanCount | output_streams () | |
PeakMeter | to_meter () | |
MonitorProcessor | to_monitorprocessor () | |
PeakMeter | to_peakmeter () | |
PluginInsert | to_plugininsert () | |
SideChain | to_sidechain () | |
UnknownProcessor | to_unknownprocessor () |
C‡: std::list<boost::shared_ptr<ARDOUR::Processor> >
+ +Constructor | ||
---|---|---|
ℂ | ARDOUR.ProcessorList () | |
Methods | ||
LuaTable | add (LuaTable {Processor}) | |
Processor | back () | |
bool | empty () | |
Processor | front () | |
LuaIter | iter () | |
void | push_back (Processor) | |
void | reverse () | |
unsigned long | size () | |
LuaTable | table () | |
void | unique () |
C‡: std::vector<boost::shared_ptr<ARDOUR::Processor> >
Constructor | ||
---|---|---|
ℂ | ARDOUR.ProcessorVector () | |
ℂ | ARDOUR.ProcessorVector () | |
Methods | ||
LuaTable | add (LuaTable {Processor}) | |
Processor | at (unsigned long) | |
Constructor | ||
ℂ | ARDOUR.RegionList () | |
Methods | ||
Region | back () | |
bool | empty () | |
Region | front () | |
LuaIter | iter () | |
void | reverse () | |
unsigned long | size () | |
************************************************************* Pure interface begins here************************************************************* | ||
int | remove_processor (Processor, ProcessorStreams, bool) | |
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 | ||
bool | reset_plugin_insert (Processor) | |
Constructor | ||
ℂ | ARDOUR.RouteGroupList () | |
Methods | ||
RouteGroup | back () | |
bool | empty () | |
RouteGroup | front () | |
LuaIter | iter () | |
void | reverse () | |
unsigned long | size () | |
Constructor | ||
ℂ | ARDOUR.RouteList () | |
Methods | ||
Route | back () | |
bool | empty () | |
Route | front () | |
LuaIter | iter () | |
void | reverse () | |
unsigned long | size () | |
abort an open undo command This must only be called after begin_reversible_command () | ||
bool | actively_recording () | |
void | add_command (Command) | |
void | add_internal_sends (Route, Placement, RouteListPtr) | |
StatefulDiffCommand | add_stateful_diff_command (StatefulDestructiblePtr) | |
create an StatefulDiffCommand from the given object and add it to the stack. This function must only be called after begin_reversible_command. Failing to do so may lead to a crash.
Returns the allocated StatefulDiffCommand (already added via add_command) | ||
void | begin_reversible_command (std::string) | |
begin collecting undo information This call must always be followed by either begin_reversible_command() or commit_reversible_command()
| ||
void | cancel_all_solo () | |
SessionConfiguration | cfg () | |
void | clear_all_solo_state (RouteListPtr) | |
void | commit_reversible_command (Command) | |
finalize an undo command and commit pending transactions This must only be called after begin_reversible_command ()
| ||
Controllable | controllable_by_id (ID) | |
void | goto_end () | |
void | goto_start (bool) | |
long | last_transport_start () | |
bool | listening () | |
Locations | locations () | |
Route | master_out () | |
void | maybe_enable_record (bool) | |
int | save_state (std::string, bool, bool, bool) | |
save session
Returns zero on success | ||
void | scripts_changed () | |
void | set_control (AutomationControl, double, GroupControlDisposition) | |
void | set_controls (ControlListPtr, double, GroupControlDisposition) | |
void | set_dirty () | |
void | set_exclusive_input_active (RouteListPtr, bool, bool) | |
std::string | snap_name () | |
bool | solo_isolated () | |
bool | soloing () | |
Source | source_by_id (ID) | |
TempoMap | tempo_map () | |
bool | timecode_drop_frames () | |
bool | active () | |
void | deactivate () | |
std::string | display_name () | |
bool | display_to_user () | |
ChanCount | input_streams () | |
ChanCount | output_streams () | |
Cast | ||
PeakMeter | to_meter () | |
MonitorProcessor | to_monitorprocessor () | |
PeakMeter | to_peakmeter () | |
PluginInsert | to_plugininsert () | |
SideChain | to_sidechain () | |
UnknownProcessor | to_unknownprocessor () |
Constructor | ||
---|---|---|
ℂ | ARDOUR.SourceList () | |
ℂ | ARDOUR.SourceList () | |
Methods | ||
LuaTable | add (LuaTable {Source}) | |
Source | at (unsigned long) | |
************************************************************* Pure interface begins here************************************************************* | ||
int | remove_processor (Processor, ProcessorStreams, bool) | |
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 | ||
bool | reset_plugin_insert (Processor) | |
bool | active () | |
void | deactivate () | |
std::string | display_name () | |
bool | display_to_user () | |
ChanCount | input_streams () | |
ChanCount | output_streams () | |
Cast | ||
PeakMeter | to_meter () | |
MonitorProcessor | to_monitorprocessor () | |
PeakMeter | to_peakmeter () | |
PluginInsert | to_plugininsert () | |
SideChain | to_sidechain () | |
UnknownProcessor | to_unknownprocessor () |
C‡: AxisView
+ +AxisView defines the abstract base class for horizontal and vertical presentations of Stripables.
This class object is only used indirectly as return-value and function-parameter. It provides no methods by itself.
C‡: PublicEditor
@@ -3772,9 +3894,13 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to CPossibly start the audition of a region. If
Returns The current mouse mode (gain, object, range, timefx etc.) (defined in editing_syms.h)
Redo some transactions.
Set the mouse mode (gain, object, range, timefx etc.)
Set the snap mode.
Class to represent list of selected regions.
Methods | ||
---|---|---|
void | clear_all () | |
Empty this RegionSelection. | ||
long | end_frame () | |
unsigned long | n_midi_regions () | |
RegionList | regionlist () | |
long | start () |
C‡: RegionView
+is-a: ArdourUI:TimeAxisViewItem
+ +Base class for items that may appear upon a TimeAxisView.
This class object is only used indirectly as return-value and function-parameter. It provides no methods by itself.
+C‡: RouteTimeAxisView
+is-a: ArdourUI:RouteUI
+ +Base class for objects with auto-disconnection. trackable must be inherited when objects shall automatically invalidate slots referring to them on destruction. A slot built from a member function of a trackable derived type installs a callback that is invoked when the trackable object is destroyed or overwritten.
add_destroy_notify_callback() and remove_destroy_notify_callback() can be used to manually install and remove callbacks when notification of the object dying is needed.
notify_callbacks() invokes and removes all previously installed callbacks and can therefore be used to disconnect from all signals.
Note that there is no virtual destructor. Don't use trackable* as pointer type for managing your data or the destructors of your derived types won't be called when deleting your objects.
signal
Cast | ||
---|---|---|
TimeAxisView | to_timeaxisview () |
C‡: RouteUI
+is-a: ArdourUI:Selectable
+ +Base class for objects with auto-disconnection. trackable must be inherited when objects shall automatically invalidate slots referring to them on destruction. A slot built from a member function of a trackable derived type installs a callback that is invoked when the trackable object is destroyed or overwritten.
add_destroy_notify_callback() and remove_destroy_notify_callback() can be used to manually install and remove callbacks when notification of the object dying is needed.
notify_callbacks() invokes and removes all previously installed callbacks and can therefore be used to disconnect from all signals.
Note that there is no virtual destructor. Don't use trackable* as pointer type for managing your data or the destructors of your derived types won't be called when deleting your objects.
signal
This class object is only used indirectly as return-value and function-parameter. It provides no methods by itself.
+C‡: Selectable
+ +Base class for objects with auto-disconnection. trackable must be inherited when objects shall automatically invalidate slots referring to them on destruction. A slot built from a member function of a trackable derived type installs a callback that is invoked when the trackable object is destroyed or overwritten.
add_destroy_notify_callback() and remove_destroy_notify_callback() can be used to manually install and remove callbacks when notification of the object dying is needed.
notify_callbacks() invokes and removes all previously installed callbacks and can therefore be used to disconnect from all signals.
Note that there is no virtual destructor. Don't use trackable* as pointer type for managing your data or the destructors of your derived types won't be called when deleting your objects.
signal
This class object is only used indirectly as return-value and function-parameter. It provides no methods by itself.
C‡: Selection
@@ -3911,6 +4071,35 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to CC‡: std::list<Selectable* >
+ +Constructor | ||
---|---|---|
ℂ | ArdourUI.SelectionList () | |
Methods | ||
Selectable | back () | |
bool | empty () | |
Selectable | front () | |
LuaIter | iter () | |
void | push_back (Selectable) | |
void | reverse () | |
unsigned long | size () | |
LuaTable | table () | |
void | unique () |
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.
+C‡: TimeAxisViewItem
+is-a: ArdourUI:Selectable
+ +Base class for items that may appear upon a TimeAxisView.
This class object is only used indirectly as return-value and function-parameter. It provides no methods by itself.
C‡: TimeSelection
is-a: ARDOUR:AudioRangeList
@@ -3926,7 +4115,9 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to CMethods | ||
---|---|---|
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 () |
C‡: TrackViewList
+is-a: ArdourUI:TrackViewStdList
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 () |
C‡: std::list<TimeAxisView* >
+ +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‡: unsigned char*
@@ -3966,6 +4207,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to CConstructor | ||
---|---|---|
ℂ | C.DoubleVector () | |
ℂ | C.DoubleVector () | |
Methods | ||
LuaTable | add (LuaTable {double}) | |
double | at (unsigned long) |
Constructor | ||
---|---|---|
ℂ | C.FloatArrayVector () | |
ℂ | C.FloatArrayVector () | |
Methods | ||
LuaTable | add (LuaTable {FloatArray}) | |
FloatArray | at (unsigned long) |
Constructor | ||
---|---|---|
ℂ | C.FloatVector () | |
ℂ | C.FloatVector () | |
Methods | ||
LuaTable | add (LuaTable {float}) | |
float | at (unsigned long) | |
ℂ | C.StringList () | |
Methods | ||
LuaTable | add (LuaTable {std::string}) | |
std::string | back () | |
bool | empty () | |
std::string | front () | |
LuaIter | iter () | |
void | push_back (std::string) | |
void | reverse () |
Constructor | ||
---|---|---|
ℂ | C.StringVector () | |
ℂ | C.StringVector () | |
Methods | ||
LuaTable | add (LuaTable {std::string}) | |
std::string | at (unsigned long) | |
Queries whether the layout had to ellipsize any paragraphs. This returns true if the ellipsization mode for layout is not Pango::ELLIPSIZE_NONE, a positive width is set on layout, and there are paragraphs exceeding that width that have to be ellipsized. Returns true if any paragraphs had to be ellipsized, false otherwise. | ||
bool | is_wrapped () | |
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. | ||
void | layout_cairo_path (Context) | |
void | set_ellipsize (EllipsizeMode) | |
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.
| ||
void | set_markup (std::string) |
Constructor | ||
---|---|---|
ℂ | PBD.IdVector () | |
ℂ | PBD.IdVector () | |
Methods | ||
LuaTable | add (LuaTable {ID}) | |
ID | at (unsigned long) |
Constructor | ||
---|---|---|
ℂ | Vamp.Plugin.FeatureList () | |
ℂ | Vamp.Plugin.FeatureList () | |
Methods | ||
LuaTable | add (LuaTable {Feature}) | |
Feature | at (unsigned long) |
Constructor | ||
---|---|---|
ℂ | Vamp.Plugin.OutputList () | |
ℂ | Vamp.Plugin.OutputList () | |
Methods | ||
LuaTable | add (LuaTable {OutputDescriptor}) | |
OutputDescriptor | at (unsigned long) |
Constructor | ||
---|---|---|
ℂ | Vamp.PluginBase.ParameterList () | |
ℂ | Vamp.PluginBase.ParameterList () | |
Methods | ||
LuaTable | add (LuaTable {ParameterDescriptor}) | |
ParameterDescriptor | at (unsigned long) |