GeneratorFixedValue< T > Class Template Reference

Just returns a constant value. More...

#include <SoundGenerator.h>

Inheritance diagram for GeneratorFixedValue< T >:

Public Member Functions
virtual AudioInfo	audioInfo ()
	Provides the AudioInfo.
bool	begin () override
	Starts the generation of samples.
virtual bool	begin (AudioInfo info)
virtual AudioInfo	defaultConfig ()
	Provides the default configuration.
virtual void	end ()
	ends the processing
virtual bool	isActive ()
bool	isRunning ()
virtual size_t	readBytes (uint8_t *data, size_t len)
	Provides the data as byte array with the requested number of channels.
T	readSample () override
	Provides a single sample.
virtual void	setAudioInfo (AudioInfo info)
	Defines/updates the AudioInfo.
virtual void	setFrequency (float frequency)
	Abstract method: not implemented! Just provides an error message...
void	setValue (T value)

Protected Member Functions
size_t	readBytesFrames (uint8_t *buffer, size_t lengthBytes, int frames, int channels)
size_t	readBytesFromBuffer (uint8_t *buffer, size_t lengthBytes, int frame_size, int channels)

Protected Attributes
bool	active = false
bool	activeWarningIssued = false
AudioInfo	info
bool	is_running = false
RingBuffer< uint8_t >	ring_buffer {0}
T	value_return = 0
T	value_set = 0

Detailed Description

template<class T = int16_t>
class audio_tools::GeneratorFixedValue< T >

Just returns a constant value.

Author

Phil Schatzmann

Copyright

GPLv3

Template Parameters

T

Member Function Documentation

begin() [1/2]

template<class T = int16_t>

bool begin ( )

inlineoverridevirtual

Starts the generation of samples.

Reimplemented from SoundGenerator< T >.

begin() [2/2]

template<class T = int16_t>

virtual bool begin ( AudioInfo  info )

inlinevirtual

Reimplemented from SoundGenerator< T >.

defaultConfig()

template<class T = int16_t>

virtual AudioInfo defaultConfig ( )

inlinevirtualinherited

Provides the default configuration.

Reimplemented in STKGenerator< StkCls, T >, STKGenerator< StkCls, int16_t >, SineWaveGenerator< T >, and SineWaveGenerator< int16_t >.

end()

template<class T = int16_t>

virtual void end ( )

inlinevirtualinherited

ends the processing

Reimplemented in GeneratorFromArray< T >.

isActive()

template<class T = int16_t>

virtual bool isActive ( )

inlinevirtualinherited

Checks if the begin method has been called - after end() isActive returns false

readSample()

template<class T = int16_t>

T readSample ( )

inlineoverridevirtual

Provides a single sample.

Implements SoundGenerator< T >.

setAudioInfo()

template<class T = int16_t>

virtual void setAudioInfo ( AudioInfo  info )

inlinevirtualinherited

Defines/updates the AudioInfo.

Reimplemented in SineWaveGenerator< T >, and SineWaveGenerator< int16_t >.

setFrequency()

template<class T = int16_t>

virtual void setFrequency ( float  frequency )

inlinevirtualinherited

Abstract method: not implemented! Just provides an error message...

Reimplemented in SineFromTable< T >, STKGenerator< StkCls, T >, STKGenerator< StkCls, int16_t >, SineWaveGenerator< T >, and SineWaveGenerator< int16_t >.

---

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

• src/AudioTools/CoreAudio/AudioEffects/SoundGenerator.h