Arduino AudioKit HAL
Public Member Functions | Public Attributes | List of all members
AudioKitConfig Struct Reference

Configuation for AudioKit. More...

#include <AudioKitHAL.h>

Public Member Functions

bool isMaster ()
 Returns true if the CODEC is the master.
 
int bitsPerSample ()
 provides the bits per sample
 
uint32_t sampleRate ()
 Provides the sample rate in samples per second. More...
 

Public Attributes

i2s_port_t i2s_num = (i2s_port_t)0
 
gpio_num_t mclk_gpio = (gpio_num_t)0
 
bool sd_active = true
 
audio_hal_adc_input_t adc_input = AUDIOKIT_DEFAULT_INPUT
 
audio_hal_dac_output_t dac_output =AUDIOKIT_DEFAULT_OUTPUT
 
audio_hal_codec_mode_t codec_mode
 
audio_hal_iface_mode_t master_slave_mode = AUDIOKIT_DEFAULT_MASTER_SLAVE
 
audio_hal_iface_format_t fmt = AUDIOKIT_DEFAULT_I2S_FMT
 
audio_hal_iface_samples_t sample_rate = AUDIOKIT_DEFAULT_RATE
 
audio_hal_iface_bits_t bits_per_sample = AUDIOKIT_DEFAULT_BITSIZE
 

Detailed Description

Configuation for AudioKit.

Definition at line 57 of file AudioKitHAL.h.

Member Function Documentation

◆ sampleRate()

uint32_t AudioKitConfig::sampleRate ( )
inline

Provides the sample rate in samples per second.

< set to 8k samples per second

< set to 11.025k samples per second

< set to 16k samples in per second

< set to 22.050k samples per second

< set to 24k samples in per second

< set to 32k samples in per second

< set to 44.1k samples per second

< set to 48k samples per second

Definition at line 88 of file AudioKitHAL.h.

88  {
89  switch (sample_rate) {
90  case AUDIO_HAL_08K_SAMPLES: /*!< set to 8k samples per second */
91  return 8000;
92  case AUDIO_HAL_11K_SAMPLES: /*!< set to 11.025k samples per second */
93  return 11000;
94  case AUDIO_HAL_16K_SAMPLES: /*!< set to 16k samples in per second */
95  return 16000;
96  case AUDIO_HAL_22K_SAMPLES: /*!< set to 22.050k samples per second */
97  return 22000;
98  case AUDIO_HAL_24K_SAMPLES: /*!< set to 24k samples in per second */
99  return 24000;
100  case AUDIO_HAL_32K_SAMPLES: /*!< set to 32k samples in per second */
101  return 32000;
102  case AUDIO_HAL_44K_SAMPLES: /*!< set to 44.1k samples per second */
103  return 44000;
104  case AUDIO_HAL_48K_SAMPLES: /*!< set to 48k samples per second */
105  return 48000;
106  }
107  KIT_LOGE("sample rate not supported: %d", sample_rate);
108  return 0;
109  }
audio_hal_iface_samples_t sample_rate
Definition: AudioKitHAL.h:67

Member Data Documentation

◆ adc_input

audio_hal_adc_input_t AudioKitConfig::adc_input = AUDIOKIT_DEFAULT_INPUT

set adc channel with audio_hal_adc_input_t

Definition at line 62 of file AudioKitHAL.h.

◆ bits_per_sample

audio_hal_iface_bits_t AudioKitConfig::bits_per_sample = AUDIOKIT_DEFAULT_BITSIZE

i2s interface number of bits per sample

Definition at line 68 of file AudioKitHAL.h.

◆ codec_mode

audio_hal_codec_mode_t AudioKitConfig::codec_mode

select codec mode: adc, dac or both

Definition at line 64 of file AudioKitHAL.h.

◆ dac_output

audio_hal_dac_output_t AudioKitConfig::dac_output =AUDIOKIT_DEFAULT_OUTPUT

set dac channel

Definition at line 63 of file AudioKitHAL.h.

◆ fmt

audio_hal_iface_format_t AudioKitConfig::fmt = AUDIOKIT_DEFAULT_I2S_FMT

I2S interface format

Definition at line 66 of file AudioKitHAL.h.

◆ master_slave_mode

audio_hal_iface_mode_t AudioKitConfig::master_slave_mode = AUDIOKIT_DEFAULT_MASTER_SLAVE

audio codec chip mode

Definition at line 65 of file AudioKitHAL.h.

◆ sample_rate

audio_hal_iface_samples_t AudioKitConfig::sample_rate = AUDIOKIT_DEFAULT_RATE

I2S interface samples per second

Definition at line 67 of file AudioKitHAL.h.


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