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

ICYStream implementation for the ESP32 based on a FreeRTOS task This is a Icecast/Shoutcast Audio Stream which splits the data into metadata and audio data. The Audio data is provided via the regular stream functions. The metadata is handled with the help of the MetaDataICY state machine and provided via a callback method. More...

#include <ICYStreamBuffered.h>

Inheritance diagram for ICYStreamBuffered:
AbstractURLStream AudioStream BaseStream AudioInfoSupport AudioInfoSource Stream Print

Public Member Functions

 ICYStreamBuffered (Client &clientPar, int readBufferSize=DEFAULT_BUFFER_SIZE)
 
 ICYStreamBuffered (const char *network, const char *password, int readBufferSize=DEFAULT_BUFFER_SIZE)
 
 ICYStreamBuffered (int readBufferSize=DEFAULT_BUFFER_SIZE)
 
virtual void addNotifyAudioChange (AudioInfoSupport &bi)
 Adds target to be notified about audio changes.
 
virtual AudioInfo audioInfo () override
 provides the actual input AudioInfo
 
virtual AudioInfo audioInfoOut ()
 provides the actual output AudioInfo: this is usually the same as audioInfo() unless we use a transforming stream
 
virtual int available () override
 
int availableForWrite () override
 Writes are not supported.
 
virtual bool begin ()
 
virtual bool begin (const char *urlStr, const char *acceptMime=nullptr, MethodID action=GET, const char *reqMime="", const char *reqData="") override
 
virtual void clearNotifyAudioChange ()
 Deletes all change notify subscriptions.
 
virtual void end () override
 
virtual void flush () override
 Not implemented.
 
virtual HttpRequesthttpRequest () override
 provides access to the HttpRequest
 
bool isNotifyActive ()
 Checks if the automatic AudioInfo update is active.
 
 operator bool ()
 
virtual int peek () override
 
virtual int read () override
 
virtual size_t readBytes (uint8_t *buffer, size_t length) override
 
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 newInfo) override
 Defines the input AudioInfo.
 
void setClient (Client &client) override
 (Re-)defines the client
 
virtual bool setMetadataCallback (void(*fn)(MetaDataType info, const char *str, int len)) override
 
void setNotifyActive (bool flag)
 Deactivate/Reactivate automatic AudioInfo updates: (default is active)
 
void setPassword (const char *password) override
 Sets the password that will be used for logging in (when calling begin)
 
virtual void setPowerSave (bool ps)=0
 
void setSSID (const char *ssid) override
 Sets the ssid that will be used for logging in (when calling begin)
 
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

virtual int not_supported (int out, const char *msg="")
 
void notifyAudioChange (AudioInfo info)
 
void refillReadBuffer ()
 

Protected Attributes

int _timeout = 10
 
AudioInfo info
 
bool is_notify_active = true
 
Vector< AudioInfoSupport * > notify_vector
 
BufferedTaskStream taskStream
 
RingBuffer< uint8_t > tmp_in {0}
 
RingBuffer< uint8_t > tmp_out {0}
 
ICYStream urlStream
 

Detailed Description

ICYStream implementation for the ESP32 based on a FreeRTOS task This is a Icecast/Shoutcast Audio Stream which splits the data into metadata and audio data. The Audio data is provided via the regular stream functions. The metadata is handled with the help of the MetaDataICY state machine and provided via a callback method.

This is basically just a URLStream with the metadata turned on.

Author
Phil Schatzmann

Member Function Documentation

◆ setPowerSave()

virtual void setPowerSave ( bool  ps)
pure virtualinherited

if set to true, it activates the power save mode which comes at the cost of performance! - By default this is deactivated. ESP32 Only!

Implemented in URLStream, and ICYStream.


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