arduino-audio-tools
Loading...
Searching...
No Matches
AdapterPrintToAudioOutput Class Reference

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

#include <CodecTSDemux.h>

Inheritance diagram for AdapterPrintToAudioOutput:
AudioOutputAdapter AudioOutput Print AudioInfoSupport AudioInfoSource Print AudioInfoSupport AudioInfoSource

Public Member Functions

 AdapterPrintToAudioOutput ()=default
 AdapterPrintToAudioOutput (Print &print)
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.
AudioInfo audioInfo ()
 provides the actual input AudioInfo
virtual AudioInfo audioInfoOut ()
virtual AudioInfo audioInfoOut ()
virtual int availableForWrite () override
virtual int availableForWrite () override
virtual bool begin ()
virtual bool begin ()
virtual bool begin (AudioInfo info)
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 end ()
virtual void flush ()
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 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.
void setAudioInfo (AudioInfo info)
 Defines the input AudioInfo.
void setNotifyActive (bool flag)
 Deactivate/Reactivate automatic AudioInfo updates: (default is active).
void setNotifyActive (bool flag)
 Deactivate/Reactivate automatic AudioInfo updates: (default is active).
void setStream (Print &out)
size_t write (const uint8_t *data, size_t len)
virtual size_t write (uint8_t ch) override
virtual void writeSilence (size_t len)
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
Print * p_print = nullptr
SingleBuffer< uint8_t > tmp { 8 }
int tmpPos = 0

Detailed Description

Wrapper which converts a Print to a AudioOutput.

Constructor & Destructor Documentation

◆ AdapterPrintToAudioOutput() [1/2]

AdapterPrintToAudioOutput ( )
default

◆ AdapterPrintToAudioOutput() [2/2]

AdapterPrintToAudioOutput ( Print & print)
inline

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

AudioInfo audioInfo ( )
inlinevirtual

provides the actual input AudioInfo

Reimplemented from AudioOutput.

◆ audioInfoOut() [1/2]

◆ audioInfoOut() [2/2]

◆ availableForWrite() [1/2]

◆ availableForWrite() [2/2]

◆ begin() [1/4]

◆ begin() [2/4]

◆ begin() [3/4]

virtual bool begin ( AudioInfo info)
inlinevirtualinherited

◆ begin() [4/4]

virtual bool begin ( AudioInfo info)
inlinevirtualinherited

◆ clearNotifyAudioChange() [1/2]

virtual void clearNotifyAudioChange ( )
inlinevirtualinherited

◆ clearNotifyAudioChange() [2/2]

virtual void clearNotifyAudioChange ( )
inlinevirtualinherited

◆ end() [1/2]

◆ end() [2/2]

◆ flush() [1/2]

virtual void flush ( )
inlinevirtualinherited

Reimplemented from Print.

Reimplemented in HexDumpOutput, HexDumpOutput, MultiOutput, HexDumpOutput, and MultiOutput.

◆ flush() [2/2]

virtual void flush ( )
inlinevirtualinherited

Reimplemented from Print.

Reimplemented in HexDumpOutput, HexDumpOutput, MultiOutput, HexDumpOutput, and MultiOutput.

◆ isDeletable()

virtual bool isDeletable ( )
inlinevirtual

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

Reimplemented from AudioOutput.

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

virtual operator bool ( )
inlinevirtualinherited

◆ operator bool() [2/2]

virtual operator bool ( )
inlinevirtualinherited

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

void setAudioInfo ( AudioInfo info)
inlinevirtual

Defines the input AudioInfo.

Reimplemented from AudioOutput.

◆ 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).

◆ setStream()

void setStream ( Print & out)
inline

◆ write() [1/2]

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

Implements AudioOutput.

◆ write() [2/2]

virtual size_t write ( uint8_t ch)
inlineoverridevirtualinherited

Reimplemented in MultiOutput, MetaDataOutput, and MultiOutput.

◆ writeSilence() [1/2]

virtual void writeSilence ( size_t len)
inlinevirtualinherited

Writes n 0 values (= silence)

Parameters
len

◆ writeSilence() [2/2]

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
protected

◆ is_active

bool is_active = false
protectedinherited

◆ is_notify_active

bool is_notify_active = true
protectedinherited

◆ notify_vector

Vector< AudioInfoSupport * > notify_vector
protectedinherited

◆ p_print

Print* p_print = nullptr
protected

◆ tmp

SingleBuffer< uint8_t > tmp { 8 }
protectedinherited

◆ tmpPos

int tmpPos = 0
protectedinherited

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