pl-nk v0.4.5
Plonk|Plink|Plank are a set of cross-platform C/C++ frameworks for audio software development
Static Public Member Functions
PatchUnit< SampleType > Class Template Reference

Patch channel. More...

List of all members.

Static Public Member Functions

static UnitType ar (UnitVariableType const &initialSource, const bool allowAutoDelete=true, const int preferredNumChannels=0, DurationUnitType const &fadeDuration=DurationType(0.1), BlockSize const &preferredBlockSize=BlockSize::getDefault(), SampleRate const &preferredSampleRate=SampleRate::getDefault()) throw ()
 Create control rate variable.

Detailed Description

template<class SampleType>
class PatchUnit< SampleType >

Patch channel.

Safe repatching of signals.

Factory functions:
  • ar (initialSource, allowAutoDelete=true, preferredNumChannels=0, fadeDuration=0.1, mul=1, add=0, preferredBlockSize=default, preferredSampleRate=default)
Inputs:
  • initialSource: (unitvariable, multi)
  • allowAutoDelete: (bool) whether this unit can be caused to be deleted by the unit it contains
  • preferredNumChannels: (int) force this unit to have a certain number of channels (0= the channel count in initialSource)
  • fadeDuration: (unit, mono) the crossfade time in seconds to be used when patch sources are changed
  • mul: (unit) the multiplier applied to the output (NB NOT multi)
  • add: (unit) the offset aded to the output (NB NOT multi)
  • 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 PatchUnit< SampleType >::ar ( UnitVariableType const &  initialSource,
const bool  allowAutoDelete = true,
const int  preferredNumChannels = 0,
DurationUnitType const &  fadeDuration = DurationType (0.1),
BlockSize const &  preferredBlockSize = BlockSize::getDefault(),
SampleRate const &  preferredSampleRate = SampleRate::getDefault() 
) throw () [inline, static]

Create control rate variable.


The documentation for this class was generated from the following file:
 All Classes Functions Typedefs Enumerations Enumerator Properties