From 0af612346eb142fb4c39a7403d10915a1184c476 Mon Sep 17 00:00:00 2001 From: Robin Gareus Date: Thu, 3 Nov 2022 03:22:43 +0100 Subject: [PATCH] Update Lua doc for 7.1 --- include/class-reference.html | 99 +++++++++++++++++++++++++++++------- 1 file changed, 81 insertions(+), 18 deletions(-) diff --git a/include/class-reference.html b/include/class-reference.html index 5695ad9..5b20480 100644 --- a/include/class-reference.html +++ b/include/class-reference.html @@ -129,7 +129,7 @@ Pointer Classes cannot be created in Lua scripts. It always requires a call to C std::stringuser_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::stringuser_config_directory (int) -

user_config_directory() exists IF version was negative.

version
of the program. If
version
is negative, the build-time string PROGRAM_VERSION will be used to determine the version number.

Returns the path to the directory used to store user specific configuration files for the given

+

user_config_directory() exists IF version was negative.

Returns the path to the directory used to store user specific configuration files for the given version of the program. If version is negative, the build-time string PROGRAM_VERSION will be used to determine the version number.

↠ ARDOUR:Amp

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

@@ -357,7 +357,7 @@ Pointer Classes cannot be created in Lua scripts. It always requires a call to C - + @@ -857,6 +857,7 @@ Pointer Classes cannot be created in Lua scripts. It always requires a call to C + @@ -913,6 +914,19 @@ Pointer Classes cannot be created in Lua scripts. It always requires a call to C
Methods
voidadd_region (Region, timepos_t, float, bool)
Regioncombine (RegionList)
Regioncombine (RegionList, Track)
unsigned intcount_regions_at (timepos_t)
Playlistcut (TimelineRangeList&, bool)
DataTypedata_type ()
Methods
voiddump_registry ()
std::stringname ()
ControllableSetregistered_controllables ()
Cast
AutomationControlto_automationcontrol ()
MPGainControlto_mpgain ()
Cast
AutomationListto_automationlist ()
+

∁ ARDOUR:AutomationTypeSet

+

C‡: std::set<ARDOUR::AutomationType >

+
+ + + + + + + + + +
Constructor
ℂARDOUR.AutomationTypeSet ()
Methods
voidclear ()
boolempty ()
LuaIteriter ()
unsigned longsize ()
LuaTabletable ()

∁ ARDOUR:BackendVector

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

@@ -1048,6 +1062,19 @@ Pointer Classes cannot be created in Lua scripts. It always requires a call to C LuaTabletable () voidunique () +

∁ ARDOUR:ControllableSet

+

C‡: std::set<boost::shared_ptr<PBD::Controllable> > >

+
+ + + + + + + + + +
Constructor
ℂARDOUR.ControllableSet ()
Methods
voidclear ()
boolempty ()
LuaIteriter ()
unsigned longsize ()
LuaTabletable ()

ℕ ARDOUR.DSP

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

reset filter state

voidrun (FloatArray, unsigned int)

process audio data

data
pointer to audio-data
n_samples
number of samples to process
voidset_coefficients (double, double, double, double, double)

∁ ARDOUR:DSP:Convolution

C‡: ARDOUR::DSP::Convolution

@@ -1659,6 +1687,7 @@ Pointer Classes cannot be created in Lua scripts. It always requires a call to C Methods voiddump_registry () std::stringname () + ControllableSetregistered_controllables () Cast AutomationControlto_automationcontrol () MPGainControlto_mpgain () @@ -1850,7 +1879,7 @@ Pointer Classes cannot be created in Lua scripts. It always requires a call to C

Inherited from ARDOUR:Send

- + @@ -2222,6 +2251,7 @@ Pointer Classes cannot be created in Lua scripts. It always requires a call to C + @@ -2255,6 +2285,7 @@ Pointer Classes cannot be created in Lua scripts. It always requires a call to C + @@ -2370,7 +2401,7 @@ Pointer Classes cannot be created in Lua scripts. It always requires a call to C
Methods
GainControlgain_control ()
GainControlgain_control ()
longget_delay_in ()
longget_delay_out ()
boolis_foldback ()
Methods
voiddump_registry ()
std::stringname ()
ControllableSetregistered_controllables ()
Cast
AutomationControlto_automationcontrol ()
MPGainControlto_mpgain ()
Methods
voiddump_registry ()
std::stringname ()
ControllableSetregistered_controllables ()
Cast
AutomationControlto_automationcontrol ()
MPGainControlto_mpgain ()
- + @@ -2769,6 +2800,7 @@ Pointer Classes cannot be created in Lua scripts. It always requires a call to C
Methods
voidadd_region (Region, timepos_t, float, bool)
Regioncombine (RegionList)
Regioncombine (RegionList, Track)
unsigned intcount_regions_at (timepos_t)
Playlistcut (TimelineRangeList&, bool)
DataTypedata_type ()
+ @@ -2824,6 +2856,7 @@ Pointer Classes cannot be created in Lua scripts. It always requires a call to C + @@ -2964,6 +2997,7 @@ Pointer Classes cannot be created in Lua scripts. It always requires a call to C + @@ -3178,6 +3212,7 @@ Pointer Classes cannot be created in Lua scripts. It always requires a call to C + @@ -3199,7 +3234,7 @@ Pointer Classes cannot be created in Lua scripts. It always requires a call to C
Methods
boolapply ()
boolapply_to (ControllableSet, AutomationTypeSet)
voidclear ()
boolempty ()
boolisnil ()
Methods
voiddump_registry ()
std::stringname ()
ControllableSetregistered_controllables ()
Cast
AutomationControlto_automationcontrol ()
MPGainControlto_mpgain ()
Methods
voiddump_registry ()
std::stringname ()
ControllableSetregistered_controllables ()
Cast
AutomationControlto_automationcontrol ()
MPGainControlto_mpgain ()
Methods
voiddump_registry ()
std::stringname ()
ControllableSetregistered_controllables ()
Cast
AutomationControlto_automationcontrol ()
MPGainControlto_mpgain ()
- + @@ -3352,6 +3387,7 @@ Pointer Classes cannot be created in Lua scripts. It always requires a call to C + @@ -3873,7 +3909,6 @@ Pointer Classes cannot be created in Lua scripts. It always requires a call to C - @@ -3908,11 +3943,11 @@ Pointer Classes cannot be created in Lua scripts. It always requires a call to C - + @@ -3985,7 +4020,6 @@ Pointer Classes cannot be created in Lua scripts. It always requires a call to C - @@ -4045,7 +4079,6 @@ Pointer Classes cannot be created in Lua scripts. It always requires a call to C - @@ -4080,11 +4113,11 @@ Pointer Classes cannot be created in Lua scripts. It always requires a call to C - + @@ -4157,7 +4190,6 @@ Pointer Classes cannot be created in Lua scripts. It always requires a call to C - @@ -4218,7 +4250,6 @@ Pointer Classes cannot be created in Lua scripts. It always requires a call to C - @@ -4253,11 +4284,11 @@ Pointer Classes cannot be created in Lua scripts. It always requires a call to C - + @@ -4330,7 +4361,6 @@ Pointer Classes cannot be created in Lua scripts. It always requires a call to C -
Methods
voidadd_region (Region, timepos_t, float, bool)
Regioncombine (RegionList)
Regioncombine (RegionList, Track)
unsigned intcount_regions_at (timepos_t)
Playlistcut (TimelineRangeList&, bool)
DataTypedata_type ()
Methods
voiddump_registry ()
std::stringname ()
ControllableSetregistered_controllables ()
Cast
AutomationControlto_automationcontrol ()
MPGainControlto_mpgain ()
LayerModelget_layer_model ()
unsigned intget_limit_n_automatables ()
boolget_link_send_and_route_panner ()
std::stringget_linux_pingback_url ()
ListenPositionget_listen_position ()
boolget_locate_while_waiting_for_sync ()
LoopFadeChoiceget_loop_fade_choice ()
boolget_mute_affects_pre_fader ()
boolget_new_plugins_active ()
unsigned intget_osc_port ()
std::stringget_osx_pingback_url ()
AutoConnectOptionget_output_auto_connect ()
unsigned intget_periodic_safety_backup_interval ()
boolget_periodic_safety_backups ()
PFLPositionget_pfl_position ()
std::stringget_pingback_url ()
unsigned intget_plugin_cache_version ()
std::stringget_plugin_path_lxvst ()
std::stringget_plugin_path_vst ()
boolget_video_advanced_setup ()
std::stringget_video_server_docroot ()
std::stringget_video_server_url ()
std::stringget_windows_pingback_url ()
boolget_work_around_jack_no_copy_optimization ()
std::stringget_xjadeo_binary ()
boolset_afl_position (AFLPosition)
boolset_layer_model (LayerModel)
boolset_limit_n_automatables (unsigned int)
boolset_link_send_and_route_panner (bool)
boolset_linux_pingback_url (std::string)
boolset_listen_position (ListenPosition)
boolset_locate_while_waiting_for_sync (bool)
boolset_loop_fade_choice (LoopFadeChoice)
boolset_mute_affects_pre_fader (bool)
boolset_new_plugins_active (bool)
boolset_osc_port (unsigned int)
boolset_osx_pingback_url (std::string)
boolset_output_auto_connect (AutoConnectOption)
boolset_periodic_safety_backup_interval (unsigned int)
boolset_periodic_safety_backups (bool)
boolset_pfl_position (PFLPosition)
boolset_pingback_url (std::string)
boolset_plugin_cache_version (unsigned int)
boolset_plugin_path_lxvst (std::string)
boolset_plugin_path_vst (std::string)
boolset_video_advanced_setup (bool)
boolset_video_server_docroot (std::string)
boolset_video_server_url (std::string)
boolset_windows_pingback_url (std::string)
boolset_work_around_jack_no_copy_optimization (bool)
boolset_xjadeo_binary (std::string)
Properties
ARDOUR.LayerModellayer_model
unsigned intlimit_n_automatables
boollink_send_and_route_panner
std::stringlinux_pingback_url
ARDOUR.ListenPositionlisten_position
boollocate_while_waiting_for_sync
ARDOUR.LoopFadeChoiceloop_fade_choice
boolmute_affects_pre_fader
boolnew_plugins_active
unsigned intosc_port
std::stringosx_pingback_url
ARDOUR.AutoConnectOptionoutput_auto_connect
unsigned intperiodic_safety_backup_interval
boolperiodic_safety_backups
ARDOUR.PFLPositionpfl_position
std::stringpingback_url
unsigned intplugin_cache_version
std::stringplugin_path_lxvst
std::stringplugin_path_vst
boolvideo_advanced_setup
std::stringvideo_server_docroot
std::stringvideo_server_url
std::stringwindows_pingback_url
boolwork_around_jack_no_copy_optimization
std::stringxjadeo_binary
@@ -4854,7 +4884,7 @@ Pointer Classes cannot be created in Lua scripts. It always requires a call to C

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

- + @@ -4938,6 +4968,7 @@ Pointer Classes cannot be created in Lua scripts. It always requires a call to C + @@ -5017,6 +5048,7 @@ Pointer Classes cannot be created in Lua scripts. It always requires a call to C + @@ -5326,6 +5358,19 @@ Pointer Classes cannot be created in Lua scripts. It always requires a call to C
Methods
GainControlgain_control ()
GainControlgain_control ()
longget_delay_in ()
longget_delay_out ()
boolis_foldback ()
StatefulDiffCommandadd_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.

sfd
the object to diff

Returns the allocated StatefulDiffCommand (already added via add_command)

boolapply_nth_mixer_scene (unsigned long)
boolapply_nth_mixer_scene_to (unsigned long, RouteList)
voidbegin_reversible_command (std::string)

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
BundleListPtrbundles ()
voidset_dirty ()
voidset_exclusive_input_active (RouteListPtr, bool, bool)
voidset_session_range_is_free (bool)
...simple_export (--lua--)
std::stringsnap_name ()
boolsolo_isolated ()
boolsoloing ()
Statefulto_stateful ()
StatefulDestructibleto_statefuldestructible ()
+

∁ ARDOUR:SimpleExport

+

C‡: ARDOUR::SimpleExport

+
+

Base class for audio export

This allows one to export audio from the session's master bus using a given export-preset.

+ + + + + + + + +
Methods
boolcheck_outputs ()
boolrun_export ()
voidset_folder (std::string)
voidset_name (std::string)
boolset_preset (std::string)
voidset_range (long, long)

↠ ARDOUR:Slavable

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

@@ -5381,6 +5426,7 @@ Pointer Classes cannot be created in Lua scripts. It always requires a call to C Methods voiddump_registry () std::stringname () + ControllableSetregistered_controllables () Cast AutomationControlto_automationcontrol () MPGainControlto_mpgain () @@ -5444,6 +5490,7 @@ Pointer Classes cannot be created in Lua scripts. It always requires a call to C Methods voiddump_registry () std::stringname () + ControllableSetregistered_controllables () Cast AutomationControlto_automationcontrol () MPGainControlto_mpgain () @@ -5506,6 +5553,7 @@ Pointer Classes cannot be created in Lua scripts. It always requires a call to C Methods voiddump_registry () std::stringname () + ControllableSetregistered_controllables () Cast AutomationControlto_automationcontrol () MPGainControlto_mpgain () @@ -5567,6 +5615,7 @@ Pointer Classes cannot be created in Lua scripts. It always requires a call to C Methods voiddump_registry () std::stringname () + ControllableSetregistered_controllables () Cast AutomationControlto_automationcontrol () MPGainControlto_mpgain () @@ -6272,6 +6321,8 @@ Pointer Classes cannot be created in Lua scripts. It always requires a call to C longpixel_to_sample (double) voidplay_selection () voidplay_with_preroll () + voidquick_export () +

Open Simple Export Dialog

voidredo (unsigned int)

Redo some transactions.

n
Number of transaction to redo.
RegionViewregionview_from_region (Region) @@ -6295,7 +6346,7 @@ Pointer Classes cannot be created in Lua scripts. It always requires a call to C

Set whether the editor should follow the playhead.

yn
true to follow playhead, otherwise false.
catch_up
true to reset the editor view to show the playhead (if yn == true), otherwise false.
voidset_loop_range (timepos_t, timepos_t, std::string) voidset_mouse_mode (MouseMode, bool) -

Set the mouse mode (gain, object, range, timefx etc.)

m
Mouse mode (defined in editing_syms.h)
force
Perform the effects of the change even if no change is required (ie even if the current mouse mode is equal to
+

Set the mouse mode (gain, object, range, timefx etc.)

m
Mouse mode (defined in editing_syms.h)
force
Perform the effects of the change even if no change is required (ie even if the current mouse mode is equal to m)
voidset_punch_range (timepos_t, timepos_t, std::string) voidset_selection (SelectionList, Operation) voidset_snap_mode (SnapMode) @@ -6596,6 +6647,7 @@ Pointer Classes cannot be created in Lua scripts. It always requires a call to C boolget_show_editor_meter () boolget_show_grids_ruler () boolget_show_inline_display_by_default () + boolget_show_manager_if_plugins_are_missing () boolget_show_mini_timeline () boolget_show_name_highlight () boolget_show_on_cue_page () @@ -6722,6 +6774,7 @@ Pointer Classes cannot be created in Lua scripts. It always requires a call to C boolset_show_editor_meter (bool) boolset_show_grids_ruler (bool) boolset_show_inline_display_by_default (bool) + boolset_show_manager_if_plugins_are_missing (bool) boolset_show_mini_timeline (bool) boolset_show_name_highlight (bool) boolset_show_on_cue_page (bool) @@ -6849,6 +6902,7 @@ Pointer Classes cannot be created in Lua scripts. It always requires a call to C boolshow_editor_meter boolshow_grids_ruler boolshow_inline_display_by_default + boolshow_manager_if_plugins_are_missing boolshow_mini_timeline boolshow_name_highlight boolshow_on_cue_page @@ -7445,6 +7499,7 @@ Pointer Classes cannot be created in Lua scripts. It always requires a call to C

Get `internal' value

Returns raw value as used for the plugin/processor control port

boolisnil () std::stringname () + ControllableSetregistered_controllables () Cast AutomationControlto_automationcontrol () MPGainControlto_mpgain () @@ -8273,6 +8328,7 @@ Pointer Classes cannot be created in Lua scripts. It always requires a call to C

∈ ARDOUR.DSP.Generator.Type

- + -
Ardour 7.0  -  Sat, 15 Oct 2022 00:20:41 +0200
+
Ardour 7.1  -  Thu, 03 Nov 2022 03:15:23 +0100
-- 2.37.2