I2SConfigZephyr Class Reference

Configuration for i2s. More...

#include <I2SConfigZephyr.h>

Inheritance diagram for I2SConfigZephyr:

Collaboration diagram for I2SConfigZephyr:

Public Member Functions
	I2SConfigZephyr ()=default
	I2SConfigZephyr (const I2SConfigZephyr &cfg)=default
	Default Copy Constructor.
	I2SConfigZephyr (RxTxMode mode)
	Constructor.
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.
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)
int	buffer_count = I2S_BUFFER_COUNT
int	buffer_size = I2S_BUFFER_SIZE
uint16_t	channels = DEFAULT_CHANNELS
	Number of channels: 2=stereo, 1=mono.
device *	dev = nullptr
I2SFormat	i2s_format = I2S_STD_FORMAT
bool	is_master = true
RxTxMode	rx_tx_mode = TX_MODE
	public settings
sample_rate_t	sample_rate = DEFAULT_SAMPLE_RATE
	Sample Rate: e.g 44100.

Detailed Description

Configuration for i2s.

Assign the i2s device to dev e.g. with dev = DEVICE_DT_GET(DT_ALIAS(i2s0));

Author

Phil Schatzmann

Copyright

GPLv3

Constructor & Destructor Documentation

I2SConfigZephyr() [1/3]

I2SConfigZephyr ( )

default

I2SConfigZephyr() [2/3]

I2SConfigZephyr ( const I2SConfigZephyr &  cfg )

default

Default Copy Constructor.

I2SConfigZephyr() [3/3]

I2SConfigZephyr ( RxTxMode  mode )

inline

Constructor.

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

void logInfo ( const char *  source = "" )

inlinevirtual

Reimplemented from AudioInfo.

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)

buffer_count

int buffer_count = I2S_BUFFER_COUNT

buffer_size

int buffer_size = I2S_BUFFER_SIZE

channels

uint16_t channels = DEFAULT_CHANNELS

inherited

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

dev

device* dev = nullptr

i2s_format

I2SFormat i2s_format = I2S_STD_FORMAT

is_master

bool is_master = true

rx_tx_mode

RxTxMode rx_tx_mode = TX_MODE

public settings

sample_rate

sample_rate_t sample_rate = DEFAULT_SAMPLE_RATE

inherited

Sample Rate: e.g 44100.

---

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

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