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 BaseStream AudioInfoSupport AudioInfoSource Stream Print

Public Member Functions

 GeneratedSoundStream (SoundGenerator< T > &generator)
virtual void addNotifyAudioChange (AudioInfoSupport &bi)
 Adds target to be notified about audio changes.
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 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
virtual void clearNotifyAudioChange ()
 Deletes all change notify subscriptions.
AudioInfo defaultConfig ()
void end () override
 stop the processing
void flush () override
bool isActive ()
bool isNotifyActive ()
 Checks if the automatic AudioInfo update is active.
 operator bool ()
size_t readBytes (uint8_t *data, size_t len) 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 bool removeNotifyAudioChange (AudioInfoSupport &bi)
 Removes a target in order not to be notified about audio changes.
void setAudioInfo (AudioInfo newInfo) override
 Defines the input AudioInfo.
void setInput (SoundGenerator< T > &generator)
void setNotifyActive (bool flag)
 Deactivate/Reactivate automatic AudioInfo updates: (default is active)
virtual size_t write (const uint8_t *data, size_t len) 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 notifyAudioChange (AudioInfo info)
void refillReadBuffer ()

Protected Attributes

int _timeout = 10
bool active = true
SoundGenerator< T > * generator_ptr
AudioInfo info
bool is_notify_active = true
Vector< AudioInfoSupport * > notify_vector
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: