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

Copies data from a buffer to an output block. More...

List of all members.

Static Public Member Functions

static UnitType ar (Buffer const &buffer, DoubleVariable const &overlap=Math< DoubleVariable >::get1(), BlockSize const &preferredBlockSize=BlockSize::noPreference(), SampleRate const &preferredSampleRate=SampleRate::getDefault()) throw ()
 Create an audio rate block generator.
static UnitType ar (BufferArray const &buffers, DoubleVariable const &overlap=Math< DoubleVariable >::get1(), BlockSize const &preferredBlockSize=BlockSize::noPreference(), SampleRate const &preferredSampleRate=SampleRate::getDefault()) throw ()
 Create an audio rate block generator.

Detailed Description

template<class SampleType>
class BlockUnit< SampleType >

Copies data from a buffer to an output block.

Can be used to generate windowing functions for example.

Factory functions:
  • ar (buffer, overlap=1, preferredBlockSize=default, preferredSampleRate=default)
  • ar (buffers, overlap=1, preferredBlockSize=default, preferredSampleRate=default)
  • kr (buffer, overlap=1)
Inputs:
  • buffer: (buffer) the buffer to use
  • buffers: (buffers) an array of buffers to use
  • overlap: (doublevariable) the overlap to use 1= no overlap, 0.5= blocks overlap by half their length
  • 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 BlockUnit< SampleType >::ar ( Buffer const &  buffer,
DoubleVariable const &  overlap = Math<DoubleVariable>::get1(),
BlockSize const &  preferredBlockSize = BlockSize::noPreference(),
SampleRate const &  preferredSampleRate = SampleRate::getDefault() 
) throw () [inline, static]

Create an audio rate block generator.

template<class SampleType >
static UnitType BlockUnit< SampleType >::ar ( BufferArray const &  buffers,
DoubleVariable const &  overlap = Math<DoubleVariable>::get1(),
BlockSize const &  preferredBlockSize = BlockSize::noPreference(),
SampleRate const &  preferredSampleRate = SampleRate::getDefault() 
) throw () [inline, static]

Create an audio rate block generator.


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