MixerUnit< SampleType > Class Template Reference

Mixer. More...

List of all members.

Static Public Member Functions
static UnitType	ar (UnitType const &input, const bool allowAutoDelete=true, UnitType const &mul=SampleType(1), UnitType const &add=SampleType(0), BlockSize const &preferredBlockSize=BlockSize::getDefault(), SampleRate const &preferredSampleRate=SampleRate::getDefault()) throw ()
	Create an audio rate channel mixer.
static UnitType	ar (UnitsType const &array, const bool allowAutoDelete=true, const bool purgeExpiredUnits=true, const int preferredNumChannels=0, UnitType const &mul=SampleType(1), UnitType const &add=SampleType(0), BlockSize const &preferredBlockSize=BlockSize::getDefault(), SampleRate const &preferredSampleRate=SampleRate::getDefault()) throw ()
	Create an audio rate unit mixer.
static UnitType	ar (QueueType const &queue, const bool allowAutoDelete=true, const bool purgeExpiredUnits=true, const int preferredNumChannels=0, UnitType const &mul=SampleType(1), UnitType const &add=SampleType(0), BlockSize const &preferredBlockSize=BlockSize::getDefault(), SampleRate const &preferredSampleRate=SampleRate::getDefault()) throw ()
	Create an audio rate unit queue mixer.

---

Detailed Description

template<class SampleType>
class MixerUnit< SampleType >

Mixer.

Factory functions:

• ar (input, allowAutoDelete=true, mul=1, add=0, preferredBlockSize=default, preferredSampleRate=default)
• ar (array, allowAutoDelete=true, purgeNullUnits=true, preferredNumChannels=0, mul=1, add=0, preferredBlockSize=default, preferredSampleRate=default)
• ar (queue, allowAutoDelete=true, purgeNullUnits=true, preferredNumChannels=0, mul=1, add=0, preferredBlockSize=default, preferredSampleRate=default)

Inputs:

• input: (unit) the input unit to mix
• array: (units, multi) the array of units to mix
• queue: (unit queue) the queue of units to mix
• allowAutoDelete: (bool) whether this unit can be casued to be deleted by the unit(s) it contains
• purgeNullUnits: (bool) whether null units are removed from the array during processing
• preferredNumChannels: (int) force this unit to have a certain number of channels (0= the maximum channel count in array)
• mul: (unit, multi) the multiplier applied to the output
• add: (unit, multi) the offset aded to the output
• 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 MixerUnit< SampleType >::ar	(	UnitType const &	input,
		const bool	allowAutoDelete = true,
		UnitType const &	mul = SampleType (1),
		UnitType const &	add = SampleType (0),
		BlockSize const &	preferredBlockSize = BlockSize::getDefault(),
		SampleRate const &	preferredSampleRate = SampleRate::getDefault()
	)		throw () [inline, static]

Create an audio rate channel mixer.

template<class SampleType >

static UnitType MixerUnit< SampleType >::ar	(	QueueType const &	queue,
		const bool	allowAutoDelete = true,
		const bool	purgeExpiredUnits = true,
		const int	preferredNumChannels = 0,
		UnitType const &	mul = SampleType (1),
		UnitType const &	add = SampleType (0),
		BlockSize const &	preferredBlockSize = BlockSize::getDefault(),
		SampleRate const &	preferredSampleRate = SampleRate::getDefault()
	)		throw () [inline, static]

Create an audio rate unit queue mixer.

template<class SampleType >

static UnitType MixerUnit< SampleType >::ar	(	UnitsType const &	array,
		const bool	allowAutoDelete = true,
		const bool	purgeExpiredUnits = true,
		const int	preferredNumChannels = 0,
		UnitType const &	mul = SampleType (1),
		UnitType const &	add = SampleType (0),
		BlockSize const &	preferredBlockSize = BlockSize::getDefault(),
		SampleRate const &	preferredSampleRate = SampleRate::getDefault()
	)		throw () [inline, static]

Create an audio rate unit mixer.

---

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

• plonk_Mixers.h