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
CombFBUnit< SampleType, InterpTypeCode > Class Template Reference

A comb filter setting the feedback amount directly. More...

List of all members.

Static Public Member Functions

static UnitType ar (UnitType const &input, DurationUnitType const &duration=DurationType(0.5), FeedbackUnitType const &feedback=FeedbackType(0.5), const DurationType maximumDuration=DurationType(1.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 comb filter.

Detailed Description

template<class SampleType, Interp::TypeCode InterpTypeCode>
class CombFBUnit< SampleType, InterpTypeCode >

A comb filter setting the feedback amount directly.

Factory functions:
  • ar (input, duration=0.5, feedback=0.5, maximumDuration=1, mul=1, add=0, preferredBlockSize=default, preferredSampleRate=default)
Inputs:
  • input: (unit, multi) the unit to which delay is applied
  • duration: (unit, multi) the delay duration in seconds
  • feedback: (unit, multi) the feedback amount multiplier
  • maximumDuration: (real) the maximum delay time in seconds (this can be equal to duration if duration is a constant)
  • 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 , Interp::TypeCode InterpTypeCode>
static UnitType CombFBUnit< SampleType, InterpTypeCode >::ar ( UnitType const &  input,
DurationUnitType const &  duration = DurationType (0.5),
FeedbackUnitType const &  feedback = FeedbackType (0.5),
const DurationType  maximumDuration = DurationType (1.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 comb filter.


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