#include <mixer_speaker.h>

Inheritance diagram for esphome::mixer_speaker::MixerSpeaker:

Public Member Functions
void	dump_config () override

void	setup () override

void	loop () override

void	init_source_speakers (size_t count)

void	add_source_speaker (SourceSpeaker *source_speaker)

esp_err_t	start (audio::AudioStreamInfo &stream_info)
	Starts the mixer task.

void	set_output_channels (uint8_t output_channels)

void	set_output_speaker (speaker::Speaker *speaker)

void	set_queue_mode (bool queue_mode)

void	set_task_stack_in_psram (bool task_stack_in_psram)

speaker::Speaker *	get_output_speaker () const

uint32_t	get_frames_in_pipeline () const
	Returns the current number of frames in the output pipeline (written but not yet played)

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)

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

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.

virtual 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 (const char *message=nullptr)

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

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

const LogString *	get_component_log_str () const
	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_task_ ()
	Starts the mixer task after allocating memory for the task stack.

esp_err_t	delete_task_ ()
	If the task is stopped, it sets the task handle to the nullptr and deallocates its stack.

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

virtual void	call_setup ()

virtual void	call_dump_config ()

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

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)

Static Protected Member Functions
static void	copy_frames (const int16_t input_buffer, audio::AudioStreamInfo input_stream_info, int16_t output_buffer, audio::AudioStreamInfo output_stream_info, uint32_t frames_to_transfer)
	Copies audio frames from the input buffer to the output buffer taking into account the number of channels in each stream.

static void	mix_audio_samples (const int16_t primary_buffer, audio::AudioStreamInfo primary_stream_info, const int16_t secondary_buffer, audio::AudioStreamInfo secondary_stream_info, int16_t *output_buffer, audio::AudioStreamInfo output_stream_info, uint32_t frames_to_mix)
	Mixes the primary and secondary streams taking into account the number of channels in each stream.

static void	audio_mixer_task (void *params)

Protected Attributes
EventGroupHandle_t	event_group_ {nullptr}

FixedVector< SourceSpeaker * >	source_speakers_

speaker::Speaker *	output_speaker_ {nullptr}

uint8_t	output_channels_

bool	queue_mode_

bool	task_stack_in_psram_ {false}

TaskHandle_t	task_handle_ {nullptr}

StaticTask_t	task_stack_

StackType_t *	task_stack_buffer_ {nullptr}

optional< audio::AudioStreamInfo >	audio_stream_info_

std::atomic< uint32_t >	frames_in_pipeline_ {0}

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.

const LogString *	component_source_ {nullptr}

uint16_t	warn_if_blocking_over_ {WARN_IF_BLOCKING_OVER_MS}
	Warn if blocked for this many ms (max 65.5s)

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 Bits 5-7: Unused - reserved for future expansion.

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

Detailed Description

Definition at line 133 of file mixer_speaker.h.

Member Function Documentation

◆ add_source_speaker()

void esphome::mixer_speaker::MixerSpeaker::add_source_speaker ( SourceSpeaker * source_speaker )

inline

Definition at line 140 of file mixer_speaker.h.

◆ audio_mixer_task()

void esphome::mixer_speaker::MixerSpeaker::audio_mixer_task ( void * params )

staticprotected

Definition at line 646 of file mixer_speaker.cpp.

◆ copy_frames()

void esphome::mixer_speaker::MixerSpeaker::copy_frames	(	const int16_t *	input_buffer,
		audio::AudioStreamInfo	input_stream_info,
		int16_t *	output_buffer,
		audio::AudioStreamInfo	output_stream_info,
		uint32_t	frames_to_transfer )

staticprotected

Copies audio frames from the input buffer to the output buffer taking into account the number of channels in each stream.

If the output stream has more channels, the input samples are duplicated. If the output stream has less channels, the extra channel input samples are dropped.

Parameters

input_buffer
input_stream_info
output_buffer
output_stream_info
frames_to_transfer	number of frames (consisting of a sample for each channel) to copy from the input buffer

Definition at line 595 of file mixer_speaker.cpp.

◆ delete_task_()

esp_err_t esphome::mixer_speaker::MixerSpeaker::delete_task_ ( )

protected

If the task is stopped, it sets the task handle to the nullptr and deallocates its stack.

Returns: ESP_OK if the task was stopped, ESP_ERR_INVALID_STATE otherwise.

Definition at line 568 of file mixer_speaker.cpp.

◆ dump_config()

void esphome::mixer_speaker::MixerSpeaker::dump_config ( )

overridevirtual

Reimplemented from esphome::Component.

Definition at line 414 of file mixer_speaker.cpp.

◆ get_frames_in_pipeline()

uint32_t esphome::mixer_speaker::MixerSpeaker::get_frames_in_pipeline ( ) const

inline

Returns the current number of frames in the output pipeline (written but not yet played)

Definition at line 159 of file mixer_speaker.h.

◆ get_output_speaker()

speaker::Speaker * esphome::mixer_speaker::MixerSpeaker::get_output_speaker ( ) const

inline

Definition at line 156 of file mixer_speaker.h.

◆ init_source_speakers()

void esphome::mixer_speaker::MixerSpeaker::init_source_speakers ( size_t count )

inline

Definition at line 139 of file mixer_speaker.h.

◆ loop()

void esphome::mixer_speaker::MixerSpeaker::loop ( )

overridevirtual

Reimplemented from esphome::Component.

Definition at line 435 of file mixer_speaker.cpp.

◆ mix_audio_samples()

void esphome::mixer_speaker::MixerSpeaker::mix_audio_samples	(	const int16_t *	primary_buffer,
		audio::AudioStreamInfo	primary_stream_info,
		const int16_t *	secondary_buffer,
		audio::AudioStreamInfo	secondary_stream_info,
		int16_t *	output_buffer,
		audio::AudioStreamInfo	output_stream_info,
		uint32_t	frames_to_mix )

staticprotected

Mixes the primary and secondary streams taking into account the number of channels in each stream.

Primary and secondary samples are duplicated or dropped as necessary to ensure the output stream has the configured number of channels. Output samples are clamped to the corresponding int16 min or max values if the mixed sample overflows.

Parameters

primary_buffer	samples buffer for the primary stream
primary_stream_info	stream info for the primary stream
secondary_buffer	samples buffer for secondary stream
secondary_stream_info	stream info for the secondary stream
output_buffer	buffer for the mixed samples
output_stream_info	stream info for the output buffer
frames_to_mix	number of frames in the primary and secondary buffers to mix together

Definition at line 618 of file mixer_speaker.cpp.

◆ set_output_channels()

void esphome::mixer_speaker::MixerSpeaker::set_output_channels ( uint8_t output_channels )

inline

Definition at line 151 of file mixer_speaker.h.

◆ set_output_speaker()

void esphome::mixer_speaker::MixerSpeaker::set_output_speaker ( speaker::Speaker * speaker )

inline

Definition at line 152 of file mixer_speaker.h.

◆ set_queue_mode()

void esphome::mixer_speaker::MixerSpeaker::set_queue_mode ( bool queue_mode )

inline

Definition at line 153 of file mixer_speaker.h.

◆ set_task_stack_in_psram()

void esphome::mixer_speaker::MixerSpeaker::set_task_stack_in_psram ( bool task_stack_in_psram )

inline

Definition at line 154 of file mixer_speaker.h.

◆ setup()

void esphome::mixer_speaker::MixerSpeaker::setup ( )

overridevirtual

Reimplemented from esphome::Component.

Definition at line 421 of file mixer_speaker.cpp.

◆ start()

esp_err_t esphome::mixer_speaker::MixerSpeaker::start ( audio::AudioStreamInfo & stream_info )

Starts the mixer task.

Called by a source speaker giving the current audio stream information

Parameters

stream_info The calling source speaker's audio stream information

Returns: ESP_ERR_NOT_SUPPORTED if the incoming stream is incompatible due to unsupported bits per sample ESP_ERR_INVALID_ARG if the incoming stream is incompatible to be mixed with the other input audio stream ESP_ERR_NO_MEM if there isn't enough memory for the task's stack ESP_ERR_INVALID_STATE if the task fails to start ESP_OK if the incoming stream is compatible and the mixer task starts

Definition at line 510 of file mixer_speaker.cpp.

◆ start_task_()

esp_err_t esphome::mixer_speaker::MixerSpeaker::start_task_ ( )

protected

Starts the mixer task after allocating memory for the task stack.

Returns: ESP_ERR_NO_MEM if there isn't enough memory for the task's stack ESP_ERR_INVALID_STATE if the task didn't start ESP_OK if successful

Definition at line 541 of file mixer_speaker.cpp.

Field Documentation

◆ audio_stream_info_

optional<audio::AudioStreamInfo> esphome::mixer_speaker::MixerSpeaker::audio_stream_info_

protected

Definition at line 214 of file mixer_speaker.h.

◆ event_group_

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

protected

Definition at line 201 of file mixer_speaker.h.

◆ frames_in_pipeline_

std::atomic<uint32_t> esphome::mixer_speaker::MixerSpeaker::frames_in_pipeline_ {0}

protected

Definition at line 216 of file mixer_speaker.h.

◆ output_channels_

uint8_t esphome::mixer_speaker::MixerSpeaker::output_channels_

protected

Definition at line 206 of file mixer_speaker.h.

◆ output_speaker_

speaker::Speaker* esphome::mixer_speaker::MixerSpeaker::output_speaker_ {nullptr}

protected

Definition at line 204 of file mixer_speaker.h.

◆ queue_mode_

bool esphome::mixer_speaker::MixerSpeaker::queue_mode_

protected

Definition at line 207 of file mixer_speaker.h.

◆ source_speakers_

FixedVector<SourceSpeaker *> esphome::mixer_speaker::MixerSpeaker::source_speakers_

protected

Definition at line 203 of file mixer_speaker.h.

◆ task_handle_

TaskHandle_t esphome::mixer_speaker::MixerSpeaker::task_handle_ {nullptr}

protected

Definition at line 210 of file mixer_speaker.h.

◆ task_stack_

StaticTask_t esphome::mixer_speaker::MixerSpeaker::task_stack_

protected

Definition at line 211 of file mixer_speaker.h.

◆ task_stack_buffer_

StackType_t* esphome::mixer_speaker::MixerSpeaker::task_stack_buffer_ {nullptr}

protected

Definition at line 212 of file mixer_speaker.h.

◆ task_stack_in_psram_

bool esphome::mixer_speaker::MixerSpeaker::task_stack_in_psram_ {false}

protected

Definition at line 208 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

◆ add_source_speaker()

◆ audio_mixer_task()

◆ copy_frames()

◆ delete_task_()

◆ dump_config()

◆ get_frames_in_pipeline()

◆ get_output_speaker()

◆ init_source_speakers()

◆ loop()

◆ mix_audio_samples()

◆ set_output_channels()

◆ set_output_speaker()

◆ set_queue_mode()

◆ set_task_stack_in_psram()

◆ setup()

◆ start()

◆ start_task_()

Field Documentation

◆ audio_stream_info_

◆ event_group_

◆ frames_in_pipeline_

◆ output_channels_

◆ output_speaker_

◆ queue_mode_

◆ source_speakers_

◆ task_handle_

◆ task_stack_

◆ task_stack_buffer_

◆ task_stack_in_psram_