Stream which can be used to manage fade in and fade out. Before you read or write data you need to call setAudioInfo() to provide the bits_per_sample and channels. More...
#include <Fade.h>
Inheritance diagram for FadeStream:
Public Member Functions | |
| FadeStream (Print &out) | |
| FadeStream (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 |
| int | availableForWrite () override |
| virtual bool | begin () |
| bool | begin (AudioInfo info) |
| virtual void | clearNotifyAudioChange () |
| Deletes all change notify subscriptions. | |
| virtual void | end () |
| virtual void | flush () override |
| bool | isFadeComplete () |
| bool | isFadeInActive () |
| bool | isFadeOutActive () |
| bool | isNotifyActive () |
| Checks if the automatic AudioInfo update is active. | |
| operator bool () | |
| size_t | readBytes (uint8_t *buffer, size_t length) 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. | |
| void | setAudioInfo (AudioInfo info) override |
| Defines the input AudioInfo. | |
| void | setFadeInActive (bool flag) |
| void | setFadeOutActive (bool flag) |
| void | setNotifyActive (bool flag) |
| Deactivate/Reactivate automatic AudioInfo updates: (default is active) | |
| void | setOutput (Print &out) override |
| Defines/Changes the output target. | |
| void | setOutput (Stream &io) |
| same as setStream | |
| void | setStream (Print &out) |
| same as setOutput | |
| void | setStream (Stream &io) override |
| Defines/Changes the input & output. | |
| size_t | write (const uint8_t *buffer, size_t size) override |
| virtual size_t | write (uint8_t ch) override |
| void | writeEnd (Print &print, int steps=200) |
| 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 = false |
| const char * | error_msg = "setAudioInfo not called" |
| Fade | fade |
| LastSampleFader | fade_last |
| AudioInfo | info |
| bool | is_notify_active = true |
| Vector< AudioInfoSupport * > | notify_vector |
| Stream * | p_io = nullptr |
| Print * | p_out = nullptr |
| RingBuffer< uint8_t > | tmp_in {0} |
| RingBuffer< uint8_t > | tmp_out {0} |
Detailed Description
Stream which can be used to manage fade in and fade out. Before you read or write data you need to call setAudioInfo() to provide the bits_per_sample and channels.
- Copyright
- GPLv3
The documentation for this class was generated from the following file:
- src/AudioTools/Fade.h
