arduino-audio-tools
Loading...
Searching...
No Matches
Public Member Functions | Protected Attributes | List of all members
audio_tools::ConvertedStream< T, ConverterT > Class Template Reference

Construct a new Converted Stream object. Both the data of the read and write operations will be converted with the help of the indicated converter. More...

#include <AudioStreams.h>

Inheritance diagram for audio_tools::ConvertedStream< T, ConverterT >:
audio_tools::AudioStreamX audio_tools::AudioStream audio_tools::Stream audio_tools::AudioBaseInfoDependent audio_tools::AudioBaseInfoSource audio_tools::Print

Public Member Functions

 ConvertedStream (Stream &stream, ConverterT &converter)
 
virtual int available () override
 Returns the available bytes in the buffer: to be avoided. More...
 
virtual int availableForWrite ()
 
size_t readBytes (uint8_t *data, size_t length) override
 
virtual size_t write (const uint8_t *buffer, size_t size)
 
- Public Member Functions inherited from audio_tools::AudioStreamX
 AudioStreamX (AudioStreamX const &)=delete
 
virtual int available () override
 
AudioStreamXoperator= (AudioStreamX const &)=delete
 
virtual int peek () override
 
virtual int read () override
 
virtual size_t readBytes (uint8_t *buffer, size_t length) override
 
virtual size_t write (const uint8_t *buffer, size_t size) override
 
virtual size_t write (uint8_t) override
 
- Public Member Functions inherited from audio_tools::AudioStream
 AudioStream (AudioStream const &)=delete
 
virtual AudioBaseInfo audioInfo () override
 
virtual int availableForWrite () override
 
virtual bool begin ()
 
virtual void end ()
 
virtual void flush () override
 
 operator bool ()
 
AudioStreamoperator= (AudioStream const &)=delete
 
virtual size_t readBytes (char *buffer, size_t length)
 
virtual size_t readBytes (uint8_t *buffer, size_t length) STREAM_WRITE_OVERRIDE=0
 
virtual void setAudioInfo (AudioBaseInfo info) override
 
virtual void setNotifyAudioChange (AudioBaseInfoDependent &bi) override
 
virtual StreamtoStreamPointer ()
 
virtual size_t write (const uint8_t *buffer, size_t size) override=0
 
- Public Member Functions inherited from audio_tools::Stream
virtual int available ()
 
virtual int peek ()
 
virtual int read ()
 
virtual size_t readBytes (uint8_t *buffer, size_t len)
 
virtual void setTimeout (size_t t)
 
- Public Member Functions inherited from audio_tools::Print
virtual int availableForWrite ()
 
virtual void flush ()
 
virtual int print (char c, PrintCharFmt spec)
 
virtual int print (const char *msg)
 
virtual int print (int number)
 
virtual int println (const char *msg="")
 
virtual size_t write (const char *buffer, size_t size)
 
virtual size_t write (const char *str)
 
virtual size_t write (const uint8_t *buffer, size_t size)
 
virtual size_t write (uint8_t ch)
 
- Public Member Functions inherited from audio_tools::AudioBaseInfoDependent
virtual AudioBaseInfo audioInfo ()=0
 
virtual void setAudioInfo (AudioBaseInfo info)=0
 
virtual bool validate (AudioBaseInfo &info)
 
virtual void setNotifyAudioChange (AudioBaseInfoDependent &bi)=0
 

Protected Attributes

ConverterT * p_converter
 
Streamp_stream
 
- Protected Attributes inherited from audio_tools::AudioStream
AudioBaseInfo info
 
AudioBaseInfoDependentp_notify =nullptr
 

Additional Inherited Members

- Protected Member Functions inherited from audio_tools::AudioStream
virtual int not_supported (int out)
 

Detailed Description

template<typename T, class ConverterT>
class audio_tools::ConvertedStream< T, ConverterT >

Construct a new Converted Stream object. Both the data of the read and write operations will be converted with the help of the indicated converter.

Template Parameters
T
Parameters
out
converter

Member Function Documentation

◆ available()

template<typename T , class ConverterT >
virtual int audio_tools::ConvertedStream< T, ConverterT >::available ( )
inlineoverridevirtual

Returns the available bytes in the buffer: to be avoided.

Reimplemented from audio_tools::AudioStreamX.

◆ availableForWrite()

template<typename T , class ConverterT >
virtual int audio_tools::ConvertedStream< T, ConverterT >::availableForWrite ( )
inlinevirtual

Reimplemented from audio_tools::AudioStream.

◆ readBytes()

template<typename T , class ConverterT >
size_t audio_tools::ConvertedStream< T, ConverterT >::readBytes ( uint8_t *  data,
size_t  length 
)
inlineoverridevirtual

Reimplemented from audio_tools::AudioStreamX.

◆ write()

template<typename T , class ConverterT >
virtual size_t audio_tools::ConvertedStream< T, ConverterT >::write ( const uint8_t *  buffer,
size_t  size 
)
inlinevirtual

Reimplemented from audio_tools::AudioStreamX.


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