Switchboard SDK
Loading...
Searching...
No Matches
switchboard::Offset Class Reference

Applies given DC offset to incoming signal. More...

#include <Offset.hpp>

Public Member Functions

 Offset (const float offset=0.0f)
 Offset constructor.
 
void setOffset (const float offset)
 Sets the offset value.
 
float getOffset () const
 Gets the offset value currently in use.
 
void process (float *buffer, const uint numberOfFrames) const
 Applies the offset to the given audio buffer.
 
void process (AudioBuffer< float > &audioBuffer) const
 Applies the offset to the given audio buffer.
 

Detailed Description

Applies given DC offset to incoming signal.

Offset class

Constructor & Destructor Documentation

◆ Offset()

switchboard::Offset::Offset ( const float offset = 0.0f)

Offset constructor.

Parameters
offsetDC offset to be applied to the incoming signal.

Member Function Documentation

◆ getOffset()

float switchboard::Offset::getOffset ( ) const

Gets the offset value currently in use.

Returns
The offset value.

◆ process() [1/2]

void switchboard::Offset::process ( AudioBuffer< float > & audioBuffer) const

Applies the offset to the given audio buffer.

Parameters
audioBufferThe audio buffer.

◆ process() [2/2]

void switchboard::Offset::process ( float * buffer,
const uint numberOfFrames ) const

Applies the offset to the given audio buffer.

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

◆ setOffset()

void switchboard::Offset::setOffset ( const float offset)

Sets the offset value.

Parameters
offsetThe new offset.