I2SDriverBase Class Reference

#include <I2SDriverBase.h>

Inheritance diagram for I2SDriverBase:

Public Member Functions
virtual int	available ()=0
virtual int	availableForWrite ()=0
virtual bool	begin (I2SConfig cfg)=0
virtual I2SConfig	config ()=0
virtual I2SConfig	defaultConfig (RxTxMode mode)=0
virtual void	end ()=0
virtual void	flush ()
virtual size_t	readBytes (void *dest, size_t size_bytes)=0
virtual bool	setAudioInfo (AudioInfo info)=0
virtual size_t	writeBytes (const void *src, size_t size_bytes)=0

Member Function Documentation

available()

virtual int available ( )

pure virtual

Implemented in I2SDriverESP32, I2SDriverESP32V1, I2SDriverESP8266, I2SDriverNanoBLE, I2SDriverSAMD, and I2SDriverZephyr.

availableForWrite()

virtual int availableForWrite ( )

pure virtual

Implemented in I2SDriverESP32, I2SDriverESP32V1, I2SDriverESP8266, I2SDriverNanoBLE, I2SDriverSAMD, and I2SDriverZephyr.

begin()

virtual bool begin ( I2SConfig  cfg )

pure virtual

Implemented in I2SDriverESP32.

config()

virtual I2SConfig config ( )

pure virtual

Implemented in I2SDriverESP32, I2SDriverESP32V1, I2SDriverESP8266, I2SDriverNanoBLE, I2SDriverSAMD, and I2SDriverZephyr.

defaultConfig()

virtual I2SConfig defaultConfig ( RxTxMode  mode )

pure virtual

Implemented in I2SDriverESP32, I2SDriverESP32V1, I2SDriverESP8266, I2SDriverNanoBLE, I2SDriverSAMD, and I2SDriverZephyr.

end()

virtual void end ( )

pure virtual

Implemented in I2SDriverESP32, I2SDriverESP32V1, I2SDriverESP8266, I2SDriverNanoBLE, I2SDriverSAMD, and I2SDriverZephyr.

flush()

virtual void flush ( )

inlinevirtual

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()

virtual size_t readBytes ( void *  dest, size_t  size_bytes  )

pure virtual

Implemented in I2SDriverESP32, I2SDriverESP32V1, I2SDriverESP8266, I2SDriverNanoBLE, I2SDriverZephyr, and I2SDriverSAMD.

setAudioInfo()

virtual bool setAudioInfo ( AudioInfo  info )

pure virtual

Implemented in I2SDriverESP32, I2SDriverESP32V1, I2SDriverZephyr, I2SDriverESP8266, I2SDriverNanoBLE, and I2SDriverSAMD.

writeBytes()

virtual size_t writeBytes ( const void *  src, size_t  size_bytes  )

pure virtual

Implemented in I2SDriverESP32, I2SDriverESP32V1, I2SDriverESP8266, I2SDriverNanoBLE, I2SDriverSAMD, and I2SDriverZephyr.

---

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

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