Base class for all Streams. It relies on write(const uint8_t *buffer, size_t size) and readBytes(uint8_t *buffer, size_t length). More...
#include <BaseStream.h>
Public Member Functions | |
| BaseStream (BaseStream const &)=delete | |
| virtual int | available () override |
| virtual int | availableForWrite () override |
| virtual bool | begin () |
| virtual void | end () |
| virtual void | flush () override |
| operator bool () | |
| BaseStream & | operator= (BaseStream const &)=delete |
| virtual size_t | readBytes (uint8_t *data, size_t len)=0 |
| virtual size_t | write (const uint8_t *data, size_t len) override=0 |
| virtual size_t | write (uint8_t ch) override |
Protected Member Functions | |
| void | refillReadBuffer () |
Protected Attributes | |
| int | _timeout = 10 |
| RingBuffer< uint8_t > | tmp_in {0} |
| RingBuffer< uint8_t > | tmp_out {0} |
Detailed Description
Base class for all Streams. It relies on write(const uint8_t *buffer, size_t size) and readBytes(uint8_t *buffer, size_t length).
- Copyright
- GPLv3
Member Function Documentation
◆ available()
Reimplemented from Stream.
Reimplemented in AudioKitStream, A2DPStream, AudioFFTBase, HLSStream, I2SCodecStream, TfLiteAudioStream, UDPStream, ICYStreamT< T >, BufferedTaskStream, I2SStream, TimedStream, GeneratedSoundStream< T >, GeneratedSoundStream< int16_t >, BufferedStream, ConverterStream< T >, InputMerge< T >, Pipeline::ModifyingStreamAdapter, and VolumeStream.
◆ availableForWrite()
Reimplemented from Print.
Reimplemented in UDPStream, A2DPStream, AudioFFTBase, I2SCodecStream, AbstractURLStream, URLStreamESP32, I2SStream, MeasuringStream, ProgressStream, and VolumeStream.
◆ begin()
Reimplemented in AudioOutputWithCallback, HLSStream, SPDIFOutput, VS1053Stream, WM8960Stream, ESPNowStream, TimerCallbackAudioStream, QueueStream< T >, QueueStream< uint8_t >, DynamicMemoryStream, AudioFFTBase, AnalogAudioArduino, AnalogAudioStream, MemoryStream, GeneratedSoundStream< T >, GeneratedSoundStream< int16_t >, FormatConverterStream, and Pipeline.
◆ end()
Reimplemented in FaustStream< DSP >, HLSStream, I2SCodecStream, VS1053Stream, WM8960Stream, ESPNowStream, I2SStream, TimerCallbackAudioStream, QueueStream< T >, QueueStream< uint8_t >, AudioFFTBase, AudioKitStream, AnalogAudioStream, HttpRequest, ICYStreamT< T >, GeneratedSoundStream< T >, GeneratedSoundStream< int16_t >, InputMixer< T >, InputMerge< T >, and Pipeline.
◆ flush()
Reimplemented from Print.
Reimplemented in ResampleStream, BufferedTaskStream, and BufferedStream.
◆ readBytes()
Reimplemented from Stream.
Implemented in MozziStream, A2DPStream, FaustStream< DSP >, AudioFFTBase, AudioKitStream, HLSStream, I2SCodecStream, TfLiteAudioStream, ESPNowStream, UDPStream, AnalogAudioArduino, AudioEffectStreamT< T >, Equalizer3Bands, ICYStreamT< T >, BufferedTaskStream, I2SStream, TimedStream, GeneratedSoundStream< T >, GeneratedSoundStream< int16_t >, BufferedStream, MeasuringStream, ProgressStream, InputMixer< T >, InputMerge< T >, VolumeStream, and AnalogDriverESP32V1::IO16Bit.
◆ write() [1/2]
Reimplemented from Print.
Implemented in I2SCodecStream, MozziStream, SPDIFOutput, I2SStream, A2DPStream, FaustStream< DSP >, AudioFFTBase, TfLiteAudioStream, VS1053Stream, ESPNowStream, UDPStream, AnalogAudioStream, AudioEffectStreamT< T >, HttpRequest, BufferedTaskStream, TimedStream, BufferedStream, MeasuringStream, ProgressStream, VolumeStream, TfLiteAudioStreamBase, CatStream, and AnalogDriverESP32V1::IO16Bit.
◆ write() [2/2]
Reimplemented in BufferedTaskStream, and BufferedStream.
The documentation for this class was generated from the following file:
- src/AudioTools/CoreAudio/BaseStream.h
