Analyzes the audio and returns whether it was clipping in the last buffer. Accepts mono buffers. More...

#include <ClippingDetectorNode.hpp>

Inheritance diagram for switchboard::ClippingDetectorNode:

Public Member Functions
	ClippingDetectorNode ()
	Creates a ClippingDetectorNode instance.

const ClippingType	getClipping () const
	Returns the clipping type in the last buffer.

bool	setBusFormat (AudioBusFormat &busFormat) override
	Sets bus format.

bool	consume (AudioBus &bus) override
	Consumes audio data from the given bus.

Public Member Functions inherited from switchboard::SingleBusAudioSinkNode
bool	setNumberOfBuses (const uint numberOfBuses) override
	Sets number of buses.

bool	setBusFormats (AudioBusFormatList &busFormats) override
	Sets bus formats.

bool	consume (AudioBusList &buses) override
	Consumes audio data from the given buses.

Public Member Functions inherited from switchboard::AudioSinkNode
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 Parameter *	getParameter (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

Analyzes the audio and returns whether it was clipping in the last buffer. Accepts mono buffers.

Member Function Documentation

bool switchboard::ClippingDetectorNode::consume ( AudioBus & bus )

overridevirtual

Consumes audio data from the given bus.

Should be overridden by subclasses.

Parameters

bus	The bus that contain the audio data.

const ClippingType switchboard::ClippingDetectorNode::getClipping ( ) const

Returns the clipping type in the last buffer.

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

overridevirtual

Sets bus format.

Should be overridden by subclasses.

Parameters

busFormat The bus format to set.