Loading...
Searching...
No Matches
Public Member Functions | List of all members
switchboard::GainNode Class Reference

Changes the gain of the audio that flows through this node. More...

#include <GainNode.hpp>

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

Public Member Functions

WASM GainNode ()
 Creates a GainNode instance.
 
WASM float getGain () const
 Gets the current gain value.
 
WASM void setGain (const float newValue)
 Sets the gain.
 
WASM bool setBusFormat (AudioBusFormat &inputBusFormat, AudioBusFormat &outputBusFormat) override
 Sets bus format.
 
WASM bool process (AudioBus &inBus, AudioBus &outBus) override
 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
virtual bool setBusFormat (AudioBusFormat &inputBusFormat, AudioBusFormat &outputBusFormat)=0
 Sets bus format.
 
virtual bool process (AudioBus &inBus, AudioBus &outBus)=0
 Processes audio data from the given input bus and produces the audio output to the given output bus.
 
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.
 
virtual bool setNumberOfBuses (const uint numberOfInputBuses, const uint numberOfOutputBuses)=0
 Sets number of buses.
 
virtual bool setBusFormats (AudioBusFormatList &inputBusFormats, AudioBusFormatList &outputBusFormats)=0
 Sets bus formats.
 
virtual bool process (AudioBusList &inBuses, AudioBusList &outBuses)=0
 Processes audio data from the given input buses and produces the audio output to the given output buses.
 
- Public Member Functions inherited from switchboard::AudioNode
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.
 

Additional Inherited Members

- Public Attributes inherited from switchboard::AudioNode
std::string name
 The name of the audio node.
 
- Protected Attributes inherited from switchboard::AudioNode
std::string type
 

Detailed Description

Changes the gain of the audio that flows through this node.

GainNode class.

Member Function Documentation

◆ getGain()

float switchboard::GainNode::getGain ( ) const

Gets the current gain value.

Returns
The gain value.

◆ process()

bool switchboard::GainNode::process ( AudioBus &  inBus,
AudioBus &  outBus 
)
overridevirtual

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::GainNode::setBusFormat ( AudioBusFormat &  inputBusFormat,
AudioBusFormat &  outputBusFormat 
)
overridevirtual

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.

◆ setGain()

void switchboard::GainNode::setGain ( const float  newValue)

Sets the gain.

Parameters
newValueThe gain value to set.
The documentation for this class was generated from the following files: