Switchboard SDK
Loading...
Searching...
No Matches
switchboard::DuckingCompressor Class Referenceabstract

Abstract base class for compressors that can be used for audio ducking. More...

#include <DuckingCompressor.hpp>

Inheritance diagram for switchboard::DuckingCompressor:
switchboard::SimpleDuckingCompressor

Public Member Functions

virtual ~DuckingCompressor ()
 DuckingCompressor destructor.
 
virtual void setSampleRate (const uint sampleRate)=0
 Sets the sample rate.
 
virtual void setThresholdDb (const float threshold)=0
 Sets he threshold of the compressor in dB (0 = no ducking).
 
virtual void process (float *buffer, const uint numberOfFrames)=0
 Runs the audio compression algorithm on an audio buffer.
 

Detailed Description

Abstract base class for compressors that can be used for audio ducking.

Member Function Documentation

◆ process()

virtual void switchboard::DuckingCompressor::process ( float * buffer,
const uint numberOfFrames )
pure virtual

Runs the audio compression algorithm on an audio buffer.

Parameters
bufferThe stereo interleaved audio buffer.
numberOfFramesThe number of frames in the audio buffer.

Implemented in switchboard::SimpleDuckingCompressor.

◆ setSampleRate()

virtual void switchboard::DuckingCompressor::setSampleRate ( const uint sampleRate)
pure virtual

Sets the sample rate.

Parameters
sampleRateThe new sampleRate.

Implemented in switchboard::SimpleDuckingCompressor.

◆ setThresholdDb()

virtual void switchboard::DuckingCompressor::setThresholdDb ( const float threshold)
pure virtual

Sets he threshold of the compressor in dB (0 = no ducking).

Parameters
thresholdThe new threshold value in dB.

Implemented in switchboard::SimpleDuckingCompressor.