#include <i2s_audio.h>

Inheritance diagram for esphome::i2s_audio::I2SAudioComponent:

Public Member Functions
void	setup () override

i2s_pin_config_t	get_pin_config () const

i2s_std_gpio_config_t	get_pin_config () const

void	set_mclk_pin (int pin)

void	set_bclk_pin (int pin)

void	set_lrclk_pin (int pin)

void	lock ()

bool	try_lock ()

void	unlock ()

i2s_port_t	get_port () const

Public Member Functions inherited from esphome::Component
virtual void	loop ()
	This method will be called repeatedly.

virtual void	dump_config ()

virtual float	get_setup_priority () const
	priority of setup().

float	get_actual_setup_priority () const

void	set_setup_priority (float priority)

virtual float	get_loop_priority () const
	priority of loop().

void	call ()

virtual void	on_shutdown ()

virtual void	on_safe_shutdown ()

uint32_t	get_component_state () const

virtual void	mark_failed ()
	Mark this component as failed.

void	mark_failed (const char *message)

bool	is_failed () const

bool	is_ready () const

virtual bool	can_proceed ()

bool	status_has_warning () const

bool	status_has_error () const

void	status_set_warning (const char *message="unspecified")

void	status_set_error (const char *message="unspecified")

void	status_clear_warning ()

void	status_clear_error ()

void	status_momentary_warning (const std::string &name, uint32_t length=5000)

void	status_momentary_error (const std::string &name, uint32_t length=5000)

bool	has_overridden_loop () const

void	set_component_source (const char *source)
	Set where this component was loaded from for some debug messages.

const char *	get_component_source () const
	Get the integration where this component was declared as a string.

bool	should_warn_of_blocking (uint32_t blocking_time)

Protected Attributes
Mutex	lock_

I2SAudioIn *	audio_in_ {nullptr}

I2SAudioOut *	audio_out_ {nullptr}

int	mclk_pin_ {I2S_PIN_NO_CHANGE}

int	bclk_pin_ {I2S_PIN_NO_CHANGE}

int	lrclk_pin_

i2s_port_t	port_ {}

Protected Attributes inherited from esphome::Component
uint32_t	component_state_ {0x0000}
	State of this component.

float	setup_priority_override_ {NAN}

const char *	component_source_ {nullptr}

uint32_t	warn_if_blocking_over_ {WARN_IF_BLOCKING_OVER_MS}

std::string	error_message_ {}

Additional Inherited Members
Protected Member Functions inherited from esphome::Component
virtual void	call_loop ()

virtual void	call_setup ()

virtual void	call_dump_config ()

void	set_interval (const std::string &name, uint32_t interval, std::function< void()> &&f)
	Set an interval function with a unique name.

void	set_interval (uint32_t interval, std::function< void()> &&f)

bool	cancel_interval (const std::string &name)
	Cancel an interval function.

void	set_retry (const std::string &name, uint32_t initial_wait_time, uint8_t max_attempts, std::function< RetryResult(uint8_t)> &&f, float backoff_increase_factor=1.0f)
	Set an retry function with a unique name.

void	set_retry (uint32_t initial_wait_time, uint8_t max_attempts, std::function< RetryResult(uint8_t)> &&f, float backoff_increase_factor=1.0f)

bool	cancel_retry (const std::string &name)
	Cancel a retry function.

void	set_timeout (const std::string &name, uint32_t timeout, std::function< void()> &&f)
	Set a timeout function with a unique name.

void	set_timeout (uint32_t timeout, std::function< void()> &&f)

bool	cancel_timeout (const std::string &name)
	Cancel a timeout function.

void	defer (const std::string &name, std::function< void()> &&f)
	Defer a callback to the next loop() call.

void	defer (std::function< void()> &&f)
	Defer a callback to the next loop() call.

bool	cancel_defer (const std::string &name)
	Cancel a defer callback using the specified name, name must not be empty.

Detailed Description

Definition at line 57 of file i2s_audio.h.

Member Function Documentation

◆ get_pin_config() [1/2]

i2s_pin_config_t esphome::i2s_audio::I2SAudioComponent::get_pin_config ( ) const

inline

Definition at line 62 of file i2s_audio.h.

◆ get_pin_config() [2/2]

i2s_std_gpio_config_t esphome::i2s_audio::I2SAudioComponent::get_pin_config ( ) const

inline

Definition at line 72 of file i2s_audio.h.

◆ get_port()

i2s_port_t esphome::i2s_audio::I2SAudioComponent::get_port ( ) const

inline

Definition at line 94 of file i2s_audio.h.

◆ lock()

void esphome::i2s_audio::I2SAudioComponent::lock ( )

inline

Definition at line 90 of file i2s_audio.h.

◆ set_bclk_pin()

void esphome::i2s_audio::I2SAudioComponent::set_bclk_pin ( int pin )

inline

Definition at line 87 of file i2s_audio.h.

◆ set_lrclk_pin()

void esphome::i2s_audio::I2SAudioComponent::set_lrclk_pin ( int pin )

inline

Definition at line 88 of file i2s_audio.h.

◆ set_mclk_pin()

void esphome::i2s_audio::I2SAudioComponent::set_mclk_pin ( int pin )

inline

Definition at line 86 of file i2s_audio.h.

◆ setup()

void esphome::i2s_audio::I2SAudioComponent::setup ( )

overridevirtual

Reimplemented from esphome::Component.

Definition at line 16 of file i2s_audio.cpp.

◆ try_lock()

bool esphome::i2s_audio::I2SAudioComponent::try_lock ( )

inline

Definition at line 91 of file i2s_audio.h.

◆ unlock()

void esphome::i2s_audio::I2SAudioComponent::unlock ( )

inline

Definition at line 92 of file i2s_audio.h.

Field Documentation

◆ audio_in_

I2SAudioIn* esphome::i2s_audio::I2SAudioComponent::audio_in_ {nullptr}

protected

Definition at line 99 of file i2s_audio.h.

◆ audio_out_

I2SAudioOut* esphome::i2s_audio::I2SAudioComponent::audio_out_ {nullptr}

protected

Definition at line 100 of file i2s_audio.h.

◆ bclk_pin_

int esphome::i2s_audio::I2SAudioComponent::bclk_pin_ {I2S_PIN_NO_CHANGE}

protected

Definition at line 103 of file i2s_audio.h.

◆ lock_

Mutex esphome::i2s_audio::I2SAudioComponent::lock_

protected

Definition at line 97 of file i2s_audio.h.

◆ lrclk_pin_

int esphome::i2s_audio::I2SAudioComponent::lrclk_pin_

protected

Definition at line 108 of file i2s_audio.h.

◆ mclk_pin_

int esphome::i2s_audio::I2SAudioComponent::mclk_pin_ {I2S_PIN_NO_CHANGE}

protected

Definition at line 102 of file i2s_audio.h.

◆ port_

i2s_port_t esphome::i2s_audio::I2SAudioComponent::port_ {}

protected

Definition at line 109 of file i2s_audio.h.

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

esphome/components/i2s_audio/i2s_audio.h
esphome/components/i2s_audio/i2s_audio.cpp

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ get_pin_config() [1/2]

◆ get_pin_config() [2/2]

◆ get_port()

◆ lock()

◆ set_bclk_pin()

◆ set_lrclk_pin()

◆ set_mclk_pin()

◆ setup()

◆ try_lock()

◆ unlock()

Field Documentation

◆ audio_in_

◆ audio_out_

◆ bclk_pin_

◆ lock_

◆ lrclk_pin_

◆ mclk_pin_

◆ port_