arduino-audio-driver
Enumerations
Public enumeration types

Enumerations

enum  channels_t { CHANNELS2 = 2 , CHANNELS4 = 4 , CHANNELS8 = 8 , CHANNELS16 = 16 }
 Select the number of channels. More...
 
enum  codec_mode_t {
  CODEC_MODE_MIN = -1 , CODEC_MODE_NONE = 0x00 , CODEC_MODE_ENCODE = 0x01 , CODEC_MODE_DECODE = 0x02 ,
  CODEC_MODE_BOTH = 0x03 , CODEC_MODE_LINE_IN = 0x04 , CODEC_MODE_MAX
}
 Select media hal codec mode. More...
 
enum  es_mic_gain_t {
  MIC_GAIN_MIN = -1 , MIC_GAIN_0DB = 0 , MIC_GAIN_3DB = 3 , MIC_GAIN_6DB = 6 ,
  MIC_GAIN_9DB = 9 , MIC_GAIN_12DB = 12 , MIC_GAIN_15DB = 15 , MIC_GAIN_18DB = 18 ,
  MIC_GAIN_21DB = 21 , MIC_GAIN_24DB = 24 , MIC_GAIN_MAX
}
 Microphone Gain. More...
 
enum  i2s_format_t {
  I2S_NORMAL = 0 , I2S_LEFT = 1 , I2S_RIGHT = 2 , I2S_DSP = 3 ,
  I2S_TDM = 4
}
 Select I2S interface format for audio codec chip. More...
 
enum  i2s_master_slave_t { MODE_SLAVE = 0x00 , MODE_MASTER = 0x01 }
 Select I2S interface operating mode i.e. master or slave for audio codec chip. More...
 
enum class  PinLogic {
  InputActiveHigh , InputActiveLow , InputActiveTouch , Input ,
  Output , Inactive
}
 input or output More...
 
enum  sample_bits_t {
  BIT_LENGTH_MIN = -1 , BIT_LENGTH_16BITS = 0x03 , BIT_LENGTH_18BITS = 0x02 , BIT_LENGTH_20BITS = 0x01 ,
  BIT_LENGTH_24BITS = 0x00 , BIT_LENGTH_32BITS = 0x04 , BIT_LENGTH_MAX
}
 Select I2S interface number of bits per sample. More...
 
enum  samplerate_t {
  RATE_8K = 0 , RATE_11K , RATE_16K , RATE_22K ,
  RATE_24K , RATE_32K , RATE_44K , RATE_48K ,
  RATE_64K , RATE_88K , RATE_96K , RATE_128K ,
  RATE_176K , RATE_192K
}
 Select I2S interface samples per second. More...
 

Detailed Description

Enumeration Type Documentation

◆ channels_t

enum channels_t

Select the number of channels.

Enumerator
CHANNELS2 
CHANNELS4 
CHANNELS8 
CHANNELS16 

◆ codec_mode_t

Select media hal codec mode.

Enumerator
CODEC_MODE_MIN 
CODEC_MODE_NONE 
CODEC_MODE_ENCODE 

select adc

CODEC_MODE_DECODE 

select dac

CODEC_MODE_BOTH 

select both adc and dac

CODEC_MODE_LINE_IN 

set adc channel

CODEC_MODE_MAX 

◆ es_mic_gain_t

Microphone Gain.

Enumerator
MIC_GAIN_MIN 
MIC_GAIN_0DB 
MIC_GAIN_3DB 
MIC_GAIN_6DB 
MIC_GAIN_9DB 
MIC_GAIN_12DB 
MIC_GAIN_15DB 
MIC_GAIN_18DB 
MIC_GAIN_21DB 
MIC_GAIN_24DB 
MIC_GAIN_MAX 

◆ i2s_format_t

Select I2S interface format for audio codec chip.

Enumerator
I2S_NORMAL 

set normal I2S format

I2S_LEFT 

set all left format

I2S_RIGHT 

set all right format

I2S_DSP 

set dsp/pcm format

I2S_TDM 

set tdm format

◆ i2s_master_slave_t

Select I2S interface operating mode i.e. master or slave for audio codec chip.

Enumerator
MODE_SLAVE 

set slave mode

MODE_MASTER 

set master mode

◆ PinLogic

enum PinLogic
strong

input or output

Enumerator
InputActiveHigh 
InputActiveLow 
InputActiveTouch 
Input 
Output 
Inactive 

◆ sample_bits_t

Select I2S interface number of bits per sample.

Enumerator
BIT_LENGTH_MIN 
BIT_LENGTH_16BITS 
BIT_LENGTH_18BITS 
BIT_LENGTH_20BITS 
BIT_LENGTH_24BITS 
BIT_LENGTH_32BITS 
BIT_LENGTH_MAX 

◆ samplerate_t

Select I2S interface samples per second.

Enumerator
RATE_8K 

set to 8k samples per second

RATE_11K 

set to 11.025k samples per second

RATE_16K 

set to 16k samples in per second

RATE_22K 

set to 22.050k samples per second

RATE_24K 

set to 24k samples in per second

RATE_32K 

set to 32k samples in per second

RATE_44K 

set to 44.1k samples per second

RATE_48K 

set to 48k samples per second

RATE_64K 

set to 64k samples per second

RATE_88K 

set to 88.2k samples per second

RATE_96K 

set to 96k samples per second

RATE_128K 

set to 128K samples per second

RATE_176K 

set to 176.4K samples per second

RATE_192K 

set to 192k samples per second