URLStreamBufferedT< T > Class Template Reference

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

#include <URLStreamBufferedT.h>

Inheritance diagram for URLStreamBufferedT< T >:

Public Member Functions
	URLStreamBufferedT (const char *network, const char *password, int readBufferSize=DEFAULT_BUFFER_SIZE)
	URLStreamBufferedT (int readBufferSize=DEFAULT_BUFFER_SIZE)
virtual void	addNotifyAudioChange (AudioInfoSupport &bi)
	Adds target to be notified about audio changes.
void	addRequestHeader (const char *key, const char *value) override
	Adds/Updates a request header.
virtual AudioInfo	audioInfo () override
	provides the actual input AudioInfo
virtual AudioInfo	audioInfoOut ()
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="")
void	clear ()
	Clears the buffer.
virtual void	clearNotifyAudioChange ()
	Deletes all change notify subscriptions.
int	contentLength () override
	Provides the reported data size from the http reply.
void	end ()
virtual void	flush ()
const char *	getReplyHeader (const char *key) override
	Provides reply header info.
HttpRequest &	httpRequest ()
	provides access to the HttpRequest
bool	isNotifyActive ()
	Checks if the automatic AudioInfo update is active.
const char *	mime () override
	Provides the MIME type for the current stream.
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)
	Defines the buffer that holds the with encoded data.
void	setCACert (const char *cert)
	Define the Root PEM Certificate for SSL.
void	setClient (Client &client) override
	(Re-)defines the client
void	setConnectionClose (bool flag) override
	Add Connection: close to request header.
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
	ESP32 only: PowerSave off (= default setting) is much faster.
void	setSSID (const char *ssid) override
	Sets the ssid that will be used for logging in (when calling begin)
void	setWriteBufferSize (int size)
size_t	totalRead () override
	Total amout of data that was consumed so far.
const char *	urlStr () override
	Provides the url as string.
bool	waitForData (int timeout) override
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}
T	urlStream
int	write_buffer_size = MAX_SINGLE_CHARS

Detailed Description

template<class T>
class audio_tools::URLStreamBufferedT< T >

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

Author

Phil Schatzmann

Copyright

GPLv3

Constructor & Destructor Documentation

URLStreamBufferedT() [1/2]

template<class T >

URLStreamBufferedT ( int  readBufferSize = DEFAULT_BUFFER_SIZE )

inline

URLStreamBufferedT() [2/2]

template<class T >

URLStreamBufferedT ( const char *  network, const char *  password, int  readBufferSize = DEFAULT_BUFFER_SIZE  )

inline

Member Function Documentation

addNotifyAudioChange()

virtual void addNotifyAudioChange ( AudioInfoSupport &  bi )

inlinevirtualinherited

Adds target to be notified about audio changes.

Reimplemented in CodecNOP, EncodedAudioOutput, EncodedAudioStream, AACDecoderFDK, DecoderBasic, CodecChain, MP3DecoderHelix, MP3DecoderMAD, OggContainerDecoder, RTSPClient< TcpClient, UdpSocket >, Pipeline, and Pipeline::ModifyingStreamAdapter.

addRequestHeader()

template<class T >

void addRequestHeader ( const char *  key, const char *  value  )

inlineoverridevirtual

Adds/Updates a request header.

Implements AbstractURLStream.

audioInfo()

virtual AudioInfo audioInfo ( )

inlineoverridevirtualinherited

provides the actual input AudioInfo

Implements AudioInfoSupport.

Reimplemented in JupyterAudioT< T >, MozziStream, TimerCallbackAudioStream, EncodedAudioStream, PureDataStream, AdapterAudioOutputToAudioStream, GeneratedSoundStream< T >, GeneratedSoundStream< int16_t >, and InputMerge< T >.

audioInfoOut()

virtual AudioInfo audioInfoOut ( )

inlinevirtualinherited

provides the actual output AudioInfo: this is usually the same as audioInfo() unless we use a transforming stream

Reimplemented in PureDataStream, PWMAudioOutput, ChannelFormatConverterStreamT< T >, ChannelFormatConverterStream, NumberFormatConverterStreamT< TFrom, TTo >, NumberFormatConverterStream, FormatConverterStream, Pipeline, ResampleStream, and ResampleStreamT< TInterpolator >.

available()

template<class T >

virtual int available ( )

inlinevirtual

Reimplemented from BaseStream.

availableForWrite()

int availableForWrite ( )

inlineoverridevirtualinherited

Writes are not supported.

Reimplemented from BaseStream.

Reimplemented in URLStreamESP32.

begin() [1/2]

virtual bool begin ( )

inlinevirtualinherited

Reimplemented in AudioOutputWithCallback, AudioMP34DT05, I2SCodecStream, MozziStream, PureDataStream, SPDIFOutput, VS1053Stream, WM8960Stream, AdaptiveResamplingStream, AudioLoRa, ESPNowStream, VBANStream, AudioEffectStreamT< T >, Equalizer3Bands, Equalizer3BandsPerChannel, I2SStream, AudioStreamWrapper, TimerCallbackAudioStream, FrequencyDetectorAutoCorrelation, GoertzelStream, ResampleStreamT< TInterpolator >, FileLoopT< FileType >, FileLoopT< File >, LoRaStream, EncodedAudioStream, AudioBoardStream, AudioFFTBase, AudioKitStream, MiniAudioStream, PortAudioStream, StdioStream, HLSStreamT< URLStream >, AnalogAudioArduino, AnalogAudioStream, AdapterAudioOutputToAudioStream, TimedStream, MemoryStream, GeneratedSoundStream< T >, GeneratedSoundStream< int16_t >, MeasuringStream, ProgressStream, Throttle, InputMerge< T >, CallbackStream, FilteredStream< T, TF >, FilteredStream< int16_t, int16_t >, VolumeMeter, AudioInputMonitor, ChannelFormatConverterStreamT< T >, ChannelFormatConverterStream, NumberFormatConverterStreamT< TFrom, TTo >, NumberFormatConverterStream, FormatConverterStream, CatStream, QueueStream< T >, QueueStream< uint8_t >, DynamicMemoryStream, Pipeline, Pipeline::ModifyingStreamAdapter, ResampleStream, VolumeStream, and EqualizerNBands< SampleT, AccT, NUM_TAPS, NUM_BANDS >.

begin() [2/2]

template<class T >

bool begin ( const char *  urlStr, const char *  acceptMime = nullptr, MethodID  action = GET, const char *  reqMime = "", const char *  reqData = ""  )

inlinevirtual

Implements AbstractURLStream.

clear()

template<class T >

void clear ( )

inline

Clears the buffer.

clearNotifyAudioChange()

virtual void clearNotifyAudioChange ( )

inlinevirtualinherited

Deletes all change notify subscriptions.

Reimplemented in RTSPClient< TcpClient, UdpSocket >.

contentLength()

template<class T >

int contentLength ( )

inlineoverridevirtual

Provides the reported data size from the http reply.

Implements AbstractURLStream.

end()

template<class T >

void end ( )

inlinevirtual

Implements AbstractURLStream.

flush()

template<class T >

virtual void flush ( )

inlinevirtual

Reimplemented from BaseStream.

getReplyHeader()

template<class T >

const char * getReplyHeader ( const char *  key )

inlineoverridevirtual

Provides reply header info.

Implements AbstractURLStream.

httpRequest()

template<class T >

HttpRequest & httpRequest ( )

inlinevirtual

provides access to the HttpRequest

Implements AbstractURLStream.

isNotifyActive()

bool isNotifyActive ( )

inlineinherited

Checks if the automatic AudioInfo update is active.

mime()

const char * mime ( )

inlineoverridevirtualinherited

Provides the MIME type for the current stream.

Implements MimeSource.

not_supported()

virtual int not_supported ( int  out, const char *  msg = ""  )

inlineprotectedvirtualinherited

notifyAudioChange()

void notifyAudioChange ( AudioInfo  info )

inlineprotectedinherited

operator bool()

virtual operator bool ( )

inlinevirtualinherited

Reimplemented in A2DPStream, ICYStreamT< T >, AudioBLEStream, AudioFFTBase, PortAudioStream, URLStream, I2SStream, AdapterAudioOutputToAudioStream, TimedStream, MemoryStream, GeneratedSoundStream< T >, GeneratedSoundStream< int16_t >, and Pipeline.

peek()

template<class T >

virtual int peek ( )

inlinevirtual

read()

template<class T >

virtual int read ( )

inlinevirtual

readBytes()

template<class T >

virtual size_t readBytes ( uint8_t *  data, size_t  len  )

inlinevirtual

Reimplemented from AudioStream.

readSilence()

virtual size_t readSilence ( uint8_t *  buffer, size_t  length  )

inlinevirtualinherited

Source to generate silence: just sets the buffer to 0.

refillReadBuffer()

void refillReadBuffer ( )

inlineprotectedinherited

removeNotifyAudioChange()

virtual bool removeNotifyAudioChange ( AudioInfoSupport &  bi )

inlinevirtualinherited

Removes a target in order not to be notified about audio changes.

Reimplemented in RTSPClient< TcpClient, UdpSocket >.

setAudioInfo()

virtual void setAudioInfo ( AudioInfo  info )

inlineoverridevirtualinherited

Defines the input AudioInfo.

Implements AudioInfoSupport.

Reimplemented in VS1053Stream, WM8960Stream, ChannelFormatConverterStreamT< T >, ChannelFormatConverterStream, VolumeStream, MiniAudioStream, PortAudioStream, I2SCodecStream, MozziStream, SPDIFOutput, AudioLoRa, AnalogAudioStream, I2SStream, TimerCallbackAudioStream, AudioBLEStream, LoRaStream, AudioFFTBase, AudioKitStream, VBANStream, AnalogAudioArduino, Equalizer3Bands, Equalizer3BandsPerChannel, AdapterAudioOutputToAudioStream, TimedStream, MeasuringStream, ProgressStream, CallbackStream, VolumeMeter, AudioInputMonitor, FormatConverterStream, FadeStream, GoertzelStream, Pipeline::ModifyingStreamAdapter, MDFEchoCancellationStream< Allocator >, EncodedAudioStream, PureDataStream, GeneratedSoundStream< T >, GeneratedSoundStream< int16_t >, NumberFormatConverterStreamT< TFrom, TTo >, NumberFormatConverterStream, Pipeline, ResampleStream, and ResampleStreamT< TInterpolator >.

setBufferSize()

template<class T >

void setBufferSize ( int  bufferSize, int  bufferCount  )

inline

Defines the buffer that holds the with encoded data.

setCACert()

template<class T >

void setCACert ( const char *  cert )

inlinevirtual

Define the Root PEM Certificate for SSL.

Implements AbstractURLStream.

setClient()

template<class T >

void setClient ( Client &  client )

inlineoverridevirtual

(Re-)defines the client

Implements AbstractURLStream.

setConnectionClose()

template<class T >

void setConnectionClose ( bool  flag )

inlineoverridevirtual

Add Connection: close to request header.

Implements AbstractURLStream.

setMetadataCallback()

virtual bool setMetadataCallback ( void(*)(MetaDataType info, const char *str, int len)  fn )

inlinevirtualinherited

Reimplemented in ICYStreamBuffered, and ICYStreamT< T >.

setNotifyActive()

void setNotifyActive ( bool  flag )

inlineinherited

Deactivate/Reactivate automatic AudioInfo updates: (default is active)

setPassword()

template<class T >

void setPassword ( const char *  password )

inlineoverridevirtual

Sets the password that will be used for logging in (when calling begin)

Implements AbstractURLStream.

setPowerSave()

template<class T >

void setPowerSave ( bool  ps )

inlineoverridevirtual

ESP32 only: PowerSave off (= default setting) is much faster.

Implements AbstractURLStream.

setSSID()

template<class T >

void setSSID ( const char *  ssid )

inlineoverridevirtual

Sets the ssid that will be used for logging in (when calling begin)

Implements AbstractURLStream.

setWriteBufferSize()

void setWriteBufferSize ( int  size )

inlineinherited

totalRead()

template<class T >

size_t totalRead ( )

inlineoverridevirtual

Total amout of data that was consumed so far.

Implements AbstractURLStream.

urlStr()

template<class T >

const char * urlStr ( )

inlineoverridevirtual

Provides the url as string.

Implements AbstractURLStream.

waitForData()

template<class T >

bool waitForData ( int  timeout )

inlineoverridevirtual

Waits the indicated time for the data to be available waits for some data - returns false if the request has failed

Implements AbstractURLStream.

write() [1/2]

virtual size_t write ( const uint8_t *  data, size_t  len  )

inlineoverridevirtualinherited

Implements BaseStream.

Reimplemented in URLStream, LMSEchoCancellationStream< T >, MDFEchoCancellationStream< Allocator >, AudioBLEServer, ESP3288AudioOutput, I2SCodecStream, MozziStream, PureDataStream, SPDIFOutput, AudioLoRa, I2SStream, AudioStreamWrapper, ConverterStream< T >, LoRaStream, EncodedAudioStream, FaustStream< DSP >, AudioFFTBase, AudioKitStream, MiniAudioStream, PortAudioStream, TfLiteAudioStream, VS1053Stream, A2DPStream, AdaptiveResamplingStream, BufferedTaskStream, URLStreamESP32, VBANStream, AnalogAudioArduino, AnalogAudioStream, AudioEffectStreamT< T >, Equalizer3Bands, Equalizer3BandsPerChannel, AdapterAudioOutputToAudioStream, TimedStream, MemoryStream, RingBufferStream, BufferedStream, MeasuringStream, ProgressStream, Throttle, CallbackStream, FilteredStream< T, TF >, FilteredStream< int16_t, int16_t >, VolumeMeter, AudioInputMonitor, ChannelFormatConverterStreamT< T >, ChannelFormatConverterStream, NumberFormatConverterStreamT< TFrom, TTo >, NumberFormatConverterStream, FormatConverterStream, FadeStream, FrequencyDetectorAutoCorrelation, FrequencyDetectorZeroCrossing, GoertzelStream, Pipeline, Pipeline::ModifyingStreamAdapter, ResampleStream, ResampleStreamT< TInterpolator >, VolumeStream, AudioBLEClient, AudioBLEClient, AudioBLEServer, EqualizerNBands< SampleT, AccT, NUM_TAPS, NUM_BANDS >, TfLiteAudioStreamBase, WM8960Stream, AnalogDriverESP32V1::IO16Bit, and AnalogDriverESP32V2::IO16Bit.

write() [2/2]

virtual size_t write ( uint8_t  ch )

inlineoverridevirtualinherited

Reimplemented in MemoryStream, AudioStreamWrapper, BufferedTaskStream, RingBufferStream, BufferedStream, and URLStream.

writeSilence()

virtual void writeSilence ( size_t  len )

inlinevirtualinherited

Writes len bytes of silence (=0).

Member Data Documentation

_timeout

int _timeout = 10

protectedinherited

info

AudioInfo info

protectedinherited

is_notify_active

bool is_notify_active = true

protectedinherited

notify_vector

Vector<AudioInfoSupport*> notify_vector

protectedinherited

taskStream

template<class T >

BufferedTaskStream taskStream

protected

tmp_in

RingBuffer<uint8_t> tmp_in {0}

protectedinherited

tmp_out

RingBuffer<uint8_t> tmp_out {0}

protectedinherited

urlStream

template<class T >

T urlStream

protected

write_buffer_size

int write_buffer_size = MAX_SINGLE_CHARS

protectedinherited

---

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

• src/AudioTools/Communication/HTTP/URLStreamBufferedT.h