AudioOutput Class Reference

Abstract Audio Ouptut class. More...

#include <AudioOutput.h>

Inheritance diagram for AudioOutput:

Public Member Functions
virtual	~AudioOutput ()=default
virtual void	addNotifyAudioChange (AudioInfoSupport &bi)
	Adds target to be notified about audio changes.
virtual void	addNotifyAudioChange (AudioInfoSupport &bi)
	Adds target to be notified about audio changes.
virtual AudioInfo	audioInfo () override
	provides the actual input AudioInfo
virtual AudioInfo	audioInfoOut ()
virtual AudioInfo	audioInfoOut ()
virtual int	availableForWrite () override
virtual bool	begin ()
virtual bool	begin (AudioInfo info)
virtual void	clearNotifyAudioChange ()
	Deletes all change notify subscriptions.
virtual void	clearNotifyAudioChange ()
	Deletes all change notify subscriptions.
virtual void	end ()
virtual void	flush ()
virtual bool	isDeletable ()
	If true we need to release the related memory in the destructor.
bool	isNotifyActive ()
	Checks if the automatic AudioInfo update is active.
bool	isNotifyActive ()
	Checks if the automatic AudioInfo update is active.
virtual	operator bool ()
virtual bool	removeNotifyAudioChange (AudioInfoSupport &bi)
	Removes a target in order not to be notified about audio changes.
virtual bool	removeNotifyAudioChange (AudioInfoSupport &bi)
	Removes a target in order not to be notified about audio changes.
virtual void	setAudioInfo (AudioInfo info)=0
	Defines the input AudioInfo.
virtual void	setAudioInfo (AudioInfo newInfo) override
void	setNotifyActive (bool flag)
	Deactivate/Reactivate automatic AudioInfo updates: (default is active).
void	setNotifyActive (bool flag)
	Deactivate/Reactivate automatic AudioInfo updates: (default is active).
virtual size_t	write (const uint8_t *data, size_t len) override=0
virtual size_t	write (uint8_t ch) override
virtual void	writeSilence (size_t len)

Protected Member Functions
void	notifyAudioChange (AudioInfo info)
void	notifyAudioChange (AudioInfo info)

Protected Attributes
int	_timeout = 10
AudioInfo	cfg
bool	is_active = false
bool	is_notify_active = true
Vector< AudioInfoSupport * >	notify_vector
SingleBuffer< uint8_t >	tmp {MAX_SINGLE_CHARS}
int	tmpPos = 0

Detailed Description

Abstract Audio Ouptut class.

Author

Phil Schatzmann

Copyright

GPLv3

Constructor & Destructor Documentation

~AudioOutput()

virtual ~AudioOutput ( )

virtualdefault

Member Function Documentation

addNotifyAudioChange() [1/2]

virtual void addNotifyAudioChange ( AudioInfoSupport & bi )

inlinevirtualinherited

Adds target to be notified about audio changes.

Reimplemented in CodecNOP, CodecNOP, EncodedAudioOutput, and EncodedAudioStream.

addNotifyAudioChange() [2/2]

virtual void addNotifyAudioChange ( AudioInfoSupport & bi )

inlinevirtualinherited

Adds target to be notified about audio changes.

Reimplemented in CodecNOP, CodecNOP, EncodedAudioOutput, and EncodedAudioStream.

audioInfo()

virtual AudioInfo audioInfo ( )

inlineoverridevirtual

provides the actual input AudioInfo

Implements AudioInfoSupport.

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.

availableForWrite()

virtual int availableForWrite ( )

inlineoverridevirtual

Reimplemented from Print.

begin() [1/2]

virtual bool begin ( )

inlinevirtual

Reimplemented in AudioOutputWithCallback.

begin() [2/2]

virtual bool begin ( AudioInfo info )

inlinevirtual

clearNotifyAudioChange() [1/2]

virtual void clearNotifyAudioChange ( )

inlinevirtualinherited

Deletes all change notify subscriptions.

Reimplemented in RTSPClient< TcpClient, UdpSocket >, RTSPClient< EthernetClient, EthernetUDP >, and RTSPClient< WiFiClient, WiFiUDP >.

clearNotifyAudioChange() [2/2]

virtual void clearNotifyAudioChange ( )

inlinevirtualinherited

Deletes all change notify subscriptions.

Reimplemented in RTSPClient< TcpClient, UdpSocket >, RTSPClient< EthernetClient, EthernetUDP >, and RTSPClient< WiFiClient, WiFiUDP >.

end()

virtual void end ( )

inlinevirtual

flush()

virtual void flush ( )

inlinevirtual

Reimplemented from Print.

isDeletable()

virtual bool isDeletable ( )

inlinevirtual

If true we need to release the related memory in the destructor.

isNotifyActive() [1/2]

bool isNotifyActive ( )

inlineinherited

Checks if the automatic AudioInfo update is active.

isNotifyActive() [2/2]

bool isNotifyActive ( )

inlineinherited

Checks if the automatic AudioInfo update is active.

notifyAudioChange() [1/2]

void notifyAudioChange ( AudioInfo info )

inlineprotectedinherited

notifyAudioChange() [2/2]

void notifyAudioChange ( AudioInfo info )

inlineprotectedinherited

operator bool()

virtual operator bool ( )

inlinevirtual

removeNotifyAudioChange() [1/2]

virtual bool removeNotifyAudioChange ( AudioInfoSupport & bi )

inlinevirtualinherited

Removes a target in order not to be notified about audio changes.

removeNotifyAudioChange() [2/2]

virtual bool removeNotifyAudioChange ( AudioInfoSupport & bi )

inlinevirtualinherited

Removes a target in order not to be notified about audio changes.

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 newInfo )

inlineoverridevirtual

setNotifyActive() [1/2]

void setNotifyActive ( bool flag )

inlineinherited

Deactivate/Reactivate automatic AudioInfo updates: (default is active).

setNotifyActive() [2/2]

void setNotifyActive ( bool flag )

inlineinherited

Deactivate/Reactivate automatic AudioInfo updates: (default is active).

write() [1/2]

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

overridepure virtual

Reimplemented from Print.

write() [2/2]

virtual size_t write ( uint8_t ch )

inlineoverridevirtual

writeSilence()

virtual void writeSilence ( size_t len )

inlinevirtual

Writes n 0 values (= silence)

Parameters

len

Member Data Documentation

_timeout

int _timeout = 10

protectedinherited

cfg

AudioInfo cfg

protected

is_active

bool is_active = false

protected

is_notify_active

bool is_notify_active = true

protectedinherited

notify_vector

Vector< AudioInfoSupport * > notify_vector

protectedinherited

tmp

SingleBuffer<uint8_t> tmp {MAX_SINGLE_CHARS}

protected

tmpPos

int tmpPos = 0

protected

---

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

• src/AudioTools/CoreAudio/AudioOutput.h