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

ESP8266Audio AudioOutput class which stores the data in a temporary buffer. The buffer can be consumed e.g. by a callback function by calling read(); Dependencies: ESP8266Audio Library Dependencies: ESP32-A2DP Library. More...

#include <AudioESP8266.h>

Inheritance diagram for AudioOutputWithCallback:
AudioOutput BufferedStream Print AudioInfoSupport AudioInfoSource AudioStream Stream AudioInfoSupport AudioInfoSource Print

Public Member Functions

 AudioOutputWithCallback (int bufferSize, int bufferCount)
 
virtual AudioInfo audioInfo () override
 
virtual AudioInfo audioInfo () override
 
virtual int available () override
 Returns the available bytes in the buffer: to be avoided.
 
virtual int availableForWrite () override
 
virtual int availableForWrite () override
 
virtual bool begin ()
 Activates the output.
 
virtual bool begin (AudioInfo info)
 
void clear ()
 Clears all the data in the buffer.
 
virtual bool ConsumeSample (int16_t sample[2])
 puts the sample into a buffer
 
virtual void end ()
 
virtual void end ()
 
virtual void flush () override
 
virtual void flush () override
 empties the buffer
 
virtual bool isDeletable ()
 If true we need to release the related memory in the destructor.
 
 operator bool ()
 
 operator bool ()
 
virtual int peek () override
 peeks a byte - to be avoided
 
virtual int read () override
 reads a byte - to be avoided
 
size_t read (Frame *src, size_t len)
 Provides the data from the internal buffer to the callback.
 
size_t readBytes (uint8_t *data, size_t length) override
 Use this method !!
 
virtual size_t readSilence (uint8_t *buffer, size_t length)
 Source to generate silence: just sets the buffer to 0.
 
virtual void setAudioInfo (AudioInfo info) override
 
virtual void setAudioInfo (AudioInfo info) override
 
virtual void setNotifyAudioChange (AudioInfoSupport &bi) override
 
virtual void setNotifyAudioChange (AudioInfoSupport &bi) override
 
virtual bool stop ()
 stops the processing
 
virtual bool validate (AudioInfo &info)
 
virtual size_t write (const uint8_t *buffer, size_t size) override=0
 
virtual size_t write (const uint8_t *data, size_t len) override
 Use this method: write an array.
 
virtual size_t write (uint8_t c) override
 writes a byte to the buffer
 
virtual size_t write (uint8_t ch) override
 
virtual void writeSilence (size_t len)
 
virtual void writeSilence (size_t len)
 Writes len bytes of silence (=0).
 

Protected Member Functions

virtual int not_supported (int out, const char *msg="")
 
virtual size_t readExt (uint8_t *data, size_t len)
 
void refill ()
 
void refillReadBuffer ()
 
virtual size_t writeExt (const uint8_t *data, size_t len)
 

Protected Attributes

bool active
 
SingleBuffer< uint8_t > * buffer = nullptr
 
NBuffer< Frame > * callback_buffer_ptr
 
AudioInfo cfg
 
AudioInfo info
 
bool is_active = false
 
AudioInfoSupportp_notify = nullptr
 
AudioInfoSupportp_notify =nullptr
 
SingleBuffer< uint8_t > tmp {MAX_SINGLE_CHARS}
 
RingBuffer< uint8_t > tmp_in {0}
 
RingBuffer< uint8_t > tmp_out {0}
 
int tmpPos = 0
 

Detailed Description

ESP8266Audio AudioOutput class which stores the data in a temporary buffer. The buffer can be consumed e.g. by a callback function by calling read(); Dependencies: ESP8266Audio Library Dependencies: ESP32-A2DP Library.

Author
Phil Schatzmann

Member Function Documentation

◆ 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: