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

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 AudioBaseInfoDependent AudioBaseInfoSource Print A2DPStream AbstractURLStream AudioStreamWrapper AudioStreamX BufferedStream BufferedTaskStream I2SStream MemoryStream MozziStream RingBufferStream

Public Member Functions

 AudioStream (AudioStream const &)=delete
 
virtual AudioBaseInfo audioInfo () override
 
virtual int availableForWrite () override
 
virtual bool begin ()
 
virtual void end ()
 
virtual void flush () override
 
 operator bool ()
 
AudioStreamoperator= (AudioStream const &)=delete
 
virtual size_t readBytes (char *buffer, size_t length)
 
virtual size_t readBytes (uint8_t *buffer, size_t length) STREAM_WRITE_OVERRIDE=0
 
virtual void setAudioInfo (AudioBaseInfo info) override
 
virtual void setNotifyAudioChange (AudioBaseInfoDependent &bi) override
 
virtual StreamtoStreamPointer ()
 
virtual size_t write (const uint8_t *buffer, size_t size) override=0
 
virtual void writeSilence (size_t len)
 
- Public Member Functions inherited from Stream
virtual int available ()
 
virtual int peek ()
 
virtual int read ()
 
virtual void setTimeout (size_t t)
 
- Public Member Functions inherited from Print
virtual int print (char c, PrintCharFmt spec)
 
virtual int print (const char *msg)
 
virtual int print (int number)
 
virtual int println (const char *msg="")
 
virtual size_t write (const char *buffer, size_t size)
 
virtual size_t write (const char *str)
 
virtual size_t write (uint8_t ch)
 
- Public Member Functions inherited from AudioBaseInfoDependent
virtual bool validate (AudioBaseInfo &info)
 

Protected Member Functions

virtual int not_supported (int out)
 

Protected Attributes

AudioBaseInfo info
 
AudioBaseInfoDependentp_notify =nullptr
 

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

Member Function Documentation

◆ writeSilence()

virtual void writeSilence ( size_t  len)
inlinevirtual

Writes n 0 values (= silence)

Parameters
len

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