arduino-audio-tools
Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes | Friends | List of all members
AudioKitStreamConfig Class Reference

Configuration for AudioKitStream: we use as subclass of I2SConfig. More...

#include <AudioKit.h>

Inheritance diagram for AudioKitStreamConfig:
I2SConfigESP32 AudioInfo

Public Member Functions

 AudioKitStreamConfig (RxTxMode mode=RXTX_MODE)
 
virtual void clear ()
 
void copyFrom (AudioInfo info)
 Same as set.
 
bool equals (AudioInfo alt)
 Returns true if alt values are the same like the current values.
 
bool equalsExSampleRate (AudioInfo alt)
 Checks if only the sample rate is different.
 
void logInfo (const char *source="")
 
 operator bool ()
 Returns true if all components are defined (no component is 0)
 
bool operator!= (AudioInfo alt)
 Returns true if alt values are the different from the current values.
 
bool operator== (AudioInfo alt)
 Returns true if alt values are the same like the current values.
 
void set (AudioInfo info)
 Copies the values from info.
 
void setAudioInfo (AudioInfo info)
 Same as set.
 
AudioKitConfig toAudioKitConfig ()
 convert to config object needed by HAL
 

Public Attributes

bool auto_clear = I2S_AUTO_CLEAR
 
uint8_t bits_per_sample = DEFAULT_BITS_PER_SAMPLE
 Number of bits per sample (int16_t = 16 bits)

 
int buffer_count = I2S_BUFFER_COUNT
 
int buffer_size = I2S_BUFFER_SIZE
 
uint16_t channels = DEFAULT_CHANNELS
 Number of channels: 2=stereo, 1=mono.
 
bool default_actions_active = true
 
audio_hal_func_t driver = AUDIO_DRIVER
 
uint32_t fixed_mclk = 0
 
I2SFormat i2s_format = I2S_STD_FORMAT
 
audio_hal_adc_input_t input_device = AUDIOKIT_DEFAULT_INPUT
 
bool is_master = true
 
audio_hal_dac_output_t output_device = AUDIOKIT_DEFAULT_OUTPUT
 
int pin_bck = PIN_I2S_BCK
 
int pin_data = -1
 
int pin_data_rx = -1
 
int pin_mck = -1
 
int pin_ws = PIN_I2S_WS
 
audio_kit_pins pins
 
int port_no = 0
 
RxTxMode rx_tx_mode = RXTX_MODE
 public settings
 
sample_rate_t sample_rate = DEFAULT_SAMPLE_RATE
 Sample Rate: e.g 44100.
 
bool sd_active = true
 
I2SSignalType signal_type = Digital
 
bool use_apll = I2S_USE_APLL
 

Protected Member Functions

void setupI2SPins (RxTxMode rxtx_mode)
 Defines the pins based on the information provided by the AudioKit project.
 
audio_hal_iface_bits_t toBits ()
 
audio_hal_codec_mode_t toCodecMode ()
 Convert to audio_hal_codec_mode_t.
 
audio_hal_iface_format_t toFormat ()
 Convert to audio_hal_iface_format_t.
 
audio_hal_iface_mode_t toMode ()
 
audio_hal_iface_samples_t toSampleRate ()
 Convert to audio_hal_iface_samples_t.
 

Protected Attributes

AudioKitConfig audiokit_config
 
board_driver board
 

Friends

class AudioKitStream
 

Detailed Description

Configuration for AudioKitStream: we use as subclass of I2SConfig.

Author
Phil Schatzmann

Member Function Documentation

◆ toMode()

audio_hal_iface_mode_t toMode ( )
inlineprotected

Determine if ESP32 is master or slave - this is just the oposite of the HAL device


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