SPIRegAudioMasterConfig Struct Reference

Configuration for SPIRegAudioMaster. More...

#include <SPIRegAudioMaster.h>

Inheritance diagram for SPIRegAudioMasterConfig:

Collaboration diagram for SPIRegAudioMasterConfig:

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
decltype(MSBFIRST)	bit_order = MSBFIRST
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.
uint32_t	clock_hz = 4000000
int	cs_pin = 10
uint8_t	data_mode = SPI_MODE0
bool	is_blocking_write = false
	true: write() waits until the slave has enough space
size_t	max_payload = 256
uint32_t	reply_gap_us = 300
	Pause (us) between a read request and the reply frame.
sample_rate_t	sample_rate = DEFAULT_SAMPLE_RATE
	Sample Rate: e.g 44100.

Detailed Description

Configuration for SPIRegAudioMaster.

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

bit_order

decltype(MSBFIRST) bit_order = MSBFIRST

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.

clock_hz

uint32_t clock_hz = 4000000

cs_pin

int cs_pin = 10

data_mode

uint8_t data_mode = SPI_MODE0

is_blocking_write

bool is_blocking_write = false

true: write() waits until the slave has enough space

max_payload

size_t max_payload = 256

Max audio bytes per frame: must not be bigger than the slave's max_payload

reply_gap_us

uint32_t reply_gap_us = 300

Pause (us) between a read request and the reply frame.

sample_rate

sample_rate_t sample_rate = DEFAULT_SAMPLE_RATE

inherited

Sample Rate: e.g 44100.

---

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

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