#include <router_speaker.h>

Inheritance diagram for esphome::router::Router:

Public Member Functions
float	get_setup_priority () const override

void	setup () override

void	loop () override

void	dump_config () override

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

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

void	start () override

void	stop () override

void	finish () override

bool	has_buffered_data () const override

void	set_pause_state (bool pause_state) override

bool	get_pause_state () const override

void	set_volume (float volume) override

float	get_volume () override

void	set_mute_state (bool mute_state) override

bool	get_mute_state () override

void	set_output_count (size_t count)

void	add_output (speaker::Speaker *spk)

bool	switch_to_output (speaker::Speaker *target)
	Switch the active output to the given speaker.

speaker::Speaker *	get_active_output () const

Public Member Functions inherited from esphome::Component
float	get_actual_setup_priority () const

void	set_setup_priority (float priority)

void	call ()

virtual void	on_shutdown ()

virtual void	on_safe_shutdown ()

virtual bool	teardown ()
	Called during teardown to allow component to gracefully finish operations.

virtual void	on_powerdown ()
	Called after teardown is complete to power down hardware.

uint8_t	get_component_state () const

void	reset_to_construction_state ()
	Reset this component back to the construction state to allow setup to run again.

bool	is_in_loop_state () const
	Check if this component has completed setup and is in the loop state.

bool	is_idle () const
	Check if this component is idle.

void	mark_failed ()
	Mark this component as failed.

void	mark_failed (const LogString *message)

void	disable_loop ()
	Disable this component's loop.

void	enable_loop ()
	Enable this component's loop.

void	enable_loop_soon_any_context ()
	Thread and ISR-safe version of enable_loop() that can be called from any context.

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 ()

void	status_set_warning (const char *message)

void	status_set_warning (const LogString *message)

void	status_set_error ()

void	status_set_error (const LogString *message)

void	status_clear_warning ()

void	status_clear_error ()

void	status_momentary_warning (const char *name, uint32_t length=5000)
	Set warning status flag and automatically clear it after a timeout.

void	status_momentary_error (const char *name, uint32_t length=5000)
	Set error status flag and automatically clear it after a timeout.

bool	has_overridden_loop () const

const LogString *	get_component_log_str () const ESPHOME_ALWAYS_INLINE
	Get the integration where this component was declared as a LogString for logging.

bool	should_warn_of_blocking (uint32_t blocking_time)

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

void	set_audio_dac (audio_dac::AudioDac *audio_dac)

void	set_audio_stream_info (const audio::AudioStreamInfo &audio_stream_info)

audio::AudioStreamInfo &	get_audio_stream_info ()

template<typename F >
void	add_audio_output_callback (F &&callback)
	Callback function for sending the duration of the audio written to the speaker since the last callback.

Protected Member Functions
void	apply_cached_state_to_active_ ()

Protected Member Functions inherited from esphome::Component
friend	void::setup ()

friend	void::original_setup ()

void	set_component_source_ (uint8_t index)
	Set where this component was loaded from for some debug messages.

virtual void	call_setup ()

void	call_dump_config_ ()

void	enable_loop_slow_path_ ()

void	set_component_state_ (uint8_t state)
	Helper to set component state (clears state bits and sets new state)

bool	set_status_flag_ (uint8_t flag)
	Helper to set a status LED flag on both this component and the app.

void	set_interval (uint32_t id, uint32_t interval, std::function< void()> &&f)
	Set an interval function with a numeric ID (zero heap allocation).

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

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

bool	cancel_interval (uint32_t id)

bool	cancel_interval (InternalSchedulerID id)

ESPDEPRECATED("set_retry is deprecated and will be removed in 2026.8.0. Use set_timeout or set_interval instead.", "2026.2.0") void set_retry(const std	ESPDEPRECATED ("set_retry is deprecated and will be removed in 2026.8.0. Use set_timeout or set_interval instead.", "2026.2.0") void set_retry(const char *name

	ESPDEPRECATED ("set_retry is deprecated and will be removed in 2026.8.0. Use set_timeout or set_interval instead.", "2026.2.0") void set_retry(uint32_t id

	ESPDEPRECATED ("set_retry is deprecated and will be removed in 2026.8.0. Use set_timeout or set_interval instead.", "2026.2.0") void set_retry(uint32_t initial_wait_time

ESPDEPRECATED("cancel_retry is deprecated and will be removed in 2026.8.0.", "2026.2.0") bool cancel_retry(const std	ESPDEPRECATED ("cancel_retry is deprecated and will be removed in 2026.8.0.", "2026.2.0") bool cancel_retry(const char *name)

	ESPDEPRECATED ("cancel_retry is deprecated and will be removed in 2026.8.0.", "2026.2.0") bool cancel_retry(uint32_t id)

void	set_timeout (uint32_t id, uint32_t timeout, std::function< void()> &&f)
	Set a timeout function with a numeric ID (zero heap allocation).

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

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

bool	cancel_timeout (uint32_t id)

bool	cancel_timeout (InternalSchedulerID id)

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

void	defer (uint32_t id, std::function< void()> &&f)
	Defer a callback with a numeric ID (zero heap allocation)

bool	cancel_defer (uint32_t id)

void	status_clear_warning_slow_path_ ()

void	status_clear_error_slow_path_ ()

Protected Attributes
std::atomic< uint32_t >	frames_in_pipeline_ {0}

bool	cached_pause_ {false}

std::atomic< int8_t >	pending_start_prev_idx_ {-1}

Protected Attributes inherited from esphome::Component
ESPDEPRECATED("Use const char* or uint32_t overload instead. Removed in 2026.7.0", "2026.1.0") void set_interval(const std voi	set_interval )(const char *name, uint32_t interval, std::function< void()> &&f)
	Set an interval function with a unique name.

ESPDEPRECATED("Use const char* or uint32_t overload instead. Removed in 2026.7.0", "2026.1.0") bool cancel_interval(const std boo	cancel_interval )(const char *name)
	Cancel an interval function.

ESPDEPRECATED("set_retry is deprecated and will be removed in 2026.8.0. Use set_timeout or set_interval instead.", "2026.2.0") void set_retry(const std uint32_t	initial_wait_time

ESPDEPRECATED("set_retry is deprecated and will be removed in 2026.8.0. Use set_timeout or set_interval instead.", "2026.2.0") void set_retry(const std uint32_t uint8_t	max_attempts

ESPDEPRECATED("set_retry is deprecated and will be removed in 2026.8.0. Use set_timeout or set_interval instead.", "2026.2.0") void set_retry(const std uint32_t uint8_t std::function< RetryResult(uint8_t)> &&	f

ESPDEPRECATED("set_retry is deprecated and will be removed in 2026.8.0. Use set_timeout or set_interval instead.", "2026.2.0") void set_retry(const std uint32_t uint8_t std::function< RetryResult(uint8_t)> float	backoff_increase_factor = 1.0f)

uint32_t	initial_wait_time

uint32_t uint8_t	max_attempts

uint32_t uint8_t std::function< RetryResult(uint8_t)> &&	f

uint32_t uint8_t std::function< RetryResult(uint8_t)> float	backoff_increase_factor = 1.0f)

uint8_t	max_attempts

uint8_t std::function< RetryResult(uint8_t)> &&	f

uint8_t std::function< RetryResult(uint8_t)> float	backoff_increase_factor = 1.0f)

ESPDEPRECATED("Use const char* or uint32_t overload instead. Removed in 2026.7.0", "2026.1.0") void set_timeout(const std voi	set_timeout )(const char *name, uint32_t timeout, std::function< void()> &&f)
	Set a timeout function with a unique name.

ESPDEPRECATED("Use const char* or uint32_t overload instead. Removed in 2026.7.0", "2026.1.0") bool cancel_timeout(const std boo	cancel_timeout )(const char *name)
	Cancel a timeout function.

ESPDEPRECATED("Use const char* overload instead. Removed in 2026.7.0", "2026.1.0") void defer(const std voi	defer )(const char *name, std::function< void()> &&f)
	Defer a callback to the next loop() call.

ESPDEPRECATED("Use const char* overload instead. Removed in 2026.7.0", "2026.1.0") bool cancel_defer(const std boo	cancel_defer )(const char *name)
	Cancel a defer callback using the specified name, name must not be empty.

uint8_t	component_source_index_ {0}
	Index into component source PROGMEM lookup table (0 = not set)

uint8_t	warn_if_blocking_over_ {WARN_IF_BLOCKING_OVER_CS}
	Warn threshold in centiseconds (max 2550ms)

uint8_t	component_state_ {0x00}
	State of this component - each bit has a purpose: Bits 0-2: Component state (0x00=CONSTRUCTION, 0x01=SETUP, 0x02=LOOP, 0x03=FAILED, 0x04=LOOP_DONE) Bit 3: STATUS_LED_WARNING Bit 4: STATUS_LED_ERROR Bit 5: Has overridden loop() (set at registration time) Bits 6-7: Unused - reserved for future expansion.

volatile bool	pending_enable_loop_ {false}
	ISR-safe flag for enable_loop_soon_any_context.

ComponentRuntimeStats	runtime_stats_

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

audio::AudioStreamInfo	audio_stream_info_

float	volume_ {1.0f}

bool	mute_state_ {false}

audio_dac::AudioDac *	audio_dac_ {nullptr}

CallbackManager< void(uint32_t, int64_t)>	audio_output_callback_ {}

Detailed Description

Definition at line 16 of file router_speaker.h.

Member Function Documentation

◆ add_output()

void esphome::router::Router::add_output ( speaker::Speaker * spk )

inline

Definition at line 44 of file router_speaker.h.

◆ apply_cached_state_to_active_()

void esphome::router::Router::apply_cached_state_to_active_ ( )

protected

Definition at line 226 of file router_speaker.cpp.

◆ dump_config()

void esphome::router::Router::dump_config ( )

overridevirtual

Reimplemented from esphome::Component.

Definition at line 96 of file router_speaker.cpp.

◆ finish()

void esphome::router::Router::finish ( )

overridevirtual

Reimplemented from esphome::speaker::Speaker.

Definition at line 146 of file router_speaker.cpp.

◆ get_active_output()

speaker::Speaker * esphome::router::Router::get_active_output ( ) const

inline

Definition at line 52 of file router_speaker.h.

◆ get_mute_state()

bool esphome::router::Router::get_mute_state ( )

inlineoverridevirtual

Reimplemented from esphome::speaker::Speaker.

Definition at line 40 of file router_speaker.h.

◆ get_pause_state()

bool esphome::router::Router::get_pause_state ( ) const

inlineoverridevirtual

Reimplemented from esphome::speaker::Speaker.

Definition at line 34 of file router_speaker.h.

◆ get_setup_priority()

float esphome::router::Router::get_setup_priority ( ) const

inlineoverridevirtual

Reimplemented from esphome::Component.

Definition at line 18 of file router_speaker.h.

◆ get_volume()

float esphome::router::Router::get_volume ( )

inlineoverridevirtual

Reimplemented from esphome::speaker::Speaker.

Definition at line 37 of file router_speaker.h.

◆ has_buffered_data()

bool esphome::router::Router::has_buffered_data ( ) const

overridevirtual

Implements esphome::speaker::Speaker.

Definition at line 152 of file router_speaker.cpp.

◆ loop()

void esphome::router::Router::loop ( )

overridevirtual

Reimplemented from esphome::Component.

Definition at line 49 of file router_speaker.cpp.

◆ play() [1/2]

size_t esphome::router::Router::play	(	const uint8_t *	data,
		size_t	length )

inlineoverridevirtual

Implements esphome::speaker::Speaker.

Definition at line 24 of file router_speaker.h.

◆ play() [2/2]

size_t esphome::router::Router::play	(	const uint8_t *	data,
		size_t	length,
		TickType_t	ticks_to_wait )

override

Definition at line 103 of file router_speaker.cpp.

◆ set_mute_state()

void esphome::router::Router::set_mute_state ( bool mute_state )

overridevirtual

Reimplemented from esphome::speaker::Speaker.

Definition at line 164 of file router_speaker.cpp.

◆ set_output_count()

void esphome::router::Router::set_output_count ( size_t count )

inline

Definition at line 43 of file router_speaker.h.

◆ set_pause_state()

void esphome::router::Router::set_pause_state ( bool pause_state )

overridevirtual

Reimplemented from esphome::speaker::Speaker.

Definition at line 154 of file router_speaker.cpp.

◆ set_volume()

void esphome::router::Router::set_volume ( float volume )

overridevirtual

Reimplemented from esphome::speaker::Speaker.

Definition at line 159 of file router_speaker.cpp.

◆ setup()

void esphome::router::Router::setup ( )

overridevirtual

Reimplemented from esphome::Component.

Definition at line 28 of file router_speaker.cpp.

◆ start()

void esphome::router::Router::start ( )

overridevirtual

Implements esphome::speaker::Speaker.

Definition at line 132 of file router_speaker.cpp.

◆ stop()

void esphome::router::Router::stop ( )

overridevirtual

Implements esphome::speaker::Speaker.

Definition at line 139 of file router_speaker.cpp.

◆ switch_to_output()

bool esphome::router::Router::switch_to_output ( speaker::Speaker * target )

Switch the active output to the given speaker.

Must be one of the configured outputs. Returns false if target is not in the output list.

Definition at line 169 of file router_speaker.cpp.

Field Documentation

◆ cached_pause_

bool esphome::router::Router::cached_pause_ {false}

protected

Definition at line 62 of file router_speaker.h.

◆ frames_in_pipeline_

std::atomic<uint32_t> esphome::router::Router::frames_in_pipeline_ {0}

protected

Definition at line 60 of file router_speaker.h.

◆ pending_start_prev_idx_

std::atomic<int8_t> esphome::router::Router::pending_start_prev_idx_ {-1}

protected

Definition at line 71 of file router_speaker.h.

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

esphome/components/router/speaker/router_speaker.h
esphome/components/router/speaker/router_speaker.cpp

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Function Documentation

◆ add_output()

◆ apply_cached_state_to_active_()

◆ dump_config()

◆ finish()

◆ get_active_output()

◆ get_mute_state()

◆ get_pause_state()

◆ get_setup_priority()

◆ get_volume()

◆ has_buffered_data()

◆ loop()

◆ play() [1/2]

◆ play() [2/2]

◆ set_mute_state()

◆ set_output_count()

◆ set_pause_state()

◆ set_volume()

◆ setup()

◆ start()

◆ stop()

◆ switch_to_output()

Field Documentation

◆ cached_pause_

◆ frames_in_pipeline_

◆ pending_start_prev_idx_