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

URLStream implementation for the ESP32 based on a separate FreeRTOS task. More...

#include <URLStreamBuffered.h>

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

Public Member Functions

 URLStreamBuffered (Client &clientPar, int readBufferSize=DEFAULT_BUFFER_SIZE)
 
 URLStreamBuffered (const char *network, const char *password, int readBufferSize=DEFAULT_BUFFER_SIZE)
 
 URLStreamBuffered (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 ()
 
int availableForWrite () override
 Writes are not supported.
 
virtual bool begin ()
 
bool begin (const char *urlStr, const char *acceptMime=nullptr, MethodID action=GET, const char *reqMime="", const char *reqData="")
 
virtual void clearNotifyAudioChange ()
 Deletes all change notify subscriptions.
 
void end ()
 
virtual void flush ()
 
HttpRequesthttpRequest ()
 provides access to the HttpRequest
 
bool isNotifyActive ()
 Checks if the automatic AudioInfo update is active.
 
virtual operator bool ()
 
virtual int peek ()
 
virtual int read ()
 
virtual size_t readBytes (uint8_t *data, size_t len)
 
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 setBufferSize (int bufferSize, int bufferCount)
 
void setClient (Client &client) override
 (Re-)defines the client
 
virtual bool setMetadataCallback (void(*fn)(MetaDataType info, const char *str, int len))
 
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)
 
void setPowerSave (bool ps) override
 
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 *data, size_t len) 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}
 
URLStream urlStream
 

Detailed Description

URLStream implementation for the ESP32 based on a separate FreeRTOS task.

Author
Phil Schatzmann

Member Function Documentation

◆ setPowerSave()

void setPowerSave ( bool  ps)
inlineoverridevirtual

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

Implements AbstractURLStream.


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