arduino-audio-tools
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
AudioOutput Class Referenceabstract

Abstract Audio Ouptut class. More...

#include <AudioOutput.h>

Inheritance diagram for AudioOutput:
Print AudioInfoSupport AudioInfoSource AudioESP32ULP AudioFFTBase AudioOutputAdapter AudioOutputWithCallback AudioServerEx AudioSyncWriter ChannelSplitOutput ChannelsSelectOutput CsvOutput< T > HexDumpOutput MemoryOutput MetaDataOutput ModifyingOutput OggContainerOutput PWMAudioOutput PitchShiftOutput< T, BufferT > RTSPOutput VolumeOutput

Public Member Functions

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 ()
 provides the actual output AudioInfo: this is usually the same as audioInfo() unless we use a transforming stream
 
virtual int availableForWrite () override
 
virtual bool begin ()
 
virtual bool begin (AudioInfo info)
 
virtual void clearNotifyAudioChange ()
 Deletes all change notify subscriptions.
 
virtual void end ()
 
virtual void flush () override
 
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.
 
 operator bool ()
 
virtual bool removeNotifyAudioChange (AudioInfoSupport &bi)
 Removes a target in order not to be notified about audio changes.
 
virtual void setAudioInfo (AudioInfo newInfo) override
 Defines the input AudioInfo.
 
void setNotifyActive (bool flag)
 Deactivate/Reactivate automatic AudioInfo updates: (default is active)
 
virtual size_t write (const uint8_t *buffer, size_t size) override=0
 
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
 
SingleBuffer< uint8_t > tmp {MAX_SINGLE_CHARS}
 
int tmpPos = 0
 

Detailed Description

Abstract Audio Ouptut class.

Author
Phil Schatzmann

Member Function Documentation

◆ writeSilence()

virtual void writeSilence ( size_t  len)
inlinevirtual

Writes n 0 values (= silence)

Parameters
len

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