X-Git-Url: http://shamusworld.gotdns.org/cgi-bin/gitweb.cgi?a=blobdiff_plain;f=include%2Flua-scripting.html;h=2dfb4282ccab9f2d36c8ca9987314a4ac641d1b7;hb=c74044cf7983302a714cdf60c61d1276728303cb;hp=ae3b3676ed7b240c349c5a270018bffe24182d0f;hpb=1694ece4af52e5e1c23d386e7bc030b5758e2c64;p=ardour-manual
diff --git a/include/lua-scripting.html b/include/lua-scripting.html
index ae3b367..2dfb428 100644
--- a/include/lua-scripting.html
+++ b/include/lua-scripting.html
@@ -74,21 +74,21 @@ Like Control surfaces and the GUI, Lua Scripts are confined to certain aspects o
In Ardour's case Lua is available:
-
- - Editor Action Scripts
- User initiated actions (menu, shortcuts) for batch processing
- - Editor Hooks/Callbacks
- Event triggered actions for the Editor/Mixer GUI
- - Session Scripts
- Scripts called at the start of every audio cycle (session, real-time)
- - DSP Scripts
- Audio/Midi processor - plugins with access to the Ardour session (per track/bus, real-time)
- - Script Console
- Action Script commandline
-
+
+ | Editor Action Scripts | User initiated actions (menu, shortcuts) for batch processing |
|---|
+ | Editor Hooks/Callbacks | Event triggered actions for the Editor/Mixer GUI |
|---|
+ | Session Scripts | Scripts called at the start of every audio cycle (session, real-time) |
|---|
+ | DSP Scripts | Audio/Midi processor - plugins with access to the Ardour session (per track/bus, real-time) |
|---|
+ | Script Console | Action Script commandline |
|---|
+
There are is also a special mode:
-
- - Commandline Tool
- Replaces the complete Editor GUI, direct access to libardour (no GUI) from the commandline.
- Be aware that the vast majority of complex functionality is provided by the Editor UI.
-
+
+ | Commandline Tool | Replaces the complete Editor GUI, direct access to libardour (no GUI) from the commandline.
+ Be aware that the vast majority of complex functionality is provided by the Editor UI. |
|---|
+
Managing Scripts
@@ -104,13 +104,13 @@ Apart from scripts included directly with Ardour, this includes
Files must end with .lua file extension.
Scripts are managed via the GUI
-
- - Editor Action Scripts
- Menu → Edit → Scripted Actions → Manage
- - Editor Hooks/Callbacks
- Menu → Edit → Scripted Actions → Manage
- - Session Scripts
- Menu → Session → Scripting → Add/Remove Script
- - DSP Scripts
- Mixer-strip → context menu (right click) → New Lua Proc
- - Script Console
- Menu → Window → Scripting
-
+
+ | Editor Action Scripts | Menu → Edit → Scripted Actions → Manage |
|---|
+ | Editor Hooks/Callbacks | Menu → Edit → Scripted Actions → Manage |
|---|
+ | Session Scripts | Menu → Session → Scripting → Add/Remove Script |
|---|
+ | DSP Scripts | Mixer-strip → context menu (right click) → New Lua Proc |
|---|
+ | Script Console | Menu → Window → Scripting |
|---|
+
Script Layout
@@ -140,13 +140,13 @@ Apart from scripts included directly with Ardour, this includes
The common part for all scripts is the "Descriptor". It's a Lua function which returns a table (key/values) with the following keys (the keys are case-sensitive):
-
- - type [required]
- one of "
DSP", "Session", "EditorHook", "EditorAction" (the type is not case-sensitive)
- - name [required]
- Name/Title of the script
- - author
- Your Name
- - license
- The license of the script (e.g. "GPL" or "MIT")
- - description
- A longer text explaining to the user what the script does
-
+
+ | type [required] | one of "DSP", "Session", "EditorHook", "EditorAction" (the type is not case-sensitive) |
|---|
+ | name [required] | Name/Title of the script |
|---|
+ | author | Your Name |
|---|
+ | license | The license of the script (e.g. "GPL" or "MIT") |
|---|
+ | description | A longer text explaining to the user what the script does |
|---|
+
Scripts that come with Ardour (currently mostly examples) can be found in the Source Tree.