From 0be5223f840432647ebaf541d904887ee0d74830 Mon Sep 17 00:00:00 2001 From: Robin Gareus Date: Mon, 22 Feb 2021 01:59:46 +0100 Subject: [PATCH] Update Lua doc for 6.6 --- include/class-reference.html | 118 +++++++++++++++++++++++++++++++---- 1 file changed, 106 insertions(+), 12 deletions(-) diff --git a/include/class-reference.html b/include/class-reference.html index 2f51257..0a3c477 100644 --- a/include/class-reference.html +++ b/include/class-reference.html @@ -341,6 +341,7 @@ Pointer Classes cannot be created in Lua scripts. It always requires a call to C boolphysically_connected (std::string) PortEngineport_engine () boolport_is_physical (std::string) + voidreset_input_meters ()

↠ ARDOUR:AudioPlaylist

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

@@ -386,6 +387,7 @@ Pointer Classes cannot be created in Lua scripts. It always requires a call to C RegionListPtrregions_with_end_within (Range) RegionListPtrregions_with_start_within (Range) voidremove_region (Region) + boolset_name (std::string) boolshared () voidsplit_region (Region, MusicSample) Regiontop_region_at (long) @@ -441,6 +443,22 @@ Pointer Classes cannot be created in Lua scripts. It always requires a call to C AudioPortto_audioport () MidiPortto_midiport () +

∁ ARDOUR:AudioPortMeters

+

C‡: std::map<std::string, ARDOUR::PortManager::DPM >

+
+ + + + + + + + + + + + +
Constructor
ℂARDOUR.AudioPortMeters ()
Methods
LuaTableadd (std::string, ARDOUR::PortManager::DPM )
...at (--lua--)
voidclear ()
unsigned longcount (std::string)
boolempty ()
LuaIteriter ()
unsigned longsize ()
LuaTabletable ()

∁ ARDOUR:AudioRange

C‡: ARDOUR::AudioRange

@@ -502,6 +520,7 @@ Pointer Classes cannot be created in Lua scripts. It always requires a call to C boolautomatic () boolcan_move () boolcaptured () + voidcaptured_xruns (XrunPositions&, bool) voidclear_sync_position () Controlcontrol (Parameter, bool) boolcovers (long) @@ -618,6 +637,7 @@ Pointer Classes cannot be created in Lua scripts. It always requires a call to C Methods std::stringancestor_name () boolcan_be_analysed () + XrunPositionscaptured_xruns () boolhas_been_analysed () longnatural_position () longtimeline_position () @@ -915,6 +935,8 @@ Pointer Classes cannot be created in Lua scripts. It always requires a call to C

Remove all events after the given time from this list.

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

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

overall_length
overall length in audio samples
+ Cast + AutomationListto_automationlist ()

∁ ARDOUR:BackendVector

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

@@ -1064,7 +1086,7 @@ Pointer Classes cannot be created in Lua scripts. It always requires a call to C

Instantiate Biquad Filter

samplerate
Samplerate
Methods voidcompute (Type, double, double, double) -

setup filter, compute coefficients

type
filter type (LowPass, HighPass, etc)
freq
filter frequency
Q
filter quality
gain
filter gain
+

setup filter, compute coefficients

t
filter type (LowPass, HighPass, etc)
freq
filter frequency
Q
filter quality
gain
filter gain
voidconfigure (double, double, double, double, double)

setup filter, set coefficients directly

floatdB_at_freq (float) @@ -1145,7 +1167,7 @@ Pointer Classes cannot be created in Lua scripts. It always requires a call to C

process current data in buffer

floatfreq_at_bin (unsigned int) floatpower_at_bin (unsigned int, float) -

query

b
the frequency bin 0 .. window_size / 2
norm
gain factor (set equal to bin for 1/f normalization)

Returns signal power at given bin (in dBFS)

+

query

bin
the frequency bin 0 .. window_size / 2
norm
gain factor (set equal to bin for 1/f normalization)

Returns signal power at given bin (in dBFS)

voidset_data_hann (FloatArray, unsigned int, unsigned int)

∁ ARDOUR:DSP:Generator

@@ -1563,6 +1585,7 @@ Pointer Classes cannot be created in Lua scripts. It always requires a call to C Methods std::stringancestor_name () boolcan_be_analysed () + XrunPositionscaptured_xruns () boolempty () boolhas_been_analysed () longlength (long) @@ -1759,7 +1782,7 @@ Pointer Classes cannot be created in Lua scripts. It always requires a call to C

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

is-a: ARDOUR:Return

-

A mixer strip element (Processor) with 1 or 2 IO elements.

+

A mixer strip element - plugin, send, meter, etc

@@ -2023,14 +2046,15 @@ Pointer Classes cannot be created in Lua scripts. It always requires a call to C - + - + - + + + + @@ -2155,6 +2181,22 @@ Pointer Classes cannot be created in Lua scripts. It always requires a call to C
Methods
boolisnil ()

List all installed plugins

longmonotonic_time ()
Processornew_luaproc (Session, std::string)

create a new Lua Processor (Plugin)

s
Session Handle
p
Identifier or Name of the Processor

Returns Processor object (may be nil)

create a new Lua Processor (Plugin)

s
Session Handle
name
Identifier or Name of the Processor

Returns Processor object (may be nil)

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

create a new Plugin Instance

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

Returns Processor or nil

create a new Plugin Instance

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

Returns Processor or nil

PluginInfonew_plugin_info (std::string, PluginType)

search a Plugin

id
Plugin Name, ID or URI
type
Plugin Type

Returns PluginInfo or nil if not found

search a Plugin

name
Plugin Name, ID or URI
type
Plugin Type

Returns PluginInfo or nil if not found

Processornil_proc ()
NotePtrListnote_list (MidiModel)
std::stringpath_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 ()
@@ -2045,6 +2069,8 @@ Pointer Classes cannot be created in Lua scripts. It always requires a call to C

reset a processor to its default values (only works for plugins )

This is a wrapper which looks up the Processor by plugin-insert.

proc
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)

voidsegfault ()

Crash Test Dummy

boolset_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.

pi
Plugin-Insert
which
control-input to set (starting at 0)
value
value to set

Returns true on success, false on error or out-of-bounds value

boolset_processor_param (Processor, unsigned int, float)
...get (--lua--)
...set (--lua--)
+

∁ ARDOUR:MIDIPortMeters

+

C‡: std::map<std::string, ARDOUR::PortManager::MPM >

+
+ + + + + + + + + + + + +
Constructor
ℂARDOUR.MIDIPortMeters ()
Methods
LuaTableadd (std::string, ARDOUR::PortManager::MPM )
...at (--lua--)
voidclear ()
unsigned longcount (std::string)
boolempty ()
LuaIteriter ()
unsigned longsize ()
LuaTabletable ()

∁ ARDOUR:Meter

C‡: ARDOUR::Meter

@@ -2336,6 +2378,7 @@ Pointer Classes cannot be created in Lua scripts. It always requires a call to C RegionListPtrregions_with_end_within (Range) RegionListPtrregions_with_start_within (Range) voidremove_region (Region) + boolset_name (std::string) boolshared () voidsplit_region (Region, MusicSample) Regiontop_region_at (long) @@ -2418,6 +2461,7 @@ Pointer Classes cannot be created in Lua scripts. It always requires a call to C boolautomatic () boolcan_move () boolcaptured () + voidcaptured_xruns (XrunPositions&, bool) voidclear_sync_position () Controlcontrol (Parameter, bool) boolcovers (long) @@ -2508,6 +2552,7 @@ Pointer Classes cannot be created in Lua scripts. It always requires a call to C Methods std::stringancestor_name () boolcan_be_analysed () + XrunPositionscaptured_xruns () boolhas_been_analysed () longnatural_position () longtimeline_position () @@ -2900,7 +2945,18 @@ Pointer Classes cannot be created in Lua scripts. It always requires a call to C Methods std::stringmidi_note_name (unsigned char, bool) Data Members + unsigned intdisplay_priority +

higher is more important http://lv2plug.in/ns/ext/port-props#displayPriority

+ boolenumeration + boolinline_ctrl + boolinteger_step std::stringlabel + floatlargestep + std::stringprint_fmt +

format string for pretty printing

+ floatsmallstep + boolsr_dependent + floatstep

Inherited from Evoral:ParameterDescriptor

@@ -3059,6 +3115,7 @@ Pointer Classes cannot be created in Lua scripts. It always requires a call to C + @@ -3252,8 +3309,10 @@ Pointer Classes cannot be created in Lua scripts. It always requires a call to C + +
RegionListPtrregions_with_end_within (Range)
RegionListPtrregions_with_start_within (Range)
voidremove_region (Region)
boolset_name (std::string)
boolshared ()
voidsplit_region (Region, MusicSample)
Regiontop_region_at (long)
boolreset_parameters_to_default ()
voidset_input_map (unsigned int, ChanMapping)
voidset_output_map (unsigned int, ChanMapping)
voidset_thru_map (ChanMapping)
longsignal_latency ()
boolstrict_io_configured ()
ChanMappingthru_map ()
PluginTypetype ()
boolwrite_immediate_event (EventType, unsigned long, unsigned char*)
@@ -3428,6 +3487,7 @@ Pointer Classes cannot be created in Lua scripts. It always requires a call to C boolphysically_connected (std::string) PortEngineport_engine () boolport_is_physical (std::string) + voidreset_input_meters ()

↠ ARDOUR:PortSet

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

@@ -3730,6 +3790,7 @@ Pointer Classes cannot be created in Lua scripts. It always requires a call to C RegionEquivalenceget_region_equivalence () RegionSelectionAfterSplitget_region_selection_after_split () boolget_replicate_missing_region_channels () + boolget_reset_default_speed_on_stop () boolget_run_all_transport_masters_always () boolget_save_history () intget_saved_history_depth () @@ -3888,6 +3949,7 @@ Pointer Classes cannot be created in Lua scripts. It always requires a call to C boolset_region_equivalence (RegionEquivalence) boolset_region_selection_after_split (RegionSelectionAfterSplit) boolset_replicate_missing_region_channels (bool) + boolset_reset_default_speed_on_stop (bool) boolset_run_all_transport_masters_always (bool) boolset_save_history (bool) boolset_saved_history_depth (int) @@ -4047,6 +4109,7 @@ Pointer Classes cannot be created in Lua scripts. It always requires a call to C ARDOUR.RegionEquivalenceregion_equivalence ARDOUR.RegionSelectionAfterSplitregion_selection_after_split boolreplicate_missing_region_channels + boolreset_default_speed_on_stop boolrun_all_transport_masters_always boolsave_history intsaved_history_depth @@ -4175,6 +4238,7 @@ Pointer Classes cannot be created in Lua scripts. It always requires a call to C boolautomatic () boolcan_move () boolcaptured () + voidcaptured_xruns (XrunPositions&, bool) voidclear_sync_position () Controlcontrol (Parameter, bool) boolcovers (long) @@ -4733,7 +4797,7 @@ Pointer Classes cannot be created in Lua scripts. It always requires a call to C RouteListnew_audio_route (int, int, RouteGroup, unsigned int, std::string, Flag, unsigned int) AudioTrackListnew_audio_track (int, int, RouteGroup, unsigned int, std::string, unsigned int, TrackMode, bool) RouteListnew_midi_route (RouteGroup, unsigned int, std::string, bool, PluginInfo, PresetRecord, Flag, unsigned int) - MidiTrackListnew_midi_track (ChanCount, ChanCount, bool, PluginInfo, PresetRecord, RouteGroup, unsigned int, std::string, unsigned int, TrackMode) + MidiTrackListnew_midi_track (ChanCount, ChanCount, bool, PluginInfo, PresetRecord, RouteGroup, unsigned int, std::string, unsigned int, TrackMode, bool) RouteListnew_route_from_template (unsigned int, unsigned int, std::string, std::string, PlaylistDisposition) RouteGroupnew_route_group (std::string) longnominal_sample_rate () @@ -5306,6 +5370,7 @@ Pointer Classes cannot be created in Lua scripts. It always requires a call to C Methods std::stringancestor_name () boolcan_be_analysed () + XrunPositionscaptured_xruns () boolempty () boolhas_been_analysed () boolisnil () @@ -5862,6 +5927,24 @@ Pointer Classes cannot be created in Lua scripts. It always requires a call to C unsigned longsize () LuaTabletable () +

∁ ARDOUR:XrunPositions

+

C‡: std::vector<long >

+
+ + + + + + + + + + + + + + +
Constructor
ℂARDOUR.XrunPositions ()
ℂARDOUR.XrunPositions ()
Methods
LuaTableadd (LuaTable {long})
longat (unsigned long)
voidclear ()
boolempty ()
LuaIteriter ()
voidpush_back (long)
unsigned longsize ()
LuaTabletable ()
...to_array (--lua--)

ℕ ArdourUI

@@ -5917,10 +6000,10 @@ Pointer Classes cannot be created in Lua scripts. It always requires a call to C - + - + @@ -5964,7 +6047,7 @@ Pointer Classes cannot be created in Lua scripts. It always requires a call to C - + @@ -6267,6 +6350,7 @@ Pointer Classes cannot be created in Lua scripts. It always requires a call to C + @@ -6280,6 +6364,7 @@ Pointer Classes cannot be created in Lua scripts. It always requires a call to C + @@ -6373,6 +6458,7 @@ Pointer Classes cannot be created in Lua scripts. It always requires a call to C + @@ -6386,6 +6472,7 @@ Pointer Classes cannot be created in Lua scripts. It always requires a call to C + @@ -6480,6 +6567,7 @@ Pointer Classes cannot be created in Lua scripts. It always requires a call to C + @@ -6493,6 +6581,7 @@ Pointer Classes cannot be created in Lua scripts. It always requires a call to C + @@ -6906,6 +6995,8 @@ Pointer Classes cannot be created in Lua scripts. It always requires a call to C + +
TrackViewListaxis_views_from_routes (RouteListPtr)
voidcenter_screen (long)
voidclear_playlist (Playlist)
voidclear_playlists (TimeAxisView)
voidclear_playlists (RouteUI)
voidconsider_auditioning (Region)

Possibly start the audition of a region.

If r is 0, or not an AudioRegion any current audition is cancelled. If we are currently auditioning r , the audition will be cancelled. Otherwise an audition of r will start.

r
Region to consider auditioning
voidcopy_playlists (TimeAxisView)
voidcopy_playlists (RouteUI)
MouseModecurrent_mouse_mode ()

Returns The current mouse mode (gain, object, range, timefx etc.) (defined in editing_syms.h)

longcurrent_page_samples ()
voidmaximise_editing_space ()
voidmaybe_locate_with_edit_preroll (long)
voidmouse_add_new_marker (long, bool)
voidnew_playlists (TimeAxisView)
voidnew_playlists (RouteUI)
voidnew_region_from_selection ()
voidoverride_visible_track_count ()
longpixel_to_sample (double)
ClockDeltaModeget_primary_clock_delta_mode ()
intget_recent_session_sort ()
boolget_rubberbanding_snaps_to_grid ()
unsigned intget_ruler_granularity ()
boolget_rulers_follow_grid ()
boolget_save_export_analysis_image ()
boolget_save_export_mixer_screenshot ()
boolget_show_plugin_scan_window ()
boolget_show_region_gain ()
boolget_show_region_name ()
boolget_show_region_xrun_markers ()
boolget_show_secondary_clock ()
boolget_show_snapped_cursor ()
boolget_show_toolbar_latency ()
boolset_primary_clock_delta_mode (ClockDeltaMode)
boolset_recent_session_sort (int)
boolset_rubberbanding_snaps_to_grid (bool)
boolset_ruler_granularity (unsigned int)
boolset_rulers_follow_grid (bool)
boolset_save_export_analysis_image (bool)
boolset_save_export_mixer_screenshot (bool)
boolset_show_plugin_scan_window (bool)
boolset_show_region_gain (bool)
boolset_show_region_name (bool)
boolset_show_region_xrun_markers (bool)
boolset_show_secondary_clock (bool)
boolset_show_snapped_cursor (bool)
boolset_show_toolbar_latency (bool)
ARDOUR.ClockDeltaModeprimary_clock_delta_mode
intrecent_session_sort
boolrubberbanding_snaps_to_grid
unsigned intruler_granularity
boolrulers_follow_grid
boolsave_export_analysis_image
boolsave_export_mixer_screenshot
boolshow_plugin_scan_window
boolshow_region_gain
boolshow_region_name
boolshow_region_xrun_markers
boolshow_secondary_clock
boolshow_snapped_cursor
boolshow_toolbar_latency

Remove all events after the given time from this list.

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

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

overall_length
overall length in audio samples
Cast
AutomationListto_automationlist ()

↠ Evoral:ControlSet

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

@@ -8257,6 +8348,7 @@ Pointer Classes cannot be created in Lua scripts. It always requires a call to C
  • ARDOUR:AudioEngine
  • ARDOUR:AudioPlaylist
  • ARDOUR:AudioPort
    • +
  • ARDOUR:AudioPortMeters
  • ARDOUR:AudioRange
  • ARDOUR:AudioRangeList
  • ARDOUR:AudioRegion
    • @@ -8314,6 +8406,7 @@ Pointer Classes cannot be created in Lua scripts. It always requires a call to C
  • ARDOUR:LuaOSC:Address
  • ARDOUR:LuaProc
  • ARDOUR:LuaTableRef
    • +
  • ARDOUR:MIDIPortMeters
  • ARDOUR:Meter
  • ARDOUR:MeterSection
  • ARDOUR:MetricSection
    • @@ -8410,6 +8503,7 @@ Pointer Classes cannot be created in Lua scripts. It always requires a call to C
  • ARDOUR:WeakAudioSourceList
  • ARDOUR:WeakRouteList
  • ARDOUR:WeakSourceList
    • +
  • ARDOUR:XrunPositions
  • ArdourUI
  • ArdourUI:ArdourMarker
  • ArdourUI:ArdourMarkerList
    • @@ -8489,6 +8583,6 @@ Pointer Classes cannot be created in Lua scripts. It always requires a call to C
  • Vamp:RealTime
  • os
    • - + -
    Ardour 6.5  -  Mon, 23 Nov 2020 00:28:56 +0100
    +
    Ardour 6.6  -  Mon, 22 Feb 2021 01:58:19 +0100
    -- 2.37.2