arduino-audio-tools
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
TransformationReader< T > Class Template Reference

ConverterStream Helper class which implements the readBytes with the help of write. More...

#include <AudioIO.h>

Public Member Functions

void begin (T *transform, Stream *source)
 setup of the TransformationReader class More...
 
void end ()
 
size_t readBytes (uint8_t *data, size_t len)
 
void resizeReadBuffer (int size)
 Defines the read buffer size for individual reads.
 
void resizeResultQueue (int size)
 Defines the queue size for result.
 
void setResultQueueFactor (int factor)
 Defines the queue size dependent on the read size.
 

Protected Member Functions

void restoreOutput (Print *out)
 restores the original output in the converter class More...
 
PrintsetupOutput ()
 

Protected Attributes

bool active = false
 
Vector< uint8_t > buffer {0}
 
Streamp_stream = nullptr
 
T * p_transform = nullptr
 
QueueStream< uint8_t > result_queue {result_queue_buffer}
 
RingBuffer< uint8_t > result_queue_buffer {0}
 
int result_queue_factor = 5
 

Detailed Description

template<class T>
class audio_tools::TransformationReader< T >

ConverterStream Helper class which implements the readBytes with the help of write.

Author
Phil Schatzmann
Template Parameters
Tclass name of the original transformer stream

Member Function Documentation

◆ begin()

void begin ( T *  transform,
Stream source 
)
inline

setup of the TransformationReader class

Parameters
transformThe original transformer stream
sourceThe data source of the data to be converted the requested converted bytes

◆ restoreOutput()

void restoreOutput ( Print out)
inlineprotected

restores the original output in the converter class

Parameters
out

◆ setupOutput()

Print* setupOutput ( )
inlineprotected

Makes sure that the data is written to the array

Parameters
data
Returns
original output of the converter class

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