EnvelopeUnit< SampleType > Class Template Reference

Envelope unit performs a series of breakpoints. More...

List of all members.

Static Public Member Functions
static UnitType	ar (BreakpointsType const &breakpoints, UnitType const &gate=SampleType(1), const bool deleteWhenDone=true, BlockSize const &preferredBlockSize=BlockSize::getDefault(), SampleRate const &preferredSampleRate=SampleRate::getDefault()) throw ()
	Create an audio rate envelope generator.
static UnitType	kr (BreakpointsType const &breakpoints, UnitType const &gate=SampleType(1), const bool deleteWhenDone=true) throw ()
	Create a control rate envelope generator.

---

Detailed Description

template<class SampleType>
class EnvelopeUnit< SampleType >

Envelope unit performs a series of breakpoints.

[args-todo]

• breakpoints: (breakpoints) the series of breakpoints to perform.
• gate: (unit) controls the envelope
• allowAutoDelete: (bool) whether this unit can be casued to be deleted by the unit it contains
• preferredBlockSize: the preferred output block size (for advanced usage, leave on default if unsure)
• preferredSampleRate: the preferred output sample rate (for advanced usage, leave on default if unsure)

---

Member Function Documentation

template<class SampleType >

static UnitType EnvelopeUnit< SampleType >::ar	(	BreakpointsType const &	breakpoints,
		UnitType const &	gate = SampleType (1),
		const bool	deleteWhenDone = true,
		BlockSize const &	preferredBlockSize = BlockSize::getDefault(),
		SampleRate const &	preferredSampleRate = SampleRate::getDefault()
	)		throw () [inline, static]

Create an audio rate envelope generator.

template<class SampleType >

static UnitType EnvelopeUnit< SampleType >::kr	(	BreakpointsType const &	breakpoints,
		UnitType const &	gate = SampleType (1),
		const bool	deleteWhenDone = true
	)		throw () [inline, static]

Create a control rate envelope generator.

---

The documentation for this class was generated from the following file:

• plonk_EnvelopeChannel.h