From fe3242ce08930865e296a43bbb1e8c2198d70bf6 Mon Sep 17 00:00:00 2001 From: Robin Gareus Date: Mon, 5 Dec 2016 23:50:34 +0100 Subject: [PATCH] update lua class doc --- .../24_lua-scripting/02_class_reference.html | 96 +++++++++++++------ 1 file changed, 68 insertions(+), 28 deletions(-) diff --git a/_manual/24_lua-scripting/02_class_reference.html b/_manual/24_lua-scripting/02_class_reference.html index 3ddfbf00..93e8e9a2 100644 --- a/_manual/24_lua-scripting/02_class_reference.html +++ b/_manual/24_lua-scripting/02_class_reference.html @@ -1390,7 +1390,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C voidcopy (MidiBuffer) boolempty () boolpush_back (long, unsigned long, unsigned char*) - boolpush_event (MidiEvent) + boolpush_event (Event) voidresize (unsigned long)

Reallocate the buffer used internally to handle at least size_t units of data.

The buffer is not silent after this operation. the capacity argument passed to the constructor must have been non-zero.

boolsameinstance (MidiBuffer) @@ -2735,11 +2735,59 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C Constructor ℂARDOUR.Route.ProcessorStreams () -

∅ ARDOUR:RouteGroup

+

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

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Methods
intadd (Route)

Add a route to a group. Adding a route which is already in the group is allowed; nothing will happen.

r
Route to add.
voidclear ()
voiddestroy_subgroup ()
boolempty ()
intgroup_master_number ()
boolhas_subgroup ()
boolis_active ()
boolis_color ()
boolis_gain ()
boolis_hidden ()
boolis_monitoring ()
boolis_mute ()
boolis_recenable ()
boolis_relative ()
boolis_route_active ()
boolis_select ()
boolis_solo ()
voidmake_subgroup (bool, Placement)
intremove (Route)
RouteListPtrroute_list ()
voidset_active (bool, void*)
voidset_color (bool)
voidset_gain (bool)
voidset_hidden (bool, void*)
voidset_monitoring (bool)
voidset_mute (bool)
voidset_recenable (bool)
voidset_relative (bool, void*)
voidset_route_active (bool)
voidset_select (bool)
voidset_solo (bool)
unsigned longsize ()
+

∁ ARDOUR:RouteGroupList

+

C‡: std::list<ARDOUR::RouteGroup* >

+
+ + + + + + + + + +
Constructor
ℂARDOUR.RouteGroupList ()
Methods
boolempty ()
LuaIteriter ()
voidreverse ()
unsigned longsize ()
LuaTabletable ()

∁ ARDOUR:RouteList

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

@@ -2815,11 +2863,13 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C RouteListnew_midi_route (RouteGroup, unsigned int, std::string, PluginInfo, PresetRecord, Flag, unsigned int) MidiTrackListnew_midi_track (ChanCount, ChanCount, PluginInfo, PresetRecord, RouteGroup, unsigned int, std::string, unsigned int, TrackMode) RouteListnew_route_from_template (unsigned int, unsigned int, std::string, std::string, PlaylistDisposition) + RouteGroupnew_route_group (std::string) longnominal_frame_rate ()

"native" sample rate of session, regardless of current audioengine rate, pullup/down etc

std::stringpath () Processorprocessor_by_id (ID) RecordStaterecord_status () + voidremove_route_group (RouteGroup) voidrequest_locate (long, bool) voidrequest_play_loop (bool, bool) voidrequest_stop (bool, bool) @@ -2827,6 +2877,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C Routeroute_by_id (ID) Routeroute_by_name (std::string) Routeroute_by_selected_count (unsigned int) + RouteGroupListroute_groups () intsave_state (std::string, bool, bool, bool)

save session

snapshot_name
name of the session (use an empty string for the current name)
pending
save a 'recovery', not full state (default: false)
switch_to_snapshot
switch to given snapshot after saving (default: false)
template_only
save a session template (default: false)

Returns zero on success

voidscripts_changed () @@ -3414,8 +3465,8 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C TempoSectionadd_tempo (Tempo, double, long, Type, PositionLockStyle) BBT_TIMEbbt_at_frame (long)

Returns the BBT time corresponding to the supplied frame position.

frame
the position in audio samples.

Returns the BBT time at the frame position .

- doubleexact_beat_at_frame (long, int) - doubleexact_qn_at_frame (long, int) + doubleexact_beat_at_frame (long, int) + doubleexact_qn_at_frame (long, int) MeterSectionmeter_section_at_beat (double) MeterSectionmeter_section_at_frame (long) TempoSectiontempo_section_at_frame (long) @@ -4159,31 +4210,15 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C + + + +
Methods
unsigned char*buffer ()
unsigned charchannel ()
voidclear ()
voidset_buffer (unsigned int, unsigned char*, bool)
voidset_channel (unsigned char)
voidset_type (unsigned char)
unsigned intsize ()
longtime ()
unsigned chartype ()
-

∁ Evoral:MidiEvent

-

C‡: Evoral::MIDIEvent<long>

-

is-a: Evoral:Event

-
- - - - - - -
Methods
unsigned charchannel ()
voidset_channel (unsigned char)
voidset_type (unsigned char)
unsigned chartype ()
-

Inherited from Evoral:Event

- - - - - - - -
Methods
unsigned char*buffer ()
voidclear ()
voidset_buffer (unsigned int, unsigned char*, bool)
unsigned intsize ()
longtime ()

↠ Evoral:NotePtr

C‡: boost::shared_ptr< Evoral::Note<Evoral::Beats> >, boost::weak_ptr< Evoral::Note<Evoral::Beats> >

@@ -4870,6 +4905,11 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
  • ARDOUR.MeterPoint.MeterOutput
  • ARDOUR.MeterPoint.MeterCustom
    • +

    ∈ ARDOUR.Placement

    +

    ∈ ARDOUR.NoteMode

    - + -
    Ardour 5.4-399-gb2aaffa  -  Sat, 19 Nov 2016 22:56:15 +0100
    +
    Ardour 5.5-27-ga2166a2  -  Mon, 05 Dec 2016 23:50:06 +0100