I2S_Params_ Struct Reference

Basic I2S Parameters. More...

#include <I2S.h>

Collaboration diagram for I2S_Params_:

Data Fields
I2S_OpMode	operationMode
uint32_t	samplingFrequency
uint8_t	slotLength
uint8_t	bitsPerSample
uint8_t	numChannels
I2S_DataMode	readMode
I2S_Callback	readCallback
uint32_t	readTimeout
I2S_DataMode	writeMode
I2S_Callback	writeCallback
uint32_t	writeTimeout
void *	customParams

Detailed Description

Basic I2S Parameters.

I2S parameters are used to with the I2S_open() call. Default values for these parameters are set using I2S_Params_init().

See also

I2S_Params_init()

Field Documentation

I2S_OpMode I2S_Params_::operationMode

< I2S operational mode I2S sampling frequency configuration in samples/second

uint32_t I2S_Params_::samplingFrequency

Slot length

uint8_t I2S_Params_::slotLength

Bits per sample (Word length)

uint8_t I2S_Params_::bitsPerSample

Number of channels (slots per frame)

uint8_t I2S_Params_::numChannels

Mode for all read calls

I2S_DataMode I2S_Params_::readMode

Pointer to read callback

I2S_Callback I2S_Params_::readCallback

Timeout for read semaphore

uint32_t I2S_Params_::readTimeout

Mode for all write calls

I2S_DataMode I2S_Params_::writeMode

Pointer to write callback

I2S_Callback I2S_Params_::writeCallback

Timeout for write semaphore

uint32_t I2S_Params_::writeTimeout

Pointer to device specific custom params

void* I2S_Params_::customParams

---

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

• I2S.h