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

E.g. used by Encoders and Decoders. More...

#include <AudioTypes.h>

Inheritance diagram for AudioWriter:
Inheritance graph
[legend]
Collaboration diagram for AudioWriter:
Collaboration graph
[legend]

Public Member Functions

virtual AudioInfo audioInfo ()=0
 provides the actual input AudioInfo
 
virtual AudioInfo audioInfoOut ()
 
virtual bool begin ()=0
 
virtual bool begin (AudioInfo info)
 
virtual void end ()=0
 
virtual operator bool ()=0
 
virtual void setAudioInfo (AudioInfo from)=0
 Defines the input AudioInfo.
 
virtual void setOutput (Print &out_stream)=0
 
virtual size_t write (const uint8_t *data, size_t len)=0
 

Protected Member Functions

void writeBlocking (Print *out, uint8_t *data, size_t len)
 

Detailed Description

E.g. used by Encoders and Decoders.

Member Function Documentation

◆ audioInfo()

virtual AudioInfo audioInfo ( )
pure virtualinherited

◆ audioInfoOut()

virtual AudioInfo audioInfoOut ( )
inlinevirtualinherited

◆ begin() [1/2]

virtual bool begin ( )
pure virtual

◆ begin() [2/2]

virtual bool begin ( AudioInfo  info)
inlinevirtual

◆ end()

virtual void end ( )
pure virtual

◆ operator bool()

virtual operator bool ( )
pure virtual

◆ setAudioInfo()

virtual void setAudioInfo ( AudioInfo  info)
pure virtual

◆ setOutput()

virtual void setOutput ( Print &  out_stream)
pure virtual

◆ write()

virtual size_t write ( const uint8_t *  data,
size_t  len 
)
pure virtual

◆ writeBlocking()

void writeBlocking ( Print *  out,
uint8_t *  data,
size_t  len 
)
inlineprotected

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