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

We support the Stream interface for the I2S access. In addition we allow a separate mute pin which might also be used to drive a LED... More...

#include <I2SStream.h>

Inheritance diagram for I2SStream:
AudioStream BaseStream AudioInfoSupport AudioInfoSource Stream Print

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
 
virtual int available () override
 Provides the available audio data.
 
virtual int availableForWrite () override
 Provides the available audio data.
 
bool begin ()
 
bool begin (I2SConfig cfg)
 Starts the I2S interface.
 
virtual void clearNotifyAudioChange ()
 Deletes all change notify subscriptions.
 
I2SConfig defaultConfig (RxTxMode mode=TX_MODE)
 Provides the default configuration.
 
I2SDriverdriver ()
 Provides access to the driver.
 
void end ()
 Stops the I2S interface.
 
void flush () override
 
bool isNotifyActive ()
 Checks if the automatic AudioInfo update is active.
 
virtual operator bool ()
 
virtual size_t readBytes (uint8_t *data, size_t len) override
 Reads the audio data.
 
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 info)
 updates the sample rate dynamically
 
void setNotifyActive (bool flag)
 Deactivate/Reactivate automatic AudioInfo updates: (default is active)
 
virtual size_t write (const uint8_t *data, size_t len)
 Writes the audio data to I2S.
 
virtual size_t write (uint8_t ch) override
 
virtual void writeSilence (size_t len)
 Writes len bytes of silence (=0).
 

Protected Member Functions

void mute (bool is_mute)
 set mute pin on or off
 
virtual int not_supported (int out, const char *msg="")
 
void notifyAudioChange (AudioInfo info)
 
void refillReadBuffer ()
 

Protected Attributes

int _timeout = 10
 
I2SDriver i2s
 
AudioInfo info
 
bool is_active = false
 
bool is_notify_active = true
 
int mute_pin
 
Vector< AudioInfoSupport * > notify_vector
 
RingBuffer< uint8_t > tmp_in {0}
 
RingBuffer< uint8_t > tmp_out {0}
 

Detailed Description

We support the Stream interface for the I2S access. In addition we allow a separate mute pin which might also be used to drive a LED...

Template Parameters
T
Author
Phil Schatzmann

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