SPIRegAudioSlaveConfig Struct Reference

Configuration for SPIRegAudioSlave. More...

#include <SPIRegAudioSlave.h>

Inheritance diagram for SPIRegAudioSlaveConfig:

Collaboration diagram for SPIRegAudioSlaveConfig:

Public Member Functions
virtual void	clear ()
void	copyFrom (AudioInfo info)
	Same as set.
bool	equals (AudioInfo alt)
	Returns true if alt values are the same like the current values.
bool	equalsExSampleRate (AudioInfo alt)
	Checks if only the sample rate is different.
virtual void	logInfo (const char *source="")
	operator bool ()
	Returns true if all components are defined (no component is 0)
bool	operator!= (AudioInfo alt)
	Returns true if alt values are the different from the current values.
bool	operator== (AudioInfo alt)
	Returns true if alt values are the same like the current values.
void	set (AudioInfo info)
	Copies the values from info.
void	setAudioInfo (AudioInfo info)
	Same as set.

Public Attributes
uint8_t	bits_per_sample = DEFAULT_BITS_PER_SAMPLE
	Number of bits per sample (int16_t = 16 bits)
uint16_t	channels = DEFAULT_CHANNELS
	Number of channels: 2=stereo, 1=mono.
int	cs = -1
size_t	max_payload = 256
	Largest number of audio bytes the master is allowed to send in one frame.
int	miso = -1
int	mosi = -1
sample_rate_t	sample_rate = DEFAULT_SAMPLE_RATE
	Sample Rate: e.g 44100.
int	sck = -1
uint8_t	spi_host = 2
	ESP32 only: SPI host (2 = SPI2, 3 = SPI3)
uint8_t	spi_mode = 0

Detailed Description

Configuration for SPIRegAudioSlave.

Member Function Documentation

clear()

virtual void clear ( )

inlinevirtualinherited

copyFrom()

void copyFrom ( AudioInfo  info )

inlineinherited

Same as set.

equals()

bool equals ( AudioInfo  alt )

inlineinherited

Returns true if alt values are the same like the current values.

equalsExSampleRate()

bool equalsExSampleRate ( AudioInfo  alt )

inlineinherited

Checks if only the sample rate is different.

logInfo()

virtual void logInfo ( const char *  source = "" )

inlinevirtualinherited

Reimplemented in I2SConfigESP32, I2SConfigESP32V1, I2SConfigStd, and I2SConfigZephyr.

operator bool()

operator bool ( )

inlineinherited

Returns true if all components are defined (no component is 0)

operator!=()

bool operator!= ( AudioInfo  alt )

inlineinherited

Returns true if alt values are the different from the current values.

operator==()

bool operator== ( AudioInfo  alt )

inlineinherited

Returns true if alt values are the same like the current values.

set()

void set ( AudioInfo  info )

inlineinherited

Copies the values from info.

setAudioInfo()

void setAudioInfo ( AudioInfo  info )

inlineinherited

Same as set.

Member Data Documentation

bits_per_sample

uint8_t bits_per_sample = DEFAULT_BITS_PER_SAMPLE

inherited

Number of bits per sample (int16_t = 16 bits)

channels

uint16_t channels = DEFAULT_CHANNELS

inherited

Number of channels: 2=stereo, 1=mono.

cs

int cs = -1

max_payload

size_t max_payload = 256

Largest number of audio bytes the master is allowed to send in one frame.

miso

int miso = -1

mosi

int mosi = -1

sample_rate

sample_rate_t sample_rate = DEFAULT_SAMPLE_RATE

inherited

Sample Rate: e.g 44100.

sck

int sck = -1

spi_host

uint8_t spi_host = 2

ESP32 only: SPI host (2 = SPI2, 3 = SPI3)

spi_mode

uint8_t spi_mode = 0

---

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

• src/AudioTools/Communication/SPI/SPIRegAudioSlave.h