BufferedTaskStream Class Reference

A FreeRTOS task is filling the buffer from the indicated stream. Only to be used on the ESP32. More...

#include <URLStreamBuffered.h>

Inheritance diagram for BufferedTaskStream:

Public Member Functions
	BufferedTaskStream (AudioStream &input)
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
	Returns the available bytes in the buffer: to be avoided.
virtual int	availableForWrite () override
virtual bool	begin ()
virtual void	begin (bool wait=true)
virtual void	clearNotifyAudioChange ()
	Deletes all change notify subscriptions.
virtual void	end ()
virtual void	flush () override
	empties the buffer
bool	isNotifyActive ()
	Checks if the automatic AudioInfo update is active.
virtual	operator bool ()
virtual int	peek () override
	peeks a byte - to be avoided
virtual int	read () override
	reads a byte - to be avoided
virtual size_t	readBytes (uint8_t *data, size_t len) override
	Use this method !!
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)
	Define an explicit the buffer size in bytes.
virtual void	setInput (AudioStream &input)
void	setNotifyActive (bool flag)
	Deactivate/Reactivate automatic AudioInfo updates: (default is active)
virtual size_t	write (const uint8_t *data, size_t len) override
	Use this method: write an array.
virtual size_t	write (uint8_t c) override
	writes a byte to the buffer
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	processTask ()
void	refillReadBuffer ()

Protected Attributes
int	_timeout = 10
bool	active = false
SynchronizedNBuffer< uint8_t >	buffers
AudioInfo	info
bool	is_notify_active = true
Vector< AudioInfoSupport * >	notify_vector
AudioStream *	p_stream = nullptr
bool	ready = false
Task	task
RingBuffer< uint8_t >	tmp_in {0}
RingBuffer< uint8_t >	tmp_out {0}

Detailed Description

A FreeRTOS task is filling the buffer from the indicated stream. Only to be used on the ESP32.

Author

Phil Schatzmann

Copyright

GPLv3

Member Data Documentation

buffers

SynchronizedNBuffer<uint8_t> buffers

protected

Initial value:

{DEFAULT_BUFFER_SIZE,
                                        10 }

task

Task task

protected

Initial value:

{"BufferedTaskStream",  30000 ,  2 ,
             0 }

---

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

• src/AudioTools/CoreAudio/AudioHttp/URLStreamBuffered.h