arduino-audio-tools
Loading...
Searching...
No Matches
Public Member Functions | Protected Attributes | List of all members
audio_tools::SilenceGenerator< T > Class Template Reference

Provides a fixed value (e.g. 0) as sound data. This can be used e.g. to test the output functionality which should optimally just output silence and no artifacts. More...

#include <SoundGenerator.h>

Inheritance diagram for audio_tools::SilenceGenerator< T >:
audio_tools::SoundGenerator< T >

Public Member Functions

 SilenceGenerator (T value=0)
 
readSample ()
 Provides a single sample. More...
 
- Public Member Functions inherited from audio_tools::SoundGenerator< T >
virtual AudioBaseInfo audioInfo ()
 
virtual bool begin ()
 
virtual bool begin (AudioBaseInfo info)
 
virtual AudioBaseInfo defaultConfig ()
 
virtual void end ()
 ends the processing
 
virtual bool isActive ()
 Checks if the begin method has been called - after end() isActive returns false.
 
virtual size_t readBytes (uint8_t *buffer, size_t lengthBytes)
 Provides the data as byte array with the requested number of channels.
 
virtual T readSample ()=0
 Provides a single sample. More...
 
virtual size_t readSamples (T *data, size_t sampleCount=512)
 Provides the samples into simple array - which represents 1 channel.
 
virtual size_t readSamples (T src[][2], size_t frameCount)
 Provides the samples into a 2 channel array.
 
virtual void setAudioInfo (AudioBaseInfo info)
 
virtual void setFrequency (uint16_t frequency)
 

Protected Attributes

value
 
- Protected Attributes inherited from audio_tools::SoundGenerator< T >
bool active = false
 
bool activeWarningIssued = false
 
AudioBaseInfo info
 
int output_channels = 1
 

Detailed Description

template<class T>
class audio_tools::SilenceGenerator< T >

Provides a fixed value (e.g. 0) as sound data. This can be used e.g. to test the output functionality which should optimally just output silence and no artifacts.

Author
Phil Schatzmann

Member Function Documentation

◆ readSample()

template<class T >
T audio_tools::SilenceGenerator< T >::readSample ( )
inlinevirtual

Provides a single sample.

Implements audio_tools::SoundGenerator< T >.


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