Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
ModifyingStream Class Referenceabstract

Abstract class: Objects can be put into a pipleline. More...

#include <AudioStreams.h>

Inheritance diagram for ModifyingStream:
AudioStream BaseStream AudioInfoSupport AudioInfoSource Stream Print AudioEffectStream AudioEffectStreamT< T > BufferedStream CallbackStream ConverterStream< T > Equilizer3Bands FadeStream FilteredStream< T, TF > MeasuringStream Pipeline::ModifyingStreamAdapter ProgressStream ReformatBaseStream Throttle TimedStream VolumeStream

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 available () override
virtual int availableForWrite () override
virtual bool begin ()
virtual void clearNotifyAudioChange ()
 Deletes all change notify subscriptions.
virtual void end ()
virtual void flush () override
bool isNotifyActive ()
 Checks if the automatic AudioInfo update is active.
virtual operator bool ()
virtual size_t readBytes (uint8_t *data, size_t len) override
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.
virtual void setAudioInfo (AudioInfo newInfo) override
 Defines the input AudioInfo.
void setNotifyActive (bool flag)
 Deactivate/Reactivate automatic AudioInfo updates: (default is active)
virtual void setOutput (Print &out)=0
 Defines/Changes the output target.
virtual void setStream (Stream &in)=0
 Defines/Changes the input & output.
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
AudioInfo info
bool is_notify_active = true
Vector< AudioInfoSupport * > notify_vector
RingBuffer< uint8_t > tmp_in {0}
RingBuffer< uint8_t > tmp_out {0}

Detailed Description

Abstract class: Objects can be put into a pipleline.

Phil Schatzmann

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