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

Resamples audio between two audio nodes running with different sample rates. At least one of the input and output sample rate settings has to be set. More...

#include <ResamplerNode.hpp>

Inheritance diagram for switchboard::ResamplerNode:
switchboard::SingleBusAudioProcessorNode switchboard::AudioProcessorNode switchboard::AudioNode

Public Member Functions

 ResamplerNode ()
 ResamplerNode constructor.
 
uint getInputSampleRate ()
 Returns the input sample rate.
 
void setInputSampleRate (const uint inputSampleRate)
 Sets the input sample rate.
 
uint getOutputSampleRate ()
 Returns the output sample rate.
 
void setOutputSampleRate (const uint outputSampleRate)
 Sets the output sample rate.
 
bool setBusFormat (AudioBusFormat &inputBusFormat, AudioBusFormat &outputBusFormat)
 Sets bus format.
 
bool process (AudioBus &inBus, AudioBus &outBus)
 Processes audio data from the given input bus and produces the audio output to the given output bus.
 
- Public Member Functions inherited from switchboard::SingleBusAudioProcessorNode
bool setNumberOfBuses (const uint numberOfInputBuses, const uint numberOfOutputBuses) override
 Sets number of buses.
 
bool setBusFormats (AudioBusFormatList &inputBusFormats, AudioBusFormatList &outputBusFormats) override
 Sets bus formats.
 
bool process (AudioBusList &inBuses, AudioBusList &outBuses) override
 Processes audio data from the given input buses and produces the audio output to the given output buses.
 
- Public Member Functions inherited from switchboard::AudioProcessorNode
virtual ~AudioProcessorNode ()=default
 AudioProcessorNode virtual destructor.
 
- Public Member Functions inherited from switchboard::AudioNode
 AudioNode ()
 AudioNode constructor.
 
virtual ~AudioNode ()=default
 AudioNode virtual destructor.
 
const std::string & getType () const
 Gets the type of the audio node.
 
virtual const std::string getDisplayName () const
 Gets the display name of the audio node.
 
virtual std::vector< std::unique_ptr< Parameter > > & getParameters ()
 Gets the parameters of the audio node.
 
virtual ParametergetParameter (const std::string &id)
 Gets the parameter with the given name.
 

Additional Inherited Members

- Public Attributes inherited from switchboard::AudioNode
std::string name
 The name of the audio node.
 
- Protected Member Functions inherited from switchboard::AudioNode
void initParameters (std::map< std::string, std::any > config)
 Initializes the node parameters from the given configuration values.
 
- Protected Attributes inherited from switchboard::AudioNode
std::string type
 
std::vector< std::unique_ptr< Parameter > > parameters
 

Detailed Description

Resamples audio between two audio nodes running with different sample rates. At least one of the input and output sample rate settings has to be set.

ResamplerNode class.

Member Function Documentation

◆ getInputSampleRate()

uint switchboard::ResamplerNode::getInputSampleRate ( )

Returns the input sample rate.

Returns
The input sample rate. 0 means undefined sample rate.

◆ getOutputSampleRate()

uint switchboard::ResamplerNode::getOutputSampleRate ( )

Returns the output sample rate.

Returns
The output sample rate. 0 means undefined sample rate.

◆ process()

bool switchboard::ResamplerNode::process ( AudioBus & inBus,
AudioBus & outBus )
virtual

Processes audio data from the given input bus and produces the audio output to the given output bus.

Should be overridden by subclasses.

Parameters
inBusThe input bus that contain the audio data.
outBusThe output bus which should be filled with the processed audio data.
Returns
True if audio was processed successfully, false otherwise.

Implements switchboard::SingleBusAudioProcessorNode.

◆ setBusFormat()

bool switchboard::ResamplerNode::setBusFormat ( AudioBusFormat & inputBusFormat,
AudioBusFormat & outputBusFormat )
virtual

Sets bus format.

Should be overridden by subclasses.

Parameters
inputBusFormatThe input bus format to set.
outputBusFormatThe output bus format to set.
Returns
True if the bus formats were set successfully, false otherwise.

Implements switchboard::SingleBusAudioProcessorNode.

◆ setInputSampleRate()

void switchboard::ResamplerNode::setInputSampleRate ( const uint inputSampleRate)

Sets the input sample rate.

Parameters
inputSampleRateThe input sample rate. 0 means undefined sample rate.

◆ setOutputSampleRate()

void switchboard::ResamplerNode::setOutputSampleRate ( const uint outputSampleRate)

Sets the output sample rate.

Parameters
outputSampleRateThe output sample rate. 0 means undefined sample rate.