AdapterAudioStreamToAudioOutput Class Reference

Wrapper which converts a AudioStream to a AudioOutput. More...

#include <AudioIO.h>

Inheritance diagram for AdapterAudioStreamToAudioOutput:

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

Protected Member Functions
void	notifyAudioChange (AudioInfo info)

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

Detailed Description

Wrapper which converts a AudioStream to a AudioOutput.

Constructor & Destructor Documentation

AdapterAudioStreamToAudioOutput() [1/2]

AdapterAudioStreamToAudioOutput ( )

default

AdapterAudioStreamToAudioOutput() [2/2]

AdapterAudioStreamToAudioOutput ( AudioStream &  stream )

inline

Member Function Documentation

addNotifyAudioChange()

virtual void addNotifyAudioChange ( AudioInfoSupport &  bi )

inlinevirtualinherited

Adds target to be notified about audio changes.

Reimplemented in CodecNOP, EncodedAudioOutput, EncodedAudioStream, AACDecoderFDK, DecoderBasic, CodecChain, MP3DecoderHelix, MP3DecoderMAD, OggContainerDecoder, RTSPClient< TcpClient, UdpSocket >, Pipeline, and Pipeline::ModifyingStreamAdapter.

audioInfo()

AudioInfo audioInfo ( )

inlineoverridevirtual

provides the actual input AudioInfo

Reimplemented from AudioOutput.

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, ResampleStream, and ResampleStreamT< TInterpolator >.

availableForWrite()

int availableForWrite ( )

inlineoverridevirtual

Reimplemented from AudioOutput.

begin() [1/2]

bool begin ( )

inlineoverridevirtual

Reimplemented from AudioOutput.

begin() [2/2]

virtual bool begin ( AudioInfo  info )

inlinevirtualinherited

Reimplemented in AudioESP32ULP, RTSPOutput< Platform >, RTTTLOutput< T >, ChannelsSelectOutput, CsvOutput< T >, and EncodedAudioOutput.

clearNotifyAudioChange()

virtual void clearNotifyAudioChange ( )

inlinevirtualinherited

Deletes all change notify subscriptions.

Reimplemented in RTSPClient< TcpClient, UdpSocket >.

end()

void end ( )

inlineoverridevirtual

Reimplemented from AudioOutput.

flush()

virtual void flush ( )

inlinevirtualinherited

Reimplemented from Print.

Reimplemented in MultiOutput, and HexDumpOutput.

isDeletable()

virtual bool isDeletable ( )

inlineoverridevirtual

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

Reimplemented from AudioOutput.

isNotifyActive()

bool isNotifyActive ( )

inlineinherited

Checks if the automatic AudioInfo update is active.

notifyAudioChange()

void notifyAudioChange ( AudioInfo  info )

inlineprotectedinherited

operator bool()

operator bool ( )

inlineoverridevirtual

Reimplemented from AudioOutput.

removeNotifyAudioChange()

virtual bool removeNotifyAudioChange ( AudioInfoSupport &  bi )

inlinevirtualinherited

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

Reimplemented in RTSPClient< TcpClient, UdpSocket >.

setAudioInfo()

void setAudioInfo ( AudioInfo  info )

inlineoverridevirtual

Defines the input AudioInfo.

Reimplemented from AudioOutput.

setNotifyActive()

void setNotifyActive ( bool  flag )

inlineinherited

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

setStream()

void setStream ( AudioStream &  stream )

inline

write() [1/2]

size_t write ( const uint8_t *  data, size_t  len  )

inlineoverridevirtual

Implements AudioOutput.

write() [2/2]

virtual size_t write ( uint8_t  ch )

inlineoverridevirtualinherited

Reimplemented in MetaDataOutput, and MultiOutput.

writeSilence()

virtual void writeSilence ( size_t  len )

inlinevirtualinherited

Writes n 0 values (= silence)

Parameters

len

Member Data Documentation

_timeout

int _timeout = 10

protectedinherited

cfg

AudioInfo cfg

protectedinherited

is_active

bool is_active = false

protectedinherited

is_notify_active

bool is_notify_active = true

protectedinherited

notify_vector

Vector<AudioInfoSupport*> notify_vector

protectedinherited

p_stream

AudioStream* p_stream = nullptr

protected

tmp

SingleBuffer<uint8_t> tmp {MAX_SINGLE_CHARS}

protectedinherited

tmpPos

int tmpPos = 0

protectedinherited

---

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

• src/AudioTools/CoreAudio/AudioIO.h