diff --git a/tools/fmt-luadoc.php b/tools/fmt-luadoc.php index 279225816a..80b5969894 100755 --- a/tools/fmt-luadoc.php +++ b/tools/fmt-luadoc.php @@ -514,7 +514,7 @@ div.header p {margin:.25em;}

Overview

-The top-level entry point are and . +The top-level entry point are and . Most other Classes are used indirectly starting with a Session function. e.g. Session:get_routes().

@@ -525,6 +525,21 @@ A few classes are dedicated to certain script types, e.g. Lua DSP processors hav

Detailed documentation (parameter names, method description) is not yet available. Please stay tuned.

+

Short introduction to Ardour classes

+

+Ardour's structure is object oriented. The main object is the Session. A Session contains Audio Tracks, Midi Tracks and Busses. +Audio and Midi tracks are derived from a more general "Track" Object, which in turn is derived from a "Route" (aka Bus). +(We say "An Audio Track is-a Track is-a Route"). +Tracks contain specifics. For Example a track has-a diskstream (for file i/o). +

+

+Operations are performed on objects. One gets a reference to an object and then calls a method. +e.g obj = Session:route_by_name("Audio") obj:set_name("Guitar") +

+

+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: +you cannot simply remove a track that is currently processing audio. There are various factory methods for object creation or removal. +

Class Documentation'.NL;