I2SCodecConfig Struct Reference

Configuration for I2SCodecStream. More...

#include <I2SCodecStream.h>

Inheritance diagram for I2SCodecConfig:

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.
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!= (I2SCodecConfig alt)
bool	operator== (AudioInfo alt)
	Returns true if alt values are the same like the current values.
bool	operator== (I2SCodecConfig alt)
void	set (AudioInfo info)
	Copies the values from info.
void	setAudioInfo (AudioInfo info)
	Same as set.

Public Attributes
bool	auto_clear = I2S_AUTO_CLEAR
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
int	channel_format = I2S_CHANNEL_FMT_RIGHT_LEFT
uint16_t	channels = DEFAULT_CHANNELS
	Number of channels: 2=stereo, 1=mono.
uint32_t	fixed_mclk = 0
I2SFormat	i2s_format = I2S_STD_FORMAT
PinFunction	i2s_function = PinFunction::UNDEFINED
input_device_t	input_device = ADC_INPUT_LINE1
bool	is_master = true
output_device_t	output_device = DAC_OUTPUT_ALL
int	pin_bck = PIN_I2S_BCK
int	pin_data = -1
int	pin_data_rx = -1
int	pin_mck = -1
int	pin_ws = PIN_I2S_WS
int	port_no = 0
RxTxMode	rx_tx_mode = RXTX_MODE
	public settings
sample_rate_t	sample_rate = DEFAULT_SAMPLE_RATE
	Sample Rate: e.g 44100.
bool	sd_active = true
bool	sdmmc_active = false
I2SSignalType	signal_type = Digital
bool	use_apll = I2S_USE_APLL

Detailed Description

Configuration for I2SCodecStream.

Author

Phil Schatzmann

Copyright

GPLv3

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 = "" )

inlinevirtualinherited

Reimplemented from AudioInfo.

operator bool()

operator bool ( )

inlineinherited

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

operator!=() [1/2]

bool operator!= ( AudioInfo  alt )

inlineinherited

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

operator!=() [2/2]

bool operator!= ( I2SCodecConfig  alt )

inline

operator==() [1/2]

bool operator== ( AudioInfo  alt )

inlineinherited

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

operator==() [2/2]

bool operator== ( I2SCodecConfig  alt )

inline

set()

void set ( AudioInfo  info )

inlineinherited

Copies the values from info.

setAudioInfo()

void setAudioInfo ( AudioInfo  info )

inlineinherited

Same as set.

Member Data Documentation

auto_clear

bool auto_clear = I2S_AUTO_CLEAR

inherited

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

inherited

buffer_size

int buffer_size = I2S_BUFFER_SIZE

inherited

channel_format

int channel_format = I2S_CHANNEL_FMT_RIGHT_LEFT

inherited

channels

uint16_t channels = DEFAULT_CHANNELS

inherited

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

fixed_mclk

uint32_t fixed_mclk = 0

inherited

i2s_format

I2SFormat i2s_format = I2S_STD_FORMAT

inherited

i2s_function

PinFunction i2s_function = PinFunction::UNDEFINED

input_device

input_device_t input_device = ADC_INPUT_LINE1

is_master

bool is_master = true

inherited

output_device

output_device_t output_device = DAC_OUTPUT_ALL

pin_bck

int pin_bck = PIN_I2S_BCK

inherited

pin_data

int pin_data = -1

inherited

pin_data_rx

int pin_data_rx = -1

inherited

pin_mck

int pin_mck = -1

inherited

pin_ws

int pin_ws = PIN_I2S_WS

inherited

port_no

int port_no = 0

inherited

rx_tx_mode

RxTxMode rx_tx_mode = RXTX_MODE

inherited

public settings

sample_rate

sample_rate_t sample_rate = DEFAULT_SAMPLE_RATE

inherited

Sample Rate: e.g 44100.

sd_active

bool sd_active = true

sdmmc_active

bool sdmmc_active = false

signal_type

I2SSignalType signal_type = Digital

inherited

use_apll

bool use_apll = I2S_USE_APLL

inherited

---

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

• src/AudioTools/AudioLibs/I2SCodecStream.h