switchboard::WhiteNoiseGeneratorNode Class Reference

Generates white noise. More...

#include <WhiteNoiseGeneratorNode.hpp>

Inheritance diagram for switchboard::WhiteNoiseGeneratorNode:

Public Member Functions
WASM	WhiteNoiseGeneratorNode ()
	Creates a WhiteNoiseGeneratorNode instance.
WASM bool	setBusFormat (AudioBusFormat &busFormat) override
	Sets bus format.
WASM bool	produce (AudioBus &bus) override
	Produces audio data in the given bus.
Public Member Functions inherited from switchboard::SingleBusAudioSourceNode
virtual bool	setBusFormat (AudioBusFormat &busFormat)=0
	Sets bus format.
virtual bool	produce (AudioBus &bus)=0
	Produces audio data in the given bus.
bool	setNumberOfBuses (const uint numberOfBuses) override
	Sets number of buses.
bool	setBusFormats (AudioBusFormatList &busFormats) override
	Sets bus formats.
bool	produce (AudioBusList &buses) override
	Produces audio data in the given buses.
virtual bool	setNumberOfBuses (const uint numberOfBuses)=0
	Sets number of buses.
virtual bool	setBusFormats (AudioBusFormatList &busFormats)=0
	Sets bus formats.
virtual bool	produce (AudioBusList &buses)=0
	Produces audio data in the given 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

Generates white noise.

WhiteNoiseGeneratorNode class.

Member Function Documentation

produce()

bool switchboard::WhiteNoiseGeneratorNode::produce ( AudioBus &  bus )

overridevirtual

Produces audio data in the given bus.

Should be overridden by subclasses.

Parameters

bus	The bus that should be filled with audio data.

Returns

True if audio was produced successfully, false otherwise.

Implements switchboard::SingleBusAudioSourceNode.

setBusFormat()

bool switchboard::WhiteNoiseGeneratorNode::setBusFormat ( AudioBusFormat &  busFormat )

overridevirtual

Sets bus format.

Should be overridden by subclasses.

Parameters

busFormat

The bus format to set.

Returns

True if the bus format was set successfully, false otherwise.

Implements switchboard::SingleBusAudioSourceNode.

---

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

• /Users/jenkins/.jenkins/workspace/Switchboard Developer Site - Production/SwitchboardSDK/src/all/AudioGraphNodes/WhiteNoiseGenerator/WhiteNoiseGeneratorNode.hpp
• /Users/jenkins/.jenkins/workspace/Switchboard Developer Site - Production/SwitchboardSDK/src/all/AudioGraphNodes/WhiteNoiseGenerator/WhiteNoiseGeneratorNode.cpp