AudioDriverES8374Class Class Reference

Driver API for ES8374 codec chip. More...

#include <Driver.h>

Inheritance diagram for AudioDriverES8374Class:

Public Member Functions
	AudioDriverES8374Class (int i2cAddr=0)
virtual bool	begin (CodecConfig codecCfg, DriverPins &pins)
virtual bool	end (void)
int	getVolume ()
virtual bool	isInputVolumeSupported ()
virtual bool	isVolumeSupported ()
DriverPins &	pins ()
virtual bool	setConfig (CodecConfig codecCfg)
virtual bool	setInputVolume (int volume)
bool	setMute (bool mute)
virtual bool	setMute (bool mute, int line)
	Mute individual lines: only supported for some rare DACs. More...
bool	setPAPower (bool enable)
	Sets the PA Power pin to active or inactive. More...
bool	setVolume (int volume)
	Defines the Volume (in %) if volume is 0, mute is enabled,range is 0-100. More...

Protected Member Functions
bool	configInterface (codec_mode_t mode, I2SDefinition iface)
bool	controlState (codec_mode_t mode)
bool	deinit ()
TwoWire *	getI2C ()
	Determine the TwoWire object from the I2C config or use Wire. More...
int	getI2CAddress ()
bool	init (codec_config_t codec_cfg)
int	limitValue (int volume, int min=0, int max=100)

Protected Attributes
CodecConfig	codec_cfg
int	i2c_address
DriverPins *	p_pins = nullptr

Detailed Description

Driver API for ES8374 codec chip.

Author

Phil Schatzmann

Copyright

GPLv3

Constructor & Destructor Documentation

AudioDriverES8374Class()

AudioDriverES8374Class ( int  i2cAddr = 0 )

inline

Member Function Documentation

begin()

virtual bool begin ( CodecConfig  codecCfg, DriverPins &  pins  )

inlinevirtualinherited

Reimplemented in AudioDriverWM8978Class, AudioDriverCS42448Class, AudioDriverAD1938Class, AudioDriverLyratMiniClass, AudioDriverWM8994Class, AudioDriverWM8960Class, AudioDriverCS43l22Class, and NoDriverClass.

configInterface()

bool configInterface ( codec_mode_t  mode, I2SDefinition  iface  )

inlineprotectedvirtual

< error_t value indicating success (no error)

Reimplemented from AudioDriver.

controlState()

bool controlState ( codec_mode_t  mode )

inlineprotectedvirtual

< error_t value indicating success (no error)

Reimplemented from AudioDriver.

deinit()

bool deinit ( )

inlineprotectedvirtual

< error_t value indicating success (no error)

Reimplemented from AudioDriver.

end()

virtual bool end ( void  )

inlinevirtualinherited

Reimplemented in AudioDriverCS42448Class, AudioDriverAD1938Class, AudioDriverLyratMiniClass, AudioDriverWM8960Class, NoDriverClass, and AudioDriverWM8978Class.

getI2C()

TwoWire* getI2C ( )

inlineprotectedinherited

Determine the TwoWire object from the I2C config or use Wire.

getI2CAddress()

int getI2CAddress ( )

inlineprotectedinherited

getVolume()

int getVolume ( )

inlinevirtual

Implements AudioDriver.

init()

bool init ( codec_config_t  codec_cfg )

inlineprotectedvirtual

< error_t value indicating success (no error)

Reimplemented from AudioDriver.

isInputVolumeSupported()

virtual bool isInputVolumeSupported ( )

inlinevirtualinherited

Reimplemented in AudioDriverWM8978Class, AudioDriverCS42448Class, AudioDriverAD1938Class, AudioDriverLyratMiniClass, AudioDriverWM8960Class, AudioDriverES8388Class, and NoDriverClass.

isVolumeSupported()

virtual bool isVolumeSupported ( )

inlinevirtualinherited

Reimplemented in AudioDriverWM8978Class, AudioDriverCS42448Class, AudioDriverAD1938Class, AudioDriverWM8960Class, and NoDriverClass.

limitValue()

int limitValue ( int  volume, int  min = 0, int  max = 100  )

inlineprotectedinherited

make sure that value is in range

Parameters

volume

Returns

pins()

DriverPins& pins ( )

inlineinherited

setConfig()

virtual bool setConfig ( CodecConfig  codecCfg )

inlinevirtualinherited

Reimplemented in AudioDriverWM8960Class, AudioDriverCS42448Class, AudioDriverCS43l22Class, and AudioDriverAD1938Class.

setInputVolume()

virtual bool setInputVolume ( int  volume )

inlinevirtualinherited

Reimplemented in AudioDriverWM8978Class, AudioDriverCS42448Class, AudioDriverAD1938Class, AudioDriverLyratMiniClass, AudioDriverWM8960Class, AudioDriverES8388Class, and NoDriverClass.

setMute() [1/2]

bool setMute ( bool  mute )

inlinevirtual

< error_t value indicating success (no error)

Implements AudioDriver.

setMute() [2/2]

virtual bool setMute ( bool  mute, int  line  )

inlinevirtualinherited

Mute individual lines: only supported for some rare DACs.

Reimplemented in AudioDriverES8388Class, AudioDriverAD1938Class, and AudioDriverCS42448Class.

setPAPower()

bool setPAPower ( bool  enable )

inlineinherited

Sets the PA Power pin to active or inactive.

setVolume()

bool setVolume ( int  volume )

inlinevirtual

Defines the Volume (in %) if volume is 0, mute is enabled,range is 0-100.

< error_t value indicating success (no error)

Implements AudioDriver.

Member Data Documentation

codec_cfg

CodecConfig codec_cfg

protectedinherited

i2c_address

int i2c_address

protected

p_pins

DriverPins* p_pins = nullptr

protectedinherited

---

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

• src/Driver.h