arduino-audio-tools
Public Member Functions | Public Attributes | List of all members
I2SConfigStd Class Reference

Configuration for i2s. More...

#include <I2SConfigStd.h>

Inheritance diagram for I2SConfigStd:
AudioInfo

Public Member Functions

 I2SConfigStd (const I2SConfigStd &cfg)=default
 Default Copy Constructor.
 
 I2SConfigStd (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.
 
I2SFormat i2s_format = I2S_STD_FORMAT
 
bool is_master = true
 
int pin_bck = PIN_I2S_BCK
 
int pin_data
 
int pin_data_rx
 
int pin_mck = -1
 
int pin_ws = PIN_I2S_WS
 
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.

Author
Phil Schatzmann

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