#include <i2s_audio_speaker.h>

Inheritance diagram for esphome::i2s_audio::I2SAudioSpeaker:

Public Member Functions
float	get_setup_priority () const override

void	setup () override

void	loop () override

void	set_timeout (uint32_t ms)

void	set_dout_pin (uint8_t pin)

void	set_internal_dac_mode (i2s_dac_mode_t mode)

void	set_i2s_comm_fmt (i2s_comm_format_t mode)

void	start () override

void	stop () override

void	finish () override

size_t	play (const uint8_t *data, size_t length) override

bool	has_buffered_data () const override

Public Member Functions inherited from esphome::i2s_audio::I2SAudioBase
void	set_i2s_mode (i2s_mode_t mode)

void	set_channel (i2s_channel_fmt_t channel)

void	set_sample_rate (uint32_t sample_rate)

void	set_bits_per_sample (i2s_bits_per_sample_t bits_per_sample)

void	set_bits_per_channel (i2s_bits_per_chan_t bits_per_channel)

void	set_use_apll (uint32_t use_apll)

Public Member Functions inherited from esphome::Parented< I2SAudioComponent >
	Parented ()

	Parented (I2SAudioComponent *parent)

I2SAudioComponent *	get_parent () const
	Get the parent of this object. More...

void	set_parent (I2SAudioComponent *parent)
	Set the parent of this object. More...

Public Member Functions inherited from esphome::speaker::Speaker
size_t	play (const std::vector< uint8_t > &data)

bool	is_running () const

bool	is_stopped () const

Public Member Functions inherited from esphome::Component
virtual void	dump_config ()

float	get_actual_setup_priority () const

void	set_setup_priority (float priority)

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

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. More...

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. More...

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

Protected Member Functions
void	start_ ()

void	stop_ (bool wait_on_empty)

void	watch_ ()

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. More...

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

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

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. More...

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. More...

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

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

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

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

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

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

Static Protected Member Functions
static void	player_task (void *params)

Protected Attributes
TaskHandle_t	player_task_handle_ {nullptr}

QueueHandle_t	buffer_queue_

QueueHandle_t	event_queue_

uint32_t	timeout_ {0}

uint8_t	dout_pin_ {0}

bool	task_created_ {false}

i2s_dac_mode_t	internal_dac_mode_ {I2S_DAC_CHANNEL_DISABLE}

i2s_comm_format_t	i2s_comm_fmt_

Protected Attributes inherited from esphome::i2s_audio::I2SAudioBase
i2s_mode_t	i2s_mode_ {}

i2s_channel_fmt_t	channel_

uint32_t	sample_rate_

i2s_bits_per_sample_t	bits_per_sample_

i2s_bits_per_chan_t	bits_per_channel_

bool	use_apll_

Protected Attributes inherited from esphome::Parented< I2SAudioComponent >
I2SAudioComponent *	parent_

Protected Attributes inherited from esphome::speaker::Speaker
State	state_ {STATE_STOPPED}

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

float	setup_priority_override_ {NAN}

const char *	component_source_ {nullptr}

Detailed Description

Definition at line 40 of file i2s_audio_speaker.h.

Member Function Documentation

◆ finish()

void esphome::i2s_audio::I2SAudioSpeaker::finish ( )

overridevirtual

Reimplemented from esphome::speaker::Speaker.

Definition at line 199 of file i2s_audio_speaker.cpp.

◆ get_setup_priority()

float esphome::i2s_audio::I2SAudioSpeaker::get_setup_priority ( ) const

inlineoverridevirtual

Reimplemented from esphome::Component.

Definition at line 42 of file i2s_audio_speaker.h.

◆ has_buffered_data()

bool esphome::i2s_audio::I2SAudioSpeaker::has_buffered_data ( ) const

overridevirtual

Implements esphome::speaker::Speaker.

Definition at line 291 of file i2s_audio_speaker.cpp.

◆ loop()

void esphome::i2s_audio::I2SAudioSpeaker::loop ( )

overridevirtual

Reimplemented from esphome::Component.

Definition at line 252 of file i2s_audio_speaker.cpp.

◆ play()

size_t esphome::i2s_audio::I2SAudioSpeaker::play	(	const uint8_t *	data,
		size_t	length
	)

overridevirtual

Implements esphome::speaker::Speaker.

Definition at line 266 of file i2s_audio_speaker.cpp.

◆ player_task()

void esphome::i2s_audio::I2SAudioSpeaker::player_task ( void * params )

staticprotected

Definition at line 74 of file i2s_audio_speaker.cpp.

◆ set_dout_pin()

void esphome::i2s_audio::I2SAudioSpeaker::set_dout_pin ( uint8_t pin )

inline

Definition at line 48 of file i2s_audio_speaker.h.

◆ set_i2s_comm_fmt()

void esphome::i2s_audio::I2SAudioSpeaker::set_i2s_comm_fmt ( i2s_comm_format_t mode )

inline

Definition at line 52 of file i2s_audio_speaker.h.

◆ set_internal_dac_mode()

void esphome::i2s_audio::I2SAudioSpeaker::set_internal_dac_mode ( i2s_dac_mode_t mode )

inline

Definition at line 50 of file i2s_audio_speaker.h.

◆ set_timeout()

void esphome::i2s_audio::I2SAudioSpeaker::set_timeout ( uint32_t ms )

inline

Definition at line 47 of file i2s_audio_speaker.h.

◆ setup()

void esphome::i2s_audio::I2SAudioSpeaker::setup ( )

overridevirtual

Reimplemented from esphome::Component.

Definition at line 18 of file i2s_audio_speaker.cpp.

◆ start()

void esphome::i2s_audio::I2SAudioSpeaker::start ( )

overridevirtual

Implements esphome::speaker::Speaker.

Definition at line 36 of file i2s_audio_speaker.cpp.

◆ start_()

void esphome::i2s_audio::I2SAudioSpeaker::start_ ( )

protected

Definition at line 47 of file i2s_audio_speaker.cpp.

◆ stop()

void esphome::i2s_audio::I2SAudioSpeaker::stop ( )

overridevirtual

Implements esphome::speaker::Speaker.

Definition at line 197 of file i2s_audio_speaker.cpp.

◆ stop_()

void esphome::i2s_audio::I2SAudioSpeaker::stop_ ( bool wait_on_empty )

protected

Definition at line 201 of file i2s_audio_speaker.cpp.

◆ watch_()

void esphome::i2s_audio::I2SAudioSpeaker::watch_ ( )

protected

Definition at line 220 of file i2s_audio_speaker.cpp.

Field Documentation

◆ buffer_queue_

QueueHandle_t esphome::i2s_audio::I2SAudioSpeaker::buffer_queue_

protected

Definition at line 70 of file i2s_audio_speaker.h.

◆ dout_pin_

uint8_t esphome::i2s_audio::I2SAudioSpeaker::dout_pin_ {0}

protected

Definition at line 74 of file i2s_audio_speaker.h.

◆ event_queue_

QueueHandle_t esphome::i2s_audio::I2SAudioSpeaker::event_queue_

protected

Definition at line 71 of file i2s_audio_speaker.h.

◆ i2s_comm_fmt_

i2s_comm_format_t esphome::i2s_audio::I2SAudioSpeaker::i2s_comm_fmt_

protected

Definition at line 80 of file i2s_audio_speaker.h.

◆ internal_dac_mode_

i2s_dac_mode_t esphome::i2s_audio::I2SAudioSpeaker::internal_dac_mode_ {I2S_DAC_CHANNEL_DISABLE}

protected

Definition at line 78 of file i2s_audio_speaker.h.

◆ player_task_handle_

TaskHandle_t esphome::i2s_audio::I2SAudioSpeaker::player_task_handle_ {nullptr}

protected

Definition at line 69 of file i2s_audio_speaker.h.

◆ task_created_

bool esphome::i2s_audio::I2SAudioSpeaker::task_created_ {false}

protected

Definition at line 75 of file i2s_audio_speaker.h.

◆ timeout_

uint32_t esphome::i2s_audio::I2SAudioSpeaker::timeout_ {0}

protected

Definition at line 73 of file i2s_audio_speaker.h.

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

/opt/build/esphome/esphome/components/i2s_audio/speaker/i2s_audio_speaker.h
/opt/build/esphome/esphome/components/i2s_audio/speaker/i2s_audio_speaker.cpp

Public Member Functions

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Detailed Description

Member Function Documentation

◆ finish()

◆ get_setup_priority()

◆ has_buffered_data()

◆ loop()

◆ play()

◆ player_task()

◆ set_dout_pin()

◆ set_i2s_comm_fmt()

◆ set_internal_dac_mode()

◆ set_timeout()

◆ setup()

◆ start()

◆ start_()

◆ stop()

◆ stop_()

◆ watch_()

Field Documentation

◆ buffer_queue_

◆ dout_pin_

◆ event_queue_

◆ i2s_comm_fmt_

◆ internal_dac_mode_

◆ player_task_handle_

◆ task_created_

◆ timeout_