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

#include <AudioCodecsBase.h>

Inheritance diagram for AudioEncoderExt:
AudioEncoder AudioWriter AudioInfoSupport ADPCMEncoder

Public Member Functions

AudioInfo audioInfo () override
 provides the actual input AudioInfo
 
virtual AudioInfo audioInfoOut ()
 
virtual bool begin ()=0
 
virtual bool begin (AudioInfo info)
 
virtual int blockSize ()=0
 
virtual void end ()=0
 
virtual uint32_t frameDurationUs ()
 Optional rtsp function: provide the frame duration in microseconds.
 
virtual const charmime ()=0
 Provides the mime type of the encoded result.
 
virtual operator bool ()=0
 
virtual uint16_t samplesPerFrame ()
 Optional rtsp function: provide samples per the frame.
 
void setAudioInfo (AudioInfo from) override
 Defines the sample rate, number of channels and bits per sample.
 
virtual void setOutput (Print &out_stream) override
 Default output assignment (encoders may override to store Print reference)
 
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)
 

Protected Attributes

AudioInfo info
 

Member Function Documentation

◆ audioInfo()

AudioInfo audioInfo ( )
inlineoverridevirtualinherited

provides the actual input AudioInfo

Implements AudioInfoSupport.

Reimplemented in CodecNOP, BinaryContainerEncoder, and MP3ParserEncoder.

◆ audioInfoOut()

virtual AudioInfo audioInfoOut ( )
inlinevirtualinherited

◆ begin() [1/2]

virtual bool begin ( )
pure virtualinherited

◆ begin() [2/2]

virtual bool begin ( AudioInfo  info)
inlinevirtualinherited

◆ blockSize()

virtual int blockSize ( )
pure virtual

Implemented in ADPCMEncoder.

◆ end()

virtual void end ( )
pure virtualinherited

◆ frameDurationUs()

virtual uint32_t frameDurationUs ( )
inlinevirtualinherited

Optional rtsp function: provide the frame duration in microseconds.

Reimplemented in ADPCMEncoder, OpusOggEncoder, MP3ParserEncoder, and MetaDataFilterEncoder.

◆ mime()

virtual const char * mime ( )
pure virtualinherited

◆ operator bool()

virtual operator bool ( )
pure virtualinherited

◆ samplesPerFrame()

virtual uint16_t samplesPerFrame ( )
inlinevirtualinherited

Optional rtsp function: provide samples per the frame.

Reimplemented in MP3ParserEncoder, and MetaDataFilterEncoder.

◆ setAudioInfo()

void setAudioInfo ( AudioInfo  from)
inlineoverridevirtualinherited

◆ setOutput()

virtual void setOutput ( Print out_stream)
inlineoverridevirtualinherited

◆ write()

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

◆ writeBlocking()

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

Member Data Documentation

◆ info

AudioInfo info
protectedinherited

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