#include <mixer_speaker.h>

Inheritance diagram for esphome::mixer_speaker::SourceSpeaker:

Public Member Functions
void	dump_config () override

void	setup () override

void	loop () override

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

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

void	start () override

void	stop () override

void	finish () override

bool	has_buffered_data () const override

void	set_mute_state (bool mute_state) override
	Mute state changes are passed to the parent's output speaker.

bool	get_mute_state () override

void	set_volume (float volume) override
	Volume state changes are passed to the parent's output speaker.

float	get_volume () override

void	set_pause_state (bool pause_state) override

bool	get_pause_state () const override

size_t	process_data_from_source (std::shared_ptr< audio::AudioSourceTransferBuffer > &transfer_buffer, TickType_t ticks_to_wait)
	Transfers audio from the ring buffer into the transfer buffer.

void	apply_ducking (uint8_t decibel_reduction, uint32_t duration)
	Sets the ducking level for the source speaker.

void	set_buffer_duration (uint32_t buffer_duration_ms)

void	set_parent (MixerSpeaker *parent)

void	set_timeout (uint32_t ms)

std::weak_ptr< audio::AudioSourceTransferBuffer >	get_transfer_buffer ()

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.

Public Member Functions inherited from esphome::Component
virtual float	get_setup_priority () const
	priority of setup().

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.

	ESPDEPRECATED ("Use mark_failed(LOG_STR(\"static string literal\")) instead. Do NOT use .c_str() from temporary " "strings. Will stop working in 2026.6.0", "2025.12.0") void mark_failed(const char *message)

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

	ESPDEPRECATED ("Use status_set_error(LOG_STR(\"static string literal\")) instead. Do NOT use .c_str() from temporary " "strings. Will stop working in 2026.6.0", "2025.12.0") void status_set_error(const char *message)

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)

Protected Member Functions
esp_err_t	start_ ()

void	enter_stopping_state_ ()

void	send_command_ (uint32_t command_bit, bool wake_loop=false)

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

Static Protected Member Functions
static void	duck_samples (int16_t input_buffer, uint32_t input_samples_to_duck, int8_t current_ducking_db_reduction, uint32_t *ducking_transition_samples_remaining, uint32_t samples_per_ducking_step, int8_t db_change_per_ducking_step)
	Ducks audio samples by a specified amount.

Protected Attributes
MixerSpeaker *	parent_

std::shared_ptr< audio::AudioSourceTransferBuffer >	transfer_buffer_

std::weak_ptr< RingBuffer >	ring_buffer_

uint32_t	buffer_duration_ms_

uint32_t	last_seen_data_ms_ {0}

optional< uint32_t >	timeout_ms_

bool	stop_gracefully_ {false}

bool	pause_state_ {false}

int8_t	target_ducking_db_reduction_ {0}

int8_t	current_ducking_db_reduction_ {0}

int8_t	db_change_per_ducking_step_ {1}

uint32_t	ducking_transition_samples_remaining_ {0}

uint32_t	samples_per_ducking_step_ {0}

std::atomic< uint32_t >	pending_playback_frames_ {0}

std::atomic< uint32_t >	playback_delay_frames_ {0}

std::atomic< bool >	has_contributed_ {false}

EventGroupHandle_t	event_group_ {nullptr}

uint32_t	stopping_start_ms_ {0}

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_ {}

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_

Detailed Description

Definition at line 43 of file mixer_speaker.h.

Member Function Documentation

◆ apply_ducking()

void esphome::mixer_speaker::SourceSpeaker::apply_ducking	(	uint8_t	decibel_reduction,
		uint32_t	duration )

Sets the ducking level for the source speaker.

Parameters

decibel_reduction	The dB reduction level. For example, 0 is no change, 10 is a reduction by 10 dB
duration	The number of milliseconds to transition from the current level to the new level

Definition at line 323 of file mixer_speaker.cpp.

◆ duck_samples()

void esphome::mixer_speaker::SourceSpeaker::duck_samples	(	int16_t *	input_buffer,
		uint32_t	input_samples_to_duck,
		int8_t *	current_ducking_db_reduction,
		uint32_t *	ducking_transition_samples_remaining,
		uint32_t	samples_per_ducking_step,
		int8_t	db_change_per_ducking_step )

staticprotected

Ducks audio samples by a specified amount.

When changing the ducking amount, it can transition gradually over a specified amount of samples.

Parameters

input_buffer	buffer with audio samples to be ducked in place
input_samples_to_duck	number of samples to process in `input_buffer`
current_ducking_db_reduction	pointer to the current dB reduction
ducking_transition_samples_remaining	pointer to the total number of samples left before the transition is finished
samples_per_ducking_step	total number of samples per ducking step for the transition
db_change_per_ducking_step	the change in dB reduction per step

Definition at line 357 of file mixer_speaker.cpp.

◆ dump_config()

void esphome::mixer_speaker::SourceSpeaker::dump_config ( )

overridevirtual

Reimplemented from esphome::Component.

Definition at line 80 of file mixer_speaker.cpp.

◆ enter_stopping_state_()

void esphome::mixer_speaker::SourceSpeaker::enter_stopping_state_ ( )

protected

Definition at line 406 of file mixer_speaker.cpp.

◆ finish()

void esphome::mixer_speaker::SourceSpeaker::finish ( )

overridevirtual

Reimplemented from esphome::speaker::Speaker.

Definition at line 284 of file mixer_speaker.cpp.

◆ get_mute_state()

bool esphome::mixer_speaker::SourceSpeaker::get_mute_state ( )

overridevirtual

Reimplemented from esphome::speaker::Speaker.

Definition at line 295 of file mixer_speaker.cpp.

◆ get_pause_state()

bool esphome::mixer_speaker::SourceSpeaker::get_pause_state ( ) const

inlineoverridevirtual

Reimplemented from esphome::speaker::Speaker.

Definition at line 67 of file mixer_speaker.h.

◆ get_transfer_buffer()

std::weak_ptr< audio::AudioSourceTransferBuffer > esphome::mixer_speaker::SourceSpeaker::get_transfer_buffer ( )

inline

Definition at line 85 of file mixer_speaker.h.

◆ get_volume()

float esphome::mixer_speaker::SourceSpeaker::get_volume ( )

overridevirtual

Reimplemented from esphome::speaker::Speaker.

Definition at line 302 of file mixer_speaker.cpp.

◆ has_buffered_data()

bool esphome::mixer_speaker::SourceSpeaker::has_buffered_data ( ) const

overridevirtual

Implements esphome::speaker::Speaker.

Definition at line 286 of file mixer_speaker.cpp.

◆ loop()

void esphome::mixer_speaker::SourceSpeaker::loop ( )

overridevirtual

Reimplemented from esphome::Component.

Definition at line 115 of file mixer_speaker.cpp.

◆ play() [1/2]

size_t esphome::mixer_speaker::SourceSpeaker::play	(	const uint8_t *	data,
		size_t	length )

inlineoverridevirtual

Implements esphome::speaker::Speaker.

Definition at line 50 of file mixer_speaker.h.

◆ play() [2/2]

size_t esphome::mixer_speaker::SourceSpeaker::play	(	const uint8_t *	data,
		size_t	length,
		TickType_t	ticks_to_wait )

override

Definition at line 224 of file mixer_speaker.cpp.

◆ process_data_from_source()

size_t esphome::mixer_speaker::SourceSpeaker::process_data_from_source	(	std::shared_ptr< audio::AudioSourceTransferBuffer > &	transfer_buffer,
		TickType_t	ticks_to_wait )

Transfers audio from the ring buffer into the transfer buffer.

Ducks audio while transferring.

Parameters

transfer_buffer	Locked shared_ptr to the transfer buffer (must be valid, not null)
ticks_to_wait	FreeRTOS ticks to wait while waiting to read from the ring buffer.

Returns: Number of bytes transferred from the ring buffer.

Definition at line 304 of file mixer_speaker.cpp.

◆ send_command_()

void esphome::mixer_speaker::SourceSpeaker::send_command_	(	uint32_t	command_bit,
		bool	wake_loop = false )

protected

Definition at line 243 of file mixer_speaker.cpp.

◆ set_buffer_duration()

void esphome::mixer_speaker::SourceSpeaker::set_buffer_duration ( uint32_t buffer_duration_ms )

inline

Definition at line 81 of file mixer_speaker.h.

◆ set_mute_state()

void esphome::mixer_speaker::SourceSpeaker::set_mute_state ( bool mute_state )

overridevirtual

Mute state changes are passed to the parent's output speaker.

Reimplemented from esphome::speaker::Speaker.

Definition at line 290 of file mixer_speaker.cpp.

◆ set_parent()

void esphome::mixer_speaker::SourceSpeaker::set_parent ( MixerSpeaker * parent )

inline

Definition at line 82 of file mixer_speaker.h.

◆ set_pause_state()

void esphome::mixer_speaker::SourceSpeaker::set_pause_state ( bool pause_state )

inlineoverridevirtual

Reimplemented from esphome::speaker::Speaker.

Definition at line 66 of file mixer_speaker.h.

◆ set_timeout()

void esphome::mixer_speaker::SourceSpeaker::set_timeout ( uint32_t ms )

inline

Definition at line 83 of file mixer_speaker.h.

◆ set_volume()

void esphome::mixer_speaker::SourceSpeaker::set_volume ( float volume )

overridevirtual

Volume state changes are passed to the parent's output speaker.

Reimplemented from esphome::speaker::Speaker.

Definition at line 297 of file mixer_speaker.cpp.

◆ setup()

void esphome::mixer_speaker::SourceSpeaker::setup ( )

overridevirtual

Reimplemented from esphome::Component.

Definition at line 92 of file mixer_speaker.cpp.

◆ start()

void esphome::mixer_speaker::SourceSpeaker::start ( )

overridevirtual

Implements esphome::speaker::Speaker.

Definition at line 254 of file mixer_speaker.cpp.

◆ start_()

esp_err_t esphome::mixer_speaker::SourceSpeaker::start_ ( )

protected

Definition at line 256 of file mixer_speaker.cpp.

◆ stop()

void esphome::mixer_speaker::SourceSpeaker::stop ( )

overridevirtual

Implements esphome::speaker::Speaker.

Definition at line 282 of file mixer_speaker.cpp.

Field Documentation

◆ buffer_duration_ms_

uint32_t esphome::mixer_speaker::SourceSpeaker::buffer_duration_ms_

protected

Definition at line 111 of file mixer_speaker.h.

◆ current_ducking_db_reduction_

int8_t esphome::mixer_speaker::SourceSpeaker::current_ducking_db_reduction_ {0}

protected

Definition at line 119 of file mixer_speaker.h.

◆ db_change_per_ducking_step_

int8_t esphome::mixer_speaker::SourceSpeaker::db_change_per_ducking_step_ {1}

protected

Definition at line 120 of file mixer_speaker.h.

◆ ducking_transition_samples_remaining_

uint32_t esphome::mixer_speaker::SourceSpeaker::ducking_transition_samples_remaining_ {0}

protected

Definition at line 121 of file mixer_speaker.h.

◆ event_group_

EventGroupHandle_t esphome::mixer_speaker::SourceSpeaker::event_group_ {nullptr}

protected

Definition at line 128 of file mixer_speaker.h.

◆ has_contributed_

std::atomic<bool> esphome::mixer_speaker::SourceSpeaker::has_contributed_ {false}

protected

Definition at line 126 of file mixer_speaker.h.

◆ last_seen_data_ms_

uint32_t esphome::mixer_speaker::SourceSpeaker::last_seen_data_ms_ {0}

protected

Definition at line 112 of file mixer_speaker.h.

◆ parent_

MixerSpeaker* esphome::mixer_speaker::SourceSpeaker::parent_

protected

Definition at line 106 of file mixer_speaker.h.

◆ pause_state_

bool esphome::mixer_speaker::SourceSpeaker::pause_state_ {false}

protected

Definition at line 116 of file mixer_speaker.h.

◆ pending_playback_frames_

std::atomic<uint32_t> esphome::mixer_speaker::SourceSpeaker::pending_playback_frames_ {0}

protected

Definition at line 124 of file mixer_speaker.h.

◆ playback_delay_frames_

std::atomic<uint32_t> esphome::mixer_speaker::SourceSpeaker::playback_delay_frames_ {0}

protected

Definition at line 125 of file mixer_speaker.h.

◆ ring_buffer_

std::weak_ptr<RingBuffer> esphome::mixer_speaker::SourceSpeaker::ring_buffer_

protected

Definition at line 109 of file mixer_speaker.h.

◆ samples_per_ducking_step_

uint32_t esphome::mixer_speaker::SourceSpeaker::samples_per_ducking_step_ {0}

protected

Definition at line 122 of file mixer_speaker.h.

◆ stop_gracefully_

bool esphome::mixer_speaker::SourceSpeaker::stop_gracefully_ {false}

protected

Definition at line 114 of file mixer_speaker.h.

◆ stopping_start_ms_

uint32_t esphome::mixer_speaker::SourceSpeaker::stopping_start_ms_ {0}

protected

Definition at line 129 of file mixer_speaker.h.

◆ target_ducking_db_reduction_

int8_t esphome::mixer_speaker::SourceSpeaker::target_ducking_db_reduction_ {0}

protected

Definition at line 118 of file mixer_speaker.h.

◆ timeout_ms_

optional<uint32_t> esphome::mixer_speaker::SourceSpeaker::timeout_ms_

protected

Definition at line 113 of file mixer_speaker.h.

◆ transfer_buffer_

std::shared_ptr<audio::AudioSourceTransferBuffer> esphome::mixer_speaker::SourceSpeaker::transfer_buffer_

protected

Definition at line 108 of file mixer_speaker.h.

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

esphome/components/mixer/speaker/mixer_speaker.h
esphome/components/mixer/speaker/mixer_speaker.cpp

Public Member Functions

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Detailed Description

Member Function Documentation

◆ apply_ducking()

◆ duck_samples()

◆ dump_config()

◆ enter_stopping_state_()

◆ finish()

◆ get_mute_state()

◆ get_pause_state()

◆ get_transfer_buffer()

◆ get_volume()

◆ has_buffered_data()

◆ loop()

◆ play() [1/2]

◆ play() [2/2]

◆ process_data_from_source()

◆ send_command_()

◆ set_buffer_duration()

◆ set_mute_state()

◆ set_parent()

◆ set_pause_state()

◆ set_timeout()

◆ set_volume()

◆ setup()

◆ start()

◆ start_()

◆ stop()

Field Documentation

◆ buffer_duration_ms_

◆ current_ducking_db_reduction_

◆ db_change_per_ducking_step_

◆ ducking_transition_samples_remaining_

◆ event_group_

◆ has_contributed_

◆ last_seen_data_ms_

◆ parent_

◆ pause_state_

◆ pending_playback_frames_

◆ playback_delay_frames_

◆ ring_buffer_

◆ samples_per_ducking_step_

◆ stop_gracefully_

◆ stopping_start_ms_

◆ target_ducking_db_reduction_

◆ timeout_ms_

◆ transfer_buffer_