From 840272838fb1914dfa5103e22bd481dad7251cd7 Mon Sep 17 00:00:00 2001 From: Robin Gareus Date: Sat, 19 Nov 2016 22:58:22 +0100 Subject: [PATCH] update lua class doc --- .../24_lua-scripting/02_class_reference.html | 136 +++++++++++++++--- 1 file changed, 115 insertions(+), 21 deletions(-) diff --git a/_manual/24_lua-scripting/02_class_reference.html b/_manual/24_lua-scripting/02_class_reference.html index 2465fb5..3ddfbf0 100644 --- a/_manual/24_lua-scripting/02_class_reference.html +++ b/_manual/24_lua-scripting/02_class_reference.html @@ -387,6 +387,93 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C unsigned longsize () LuaTabletable () +

↠ ARDOUR:AudioRegion

+

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

+

is-a: ARDOUR:Region

+
+

A named object associated with a Session. Objects derived from this class are expected to be destroyed before the session calls drop_references().

+ + + + + + + +
Methods
AudioSourceaudio_source (unsigned int)
boolisnil ()
boolsameinstance (AudioRegion)
floatscale_amplitude ()
voidset_scale_amplitude (float)
+

Inherited from ARDOUR:Region

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Methods
boolat_natural_position ()
boolautomatic ()
boolcan_move ()
boolcaptured ()
voidclear_sync_position ()
boolcovers (long)
voidcut_end (long, int)
voidcut_front (long, int)
DataTypedata_type ()
boolexternal ()
boolhidden ()
boolimport ()
boolis_compound ()
unsigned intlayer ()
longlength ()
boollocked ()
voidlower ()
voidlower_to_bottom ()
StringVectormaster_source_names ()
SourceListmaster_sources ()
voidmove_start (long, int)
voidmove_to_natural_position ()
boolmuted ()
unsigned intn_channels ()
voidnudge_position (long)
boolopaque ()
longposition ()

How the region parameters play together:

POSITION: first frame of the region along the timeline START: first frame of the region within its source(s) LENGTH: number of frames the region represents

boolposition_locked ()
doublequarter_note ()
voidraise ()
voidraise_to_top ()
voidset_hidden (bool)
voidset_initial_position (long)

A gui may need to create a region, then place it in an initial position determined by the user. When this takes place within one gui operation, we have to reset _last_position to prevent an implied move.

voidset_length (long, int)
voidset_locked (bool)
voidset_muted (bool)
voidset_opaque (bool)
voidset_position (long, int)
voidset_position_locked (bool)
voidset_start (long)
voidset_sync_position (long)

Set the region's sync point.

absolute_pos
Session time.
voidset_video_locked (bool)
floatshift ()
Sourcesource (unsigned int)
longstart ()
floatstretch ()
boolsync_marked ()
LuaTable(long, ...)sync_offset (int&)
longsync_position ()

Returns Sync position in session time

voidtrim_end (long, int)
voidtrim_front (long, int)
voidtrim_to (long, long, int)
boolvideo_locked ()
boolwhole_file ()
Cast
AudioRegionto_audioregion ()
MidiRegionto_midiregion ()
Readableto_readable ()
+

Inherited from ARDOUR:SessionObject

+ + + + + + +
Methods
std::stringname ()
Cast
Statefulto_stateful ()
StatefulDestructibleto_statefuldestructible ()

↠ ARDOUR:AudioSource

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

is-a: ARDOUR:Source

@@ -1517,7 +1604,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C longposition ()

How the region parameters play together:

POSITION: first frame of the region along the timeline START: first frame of the region within its source(s) LENGTH: number of frames the region represents

boolposition_locked () - doublepulse () + doublequarter_note () voidraise () voidraise_to_top () voidset_hidden (bool) @@ -1547,6 +1634,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C boolvideo_locked () boolwhole_file () Cast + AudioRegionto_audioregion () MidiRegionto_midiregion () Readableto_readable () @@ -2454,7 +2542,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C longposition ()

How the region parameters play together:

POSITION: first frame of the region along the timeline START: first frame of the region within its source(s) LENGTH: number of frames the region represents

boolposition_locked () - doublepulse () + doublequarter_note () voidraise () voidraise_to_top () boolsameinstance (Region) @@ -2485,6 +2573,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C boolvideo_locked () boolwhole_file () Cast + AudioRegionto_audioregion () MidiRegionto_midiregion () Readableto_readable () @@ -3305,12 +3394,15 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C - + - - - + + + + + +
Constructor
ℂARDOUR.Tempo (double, double)
bpm
Beats Per Minute
type
Note Type (default `4': quarter note)
npm
Note Types per minute
type
Note Type (default `4': quarter note)
Methods
doublebeats_per_minute ()
doubleframes_per_beat (long)

audio samples per beat

sr
samplerate
doubleframes_per_note_type (long)

audio samples per note type. if you want an instantaneous value for this, use TempoMap::frames_per_quarter_note_at() instead.

sr
samplerate
doubleframes_per_quarter_note (long)

audio samples per quarter note. if you want an instantaneous value for this, use TempoMap::frames_per_quarter_note_at() instead.

sr
samplerate
doublenote_type ()
doublenote_types_per_minute ()
doublequarter_notes_per_minute ()

∁ ARDOUR:TempoMap

C‡: ARDOUR::TempoMap

@@ -3318,9 +3410,10 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C

Tempo Map - mapping of timecode to musical time. convert audio-samples, sample-rate to Bar/Beat/Tick, Meter/Tempo

- + + @@ -4863,6 +4956,18 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
  • ARDOUR.LocationFlags.IsSkip
  • ARDOUR.LocationFlags.IsSkipping
    • +

    ∈ ARDOUR.DSP.Biquad.Type

    +

    ∈ Cairo.LineCap

    -

    ∈ ARDOUR.DSP.Biquad.Type

    -

    Class Index

    - + -
    Ardour 5.4-270-gd253d49  -  Thu, 10 Nov 2016 02:00:45 +0100
    +
    Ardour 5.4-399-gb2aaffa  -  Sat, 19 Nov 2016 22:56:15 +0100
    -- 2.37.2
    Methods
    MeterSectionadd_meter (Meter, double, BBT_TIME, long, PositionLockStyle)
    MeterSectionadd_meter (Meter, double, BBT_TIME, PositionLockStyle)
    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)
    MeterSectionmeter_section_at_beat (double)