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
audio_kit_pins	pins
	defines all relevant pins

audio_hal_func_t	driver = AUDIO_DRIVER
	driver which selects the codec implementation: AUDIO_CODEC_ES8388_DEFAULT_HANDLE, AUDIO_CODEC_AC101_CODEC_HANDLE, AUDIO_CODEC_ES8311_DEFAULT_HANDLE, AUDIO_CODEC_ES7243_DEFAULT_HANDLE

i2s_port_t	i2s_num = (i2s_port_t)pins.i2s_num

bool	sd_active = true

bool	auto_clear = true

bool	use_apll = true

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

Member Function Documentation

◆ sampleRate()

uint32_t audiokit::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 127 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 audiokit::AudioKitConfig::adc_input = AUDIOKIT_DEFAULT_INPUT

set adc channel with audio_hal_adc_input_t

Definition at line 96 of file AudioKitHAL.h.

◆ bits_per_sample

audio_hal_iface_bits_t audiokit::AudioKitConfig::bits_per_sample = AUDIOKIT_DEFAULT_BITSIZE

i2s interface number of bits per sample

Definition at line 105 of file AudioKitHAL.h.

◆ codec_mode

audio_hal_codec_mode_t audiokit::AudioKitConfig::codec_mode

select codec mode: adc, dac or both

Definition at line 99 of file AudioKitHAL.h.

◆ dac_output

audio_hal_dac_output_t audiokit::AudioKitConfig::dac_output = AUDIOKIT_DEFAULT_OUTPUT

set dac channel

Definition at line 98 of file AudioKitHAL.h.

◆ fmt

audio_hal_iface_format_t audiokit::AudioKitConfig::fmt = AUDIOKIT_DEFAULT_I2S_FMT

I2S interface format

Definition at line 102 of file AudioKitHAL.h.

◆ master_slave_mode

audio_hal_iface_mode_t audiokit::AudioKitConfig::master_slave_mode = AUDIOKIT_DEFAULT_MASTER_SLAVE

audio codec chip mode

Definition at line 100 of file AudioKitHAL.h.

◆ sample_rate

audio_hal_iface_samples_t audiokit::AudioKitConfig::sample_rate = AUDIOKIT_DEFAULT_RATE

I2S interface samples per second

Definition at line 103 of file AudioKitHAL.h.

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

src/AudioKitHAL.h

Public Member Functions

Public Attributes