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
SignalReadUnit< SampleType > Class Template Reference

Signal reader generator. More...

List of all members.

Static Public Member Functions

static UnitType ar (SignalType const &signal, PositionUnitType const &position, 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 signal player.
static UnitType kr (SignalType const &signal, PositionUnitType const &position, UnitType const &mul=SampleType(1), UnitType const &add=SampleType(0)) throw ()
 Create a control rate signal player.

Detailed Description

template<class SampleType>
class SignalReadUnit< SampleType >

Signal reader generator.

Factory functions:
  • ar (signal, position, mul=1, add=0, preferredBlockSize=default, preferredSampleRate=default)
  • kr (signal, position, mul=1, add=0)
Inputs:
  • signal: (signal, multi) the signal to play
  • position: (unit, multi) the read position in seconds
  • 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 SignalReadUnit< SampleType >::ar ( SignalType const &  signal,
PositionUnitType const &  position,
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 signal player.

template<class SampleType >
static UnitType SignalReadUnit< SampleType >::kr ( SignalType const &  signal,
PositionUnitType const &  position,
UnitType const &  mul = SampleType (1),
UnitType const &  add = SampleType (0) 
) throw () [inline, static]

Create a control rate signal player.


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