From cb0a24a80389463079f1932e7878a266071def04 Mon Sep 17 00:00:00 2001 From: Robin Gareus Date: Mon, 25 Apr 2016 13:50:11 +0200 Subject: [PATCH] update lua class doc --- .../24_lua-scripting/02_class_reference.html | 39 ++++++++++++++----- 1 file changed, 29 insertions(+), 10 deletions(-) diff --git a/_manual/24_lua-scripting/02_class_reference.html b/_manual/24_lua-scripting/02_class_reference.html index 2ba2acc..9ab6acc 100644 --- a/_manual/24_lua-scripting/02_class_reference.html +++ b/_manual/24_lua-scripting/02_class_reference.html @@ -5,7 +5,7 @@ title: Class Reference ---

-This documention is far from complete may be inaccurate and subject to change. +This documentation is far from complete may be inaccurate and subject to change.

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

↠ ARDOUR:AudioBackend

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

-

PortEngine is an abstract base class that defines the functionality required by Ardour.

A Port is basically an endpoint for a datastream (which can either be continuous, like audio, or event-based, like MIDI). Ports have buffers associated with them into which data can be written (if they are output ports) and from which data can be read (if they input ports). Ports can be connected together so that data written to an output port can be read from an input port. These connections can be 1:1, 1:N OR N:1.

Ports may be associated with software only, or with hardware. Hardware related ports are often referred to as physical, and correspond to some relevant physical entity on a hardware device, such as an audio jack or a MIDI connector. Physical ports may be potentially asked to monitor their inputs, though some implementations may not support this.

Most physical ports will also be considered "terminal", which means that data delivered there or read from there will go to or comes from a system outside of the PortEngine implementation's control (e.g. the analog domain for audio, or external MIDI devices for MIDI). Non-physical ports can also be considered "terminal". For example, the output port of a software synthesizer is a terminal port, because the data contained in its buffer does not and cannot be considered to come from any other port - it is synthesized by its owner.

Ports also have latency associated with them. Each port has a playback latency and a capture latency:

capture latency: how long since the data read from the buffer of a port arrived at at a terminal port. The data will have come from the "outside world" if the terminal port is also physical, or will have been synthesized by the entity that owns the terminal port.

playback latency: how long until the data written to the buffer of port will reach a terminal port.

For more detailed questions about the PortEngine API, consult the JACK API documentation, on which this entire object is based.

+

AudioBackend is an high-level abstraction for interacting with the operating system's audio and midi I/O.

@@ -603,11 +603,11 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C - + - + - +
Methods
unsigned intbuffer_size ()
ℂARDOUR.DataType (std::string)
Methods
DataTypeaudio ()

convenience contructor for DataType::AUDIO

Returns DataType::AUDIO

convenience constructor for DataType::AUDIO with managed lifetime

Returns DataType::AUDIO

DataTypemidi ()

convenience contructor for DataType::MIDI

Returns DataType::MIDI

convenience constructor for DataType::MIDI with managed lifetime

Returns DataType::MIDI

DataTypenull ()

convenience contructor for DataType::NIL

Returns DataType::NIL

convenience constructor for DataType::NIL with managed lifetime

Returns DataType::NIL

char*to_string ()

Inverse of the from-string constructor

@@ -787,7 +787,6 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C Constructor ℂARDOUR.InterThreadInfo () Data Members - boolcancel booldone floatprogress @@ -1490,6 +1489,11 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C Constructor ℂARDOUR.Route.ProcessorStreams () +

∅ ARDOUR:RouteGroup

+

C‡: ARDOUR::RouteGroup

+
+

A group identifier for routes.

RouteGroups permit to define properties which are shared among all Routes that use the given identifier.

A route can at most be in one group.

+

This class object is only used indirectly as return-value and function-parameter. It provides no methods by itself.

∁ ARDOUR:RouteList

C‡: std::list<boost::shared_ptr<ARDOUR::Route> >

@@ -1549,7 +1553,15 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C voidgoto_start () longlast_transport_start () Locationslocations () + Routemaster_out () + Routemonitor_out () std::stringname () + RouteListnew_audio_route (int, int, RouteGroup, unsigned int, std::string) +

Caller must not hold process lock.

name_template
string to use for the start of the name, or "" to use "Bus".
+ AudioTrackListnew_audio_track (int, int, TrackMode, RouteGroup, unsigned int, std::string) +

Caller must not hold process lock

name_template
string to use for the start of the name, or "" to use "Audio".
+ RouteListnew_midi_route (RouteGroup, unsigned int, std::string, PluginInfo) + MidiTrackListnew_midi_track (ChanCount, ChanCount, PluginInfo, TrackMode, RouteGroup, unsigned int, std::string) RouteListnew_route_from_template (unsigned int, std::string, std::string, PlaylistDisposition)

create a new track or bus from a template (XML path)

how_many
how many tracks or busses to create
template_path
path to xml template file
name
name (prefix) of the route to create
pd
Playlist disposition

Returns list of newly created routes

longnominal_frame_rate () @@ -1993,7 +2005,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C LuaTabletable ()

⋯ C:FloatArray

-

C‡:

+

C‡: float*

@@ -2003,7 +2015,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
Methods
voidset_table (LuaTable {float})

⋯ C:IntArray

-

C‡:

+

C‡: int*

@@ -2460,6 +2472,12 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
  • ARDOUR.RegionPoint.End
  • ARDOUR.RegionPoint.SyncPoint
    • +

    ∈ ARDOUR.TrackMode

    +

    ∈ ARDOUR.Session.RecordState

    - + -
    Ardour 4.7-720-g5bbfd0d  -  Thu, 14 Apr 2016 03:41:02 +0200
    +
    Ardour 4.7-853-g4f3f966  -  Mon, 25 Apr 2016 13:49:00 +0200
    -- 2.37.2
    Methods