ASPiK SDK
Loading...
Searching...
No Matches
SimpleDelay Class Reference

The SimpleDelay object implements a basic delay line without feedback. More...

#include <fxobjects.h>

Inheritance diagram for SimpleDelay:
IAudioSignalProcessor

Public Member Functions

virtual bool reset (double _sampleRate)
 
SimpleDelayParameters getParameters ()
 
void setParameters (const SimpleDelayParameters &params)
 
virtual double processAudioSample (double xn)
 
virtual bool canProcessAudioFrame ()
 
void createDelayBuffer (double _sampleRate, double _bufferLength_mSec)
 
double readDelay ()
 
double readDelayAtTime_mSec (double _delay_mSec)
 
double readDelayAtPercentage (double delayPercent)
 
void writeDelay (double xn)
 
- Public Member Functions inherited from IAudioSignalProcessor
virtual bool reset (double _sampleRate)=0
 
virtual double processAudioSample (double xn)=0
 
virtual bool canProcessAudioFrame ()=0
 
virtual void setSampleRate (double _sampleRate)
 
virtual void enableAuxInput (bool enableAuxInput)
 
virtual double processAuxInputAudioSample (double xn)
 
virtual bool processAudioFrame (const float *inputFrame, float *outputFrame, uint32_t inputChannels, uint32_t outputChannels)
 

Detailed Description

The SimpleDelay object implements a basic delay line without feedback.

Audio I/O:

  • Processes mono input to mono output.

Control I/F:

Author
Will Pirkle http://www.willpirkle.com
Remarks
This object is included in Designing Audio Effects Plugins in C++ 2nd Ed. by Will Pirkle
Version
Revision : 1.0
Date
Date : 2018 / 09 / 7

Member Function Documentation

◆ canProcessAudioFrame()

virtual bool SimpleDelay::canProcessAudioFrame ( )
inlinevirtual

reset members to initialized state

Implements IAudioSignalProcessor.

◆ createDelayBuffer()

void SimpleDelay::createDelayBuffer ( double  _sampleRate,
double  _bufferLength_mSec 
)
inline

create a new delay buffer

◆ getParameters()

SimpleDelayParameters SimpleDelay::getParameters ( )
inline

get parameters: note use of custom structure for passing param data

Returns
SimpleDelayParameters custom data structure

◆ processAudioSample()

virtual double SimpleDelay::processAudioSample ( double  xn)
inlinevirtual

process MONO audio delay

Parameters
xninput
Returns
the processed sample

Implements IAudioSignalProcessor.

◆ readDelay()

double SimpleDelay::readDelay ( )
inline

read delay at current location

◆ readDelayAtPercentage()

double SimpleDelay::readDelayAtPercentage ( double  delayPercent)
inline

read delay at a percentage of total length

◆ readDelayAtTime_mSec()

double SimpleDelay::readDelayAtTime_mSec ( double  _delay_mSec)
inline

read delay at current location

◆ reset()

virtual bool SimpleDelay::reset ( double  _sampleRate)
inlinevirtual

reset members to initialized state

Implements IAudioSignalProcessor.

◆ setParameters()

void SimpleDelay::setParameters ( const SimpleDelayParameters params)
inline

set parameters: note use of custom structure for passing param data

Parameters
SimpleDelayParameterscustom data structure

◆ writeDelay()

void SimpleDelay::writeDelay ( double  xn)
inline

write a new value into the delay


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