arduino-audio-tools
Loading...
Searching...
No Matches
Public Member Functions | Protected Member Functions | List of all members
audio_tools::StreamingDecoder Class Referenceabstract

A Streaming Decoder where we provide both the input and output as streams. More...

#include <AudioEncoded.h>

Inheritance diagram for audio_tools::StreamingDecoder:
audio_tools::FLACDecoder audio_tools::VorbisDecoder

Public Member Functions

virtual AudioBaseInfo audioInfo ()=0
 Provides the last available MP3FrameInfo. More...
 
virtual void begin ()=0
 Starts the processing. More...
 
virtual bool copy ()=0
 Process a single read operation - to be called in the loop. More...
 
virtual void end ()=0
 Releases the reserved memory. More...
 
virtual operator bool ()=0
 checks if the class is active More...
 
virtual void setInputStream (Stream &inStream)=0
 Defines the input data stream. More...
 
virtual void setNotifyAudioChange (AudioBaseInfoDependent &bi)=0
 Register Output Stream to be notified about changes. More...
 
virtual void setOutputStream (AudioPrint &out_stream)
 Defines the output streams and register to be notified.
 
virtual void setOutputStream (AudioStream &out_stream)
 Defines the output streams and register to be notified.
 
virtual void setOutputStream (Print &outStream)=0
 Defines the output Stream. More...
 

Protected Member Functions

virtual size_t readBytes (uint8_t *buffer, size_t len)=0
 

Detailed Description

A Streaming Decoder where we provide both the input and output as streams.

Author
Phil Schatzmann

Member Function Documentation

◆ audioInfo()

virtual AudioBaseInfo audio_tools::StreamingDecoder::audioInfo ( )
pure virtual

Provides the last available MP3FrameInfo.

Implemented in audio_tools::FLACDecoder, and audio_tools::VorbisDecoder.

◆ begin()

virtual void audio_tools::StreamingDecoder::begin ( )
pure virtual

Starts the processing.

Implemented in audio_tools::FLACDecoder, and audio_tools::VorbisDecoder.

◆ copy()

virtual bool audio_tools::StreamingDecoder::copy ( )
pure virtual

Process a single read operation - to be called in the loop.

Implemented in audio_tools::FLACDecoder, and audio_tools::VorbisDecoder.

◆ end()

virtual void audio_tools::StreamingDecoder::end ( )
pure virtual

Releases the reserved memory.

Implemented in audio_tools::FLACDecoder, and audio_tools::VorbisDecoder.

◆ operator bool()

virtual audio_tools::StreamingDecoder::operator bool ( )
pure virtual

checks if the class is active

Implemented in audio_tools::FLACDecoder, and audio_tools::VorbisDecoder.

◆ setInputStream()

virtual void audio_tools::StreamingDecoder::setInputStream ( Stream inStream)
pure virtual

Defines the input data stream.

Implemented in audio_tools::FLACDecoder, and audio_tools::VorbisDecoder.

◆ setNotifyAudioChange()

virtual void audio_tools::StreamingDecoder::setNotifyAudioChange ( AudioBaseInfoDependent bi)
pure virtual

Register Output Stream to be notified about changes.

Implemented in audio_tools::FLACDecoder, and audio_tools::VorbisDecoder.

◆ setOutputStream()

virtual void audio_tools::StreamingDecoder::setOutputStream ( Print outStream)
pure virtual

Defines the output Stream.

Implemented in audio_tools::FLACDecoder, and audio_tools::VorbisDecoder.


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