SignalPlayUnit< SampleType > Class Template Reference

Signal player generator. More...

List of all members.

Static Public Member Functions
static UnitType	ar (SignalType const &signal, RateUnitType const &rate=RateType(1), UnitType const &loop=SampleType(1), UnitType const &mul=SampleType(1), UnitType const &add=SampleType(0), const bool deleteWhenDone=true, BlockSize const &preferredBlockSize=BlockSize::getDefault(), SampleRate const &preferredSampleRate=SampleRate::getDefault()) throw ()
	Create an audio rate signal player.
static UnitType	kr (SignalType const &signal, RateUnitType const &rate, UnitType const &loop=SampleType(1), UnitType const &mul=SampleType(1), UnitType const &add=SampleType(0), const bool deleteWhenDone=true) throw ()
	Create a control rate signal player.

---

Detailed Description

template<class SampleType>
class SignalPlayUnit< SampleType >

Signal player generator.

Factory functions:

• ar (signal, rate=1, loop=1, mul=1, add=0, allowAutoDelete=true, preferredBlockSize=default, preferredSampleRate=default)
• kr (signal, rate=1, loop=1, mul=1, add=0, allowAutoDelete=true)

Inputs:

• signal: (signal, multi) the signal to play
• rate: (unit, multi) the rate of playback (1= normal speed)
• loop: (unit, multi) a flag to tell the file player to loop
• mul: (unit, multi) the multiplier applied to the output
• add: (unit, multi) the offset aded to the output
• allowAutoDelete: (bool) whether this unit can be caused 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 SignalPlayUnit< SampleType >::ar	(	SignalType const &	signal,
		RateUnitType const &	rate = RateType (1),
		UnitType const &	loop = SampleType (1),
		UnitType const &	mul = SampleType (1),
		UnitType const &	add = SampleType (0),
		const bool	deleteWhenDone = true,
		BlockSize const &	preferredBlockSize = BlockSize::getDefault(),
		SampleRate const &	preferredSampleRate = SampleRate::getDefault()
	)		throw () [inline, static]

Create an audio rate signal player.

template<class SampleType >

static UnitType SignalPlayUnit< SampleType >::kr	(	SignalType const &	signal,
		RateUnitType const &	rate,
		UnitType const &	loop = SampleType (1),
		UnitType const &	mul = SampleType (1),
		UnitType const &	add = SampleType (0),
		const bool	deleteWhenDone = true
	)		throw () [inline, static]

Create a control rate signal player.

---

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

• plonk_SignalPlay.h