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	audioInfo ()=0
	provides the actual input AudioInfo
virtual AudioInfo	audioInfoOut ()
virtual AudioInfo	audioInfoOut ()
virtual bool	begin ()=0
virtual bool	begin (AudioInfo info)
virtual void	end ()=0
virtual	operator bool ()=0
virtual void	setAudioInfo (AudioInfo info)=0
	Defines the input AudioInfo.
virtual void	setAudioInfo (AudioInfo from)=0
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() [1/2]

virtual AudioInfo audioInfo ( )

pure virtualinherited

provides the actual input AudioInfo

Implemented in AACDecoderFDK, AACDecoderHelix, AdapterAudioOutputToAudioStream, AdapterAudioStreamToAudioOutput, AdapterPrintToAudioOutput, AdaptiveResamplingBuffer, AdapterAudioOutputToAudioStream, AdapterAudioStreamToAudioOutput, AdapterPrintToAudioOutput, AudioDecoder, AudioDecoder, AudioEncoder, AudioEncoder, AudioOutput, AudioOutput, AudioStream, AudioStream, CodecNOP, CodecNOP, EncodedAudioOutput, EncodedAudioStream, GeneratedSoundStream< T >, GeneratedSoundStream< T >, GeneratedSoundStream< int16_t >, InputMerge< T >, InputMerge< T >, TimerCallbackAudioStream, TimerCallbackAudioStream, AudioDecoder, AudioEncoder, AudioOutput, AudioPlayer, AudioStream, BinaryContainerEncoder, CodecNOP, DecoderBasic, DSFDecoder, EncodedAudioOutput, EncodedAudioStream, FLACDecoder, GeneratedSoundStream< T >, InputMerge< T >, JupyterAudioT< T >, JupyterAudioT< int16_t >, MozziStream, MP3DecoderHelix, MP3DecoderMAD, MP3EncoderShine, MP3ParserEncoder, MultiStreamingDecoder, OggContainerDecoder, OpusAudioDecoder, OpusMultiStreamAudioDecoder, PureDataStream, RTSPClient< TcpClient, UdpSocket >, RTSPClient< EthernetClient, EthernetUDP >, RTSPClient< WiFiClient, WiFiUDP >, StreamingDecoder, StreamingDecoderAdapter, TimerCallbackAudioStream, VorbisDecoder, VorbisDecoder, WAVDecoder, and WavIMADecoder.

audioInfo() [2/2]

virtual AudioInfo audioInfo ( )

pure virtualinherited

provides the actual input AudioInfo

Implemented in AACDecoderFDK, AACDecoderHelix, AdapterAudioOutputToAudioStream, AdapterAudioStreamToAudioOutput, AdapterPrintToAudioOutput, AdaptiveResamplingBuffer, AdapterAudioOutputToAudioStream, AdapterAudioStreamToAudioOutput, AdapterPrintToAudioOutput, AudioDecoder, AudioDecoder, AudioEncoder, AudioEncoder, AudioOutput, AudioOutput, AudioStream, AudioStream, CodecNOP, CodecNOP, EncodedAudioOutput, EncodedAudioStream, GeneratedSoundStream< T >, GeneratedSoundStream< T >, GeneratedSoundStream< int16_t >, InputMerge< T >, InputMerge< T >, TimerCallbackAudioStream, TimerCallbackAudioStream, AudioDecoder, AudioEncoder, AudioOutput, AudioPlayer, AudioStream, BinaryContainerEncoder, CodecNOP, DecoderBasic, DSFDecoder, EncodedAudioOutput, EncodedAudioStream, FLACDecoder, GeneratedSoundStream< T >, InputMerge< T >, JupyterAudioT< T >, JupyterAudioT< int16_t >, MozziStream, MP3DecoderHelix, MP3DecoderMAD, MP3EncoderShine, MP3ParserEncoder, MultiStreamingDecoder, OggContainerDecoder, OpusAudioDecoder, OpusMultiStreamAudioDecoder, PureDataStream, RTSPClient< TcpClient, UdpSocket >, RTSPClient< EthernetClient, EthernetUDP >, RTSPClient< WiFiClient, WiFiUDP >, StreamingDecoder, StreamingDecoderAdapter, TimerCallbackAudioStream, VorbisDecoder, VorbisDecoder, WAVDecoder, and WavIMADecoder.

audioInfoOut() [1/2]

virtual AudioInfo audioInfoOut ( )

inlinevirtualinherited

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

Reimplemented in ChannelFormatConverterStream, ChannelFormatConverterStreamT< T >, FormatConverterStream, MP3EncoderShine, NumberFormatConverterStream, NumberFormatConverterStreamT< TFrom, TTo >, Pipeline, PureDataStream, PWMAudioOutput< PWMDriverT >, ResampleStream, ResampleStreamT< TInterpolator >, and SupportedRatesStream.

audioInfoOut() [2/2]

virtual AudioInfo audioInfoOut ( )

inlinevirtualinherited

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

Reimplemented in ChannelFormatConverterStream, ChannelFormatConverterStreamT< T >, FormatConverterStream, MP3EncoderShine, NumberFormatConverterStream, NumberFormatConverterStreamT< TFrom, TTo >, Pipeline, PureDataStream, PWMAudioOutput< PWMDriverT >, ResampleStream, ResampleStreamT< TInterpolator >, and SupportedRatesStream.

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() [1/2]

virtual void setAudioInfo ( AudioInfo info )

pure virtualinherited

Defines the input AudioInfo.

Implemented in AdapterAudioOutputToAudioStream, AdapterAudioStreamToAudioOutput, AdapterPrintToAudioOutput, AudioDecoder, AudioDecoder, AudioEncoder, AudioEncoder, AudioInputMonitor, AudioInputMonitor, AudioOutput, AudioOutput, AudioStream, AudioStream, AudioWriter, AudioWriter, CallbackStream, CallbackStream, ChannelsSelectOutput, CodecNOP, CodecNOP, CsvOutput< T >, CsvOutput< T >, EncodedAudioOutput, EncodedAudioStream, GeneratedSoundStream< T >, GeneratedSoundStream< T >, GeneratedSoundStream< int16_t >, MultiOutput, ProgressStream, ProgressStream, TimedStream, TimerCallbackAudioStream, TimerCallbackAudioStream, VolumeMeter, and VolumeMeter.

setAudioInfo() [2/2]

virtual void setAudioInfo ( AudioInfo from )

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:

• src/AudioTools/CoreAudio/AudioTypes.h