ObjectStream Class Reference

A Arduino Stream which makes sure that we read back the same size as we wrote. It adds a size prefix to the data stream. More...

#include <ObjectStream.h>

Inheritance diagram for ObjectStream:

Public Member Functions
virtual bool	begin ()
virtual void	end ()
virtual void	flush () override
	operator bool ()

Protected Member Functions
void	refillReadBuffer ()

Protected Attributes
int	_timeout = 10
bool	is_complete = true
int	max_object_size = 0
int	n_open_read = -1
Stream *	p_in = nullptr
Print *	p_out = nullptr
RingBuffer< uint8_t >	tmp_in {0}
RingBuffer< uint8_t >	tmp_out {0}

Detailed Description

A Arduino Stream which makes sure that we read back the same size as we wrote. It adds a size prefix to the data stream.

Author

Phil Schatzmann

Member Function Documentation

begin()

virtual bool begin ( )

inlinevirtualinherited

Reimplemented in AudioOutputWithCallback, SPDIFOutput, VS1053Stream, WM8960Stream, ESPNowStream, TimerCallbackAudioStream, FrequencyDetectorAutoCorrelation, AudioFFTBase, HLSStreamT< URLStream >, AnalogAudioArduino, AnalogAudioStream, MemoryStream, GeneratedSoundStream< T >, GeneratedSoundStream< int16_t >, FormatConverterStream, QueueStream< T >, QueueStream< uint8_t >, DynamicMemoryStream, and Pipeline.

end()

virtual void end ( )

inlinevirtualinherited

Reimplemented in FaustStream< DSP >, I2SCodecStream, VS1053Stream, WM8960Stream, ESPNowStream, I2SStream, TimerCallbackAudioStream, AudioFFTBase, AudioKitStream, HLSStreamT< URLStream >, AnalogAudioStream, HttpRequest, ICYStreamT< T >, GeneratedSoundStream< T >, GeneratedSoundStream< int16_t >, InputMixer< T >, InputMerge< T >, QueueStream< T >, QueueStream< uint8_t >, and Pipeline.

flush()

virtual void flush ( )

inlineoverridevirtualinherited

Reimplemented from Print.

Reimplemented in ResampleStream, BufferedTaskStream, and BufferedStream.

---

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

• src/AudioTools/Communication/ObjectStream.h