MultiOutput Class Reference

Replicates the output to multiple destinations. More...

#include <AudioIO.h>

Inheritance diagram for MultiOutput:

Public Member Functions
	MultiOutput ()=default
	Defines a MultiOutput with no final output: Define your outputs with add()
	MultiOutput (AudioOutput &out)
	Defines a MultiOutput with a single final outputs,.
	MultiOutput (AudioOutput &out1, AudioOutput &out2)
	Defines a MultiOutput with 2 final outputs.
	MultiOutput (AudioStream &out)
	MultiOutput (AudioStream &out1, AudioStream &out2)
	Defines a MultiOutput with 2 final outputs.
	MultiOutput (Print &out)
	MultiOutput (Print &out1, Print &out2)
void	add (AudioOutput &out)
	Add an additional AudioOutput output.
void	add (AudioStream &stream)
	Add an AudioStream to the output.
void	add (Print &print)
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 int	availableForWrite () override
virtual bool	begin ()
virtual bool	begin (AudioInfo info)
virtual void	clearNotifyAudioChange ()
	Deletes all change notify subscriptions.
virtual void	end ()
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.
virtual	operator bool ()
virtual bool	removeNotifyAudioChange (AudioInfoSupport &bi)
	Removes a target in order not to be notified about audio changes.
void	setAudioInfo (AudioInfo info)
	Defines the input AudioInfo.
void	setNotifyActive (bool flag)
	Deactivate/Reactivate automatic AudioInfo updates: (default is active)
size_t	write (const uint8_t *data, size_t len)
size_t	write (uint8_t ch)
virtual void	writeSilence (size_t len)

Protected Member Functions
void	notifyAudioChange (AudioInfo info)
void	setOutput (Print &out)
	support for Pipleline

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
Vector< AudioOutput * >	vector

Detailed Description

Replicates the output to multiple destinations.

Author

Phil Schatzmann

Copyright

GPLv3

Constructor & Destructor Documentation

MultiOutput()

MultiOutput ( Print &  out1, Print &  out2  )

inline

Defines a MultiOutput with 2 final outputs: Warning no support for AudioInfo notifications. It is recommended to use individual add calls.

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, MP3DecoderHelix, MP3DecoderMAD, OggContainerDecoder, Pipeline, and Pipeline::ModifyingStreamAdapter.

audioInfo()

virtual AudioInfo audioInfo ( )

inlineoverridevirtualinherited

provides the actual input AudioInfo

Implements AudioInfoSupport.

Reimplemented in AdapterPrintToAudioOutput, and AdapterAudioStreamToAudioOutput.

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.

availableForWrite()

virtual int availableForWrite ( )

inlineoverridevirtualinherited

Reimplemented from Print.

Reimplemented in RTSPOutput.

begin() [1/2]

virtual bool begin ( )

inlinevirtualinherited

Reimplemented in AudioOutputWithCallback, EncodedAudioOutput, OggContainerOutput, MetaDataFilter, and CsvOutput< T >.

begin() [2/2]

virtual bool begin ( AudioInfo  info )

inlinevirtualinherited

Reimplemented in AudioESP32ULP, CsvOutput< T >, and EncodedAudioOutput.

end()

virtual void end ( )

inlinevirtualinherited

Reimplemented in EncodedAudioOutput, and OggContainerOutput.

flush()

void flush ( )

inlinevirtual

Reimplemented from AudioOutput.

isDeletable()

virtual bool isDeletable ( )

inlinevirtualinherited

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

Reimplemented in AdapterPrintToAudioOutput, and AdapterAudioStreamToAudioOutput.

operator bool()

virtual operator bool ( )

inlinevirtualinherited

Reimplemented in RTSPOutput, and EncodedAudioOutput.

setAudioInfo()

void setAudioInfo ( AudioInfo  info )

inlinevirtual

Defines the input AudioInfo.

Reimplemented from AudioOutput.

setOutput()

void setOutput ( Print &  out )

inlineprotectedvirtual

support for Pipleline

Implements ModifyingOutput.

write() [1/2]

size_t write ( const uint8_t *  data, size_t  len  )

inlinevirtual

Implements AudioOutput.

write() [2/2]

size_t write ( uint8_t  ch )

inlinevirtual

Reimplemented from AudioOutput.

writeSilence()

virtual void writeSilence ( size_t  len )

inlinevirtualinherited

Writes n 0 values (= silence)

Parameters

len

---

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

• src/AudioTools/CoreAudio/AudioIO.h