I2SDriverESP8266 Class Reference

Basic I2S API - for the ESP8266 Only 16 bits are supported ! More...

#include <I2SDriverESP8266.h>

Inheritance diagram for I2SDriverESP8266:

Public Member Functions
int	available ()
	we assume the data is already available in the buffer
int	availableForWrite ()
	We limit the write size to the buffer size.
virtual bool	begin (I2SConfig cfg)=0
bool	begin (I2SConfigStd cfg)
	starts the DAC
bool	begin (RxTxMode mode=TX_MODE)
	starts the DAC with the default config
I2SConfigStd	config ()
	provides the actual configuration
I2SConfigStd	defaultConfig (RxTxMode mode)
	Provides the default configuration.
void	end ()
	stops the I2C and unistalls the driver
virtual void	flush ()
bool	setAudioInfo (AudioInfo)
	Potentially updates the sample rate (if supported)

Protected Member Functions
size_t	readBytes (void *dest, size_t size_bytes)
	reads the data from the I2S interface
size_t	writeBytes (const void *src, size_t size_bytes)
	writes the data to the I2S interface
size_t	writeExt (const void *src, size_t size_bytes)
	writes the data by making shure that we send 2 channels 16 bit data

Protected Attributes
I2SConfigStd	cfg

Friends
class	I2SStream

Detailed Description

Basic I2S API - for the ESP8266 Only 16 bits are supported !

Author

Phil Schatzmann

Copyright

GPLv3

Member Function Documentation

available()

int available ( )

inlinevirtual

we assume the data is already available in the buffer

Implements I2SDriverBase.

availableForWrite()

int availableForWrite ( )

inlinevirtual

We limit the write size to the buffer size.

Implements I2SDriverBase.

begin() [1/3]

virtual bool begin ( I2SConfig  cfg )

pure virtualinherited

Implemented in I2SDriverESP32.

begin() [2/3]

bool begin ( I2SConfigStd  cfg )

inline

starts the DAC

begin() [3/3]

bool begin ( RxTxMode  mode = TX_MODE )

inline

starts the DAC with the default config

config()

I2SConfigStd config ( )

inlinevirtual

provides the actual configuration

Implements I2SDriverBase.

defaultConfig()

I2SConfigStd defaultConfig ( RxTxMode  mode )

inlinevirtual

Provides the default configuration.

Implements I2SDriverBase.

end()

void end ( )

inlinevirtual

stops the I2C and unistalls the driver

Implements I2SDriverBase.

flush()

virtual void flush ( )

inlinevirtualinherited

Discards any audio already queued in the driver's own output buffer (e.g. the I2S DMA buffer) but not yet physically played - useful when switching to unrelated audio content (e.g. AudioPlayer moving to the next track) to stop stale samples from continuing to play out during the switch. Default no-op, since not every backend can support this; override where the underlying driver allows it.

Reimplemented in I2SDriverESP32, and I2SDriverESP32V1.

readBytes()

size_t readBytes ( void *  dest, size_t  size_bytes  )

inlineprotectedvirtual

reads the data from the I2S interface

Implements I2SDriverBase.

setAudioInfo()

bool setAudioInfo ( AudioInfo  )

inlinevirtual

Potentially updates the sample rate (if supported)

Implements I2SDriverBase.

writeBytes()

size_t writeBytes ( const void *  src, size_t  size_bytes  )

inlineprotectedvirtual

writes the data to the I2S interface

Implements I2SDriverBase.

writeExt()

size_t writeExt ( const void *  src, size_t  size_bytes  )

inlineprotected

writes the data by making shure that we send 2 channels 16 bit data

Friends And Related Symbol Documentation

I2SStream

friend class I2SStream

friend

Member Data Documentation

cfg

I2SConfigStd cfg

protected

---

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

• src/AudioTools/CoreAudio/AudioI2S/I2SDriverESP8266.h