From: Robin Gareus Date: Tue, 14 Feb 2017 14:04:10 +0000 (+0100) Subject: update lua class doc X-Git-Url: http://shamusworld.gotdns.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=f56f05b33bf5b64f0ad3f47074d1759c96b65156;p=ardour-manual update lua class doc --- diff --git a/include/class-reference.html b/include/class-reference.html index 36c2ad8..8b7a996 100644 --- a/include/class-reference.html +++ b/include/class-reference.html @@ -282,7 +282,8 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C

Inherited from ARDOUR:Playlist

- + + @@ -308,7 +309,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C - + @@ -391,6 +392,10 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C + + + + @@ -627,7 +632,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C - + @@ -1019,7 +1024,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C

Inherited from ARDOUR:SlavableAutomationControl,

Methods
voidadd_region (Region, long, float, bool, int)
voidadd_region (Region, long, float, bool, int, double, bool)

Note: this calls set_layer (..., DBL_MAX) so it will reset the layering index of region

Regioncombine (RegionList)
unsigned intcount_regions_at (long)
Playlistcut (AudioRangeList&, bool)
RegionListPtrregions_with_start_within (Range)
voidremove_region (Region)
voidsplit (long)
voidsplit_region (Region, long, int)
voidsplit_region (Region, MusicFrame)
Regiontop_region_at (long)
Regiontop_unmuted_region_at (long)
voiduncombine (Region)
Methods
AudioSourceaudio_source (unsigned int)
boolisnil ()
doublemaximum_amplitude (Progress)

Returns the maximum (linear) amplitude of the region, or a -ve number if the Progress object reports that the process was cancelled.

doublerms (Progress)

Returns the maximum (rms) signal power of the region, or a -1 if the Progress object reports that the process was cancelled.

boolsameinstance (AudioRegion)
floatscale_amplitude ()
voidset_scale_amplitude (float)
AutomationControlsend_enable_control (unsigned int)
AutomationControlsend_level_control (unsigned int)
std::stringsend_name (unsigned int)
voidset_presentation_order (unsigned int, bool)
voidset_presentation_order (unsigned int)
SoloControlsolo_control ()
SoloIsolateControlsolo_isolate_control ()
SoloSafeControlsolo_safe_control ()
- + @@ -1162,13 +1167,13 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C - + - - - - - + + + + +
Methods
voidadd_master (AutomationControl)
voidadd_master (AutomationControl, bool)
voidclear_masters ()
intget_boolean_masters ()
doubleget_masters_value ()
voidlock ()
boollocked ()
boolmatches (Flags)
intmove_to (long)
intmove_to (long, unsigned int)
std::stringname ()
intset_end (long, bool, bool)

Set end position.

force
true to force setting, even if the given new end is before the current start.
allow_bbt_recompute
True to recompute BBT end time from the new given end time.
s
New end.
intset_length (long, long, bool)
intset_start (long, bool, bool)

Set start position.

s
New start.
force
true to force setting, even if the given new start is after the current end.
allow_bbt_recompute
True to recompute BBT start time from the new given start time.
intset_end (long, bool, bool, unsigned int)

Set end position.

force
true to force setting, even if the given new end is before the current start.
allow_beat_recompute
True to recompute BEAT end time from the new given end time.
s
New end.
intset_length (long, long, bool, unsigned int)
intset_start (long, bool, bool, unsigned int)

Set start position.

s
New start.
force
true to force setting, even if the given new start is after the current end.
allow_beat_recompute
True to recompute BEAT start time from the new given start time.
longstart ()
voidunlock ()
@@ -1250,6 +1255,8 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C local acl = ac:alist() return ac:alist(), ac:to_ctrl():list(), t[2] end

Example usage: get the third input parameter of first plugin on the given route (Ardour starts counting at zero). 

 local al, cl, pd = ARDOUR.LuaAPI.plugin_automation (route:nth_plugin (0), 3)

Returns 3 parameters: AutomationList, ControlList, ParamaterDescriptor

+ boolreset_processor_to_default (Processor) +

reset a processor to its default values (only works for plugins )

This is a wrapper which looks up the Processor by plugin-insert.

proc
Plugin-Insert

Returns true on success, false when the processor is not a plugin

...sample_to_timecode (--lua--)

Generic conversion from audio sample count to timecode. (TimecodeType, sample-rate, sample-pos)

boolset_plugin_insert_param (PluginInsert, unsigned int, float) @@ -1481,7 +1488,8 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C

Inherited from ARDOUR:Playlist

- + + @@ -1507,7 +1515,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C - + @@ -1795,7 +1803,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C - + @@ -1891,6 +1899,18 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
Methods
voidadd_region (Region, long, float, bool, int)
voidadd_region (Region, long, float, bool, int, double, bool)

Note: this calls set_layer (..., DBL_MAX) so it will reset the layering index of region

Regioncombine (RegionList)
unsigned intcount_regions_at (long)
Playlistcut (AudioRangeList&, bool)
RegionListPtrregions_with_start_within (Range)
voidremove_region (Region)
voidsplit (long)
voidsplit_region (Region, long, int)
voidsplit_region (Region, MusicFrame)
Regiontop_region_at (long)
Regiontop_unmuted_region_at (long)
voiduncombine (Region)
AutomationControlsend_enable_control (unsigned int)
AutomationControlsend_level_control (unsigned int)
std::stringsend_name (unsigned int)
voidset_presentation_order (unsigned int, bool)
voidset_presentation_order (unsigned int)
SoloControlsolo_control ()
SoloIsolateControlsolo_isolate_control ()
SoloSafeControlsolo_safe_control ()
Statefulto_stateful ()
StatefulDestructibleto_statefuldestructible ()
+

∁ ARDOUR:MusicFrame

+

C‡: ARDOUR::MusicFrame

+
+ + + + + + + + +
Constructor
ℂARDOUR.MusicFrame (long, int)
Methods
voidset (long, int)
Data Members
intdivision
longframe

↠ ARDOUR:MuteControl

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

is-a: ARDOUR:SlavableAutomationControl,

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

Inherited from ARDOUR:SlavableAutomationControl,

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

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

Methods
voidadd_master (AutomationControl)
voidadd_master (AutomationControl, bool)
voidclear_masters ()
intget_boolean_masters ()
doubleget_masters_value ()
- + + @@ -2119,7 +2140,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C - + @@ -2227,7 +2248,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
Methods
voidadd_region (Region, long, float, bool, int)
voidadd_region (Region, long, float, bool, int, double, bool)

Note: this calls set_layer (..., DBL_MAX) so it will reset the layering index of region

Regioncombine (RegionList)
unsigned intcount_regions_at (long)
Playlistcut (AudioRangeList&, bool)
voidremove_region (Region)
boolsameinstance (Playlist)
voidsplit (long)
voidsplit_region (Region, long, int)
voidsplit_region (Region, MusicFrame)
Regiontop_region_at (long)
Regiontop_unmuted_region_at (long)
voiduncombine (Region)
- + @@ -2470,6 +2491,11 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
Constructor
ℂARDOUR.PluginInfo ()
ℵARDOUR.PluginInfo ()
Methods
PresetVectorget_presets (bool)
boolis_instrument ()
unsigned longsize ()
LuaTabletable ()
+

∅ ARDOUR:Progress

+

C‡: ARDOUR::Progress

+
+

A class to handle reporting of progress of something

+

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

∅ ARDOUR:Properties:BoolProperty

C‡: PBD::PropertyDescriptor<bool>

@@ -2715,7 +2741,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C AutomationControlsend_enable_control (unsigned int) AutomationControlsend_level_control (unsigned int) std::stringsend_name (unsigned int) - voidset_presentation_order (unsigned int, bool) + voidset_presentation_order (unsigned int) SoloControlsolo_control () SoloIsolateControlsolo_isolate_control () SoloSafeControlsolo_safe_control () @@ -2843,6 +2869,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C longcurrent_start_frame () voiddisable_record (bool, bool) AudioEngineengine () + boolexport_track_state (RouteListPtr, std::string) longframe_rate ()

"actual" sample rate of session, set by current audioengine rate, pullup/down etc.

unsigned intget_block_size () @@ -2858,13 +2885,13 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C longlast_transport_start () Locationslocations () Routemaster_out () - voidmaybe_enable_record () + voidmaybe_enable_record (bool) Routemonitor_out () std::stringname () RouteListnew_audio_route (int, int, RouteGroup, unsigned int, std::string, Flag, unsigned int) AudioTrackListnew_audio_track (int, int, RouteGroup, unsigned int, std::string, unsigned int, TrackMode) - 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_midi_route (RouteGroup, unsigned int, std::string, bool, PluginInfo, PresetRecord, Flag, unsigned int) + MidiTrackListnew_midi_track (ChanCount, ChanCount, bool, 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 () @@ -2891,11 +2918,8 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C Sourcesource_by_id (ID) TempoMaptempo_map () booltimecode_drop_frames () - booltimecode_drop_frames () - longtimecode_frames_per_hour () longtimecode_frames_per_hour () doubletimecode_frames_per_second () - doubletimecode_frames_per_second () ...timecode_to_sample_lua (--lua--) Tracktrack_by_diskstream_id (ID) longtransport_frame () @@ -2918,21 +2942,25 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C boolget_auto_input () boolget_auto_play () boolget_auto_return () + boolget_count_in () unsigned intget_destructive_xfade_msecs () boolget_external_sync () boolget_glue_new_markers_to_bars_and_beats () boolget_glue_new_regions_to_bars_and_beats () InsertMergePolicyget_insert_merge_policy () boolget_jack_time_master () + boolget_layered_record_mode () unsigned intget_meterbridge_label_height () boolget_midi_copy_is_fork () std::stringget_midi_search_path () + longget_minitimeline_span () SampleFormatget_native_file_data_format () HeaderFormatget_native_file_header_format () boolget_punch_in () boolget_punch_out () std::stringget_raid_path () boolget_realtime_export () + MonitorChoiceget_session_monitoring () boolget_show_busses_on_meterbridge () boolget_show_group_tabs () boolget_show_master_on_meterbridge () @@ -2966,21 +2994,25 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C boolset_auto_input (bool) boolset_auto_play (bool) boolset_auto_return (bool) + boolset_count_in (bool) boolset_destructive_xfade_msecs (unsigned int) boolset_external_sync (bool) boolset_glue_new_markers_to_bars_and_beats (bool) boolset_glue_new_regions_to_bars_and_beats (bool) boolset_insert_merge_policy (InsertMergePolicy) boolset_jack_time_master (bool) + boolset_layered_record_mode (bool) boolset_meterbridge_label_height (unsigned int) boolset_midi_copy_is_fork (bool) boolset_midi_search_path (std::string) + boolset_minitimeline_span (long) boolset_native_file_data_format (SampleFormat) boolset_native_file_header_format (HeaderFormat) boolset_punch_in (bool) boolset_punch_out (bool) boolset_raid_path (std::string) boolset_realtime_export (bool) + boolset_session_monitoring (MonitorChoice) boolset_show_busses_on_meterbridge (bool) boolset_show_group_tabs (bool) boolset_show_master_on_meterbridge (bool) @@ -3015,21 +3047,25 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C boolauto_input boolauto_play boolauto_return + boolcount_in unsigned intdestructive_xfade_msecs boolexternal_sync boolglue_new_markers_to_bars_and_beats boolglue_new_regions_to_bars_and_beats ARDOUR.InsertMergePolicyinsert_merge_policy booljack_time_master + boollayered_record_mode unsigned intmeterbridge_label_height boolmidi_copy_is_fork std::stringmidi_search_path + longminitimeline_span ARDOUR.SampleFormatnative_file_data_format ARDOUR.HeaderFormatnative_file_header_format boolpunch_in boolpunch_out std::stringraid_path boolrealtime_export + ARDOUR.MonitorChoicesession_monitoring boolshow_busses_on_meterbridge boolshow_group_tabs boolshow_master_on_meterbridge @@ -3134,7 +3170,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C

A PBD::Controllable with associated automation data (AutomationList)

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

Inherited from ARDOUR:SlavableAutomationControl,

Methods
voidadd_master (AutomationControl)
voidadd_master (AutomationControl, bool)
voidclear_masters ()
intget_boolean_masters ()
doubleget_masters_value ()
- + @@ -3245,7 +3281,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C

Inherited from ARDOUR:SlavableAutomationControl,

Methods
voidadd_master (AutomationControl)
voidadd_master (AutomationControl, bool)
voidclear_masters ()
intget_boolean_masters ()
doubleget_masters_value ()
- + @@ -3298,7 +3334,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C

Inherited from ARDOUR:SlavableAutomationControl,

Methods
voidadd_master (AutomationControl)
voidadd_master (AutomationControl, bool)
voidclear_masters ()
intget_boolean_masters ()
doubleget_masters_value ()
- + @@ -3431,7 +3467,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C - + @@ -3470,7 +3506,7 @@ 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

Methods
voidadd_master (AutomationControl)
voidadd_master (AutomationControl, bool)
voidclear_masters ()
intget_boolean_masters ()
doubleget_masters_value ()
AutomationControlsend_enable_control (unsigned int)
AutomationControlsend_level_control (unsigned int)
std::stringsend_name (unsigned int)
voidset_presentation_order (unsigned int, bool)
voidset_presentation_order (unsigned int)
SoloControlsolo_control ()
SoloIsolateControlsolo_isolate_control ()
SoloSafeControlsolo_safe_control ()
- + @@ -3478,6 +3514,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C +
Methods
MeterSectionadd_meter (Meter, double, BBT_TIME, PositionLockStyle)
MeterSectionadd_meter (Meter, double, BBT_TIME, long, 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_qn_at_frame (long, int)
MeterSectionmeter_section_at_beat (double)
MeterSectionmeter_section_at_frame (long)
TempoSectiontempo_section_at_frame (long)
TempoSectiontempo_section_at_frame (long)

∁ ARDOUR:TempoSection

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

A section of timeline with a certain Tempo.

- +
Methods
doublec_func ()
doublec ()

Inherited from ARDOUR:MetricSection

@@ -3601,7 +3638,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C - + @@ -3743,7 +3780,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C - + @@ -4946,6 +4983,13 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
  • ARDOUR.Placement.PreFader
  • ARDOUR.Placement.PostFader
    • +

    ∈ ARDOUR.MonitorChoice

    +

    ∈ ARDOUR.NoteMode

    +

    ∈ ARDOUR.MidiTrackNameSource

    +

    ∈ ARDOUR.RegionPoint

    - + -
    Ardour 5.5-66-g4992ed1  -  Thu, 08 Dec 2016 13:34:35 +0100
    - +
    Ardour 5.6-14-g7330357e1  -  Tue, 14 Feb 2017 15:03:20 +0100
    AutomationControlsend_enable_control (unsigned int)
    AutomationControlsend_level_control (unsigned int)
    std::stringsend_name (unsigned int)
    voidset_presentation_order (unsigned int, bool)
    voidset_presentation_order (unsigned int)
    SoloControlsolo_control ()
    SoloIsolateControlsolo_isolate_control ()
    SoloSafeControlsolo_safe_control ()
    longcurrent_page_samples ()
    voiddeselect_all ()
    LuaTable(...)do_embed (StringVector, ImportDisposition, ImportMode, long&, PluginInfo)
    LuaTable(...)do_import (StringVector, ImportDisposition, ImportMode, SrcQuality, long&, PluginInfo)
    LuaTable(...)do_import (StringVector, ImportDisposition, ImportMode, SrcQuality, MidiTrackNameSource, --MISSING (ARDOUR::MidiTempoMapDisposition)--, long&, PluginInfo)

    Import existing media

    booldragging_playhead ()

    Returns true if the playhead is currently being dragged, otherwise false