ESPHome 2026.11.0b6
Loading...
Searching...
No Matches
esphome::i2s_audio::I2SAudioIn Class Referenceabstract

#include <i2s_audio.h>

Inheritance diagram for esphome::i2s_audio::I2SAudioIn:
esphome::i2s_audio::I2SAudioBase esphome::Parented< I2SAudioComponent > esphome::i2s_audio::I2SAudioMicrophone

Public Member Functions

virtual void build_full_duplex_config (i2s_std_config_t &std_cfg)=0
 Builds the RX configuration the parent uses to set up a full duplex channel pair.
 
virtual void full_duplex_rx_enabling (i2s_chan_handle_t rx_handle, uint32_t dma_desc_num)=0
 Called by the parent on the main loop just before it enables the full duplex RX channel, which clears its receive queue.
 
- Public Member Functions inherited from esphome::i2s_audio::I2SAudioBase
void set_i2s_role (i2s_role_t role)
 
void set_slot_mode (i2s_slot_mode_t slot_mode)
 
void set_std_slot_mask (i2s_std_slot_mask_t std_slot_mask)
 
void set_slot_bit_width (i2s_slot_bit_width_t slot_bit_width)
 
void set_sample_rate (uint32_t sample_rate)
 
void set_use_apll (uint32_t use_apll)
 
void set_mclk_multiple (i2s_mclk_multiple_t mclk_multiple)
 
- Public Member Functions inherited from esphome::Parented< I2SAudioComponent >
 Parented ()
 
 Parented (I2SAudioComponent *parent)
 
I2SAudioComponent * get_parent () const
 Get the parent of this object.
 
void set_parent (I2SAudioComponent *parent)
 Set the parent of this object.
 

Additional Inherited Members

- Protected Member Functions inherited from esphome::i2s_audio::I2SAudioBase
i2s_clock_src_t get_clock_source_ () const
 
- Protected Attributes inherited from esphome::i2s_audio::I2SAudioBase
i2s_role_t i2s_role_ {}
 
i2s_slot_mode_t slot_mode_
 
i2s_std_slot_mask_t std_slot_mask_
 
i2s_slot_bit_width_t slot_bit_width_
 
uint32_t sample_rate_
 
bool use_apll_
 
i2s_mclk_multiple_t mclk_multiple_
 
- Protected Attributes inherited from esphome::Parented< I2SAudioComponent >
I2SAudioComponent * parent_
 

Detailed Description

Definition at line 45 of file i2s_audio.h.

Member Function Documentation

◆ build_full_duplex_config()

virtual void esphome::i2s_audio::I2SAudioIn::build_full_duplex_config ( i2s_std_config_t & std_cfg)
pure virtual

Builds the RX configuration the parent uses to set up a full duplex channel pair.

Implemented in esphome::i2s_audio::I2SAudioMicrophone.

◆ full_duplex_rx_enabling()

virtual void esphome::i2s_audio::I2SAudioIn::full_duplex_rx_enabling ( i2s_chan_handle_t rx_handle,
uint32_t dma_desc_num )
pure virtual

Called by the parent on the main loop just before it enables the full duplex RX channel, which clears its receive queue.

The channel is still disabled, so event callbacks can be registered on it.

Implemented in esphome::i2s_audio::I2SAudioMicrophone.


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