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

Common functionality for PWM output. Please use the PWMAudioOutput typedef instead which references the implementation. More...

#include <AudioPWM.h>

Inheritance diagram for PWMAudioOutput:
AudioOutput Print AudioInfoSupport AudioInfoSource

Public Member Functions

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
 
bool begin ()
 
virtual bool begin (AudioInfo info)
 
bool begin (PWMConfig config)
 starts the processing using Streams
 
virtual void clearNotifyAudioChange ()
 Deletes all change notify subscriptions.
 
PWMConfig config ()
 
virtual PWMConfig defaultConfig ()
 
PWMDriverdriver ()
 Provides access to the driver.
 
virtual void end () override
 
virtual void flush ()
 
uint32_t framesPerSecond ()
 
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 info)
 updates the sample rate dynamically
 
void setBuffer (BaseBuffer< uint8_t > *buffer)
 
void setNotifyActive (bool flag)
 Deactivate/Reactivate automatic AudioInfo updates: (default is active)
 
uint32_t underflowsPerSecond ()
 
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)
 

Protected Attributes

int _timeout = 10
 
PWMConfig audio_config
 
AudioInfo cfg
 
bool is_active = false
 
bool is_notify_active = true
 
Vector< AudioInfoSupport * > notify_vector
 
PWMDriver pwm
 
SingleBuffer< uint8_t > tmp {MAX_SINGLE_CHARS}
 
int tmpPos = 0
 

Detailed Description

Common functionality for PWM output. Please use the PWMAudioOutput typedef instead which references the implementation.

Member Function Documentation

◆ setBuffer()

void setBuffer ( BaseBuffer< uint8_t > *  buffer)
inline

You can assign your own custom buffer impelementation: must be allocated on the heap and will be cleaned up by this class

◆ 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: