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.

Public Attributes
i2s_port_t	i2s_num = (i2s_port_t)0
int	mclk_gpio = 0
bool	sd_active = true
bool	auto_clear = true
bool	use_apll = true
bool	is_i2s_active = true
int	buffer_count = 6
int	buffer_size = 512
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 66 of file AudioKitHAL.h.

Member Function Documentation

bitsPerSample()

int AudioKitConfig::bitsPerSample ( )

inline

provides the bits per sample

Definition at line 92 of file AudioKitHAL.h.

                      {
    switch (bits_per_sample) {
      case AUDIO_HAL_BIT_LENGTH_16BITS:
        return 16;
      case AUDIO_HAL_BIT_LENGTH_24BITS:
        return 24;
      case AUDIO_HAL_BIT_LENGTH_32BITS:
        return 32;
    }
    KIT_LOGE("bits_per_sample not supported: %d", bits_per_sample);
    return 0;
  }

isMaster()

bool AudioKitConfig::isMaster ( )

inline

Returns true if the CODEC is the master.

Definition at line 89 of file AudioKitHAL.h.

{ return master_slave_mode == AUDIO_HAL_MODE_MASTER; }

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 106 of file AudioKitHAL.h.

                        {
    switch (sample_rate) {
      case AUDIO_HAL_08K_SAMPLES: /*!< set to  8k samples per second */
        return 8000;
      case AUDIO_HAL_11K_SAMPLES: /*!< set to 11.025k samples per second */
        return 11025;
      case AUDIO_HAL_16K_SAMPLES: /*!< set to 16k samples in per second */
        return 16000;
      case AUDIO_HAL_22K_SAMPLES: /*!< set to 22.050k samples per second */
        return 22050;
      case AUDIO_HAL_24K_SAMPLES: /*!< set to 24k samples in per second */
        return 24000;
      case AUDIO_HAL_32K_SAMPLES: /*!< set to 32k samples in per second */
        return 32000;
      case AUDIO_HAL_44K_SAMPLES: /*!< set to 44.1k samples per second */
        return 44100;
      case AUDIO_HAL_48K_SAMPLES: /*!< set to 48k samples per second */
        return 48000;
    }
    KIT_LOGE("sample rate not supported: %d", sample_rate);
    return 0;
  }

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 80 of file AudioKitHAL.h.

auto_clear

bool AudioKitConfig::auto_clear = true

Definition at line 74 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 86 of file AudioKitHAL.h.

buffer_count

int AudioKitConfig::buffer_count = 6

Definition at line 77 of file AudioKitHAL.h.

buffer_size

int AudioKitConfig::buffer_size = 512

Definition at line 78 of file AudioKitHAL.h.

codec_mode

audio_hal_codec_mode_t AudioKitConfig::codec_mode

select codec mode: adc, dac or both

Definition at line 82 of file AudioKitHAL.h.

dac_output

audio_hal_dac_output_t AudioKitConfig::dac_output =AUDIOKIT_DEFAULT_OUTPUT

set dac channel

Definition at line 81 of file AudioKitHAL.h.

fmt

audio_hal_iface_format_t AudioKitConfig::fmt = AUDIOKIT_DEFAULT_I2S_FMT

I2S interface format

Definition at line 84 of file AudioKitHAL.h.

i2s_num

i2s_port_t AudioKitConfig::i2s_num = (i2s_port_t)0

Definition at line 67 of file AudioKitHAL.h.

is_i2s_active

bool AudioKitConfig::is_i2s_active = true

Definition at line 76 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 83 of file AudioKitHAL.h.

mclk_gpio

int AudioKitConfig::mclk_gpio = 0

Definition at line 69 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 85 of file AudioKitHAL.h.

sd_active

bool AudioKitConfig::sd_active = true

Definition at line 73 of file AudioKitHAL.h.

use_apll

bool AudioKitConfig::use_apll = true

Definition at line 75 of file AudioKitHAL.h.

---

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

• src/AudioKitHAL.h