arduino-audio-tools
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
AudioStream Class Reference

Base class for all Audio Streams. It support the boolean operator to test if the object is ready with data. More...

#include <AudioStreams.h>

Inheritance diagram for AudioStream:
Stream AudioInfoSupport AudioInfoSource Print FileLoopT< File > GeneratedSoundStream< int16_t > QueueStream< uint8_t > A2DPStream AbstractURLStream AdapterAudioOutputToAudioStream AnalogAudioStream AnalogDriverESP32V1::IO16Bit AudioEffectStream AudioEffectStreamT< T > AudioKitStream AudioMP34DT05 AudioStreamWrapper AudioSyncReader BufferedStream BufferedTaskStream CallbackStream CatStream ConverterStream< T > DynamicMemoryStream ESP3288AudioOutput ESPNowStream EncodedAudioOutput Equilizer3Bands FadeStream FaustStream< DSP > FileLoopT< FileType > FilteredStream< T, TF > GeneratedSoundStream< T > HLSStream I2SCodecStream I2SStream InputMerge< T > InputMixer< T > JupyterAudioT< T > MeasuringStream MemoryStream MiniAudioStream MozziStream NullStream PortAudioStream ProgressStream PureDataStream QueueStream< T > ReformatBaseStream RingBufferStream SPDIFOutput StdioStream TfLiteAudioStreamBase Throttle TimedStream VBANStream VS1053Stream VolumeStream WM8960Stream

Public Member Functions

 AudioStream (AudioStream const &)=delete
 
virtual void addNotifyAudioChange (AudioInfoSupport &bi)
 Adds target to be notified about audio changes.
 
virtual AudioInfo audioInfo () override
 
virtual int available () override
 
virtual int availableForWrite () override
 
virtual bool begin ()
 
virtual void clearNotifyAudioChange ()
 Deletes all change notify subscriptions.
 
virtual void end ()
 
virtual void flush () override
 
 operator bool ()
 
AudioStream & operator= (AudioStream const &)=delete
 
virtual size_t readBytes (uint8_t *buffer, size_t length)
 
virtual size_t readSilence (uint8_t *buffer, size_t length)
 Source to generate silence: just sets the buffer to 0.
 
virtual bool removeNotifyAudioChange (AudioInfoSupport &bi)
 Removes a target in order not to be notified about audio changes.
 
virtual void setAudioInfo (AudioInfo info) override
 
virtual void setNotifyAudioChange (AudioInfoSupport &bi)
 Obsolete: Use addNotifyAudioChange.
 
virtual size_t write (const uint8_t *buffer, size_t size) override
 
virtual size_t write (uint8_t ch) override
 
virtual void writeSilence (size_t len)
 Writes len bytes of silence (=0).
 

Protected Member Functions

bool contains (AudioInfoSupport &bi)
 
virtual int not_supported (int out, const char *msg="")
 
void notifyAudioChange (AudioInfo info)
 
void refillReadBuffer ()
 

Protected Attributes

int _timeout = 10
 
AudioInfo info
 
Vector< AudioInfoSupport * > notify_vector
 
RingBuffer< uint8_t > tmp_in {0}
 
RingBuffer< uint8_t > tmp_out {0}
 

Detailed Description

Base class for all Audio Streams. It support the boolean operator to test if the object is ready with data.

Author
Phil Schatzmann
Copyright
GPLv3
The documentation for this class was generated from the following file:
Generated by doxygen 1.9.1