X-Git-Url: http://shamusworld.gotdns.org/cgi-bin/gitweb.cgi?a=blobdiff_plain;f=include%2Fclass-reference.html;h=d1bf9c45f9b099def3ce6acf0c46a21933f587bd;hb=d302fd124d52a2d90caed31195f72a0fbc88a46f;hp=0f42a1ce7d810fe2c76f0ddeeff70f1a7b6346c5;hpb=4e3479eea4c28e386b37d5d67232168f4512bd2d;p=ardour-manual diff --git a/include/class-reference.html b/include/class-reference.html index 0f42a1c..d1bf9c4 100644 --- a/include/class-reference.html +++ b/include/class-reference.html @@ -130,7 +130,6 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C Methods GainControlgain_control () boolisnil () - boolsameinstance (Amp)

Inherited from ARDOUR:Processor

@@ -190,7 +189,6 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C - @@ -227,7 +225,6 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C -
unsigned intoutput_channels ()
std::stringoutput_device_name ()
unsigned intperiod_size ()
boolsameinstance (AudioBackend)
floatsample_rate ()
intset_buffer_size (unsigned int)

Set the buffer size to be used.

The device is assumed to use a double buffering scheme, so that one buffer's worth of data can be processed by hardware while software works on the other buffer. All known suitable audio APIs support this model (though ALSA allows for alternate numbers of buffers, and CoreAudio doesn't directly expose the concept).

check buffer for silence

nframes
number of frames to check
n
first non zero sample (if any)

Returns true if all samples are zero

FloatArraydata (long)
voidread_from (FloatArray, long, long, long)
boolsameinstance (AudioBuffer)
voidsilence (long, long)

silence buffer

len
number of samples to clear
offset
start offset
@@ -279,7 +276,6 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C Methods boolisnil () longread (FloatArray, FloatArray, FloatArray, long, long, unsigned int) - boolsameinstance (AudioPlaylist)

Inherited from ARDOUR:Playlist

@@ -334,7 +330,6 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
-
Methods
boolisnil ()
boolsameinstance (AudioPort)

Inherited from ARDOUR:Port

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

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)
@@ -495,8 +489,6 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C longread (FloatArray, long, long, int) longreadable_length () longreadable_length () - boolsameinstance (AudioSource) - boolsameinstance (AudioSource) floatsample_rate () Cast Readableto_readable () @@ -534,7 +526,6 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C -
Methods
boolisnil ()
boolsameinstance (AudioTrack)

Inherited from ARDOUR:Track

@@ -680,7 +671,6 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C -
Methods
AutomationControlautomation_control (Parameter, bool)
boolisnil ()
boolsameinstance (Automatable)

↠ ARDOUR:AutomatableSequence

C‡: boost::shared_ptr< ARDOUR::AutomatableSequence<Evoral::Beats> >, boost::weak_ptr< ARDOUR::AutomatableSequence<Evoral::Beats> >

@@ -689,7 +679,6 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C -
Methods
boolisnil ()
boolsameinstance (AutomatableSequence)
Cast
Sequenceto_sequence ()
@@ -711,7 +700,6 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C doubleget_value ()

Get the current effective `user' value based on automation state

boolisnil () - boolsameinstance (AutomationControl) voidset_automation_state (AutoState) voidset_automation_style (AutoStyle) voidset_value (double, GroupControlDisposition) @@ -744,7 +732,6 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C XMLNodeget_state () boolisnil () Commandmemento_command (XMLNode, XMLNode) - boolsameinstance (AutomationList) booltouch_enabled () booltouching () boolwriting () @@ -775,7 +762,6 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C ChanCountcount () AudioBufferget_audio (unsigned long) MidiBufferget_midi (unsigned long) - boolsameinstance (BufferSet)

∁ ARDOUR:ChanCount

C‡: ARDOUR::ChanCount

@@ -973,7 +959,6 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C Methods boolisnil () PannerShellpanner_shell () - boolsameinstance (Delivery)

Inherited from ARDOUR:IOProcessor

@@ -1062,7 +1047,6 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
-
Methods
boolisnil ()
boolsameinstance (GainControl)

Inherited from ARDOUR:SlavableAutomationControl,

@@ -1128,7 +1112,6 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C -
boolphysically_connected ()
Portport_by_name (unsigned int)
intremove_port (Port, void*)
boolsameinstance (IO)

Inherited from ARDOUR:SessionObject

@@ -1150,7 +1133,6 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C -
ChanCountnatural_input_streams ()
ChanCountnatural_output_streams ()
IOoutput ()
boolsameinstance (IOProcessor)

Inherited from ARDOUR:Processor

@@ -1359,7 +1341,6 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
-
Methods
boolisnil ()
boolsameinstance (LuaProc)
DspShmshmem ()
LuaTableReftable ()
@@ -1452,7 +1433,6 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C 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) voidsilence (long, long)

Clear (eg zero, or empty) buffer

unsigned longsize () @@ -1469,7 +1449,6 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C boolisnil () NoteDiffCommandnew_note_diff_command (std::string)

Start a new NoteDiff command.

This has no side-effects on the model or Session, the returned command can be held on to for as long as the caller wishes, or discarded without formality, until apply_command is called and ownership is taken.

- boolsameinstance (MidiModel)

Inherited from ARDOUR:AutomatableSequence

@@ -1533,7 +1512,6 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
-
Methods
boolisnil ()
boolsameinstance (MidiPlaylist)
voidset_note_mode (NoteMode)

Inherited from ARDOUR:Playlist

@@ -1591,7 +1569,6 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C MidiBufferget_midi_buffer (unsigned int) boolinput_active () boolisnil () - boolsameinstance (MidiPort) voidset_input_active (bool)

Inherited from ARDOUR:Port

@@ -1629,7 +1606,6 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C doublelength_beats () MidiSourcemidi_source (unsigned int) MidiModelmodel () - boolsameinstance (MidiRegion) doublestart_beats ()

Inherited from ARDOUR:Region

@@ -1717,7 +1693,6 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C boolisnil () longlength (long) MidiModelmodel () - boolsameinstance (MidiSource)

Inherited from ARDOUR:Source

@@ -1752,7 +1727,6 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
-
Methods
boolisnil ()
boolsameinstance (MidiTrack)

Inherited from ARDOUR:Track

@@ -1914,7 +1888,6 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C - @@ -1978,7 +1951,6 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C -
boolmonitor_active ()
boolmono ()
Controllablemono_control ()
boolsameinstance (MonitorProcessor)
voidset_cut (unsigned int, bool)
voidset_cut_all (bool)
voidset_dim (unsigned int, bool)
boolisnil ()
boolmuted ()
boolmuted_by_self ()
boolsameinstance (MuteControl)

Inherited from ARDOUR:SlavableAutomationControl,

@@ -2037,7 +2009,6 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C -
Methods
boolbypassed ()
boolisnil ()
boolsameinstance (PannerShell)
voidset_bypassed (bool)

Inherited from ARDOUR:SessionObject

@@ -2086,7 +2057,6 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C boolisnil () floatmeter_level (unsigned int, MeterType) voidreset_max () - boolsameinstance (PeakMeter) voidset_type (MeterType)

Inherited from ARDOUR:Processor

@@ -2128,7 +2098,6 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C Methods boolinverted (unsigned int) boolisnil () - boolsameinstance (PhaseControl) voidset_phase_invert (unsigned int, bool)
c
Audio channel index.
yn
true to invert phase, otherwise false.
@@ -2197,7 +2166,6 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C RegionListPtrregions_with_end_within (Range) RegionListPtrregions_with_start_within (Range) voidremove_region (Region) - boolsameinstance (Playlist) voidsplit (long) voidsplit_region (Region, MusicFrame) Regiontop_region_at (long) @@ -2238,7 +2206,6 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C boolparameter_is_input (unsigned int) PresetRecordpreset_by_label (std::string) PresetRecordpreset_by_uri (std::string) - boolsameinstance (Plugin) std::stringunique_id () Cast LuaProcto_luaproc () @@ -2269,7 +2236,6 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C -
Methods
boolisnil ()
boolsameinstance (PluginControl)

Inherited from ARDOUR:AutomationControl

@@ -2312,7 +2278,6 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C - @@ -2339,7 +2304,6 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C - @@ -2391,7 +2355,6 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C - @@ -2457,7 +2420,6 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C -
PresetVectorget_presets (bool)
boolis_instrument ()
boolisnil ()
boolsameinstance (PluginInfo)
Data Members
std::stringcategory
std::stringcreator
ChanMappingoutput_map (unsigned int)
Pluginplugin (unsigned int)
boolreset_parameters_to_default ()
boolsameinstance (PluginInsert)
voidset_input_map (unsigned int, ChanMapping)
voidset_output_map (unsigned int, ChanMapping)
boolstrict_io_configured ()

Returns Port human readable name

boolreceives_input ()

Returns true if this Port receives input, otherwise false

boolsameinstance (Port)
boolsends_output ()

Returns true if this Port sends output, otherwise false

Cast
Portport (DataType, unsigned long)

nth port of type t, or nth port if t = NIL

t
data type
index
port index
boolremove (Port)
boolsameinstance (PortSet)

∁ ARDOUR:PresentationInfo

C‡: ARDOUR::PresentationInfo

@@ -2521,7 +2483,6 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C ChanCountinput_streams () boolisnil () ChanCountoutput_streams () - boolsameinstance (Processor) Cast Ampto_amp () Automatableto_automatable () @@ -2617,7 +2578,6 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C unsigned intn_channels () longread (FloatArray, long, long, int) longreadable_length () - boolsameinstance (Readable)

↠ ARDOUR:Region

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

@@ -2659,7 +2619,6 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C doublequarter_note () voidraise () voidraise_to_top () - boolsameinstance (Region) 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.

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

replace plugin/processor with another

old
processor to remove
sub
processor to substitute the old one with
err
error report (index where removal vailed, channel-count why it failed) may be nil

Returns 0 on success

boolreset_plugin_insert (Processor)

reset plugin-insert configuration to default, disable customizations.

This is equivalent to calling 

 customize_plugin_insert (proc, 0, unused)
proc
Processor to reset

Returns true if successful

- boolsameinstance (Route) voidset_active (bool, void*) voidset_comment (std::string, void*) voidset_meter_point (MeterPoint, bool) @@ -3214,7 +3172,6 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C Methods boolisnil () std::stringname () - boolsameinstance (SessionObject) Cast Statefulto_stateful () StatefulDestructibleto_statefuldestructible () @@ -3227,7 +3184,6 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C -
Methods
boolisnil ()
boolsameinstance (SideChain)

Inherited from ARDOUR:IOProcessor

@@ -3280,7 +3236,6 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C -
doubleget_masters_value ()
boolisnil ()
voidremove_master (AutomationControl)
boolsameinstance (SlavableAutomationControl,)
boolslaved ()
boolslaved_to (AutomationControl)
@@ -3324,7 +3279,6 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C Methods boolcan_solo () boolisnil () - boolsameinstance (SoloControl) boolself_soloed () boolsoloed () @@ -3378,7 +3332,6 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C -
Methods
boolisnil ()
boolsameinstance (SoloIsolateControl)
boolself_solo_isolated ()
boolsolo_isolated ()
@@ -3432,7 +3385,6 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C -
Methods
boolisnil ()
boolsameinstance (SoloSafeControl)
boolsolo_safe ()

Inherited from ARDOUR:SlavableAutomationControl,

@@ -3492,7 +3444,6 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C boolisnil () longlength (long) longnatural_position () - boolsameinstance (Source) longtimeline_position () longtimestamp () intuse_count () @@ -3568,7 +3519,6 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C PresentationInfopresentation_info_ptr () AutomationControlrec_enable_control () AutomationControlrec_safe_control () - boolsameinstance (Stripable) AutomationControlsend_enable_control (unsigned int) AutomationControlsend_level_control (unsigned int) std::stringsend_name (unsigned int) @@ -3594,8 +3544,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C

Tempo, the speed at which musical time progresses (BPM).

- - + @@ -3612,7 +3561,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
Constructor
ℂARDOUR.Tempo (double, double)
npm
Note Types per minute
type
Note Type (default `4': quarter note)
ℂARDOUR.Tempo (double, double, double)
Methods
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
- + @@ -3653,7 +3602,6 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C - @@ -3769,7 +3717,6 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
Methods
MeterSectionadd_meter (Meter, double, BBT_TIME, long, PositionLockStyle)
TempoSectionadd_tempo (Tempo, double, long, Type, PositionLockStyle)
TempoSectionadd_tempo (Tempo, double, long, 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)
boolcan_record ()
boolisnil ()
Playlistplaylist ()
boolsameinstance (Track)
boolset_name (std::string)
Cast
AudioTrackto_audio_track ()
-
Methods
boolisnil ()
boolsameinstance (UnknownProcessor)

Inherited from ARDOUR:Processor

@@ -4198,7 +4145,6 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C -
LuaMetaTablearray ()
LuaTableget_table ()
unsigned char*offset (unsigned int)
boolsameinstance (unsigned char*)
voidset_table (LuaTable {unsigned char})

∁ C:DoubleVector

@@ -4225,7 +4171,6 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C LuaMetaTablearray () LuaTableget_table () FloatArrayoffset (unsigned int) - boolsameinstance (FloatArray) voidset_table (LuaTable {float})

∁ C:FloatArrayVector

@@ -4268,7 +4213,6 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C LuaMetaTablearray () LuaTableget_table () IntArrayoffset (unsigned int) - boolsameinstance (IntArray) voidset_table (LuaTable {int})

∁ C:StringList

@@ -4461,7 +4405,6 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C Methods boolisnil () ControlListlist () - boolsameinstance (Control)

↠ Evoral:ControlList

C‡: boost::shared_ptr< Evoral::ControlList >, boost::weak_ptr< Evoral::ControlList >

@@ -4481,7 +4424,6 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C boolisnil () LuaTable(double, ...)rt_safe_eval (double, bool&)

realtime safe version of eval, may fail if read-lock cannot be taken

where
absolute time in samples
ok
boolean reference if returned value is valid

Returns parameter value

- boolsameinstance (ControlList) voidset_interpolation (InterpolationStyle)

set the interpolation style of the automation data

is
interpolation style
voidthin (double) @@ -4497,7 +4439,6 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C -
Methods
boolisnil ()
boolsameinstance (ControlSet)

∁ Evoral:Event

C‡: Evoral::Event<long>

@@ -4524,7 +4465,6 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C Beatslength () unsigned charnote () unsigned charoff_velocity () - boolsameinstance (NotePtr) Beatstime () unsigned charvelocity () @@ -4574,7 +4514,6 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C -
Methods
boolisnil ()
boolsameinstance (Sequence)

∁ LuaSignal:Set

C‡: std::bitset<47ul>

@@ -4642,7 +4581,6 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C doubleget_value () boolisnil () std::stringname () - boolsameinstance (Controllable)

Inherited from PBD:StatefulPtr

@@ -4759,7 +4697,6 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
-
Methods
boolisnil ()
boolsameinstance (StatefulDestructible)

Inherited from PBD:StatefulPtr

@@ -4804,7 +4741,6 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C -
IDid ()
boolisnil ()
OwnedPropertyListproperties ()
boolsameinstance (Stateful)

∁ PBD:XMLNode

C‡: XMLNode

@@ -5739,6 +5675,6 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
  • Vamp:PluginBase:ParameterList
  • Vamp:RealTime
    • - + -
    Ardour 5.7  -  Mon, 27 Feb 2017 15:02:46 +0100
    +
    Ardour 5.8-155-g51d43c6e1  -  Thu, 16 Mar 2017 21:47:44 +0100