The Arduino Stream supports operations on single characters. This is usually not the best way to push audio information, but we will support it anyway - by using a buffer. On reads: if the buffer is empty it gets refilled. More...
#include <AudioStreams.h>
Inheritance diagram for BufferedStream:
Public Member Functions | |
| BufferedStream (size_t buffer_size) | |
| BufferedStream (size_t buffer_size, Print &out) | |
| BufferedStream (size_t buffer_size, Stream &io) | |
| 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 |
| Returns the available bytes in the buffer: to be avoided. | |
| virtual int | availableForWrite () override |
| virtual bool | begin () |
| void | clear () |
| Clears all the data in the buffer. | |
| virtual void | clearNotifyAudioChange () |
| Deletes all change notify subscriptions. | |
| virtual void | end () |
| void | flush () override |
| empties the buffer | |
| bool | isNotifyActive () |
| Checks if the automatic AudioInfo update is active. | |
| operator bool () | |
| int | peek () override |
| peeks a byte - to be avoided | |
| int | read () override |
| reads a byte - to be avoided | |
| 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 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) | |
| void | setOutput (Print &out) |
| Defines/Changes the output target. | |
| void | setStream (Print &out) |
| void | setStream (Stream &io) |
| Defines/Changes the input & output. | |
| size_t | write (const uint8_t *data, size_t len) override |
| Use this method: write an array. | |
| size_t | write (uint8_t c) override |
| writes a byte to the buffer | |
| 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) |
| 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 | |
| int | _timeout = 10 |
| SingleBuffer< uint8_t > | buffer |
| AudioInfo | info |
| bool | is_notify_active = true |
| Vector< AudioInfoSupport * > | notify_vector |
| Stream * | p_in = nullptr |
| Print * | p_out = nullptr |
| RingBuffer< uint8_t > | tmp_in {0} |
| RingBuffer< uint8_t > | tmp_out {0} |
Detailed Description
The Arduino Stream supports operations on single characters. This is usually not the best way to push audio information, but we will support it anyway - by using a buffer. On reads: if the buffer is empty it gets refilled.
- for writes if it is full it gets flushed.
- Copyright
- GPLv3
The documentation for this class was generated from the following file:
- src/AudioTools/AudioStreams.h
