AudioStream class which stores the data in a temporary queue buffer. The queue can be consumed e.g. by a callback function by calling readBytes();. More...
#include <AudioStreams.h>
Inheritance diagram for QueueStream< T >:
Public Member Functions | |
| QueueStream (BaseBuffer< T > &buffer) | |
| Create stream from any BaseBuffer subclass. | |
| QueueStream (int bufferSize, int bufferCount, bool autoRemoveOldestDataIfFull=false) | |
| Default constructor. | |
| 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 | |
| int | available () override |
| int | availableForWrite () override |
| virtual bool | begin () override |
| Activates the output. | |
| virtual bool | begin (size_t activeWhenPercentFilled) |
| Activate only when filled buffer reached %. | |
| void | clear () |
| Clears the data in the buffer. | |
| virtual void | clearNotifyAudioChange () |
| Deletes all change notify subscriptions. | |
| virtual void | end () override |
| stops the processing | |
| virtual void | flush () override |
| bool | isNotifyActive () |
| Checks if the automatic AudioInfo update is active. | |
| operator bool () | |
| Returns true if active. | |
| 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 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 |
| size_t | active_limit = 0 |
| BaseBuffer< T > * | callback_buffer_ptr |
| AudioInfo | info |
| bool | is_notify_active = true |
| Vector< AudioInfoSupport * > | notify_vector |
| bool | owns_buffer |
| bool | remove_oldest_data |
| RingBuffer< uint8_t > | tmp_in {0} |
| RingBuffer< uint8_t > | tmp_out {0} |
Detailed Description
template<class T>
class audio_tools::QueueStream< T >
AudioStream class which stores the data in a temporary queue buffer. The queue can be consumed e.g. by a callback function by calling readBytes();.
- Copyright
- GPLv3
The documentation for this class was generated from the following file:
- src/AudioTools/AudioStreams.h
