AudioWriter Class Reference

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

#include <AudioTypes.h>

Inheritance diagram for AudioWriter:

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

provides the actual input AudioInfo

Implemented in CodecNOP, JupyterAudioT< T >, MozziStream, AdapterPrintToAudioOutput, TimerCallbackAudioStream, GGWaveDecoder, AudioDecoder, AudioEncoder, AACDecoderFDK, AACDecoderHelix, DecoderBasic, MP3DecoderHelix, MP3DecoderMAD, OpusAudioDecoder, WAVDecoder, WavIMADecoder, BinaryContainerEncoder, OggContainerDecoder, PureDataStream, AdapterAudioStreamToAudioOutput, AdapterAudioOutputToAudioStream, AudioOutput, AudioPlayer, GeneratedSoundStream< T >, GeneratedSoundStream< int16_t >, InputMerge< T >, and AudioStream.

audioInfoOut()

virtual AudioInfo audioInfoOut ( )

inlinevirtualinherited

provides the actual output AudioInfo: this is usually the same as audioInfo() unless we use a transforming stream

Reimplemented in PureDataStream, PWMAudioOutput, ChannelFormatConverterStreamT< T >, ChannelFormatConverterStream, NumberFormatConverterStreamT< TFrom, TTo >, NumberFormatConverterStream, FormatConverterStream, Pipeline, and ResampleStream.

begin() [1/2]

virtual bool begin ( )

pure virtual

Implemented in AACDecoderFAAD, MP3DecoderMini, SBCEncoder, AACDecoderHelix, EncoderBase64, EncoderBasic, FLACEncoder, EncoderFloat, EncoderL16, EncoderL8, MP3DecoderHelix, MP3DecoderMAD, MTSDecoder, OpusAudioEncoder, WAVEncoder, ContainerMP4, OggContainerEncoder, and MultiDecoder.

begin() [2/2]

virtual bool begin ( AudioInfo  info )

inlinevirtual

Reimplemented in AACEncoderFDK.

end()

virtual void end ( )

pure virtual

Implemented in AACDecoderFAAD, MP3DecoderMini, SBCEncoder, AACDecoderHelix, EncoderBase64, EncoderBasic, FLACEncoder, EncoderFloat, EncoderL16, EncoderL8, MP3DecoderHelix, MP3DecoderMAD, MTSDecoder, OpusAudioEncoder, WAVEncoder, ContainerMP4, OggContainerEncoder, and MultiDecoder.

operator bool()

virtual operator bool ( )

pure virtual

Implemented in AACDecoderFAAD, MP3DecoderMini, AACDecoderHelix, ADTSDecoder, MP3DecoderHelix, and MP3DecoderMAD.

setAudioInfo()

virtual void setAudioInfo ( AudioInfo  info )

pure virtual

Defines the input AudioInfo.

Implements AudioInfoSupport.

Implemented in GGWaveDecoder, AMRNBDecoder, AMRNBEncoder, AMRWBDecoder, AMRWBEncoder, MP3EncoderLAME, AudioDecoder, AudioEncoder, AACEncoderFDK, EncoderBasic, FLACEncoder, DecoderL8, OpusAudioDecoder, OpusAudioEncoder, WAVEncoder, CodecNOP, APTXEncoder, G7xxEncoder, AACDecoderHelix, G7xxDecoder, BinaryContainerEncoder, OggContainerEncoder, and OSCContainerEncoder.

setOutput()

virtual void setOutput ( Print &  out_stream )

pure virtual

Implemented in DecoderBase64, EncoderBasic, MP3DecoderMAD, WAVEncoder, DecoderAdapter, EncoderBase64, CodecNOP, ADPCMDecoderXQ, APTXDecoder, Codec2Decoder, CopyDecoder, G722Decoder, GSMDecoder, ILBCDecoder, LC3Decoder, MP3EncoderLAME, DecoderNetworkFormat, SBCDecoder, WavIMADecoder, GGWaveDecoder, AudioDecoder, AACDecoderFDK, AACEncoderFDK, AACDecoderHelix, ADPCMDecoder, ADTSDecoder, DecoderBasic, FLACEncoder, DecoderFloat, EncoderFloat, G7xxDecoder, DecoderL16, EncoderL16, EncoderL8, MTSDecoder, OpusAudioDecoder, OpusAudioEncoder, MTSDecoderTSDemux, WAVDecoder, AVIDecoder, MultiDecoder, MetaDataFilterDecoder, MP3DecoderMini, BinaryContainerDecoder, OSCContainerDecoder, MP3DecoderHelix, OggContainerDecoder, and OggContainerEncoder.

write()

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

pure virtual

Implemented in AACDecoderFAAD, MP3DecoderMini, BinaryContainerEncoder, OSCContainerEncoder, AACDecoderHelix, ADTSDecoder, EncoderBase64, FLACEncoder, DecoderFloat, EncoderFloat, EncoderL16, EncoderL8, MP3DecoderHelix, MP3DecoderMAD, OpusAudioEncoder, WAVEncoder, ContainerMP4, OggContainerEncoder, and EncoderBasic.

---

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

• src/AudioTools/CoreAudio/AudioTypes.h