esphome::i2s_audio Namespace Reference

Data Structures
class	I2SAudioBase
class	I2SAudioComponent
class	I2SAudioIn
class	I2SAudioMicrophone
class	I2SAudioOut
class	I2SAudioSpeaker
	Standard I2S speaker implementation. More...
class	I2SAudioSpeakerBase
	Abstract base class for I2S audio speaker implementations. More...
class	I2SAudioSpeakerSPDIF
	SPDIF speaker implementation. More...
class	SPDIFEncoder

Typedefs
using	SPDIFBlockCallback = esp_err_t (*)(void *user_ctx, uint32_t *data, size_t size, TickType_t ticks_to_wait)
	Callback signature for block completion (raw function pointer for minimal overhead)

Enumerations
enum	MicrophoneEventGroupBits : uint32_t {   COMMAND_STOP = (1 << 0) , TASK_STARTING = (1 << 10) , TASK_RUNNING = (1 << 11) , TASK_STOPPED = (1 << 13) ,   ALL_BITS = 0x00FFFFFF }
enum	SpeakerEventGroupBits : uint32_t {   COMMAND_START = (1 << 0) , COMMAND_STOP = (1 << 0) , COMMAND_STOP_GRACEFULLY = (1 << 2) , TASK_STARTING = (1 << 10) ,   TASK_RUNNING = (1 << 11) , TASK_STOPPING = (1 << 12) , TASK_STOPPED = (1 << 13) , ERR_ESP_NO_MEM = (1 << 19) ,   ERR_DROPPED_EVENT = (1 << 20) , ERR_PARTIAL_WRITE = (1 << 21) , ERR_LOCKSTEP_DESYNC = (1 << 22) , ALL_BITS = 0x00FFFFFF }
enum class	I2SCommFmt : uint8_t { STANDARD , PCM , MSB }

Typedef Documentation

SPDIFBlockCallback

using esphome::i2s_audio::SPDIFBlockCallback = esp_err_t (*)(void *user_ctx, uint32_t *data, size_t size, TickType_t ticks_to_wait)

Callback signature for block completion (raw function pointer for minimal overhead)

Parameters

user_ctx	User context pointer passed during callback registration
data	Pointer to SPDIF encoded block data
size	Size of the block in bytes (always SPDIF_BLOCK_SIZE_BYTES)
ticks_to_wait	FreeRTOS ticks to wait for write completion

Returns

ESP_OK on success, or an error code

Definition at line 34 of file spdif_encoder.h.

Enumeration Type Documentation

I2SCommFmt

enum class esphome::i2s_audio::I2SCommFmt : uint8_t

strong

Enumerator
STANDARD
PCM
MSB

Definition at line 9 of file i2s_audio_speaker_standard.h.

MicrophoneEventGroupBits

enum esphome::i2s_audio::MicrophoneEventGroupBits : uint32_t

Enumerator
COMMAND_STOP
TASK_STARTING
TASK_RUNNING
TASK_STOPPED
ALL_BITS

Definition at line 24 of file i2s_audio_microphone.cpp.

SpeakerEventGroupBits

enum esphome::i2s_audio::SpeakerEventGroupBits : uint32_t

Enumerator
COMMAND_START
COMMAND_STOP
COMMAND_STOP_GRACEFULLY
TASK_STARTING
TASK_RUNNING
TASK_STOPPING
TASK_STOPPED
ERR_ESP_NO_MEM
ERR_DROPPED_EVENT
ERR_PARTIAL_WRITE
ERR_LOCKSTEP_DESYNC
ALL_BITS

Definition at line 25 of file i2s_audio_speaker.h.