Threshold Class Reference

This sound Transforms any signal to a square signal by thresholding. More...

#include <Threshold.h>

Inheritance diagram for Threshold:

Public Member Functions
	Threshold (std::shared_ptr< ISound > sound, float threshold=0.0f)
	Creates a new threshold sound.
float	getThreshold () const
	Returns the threshold.
virtual std::shared_ptr< IReader >	createReader ()
	Creates a reader for playback of the sound source.
Public Member Functions inherited from Effect
	Effect (std::shared_ptr< ISound > sound)
	Creates a new sound.
virtual	~Effect ()
	Destroys the sound.
std::shared_ptr< ISound >	getSound () const
	Returns the saved sound.
Public Member Functions inherited from ISound
virtual	~ISound ()
	Destroys the sound.

Static Public Member Functions
static sample_t AUD_LOCAL	thresholdFilter (CallbackIIRFilterReader *reader, float *threshold)
	The thresholdFilter function implements the doFilterIIR callback for the callback IIR filter.
static void AUD_LOCAL	endThresholdFilter (float *threshold)
	The endThresholdFilter function implements the endFilterIIR callback for the callback IIR filter.

Additional Inherited Members
Protected Member Functions inherited from Effect
std::shared_ptr< IReader >	getReader () const
	Returns the reader created out of the sound.
Protected Attributes inherited from Effect
std::shared_ptr< ISound >	m_sound
	If there is no reader it is created out of this sound.

Detailed Description

This sound Transforms any signal to a square signal by thresholding.

Constructor & Destructor Documentation

Threshold()

Threshold::Threshold	(	std::shared_ptr< ISound >	sound,
		float	threshold = 0.0f )

Creates a new threshold sound.

Parameters

sound	The input sound.
threshold	The threshold.

Member Function Documentation

createReader()

virtual std::shared_ptr< IReader > Threshold::createReader ( )

virtual

Creates a reader for playback of the sound source.

Returns

A pointer to an IReader object or nullptr if there has been an error.

Exceptions

Exception

An exception may be thrown if there has been a more unexpected error during reader creation.

Implements ISound.

endThresholdFilter()

void AUD_LOCAL Threshold::endThresholdFilter ( float * threshold )

static

The endThresholdFilter function implements the endFilterIIR callback for the callback IIR filter.

Parameters

threshold

The threshold value.

thresholdFilter()

sample_t AUD_LOCAL Threshold::thresholdFilter ( CallbackIIRFilterReader * reader, float * threshold )

static

The thresholdFilter function implements the doFilterIIR callback for the callback IIR filter.

Parameters

reader	The CallbackIIRFilterReader that executes the callback.
threshold	The threshold value.

Returns

The filtered sample.

---

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

• fx/Threshold.h