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

Configuation for AudioKit. More...

#include <AudioKit.h>

Public Member Functions

bool isMaster ()
 Returns true if the CODEC is the master.
 
int bitsPerSample ()
 provides the bits per sample
 
int 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
 
audio_hal_adc_input_t adc_input
 
audio_hal_dac_output_t dac_output
 
audio_hal_codec_mode_t codec_mode
 
audio_hal_iface_mode_t master_slave_mode
 
audio_hal_iface_format_t fmt
 
audio_hal_iface_samples_t sample_rate
 
audio_hal_iface_bits_t bits_per_sample
 

Detailed Description

Configuation for AudioKit.

Definition at line 54 of file AudioKit.h.

Member Function Documentation

◆ sampleRate()

int 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 91 of file AudioKit.h.

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

Member Data Documentation

◆ adc_input

audio_hal_adc_input_t AudioKitConfig::adc_input
Initial value:
=
AUDIOKIT_DEFAULT_INPUT

set adc channel with audio_hal_adc_input_t

Definition at line 58 of file AudioKit.h.

◆ bits_per_sample

audio_hal_iface_bits_t AudioKitConfig::bits_per_sample
Initial value:
=
AUDIOKIT_DEFAULT_BITSIZE

i2s interface number of bits per sample

Definition at line 70 of file AudioKit.h.

◆ codec_mode

audio_hal_codec_mode_t AudioKitConfig::codec_mode

select codec mode: adc, dac or both

Definition at line 63 of file AudioKit.h.

◆ dac_output

audio_hal_dac_output_t AudioKitConfig::dac_output
Initial value:
=
AUDIOKIT_DEFAULT_OUTPUT

set dac channel

Definition at line 61 of file AudioKit.h.

◆ fmt

audio_hal_iface_format_t AudioKitConfig::fmt
Initial value:
=
AUDIOKIT_DEFAULT_I2S_FMT

I2S interface format

Definition at line 66 of file AudioKit.h.

◆ master_slave_mode

audio_hal_iface_mode_t AudioKitConfig::master_slave_mode
Initial value:
=
AUDIOKIT_DEFAULT_MASTER_SLAVE

audio codec chip mode

Definition at line 64 of file AudioKit.h.

◆ sample_rate

audio_hal_iface_samples_t AudioKitConfig::sample_rate
Initial value:
=
AUDIOKIT_DEFAULT_RATE

I2S interface samples per second

Definition at line 68 of file AudioKit.h.


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