Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
GeneratedSoundStream< T > Class Template Reference

Source for reading generated tones. Please note. More...

#include <AudioStreams.h>

Inheritance diagram for GeneratedSoundStream< T >:
AudioStream Stream AudioInfoSupport AudioInfoSource Print

Public Member Functions

 GeneratedSoundStream (SoundGenerator< T > &generator)
AudioInfo audioInfo () override
virtual int available () override
 This is unbounded so we just return the buffer size.
virtual int availableForWrite () override
bool begin () override
 start the processing
bool begin (AudioInfo cfg)
 start the processing
AudioInfo defaultConfig ()
void end () override
 stop the processing
void flush () override
bool isActive ()
 operator bool ()
size_t readBytes (uint8_t *buffer, size_t length) override
 privide the data as byte stream
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
void setInput (SoundGenerator< T > &generator)
virtual void setNotifyAudioChange (AudioInfoSupport &bi) override
virtual bool validate (AudioInfo &info)
virtual size_t write (const uint8_t *buffer, size_t size) override
virtual size_t write (uint8_t ch) override
virtual void writeSilence (size_t len)
 Writes len bytes of silence (=0).

Protected Member Functions

virtual int not_supported (int out, const char *msg="")
void refillReadBuffer ()

Protected Attributes

bool active = false
AudioInfoSupportaudioBaseInfoDependent = nullptr
SoundGenerator< T > * generator_ptr
AudioInfo info
AudioInfoSupportp_notify =nullptr
const char * source_not_defined_error = "Source not defined"
RingBuffer< uint8_t > tmp_in {0}
RingBuffer< uint8_t > tmp_out {0}

Detailed Description

template<class T>
class audio_tools::GeneratedSoundStream< T >

Source for reading generated tones. Please note.

Phil Schatzmann

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