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

#include <AudioKit.h>

Inheritance diagram for AudioKitStreamConfig:

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

int	channel_format = I2S_CHANNEL_FMT_RIGHT_LEFT

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

Copyright: GPLv3

Constructor & Destructor Documentation

◆ AudioKitStreamConfig()

AudioKitStreamConfig ( RxTxMode mode = RXTX_MODE )

inline

Member Function Documentation

◆ clear()

virtual void clear ( )

inlinevirtualinherited

◆ copyFrom()

void copyFrom ( AudioInfo info )

inlineinherited

Same as set.

◆ equals()

bool equals ( AudioInfo alt )

inlineinherited

Returns true if alt values are the same like the current values.

◆ equalsExSampleRate()

bool equalsExSampleRate ( AudioInfo alt )

inlineinherited

Checks if only the sample rate is different.

◆ logInfo()

void logInfo ( const char * source = "" )

inlinevirtualinherited

Reimplemented from AudioInfo.

◆ operator bool()

operator bool ( )

inlineinherited

Returns true if all components are defined (no component is 0)

◆ operator!=()

bool operator!= ( AudioInfo alt )

inlineinherited

Returns true if alt values are the different from the current values.

◆ operator==()

bool operator== ( AudioInfo alt )

inlineinherited

Returns true if alt values are the same like the current values.

◆ set()

void set ( AudioInfo info )

inlineinherited

Copies the values from info.

◆ setAudioInfo()

void setAudioInfo ( AudioInfo info )

inlineinherited

Same as set.

◆ setupI2SPins()

void setupI2SPins ( RxTxMode rxtx_mode )

inlineprotected

Defines the pins based on the information provided by the AudioKit project.

◆ toAudioKitConfig()

AudioKitConfig toAudioKitConfig ( )

inline

convert to config object needed by HAL

◆ toBits()

audio_hal_iface_bits_t toBits ( )

inlineprotected

◆ toCodecMode()

audio_hal_codec_mode_t toCodecMode ( )

inlineprotected

Convert to audio_hal_codec_mode_t.

◆ toFormat()

audio_hal_iface_format_t toFormat ( )

inlineprotected

Convert to audio_hal_iface_format_t.

◆ toMode()

audio_hal_iface_mode_t toMode ( )

inlineprotected

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

◆ toSampleRate()

audio_hal_iface_samples_t toSampleRate ( )

inlineprotected

Convert to audio_hal_iface_samples_t.

Friends And Related Symbol Documentation

◆ AudioKitStream

friend class AudioKitStream

friend

Member Data Documentation

◆ audiokit_config

AudioKitConfig audiokit_config

protected

◆ auto_clear

bool auto_clear = I2S_AUTO_CLEAR

inherited

◆ bits_per_sample

uint8_t bits_per_sample = DEFAULT_BITS_PER_SAMPLE

inherited

Number of bits per sample (int16_t = 16 bits)

◆ board

board_driver board

protected

◆ buffer_count

int buffer_count = I2S_BUFFER_COUNT

inherited

◆ buffer_size

int buffer_size = I2S_BUFFER_SIZE

inherited

◆ channel_format

int channel_format = I2S_CHANNEL_FMT_RIGHT_LEFT

inherited

◆ channels

uint16_t channels = DEFAULT_CHANNELS

inherited

Number of channels: 2=stereo, 1=mono.

◆ default_actions_active

bool default_actions_active = true

◆ driver

audio_hal_func_t driver = AUDIO_DRIVER

◆ fixed_mclk

uint32_t fixed_mclk = 0

inherited

◆ i2s_format

I2SFormat i2s_format = I2S_STD_FORMAT

inherited

◆ input_device

audio_hal_adc_input_t input_device = AUDIOKIT_DEFAULT_INPUT

◆ is_master

bool is_master = true

inherited

◆ output_device

audio_hal_dac_output_t output_device = AUDIOKIT_DEFAULT_OUTPUT

◆ pin_bck

int pin_bck = PIN_I2S_BCK

inherited

◆ pin_data

int pin_data = -1

inherited

◆ pin_data_rx

int pin_data_rx = -1

inherited

◆ pin_mck

int pin_mck = -1

inherited

◆ pin_ws

int pin_ws = PIN_I2S_WS

inherited

◆ pins

audio_kit_pins pins

◆ port_no

int port_no = 0

inherited

◆ rx_tx_mode

RxTxMode rx_tx_mode = RXTX_MODE

inherited

public settings

◆ sample_rate

sample_rate_t sample_rate = DEFAULT_SAMPLE_RATE

inherited

Sample Rate: e.g 44100.

◆ sd_active

bool sd_active = true

◆ signal_type

I2SSignalType signal_type = Digital

inherited

◆ use_apll

bool use_apll = I2S_USE_APLL

inherited

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

src/AudioTools/AudioLibs/AudioKit.h

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ AudioKitStreamConfig()

Member Function Documentation

◆ clear()

◆ copyFrom()

◆ equals()

◆ equalsExSampleRate()

◆ logInfo()

◆ operator bool()

◆ operator!=()

◆ operator==()

◆ set()

◆ setAudioInfo()

◆ setupI2SPins()

◆ toAudioKitConfig()

◆ toBits()

◆ toCodecMode()

◆ toFormat()

◆ toMode()

◆ toSampleRate()

Friends And Related Symbol Documentation

◆ AudioKitStream

Member Data Documentation

◆ audiokit_config

◆ auto_clear

◆ bits_per_sample

◆ board

◆ buffer_count

◆ buffer_size

◆ channel_format

◆ channels

◆ default_actions_active

◆ driver

◆ fixed_mclk

◆ i2s_format

◆ input_device

◆ is_master

◆ output_device

◆ pin_bck

◆ pin_data

◆ pin_data_rx

◆ pin_mck

◆ pin_ws

◆ pins

◆ port_no

◆ rx_tx_mode

◆ sample_rate

◆ sd_active

◆ signal_type

◆ use_apll