arduino-audio-tools
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
Throttle Class Reference

Throttle the sending or receiving of the audio data to limit it to the indicated sample rate. More...

#include <AudioStreams.h>

Inheritance diagram for Throttle:
ModifyingStream AudioStream BaseStream AudioInfoSupport AudioInfoSource Stream Print

Public Member Functions

 Throttle (Print &out)
 
 Throttle (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 ()
 
int availableForWrite ()
 
bool begin ()
 
bool begin (AudioInfo info)
 
bool begin (ThrottleConfig cfg)
 
virtual void clearNotifyAudioChange ()
 Deletes all change notify subscriptions.
 
ThrottleConfig defaultConfig ()
 
void delayBytes (size_t bytes)
 
void delayFrames (size_t frames)
 
virtual void end ()
 
virtual void flush () override
 
int64_t getDelayMs (uint64_t frames)
 
int64_t getDelaySec (uint64_t frames)
 
int64_t getDelayUs (uint64_t frames)
 
bool isNotifyActive ()
 Checks if the automatic AudioInfo update is active.
 
virtual operator bool ()
 
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)
 
void setOutput (Print &out) override
 Defines/Changes the output target.
 
void setStream (Stream &io) override
 Defines/Changes the input & output.
 
void startDelay ()
 
size_t write (const uint8_t *data, size_t len)
 
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
 
ThrottleConfig cfg
 
int frame_size = 0
 
AudioInfo info
 
bool is_notify_active = true
 
Vector< AudioInfoSupport * > notify_vector
 
Streamp_in = nullptr
 
Printp_out = nullptr
 
uint32_t start_time = 0
 
uint32_t sum_frames = 0
 
RingBuffer< uint8_t > tmp_in {0}
 
RingBuffer< uint8_t > tmp_out {0}
 

Detailed Description

Throttle the sending or receiving of the audio data to limit it to the indicated sample rate.

Author
Phil Schatzmann

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