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

Audio Writer which is synchronizing the amount of data that can be processed with the AudioReceiver. More...

#include <AudioSync.h>

Inheritance diagram for AudioSyncWriter:
AudioOutput Print AudioInfoSupport AudioInfoSource

Public Member Functions

 AudioSyncWriter (Stream &dest)
 
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 availableForWrite () override
 
virtual bool begin ()
 
bool begin (AudioInfo &info, AudioType type)
 
virtual bool begin (AudioInfo info)
 
virtual void clearNotifyAudioChange ()
 Deletes all change notify subscriptions.
 
void end ()
 
virtual void flush () override
 
virtual bool isDeletable ()
 If true we need to release the related memory in the destructor.
 
bool isNotifyActive ()
 Checks if the automatic AudioInfo update is active.
 
 operator bool ()
 
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)
 
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)
 

Protected Member Functions

void notifyAudioChange (AudioInfo info)
 
void waitFor (int size)
 Waits for the data to be available.
 
int waitForRequest ()
 

Protected Attributes

int _timeout = 10
 
int available_to_write = 1024
 
AudioInfo cfg
 
bool is_active = false
 
bool is_notify_active = true
 
bool is_sync
 
Vector< AudioInfoSupport * > notify_vector
 
Streamp_dest
 
SingleBuffer< uint8_t > tmp {MAX_SINGLE_CHARS}
 
int tmpPos = 0
 

Detailed Description

Audio Writer which is synchronizing the amount of data that can be processed with the AudioReceiver.

Author
Phil Schatzmann

Member Function Documentation

◆ writeSilence()

virtual void writeSilence ( size_t  len)
inlinevirtualinherited

Writes n 0 values (= silence)

Parameters
len

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