MultiOutput Class Reference

Replicates the output to multiple destinations. More...

#include <AudioIO.h>

Inheritance diagram for MultiOutput:

Classes
struct	MultiOutputRecord
	Record describing a single replicated output. More...

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)
virtual	~MultiOutput ()
void	add (AudioOutput &out)
	Add an additional AudioOutput output.
void	add (AudioStream &stream)
	Add an AudioStream to the output.
void	add (Client &client)
	Add a (network) Client as output: e.g. WiFiClient, EthernetClient...
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)
void	clear ()
void	clearInactive ()
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 ()
void	remove (Print &print)
	Removes the indicated output.
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) override
size_t	write (uint8_t ch) override
virtual void	writeSilence (size_t len)

Protected Types
enum class	Kind { PrintKind , ClientKind , AudioStreamKind , AudioOutputKind }

Protected Member Functions
bool	isActive (MultiOutputRecord &rec)
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< MultiOutputRecord >	vector

Detailed Description

Replicates the output to multiple destinations.

Author

Phil Schatzmann

Copyright

GPLv3

Member Enumeration Documentation

Kind

enum class Kind

strongprotected

Identifies the actual type behind the stored Print pointer so that clearInactive() can safely static_cast back to call operator bool()

Enumerator
PrintKind
ClientKind
AudioStreamKind
AudioOutputKind

Constructor & Destructor Documentation

MultiOutput() [1/7]

MultiOutput ( )

default

Defines a MultiOutput with no final output: Define your outputs with add()

MultiOutput() [2/7]

MultiOutput ( Print &  out )

inline

MultiOutput() [3/7]

MultiOutput ( AudioOutput &  out )

inline

Defines a MultiOutput with a single final outputs,.

MultiOutput() [4/7]

MultiOutput ( AudioStream &  out )

inline

MultiOutput() [5/7]

MultiOutput ( AudioOutput &  out1, AudioOutput &  out2  )

inline

Defines a MultiOutput with 2 final outputs.

MultiOutput() [6/7]

MultiOutput ( AudioStream &  out1, AudioStream &  out2  )

inline

Defines a MultiOutput with 2 final outputs.

MultiOutput() [7/7]

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.

~MultiOutput()

virtual ~MultiOutput ( )

inlinevirtual

Member Function Documentation

add() [1/4]

void add ( AudioOutput &  out )

inline

Add an additional AudioOutput output.

add() [2/4]

void add ( AudioStream &  stream )

inline

Add an AudioStream to the output.

add() [3/4]

void add ( Client &  client )

inline

Add a (network) Client as output: e.g. WiFiClient, EthernetClient...

add() [4/4]

void add ( Print &  print )

inline

Add a generic Print output: Warning no support for AudioInfo notifications. It is recommended to use one of the other add() methods.

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

virtual AudioInfo audioInfo ( )

inlineoverridevirtualinherited

provides the actual input AudioInfo

Implements AudioInfoSupport.

Reimplemented in AdapterPrintToAudioOutput, EncodedAudioOutput, 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 MP3EncoderShine, PureDataStream, PWMAudioOutput< PWMDriverT >, ChannelFormatConverterStreamT< T >, ChannelFormatConverterStream, NumberFormatConverterStreamT< TFrom, TTo >, NumberFormatConverterStream, FormatConverterStream, Pipeline, ResampleStream, and ResampleStreamT< TInterpolator >.

availableForWrite()

virtual int availableForWrite ( )

inlineoverridevirtualinherited

Reimplemented from Print.

Reimplemented in AudioESP32ULP, RTSPOutput< Platform >, SPIAudioMaster, EncodedAudioOutput, AudioServerEx, AudioSyncWriter, AdapterAudioStreamToAudioOutput, CsvOutput< T >, MemoryOutput, and PWMAudioOutput< PWMDriverT >.

begin() [1/2]

virtual bool begin ( )

inlinevirtualinherited

Reimplemented in OSCContainerEncoder::OSCOutput, AudioOutputWithCallback, AudioServerEx, RTSPOutput< Platform >, PitchShiftOutput< T, BufferT >, PWMAudioOutput< PWMDriverT >, RTTTLOutput< T >, EncodedAudioOutput, OggContainerOutput, R2ROutput, AdapterAudioStreamToAudioOutput, ChannelsSelectOutput, MetaDataFilter, CsvOutput< T >, HexDumpOutput, MemoryOutput, RTTTLOutput< T >, FFTEffect, FFTPitchShift, and FFTEqualizer.

begin() [2/2]

virtual bool begin ( AudioInfo  info )

inlinevirtualinherited

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

clear()

void clear ( )

inline

Removes all output components: the referenced Print/AudioOutput/ AudioStream/Client objects are never owned by MultiOutput, so no memory needs to be released here.

clearInactive()

void clearInactive ( )

inline

Removes all outputs which are no longer active. Client, AudioStream and AudioOutput provide an operator bool() which is used to determine if the output is still active; plain Print outputs cannot be checked and are always kept.

clearNotifyAudioChange()

virtual void clearNotifyAudioChange ( )

inlinevirtualinherited

Deletes all change notify subscriptions.

Reimplemented in RTSPClient< TcpClient, UdpSocket >.

end()

virtual void end ( )

inlinevirtualinherited

Reimplemented in AudioESP32ULP, AudioServerEx, AudioSyncWriter, RTSPOutput< Platform >, SPIAudioMaster, PitchShiftOutput< T, BufferT >, MetaDataOutput, EncodedAudioOutput, OpusOggWriter, OggContainerOutput, AdapterAudioStreamToAudioOutput, MetaDataFilter, and PWMAudioOutput< PWMDriverT >.

flush()

void flush ( )

inlinevirtual

Reimplemented from AudioOutput.

isActive()

bool isActive ( MultiOutputRecord &  rec )

inlineprotected

Determines if the output is still active: Client, AudioStream and AudioOutput support this via their operator bool(); plain Print outputs cannot be checked and are always reported as active.

isDeletable()

virtual bool isDeletable ( )

inlinevirtualinherited

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

Reimplemented in AdapterPrintToAudioOutput, and AdapterAudioStreamToAudioOutput.

isNotifyActive()

bool isNotifyActive ( )

inlineinherited

Checks if the automatic AudioInfo update is active.

notifyAudioChange()

void notifyAudioChange ( AudioInfo  info )

inlineprotectedinherited

operator bool()

virtual operator bool ( )

inlinevirtualinherited

Reimplemented in RTSPOutput< Platform >, EncodedAudioOutput, and AdapterAudioStreamToAudioOutput.

remove()

void remove ( Print &  print )

inline

Removes the indicated output.

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 )

inlinevirtual

Defines the input AudioInfo.

Reimplemented from AudioOutput.

setNotifyActive()

void setNotifyActive ( bool  flag )

inlineinherited

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

setOutput()

void setOutput ( Print &  out )

inlineprotectedvirtual

support for Pipleline

Implements ModifyingOutput.

write() [1/2]

size_t write ( const uint8_t *  data, size_t  len  )

inlineoverridevirtual

Implements AudioOutput.

write() [2/2]

size_t write ( uint8_t  ch )

inlineoverridevirtual

Reimplemented from AudioOutput.

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

tmp

SingleBuffer<uint8_t> tmp {MAX_SINGLE_CHARS}

protectedinherited

tmpPos

int tmpPos = 0

protectedinherited

vector

Vector<MultiOutputRecord> vector

protected

---

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

• src/AudioTools/CoreAudio/AudioIO.h