audio_tools::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 audio_tools::AudioStream:

Public Member Functions
virtual AudioBaseInfo	audioInfo ()
virtual bool	begin ()
virtual void	end ()
	operator bool ()
virtual size_t	readBytes (char *buffer, size_t length)
virtual size_t	readBytes (uint8_t *buffer, size_t length)=0
virtual void	setAudioInfo (AudioBaseInfo info)
virtual void	setNotifyAudioChange (AudioBaseInfoDependent &bi)
virtual size_t	write (const uint8_t *buffer, size_t size)=0
Public Member Functions inherited from Stream
virtual int	available ()=0
bool	find (char target)
bool	find (const char *target)
bool	find (const char *target, size_t length)
bool	find (const uint8_t *target)
bool	find (const uint8_t *target, size_t length)
bool	findUntil (const char *target, const char *terminator)
bool	findUntil (const char *target, size_t targetLen, const char *terminate, size_t termLen)
bool	findUntil (const uint8_t *target, const char *terminator)
bool	findUntil (const uint8_t *target, size_t targetLen, const char *terminate, size_t termLen)
unsigned long	getTimeout (void)
float	parseFloat (LookaheadMode lookahead=SKIP_ALL, char ignore=NO_IGNORE_CHAR)
long	parseInt (LookaheadMode lookahead=SKIP_ALL, char ignore=NO_IGNORE_CHAR)
virtual int	peek ()=0
virtual int	read ()=0
size_t	readBytes (char *buffer, size_t length)
size_t	readBytes (uint8_t *buffer, size_t length)
size_t	readBytesUntil (char terminator, char *buffer, size_t length)
size_t	readBytesUntil (char terminator, uint8_t *buffer, size_t length)
String	readString ()
String	readStringUntil (char terminator)
void	setTimeout (unsigned long timeout)
Public Member Functions inherited from Print
virtual int	availableForWrite ()
void	clearWriteError ()
virtual void	flush ()
int	getWriteError ()
size_t	print (char)
size_t	print (const __FlashStringHelper *)
size_t	print (const char[])
size_t	print (const Printable &)
size_t	print (const String &)
size_t	print (double, int=2)
size_t	print (int, int=DEC)
size_t	print (long long, int=DEC)
size_t	print (long, int=DEC)
size_t	print (unsigned char, int=DEC)
size_t	print (unsigned int, int=DEC)
size_t	print (unsigned long long, int=DEC)
size_t	print (unsigned long, int=DEC)
size_t	println (char)
size_t	println (const __FlashStringHelper *)
size_t	println (const char[])
size_t	println (const Printable &)
size_t	println (const String &s)
size_t	println (double, int=2)
size_t	println (int, int=DEC)
size_t	println (long long, int=DEC)
size_t	println (long, int=DEC)
size_t	println (unsigned char, int=DEC)
size_t	println (unsigned int, int=DEC)
size_t	println (unsigned long long, int=DEC)
size_t	println (unsigned long, int=DEC)
size_t	println (void)
size_t	write (const char *buffer, size_t size)
size_t	write (const char *str)
virtual size_t	write (uint8_t)=0
Public Member Functions inherited from audio_tools::AudioBaseInfoDependent
virtual bool	validate (AudioBaseInfo &info)

Protected Member Functions
virtual int	not_supported (int out)
Protected Member Functions inherited from Stream
int	findMulti (struct MultiTarget *targets, int tCount)
float	parseFloat (char ignore)
long	parseInt (char ignore)
int	peekNextDigit (LookaheadMode lookahead, bool detectDecimal)
int	timedPeek ()
int	timedRead ()
Protected Member Functions inherited from Print
void	setWriteError (int err=1)

Protected Attributes
AudioBaseInfo	info
AudioBaseInfoDependent *	p_notify =nullptr
Protected Attributes inherited from Stream
unsigned long	_startMillis
unsigned long	_timeout

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:

• src/AudioTools/AudioStreams.h