#include <speaker_media_player.h>

Inheritance diagram for esphome::speaker::SpeakerMediaPlayer:

Public Member Functions
float	get_setup_priority () const override

void	setup () override

void	loop () override

media_player::MediaPlayerTraits	get_traits () override

bool	is_muted () const override

void	set_buffer_size (size_t buffer_size)

void	set_task_stack_in_psram (bool task_stack_in_psram)

void	set_volume_increment (float volume_increment)

void	set_volume_initial (float volume_initial)

void	set_volume_max (float volume_max)

void	set_volume_min (float volume_min)

void	set_announcement_speaker (Speaker *announcement_speaker)

void	set_announcement_format (const media_player::MediaPlayerSupportedFormat &announcement_format)

void	set_media_speaker (Speaker *media_speaker)

void	set_media_format (const media_player::MediaPlayerSupportedFormat &media_format)

Trigger *	get_mute_trigger () const

Trigger *	get_unmute_trigger () const

Trigger< float > *	get_volume_trigger () const

void	play_file (audio::AudioFile *media_file, bool announcement, bool enqueue)

void	set_playlist_delay_ms (AudioPipelineType pipeline_type, uint32_t delay_ms)

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

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.

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

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

Public Member Functions inherited from esphome::media_player::MediaPlayer
MediaPlayerCall	make_call ()

void	publish_state ()

void	add_on_state_callback (std::function< void()> &&callback)

Public Member Functions inherited from esphome::EntityBase
const StringRef &	get_name () const

void	set_name (const char *name)

bool	has_own_name () const

std::string	get_object_id () const

void	set_object_id (const char *object_id)

uint32_t	get_object_id_hash ()

bool	is_internal () const

void	set_internal (bool internal)

bool	is_disabled_by_default () const

void	set_disabled_by_default (bool disabled_by_default)

EntityCategory	get_entity_category () const

void	set_entity_category (EntityCategory entity_category)

ESPDEPRECATED("Use get_icon_ref() instead for better performance (avoids string copy). Will be removed in ESPHome 2026.5.0", "2025.11.0") std void	set_icon (const char *icon)

StringRef	get_icon_ref () const

uint32_t	get_device_id () const

void	set_device (Device *device)

bool	has_state () const

void	set_has_state (bool state)

uint32_t	get_preference_hash ()
	Get a unique hash for storing preferences/settings for this entity.

Protected Member Functions
void	control (const media_player::MediaPlayerCall &call) override

void	set_volume_ (float volume, bool publish=true)
	Updates this->volume and saves volume/mute state to flash for restortation if publish is true.

void	set_mute_state_ (bool mute_state)
	Sets the mute state.

void	save_volume_restore_state_ ()
	Saves the current volume and mute state to the flash for restoration.

bool	single_pipeline_ ()
	Returns true if the media player has only the announcement pipeline defined, false if both the announcement and media pipelines are defined.

void	watch_media_commands_ ()

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 (const std::string &name, uint32_t interval, std::function< void()> &&f)
	Set an interval function with a unique name.

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

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

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

bool	cancel_interval (const char *name)

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 (const char *name, uint32_t timeout, std::function< void()> &&f)
	Set a timeout function with a const char* name.

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

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

bool	cancel_timeout (const char *name)

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

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

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.

Protected Member Functions inherited from esphome::media_player::MediaPlayer
Protected Member Functions inherited from esphome::EntityBase
StringRef	get_object_id_ref_for_api_ () const

void	calc_object_id_ ()

bool	is_object_id_dynamic_ () const
	Check if the object_id is dynamic (changes with MAC suffix)

Protected Attributes
std::unique_ptr< AudioPipeline >	announcement_pipeline_

std::unique_ptr< AudioPipeline >	media_pipeline_

Speaker *	media_speaker_ {nullptr}

Speaker *	announcement_speaker_ {nullptr}

optional< media_player::MediaPlayerSupportedFormat >	media_format_

AudioPipelineState	media_pipeline_state_ {AudioPipelineState::STOPPED}

bool	media_repeat_one_ {false}

uint32_t	media_playlist_delay_ms_ {0}

optional< media_player::MediaPlayerSupportedFormat >	announcement_format_

AudioPipelineState	announcement_pipeline_state_ {AudioPipelineState::STOPPED}

bool	announcement_repeat_one_ {false}

uint32_t	announcement_playlist_delay_ms_ {0}

QueueHandle_t	media_control_command_queue_

std::deque< PlaylistItem >	announcement_playlist_

std::deque< PlaylistItem >	media_playlist_

size_t	buffer_size_

bool	task_stack_in_psram_

bool	is_paused_ {false}

bool	is_muted_ {false}

float	volume_increment_

float	volume_initial_

float	volume_max_

float	volume_min_

ESPPreferenceObject	pref_

Trigger *	mute_trigger_ = new Trigger<>()

Trigger *	unmute_trigger_ = new Trigger<>()

Trigger< float > *	volume_trigger_ = new Trigger<float>()

Protected Attributes inherited from esphome::Component
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.

Protected Attributes inherited from esphome::media_player::MediaPlayer
friend	MediaPlayerCall

CallbackManager< void()>	state_callback_ {}

Protected Attributes inherited from esphome::EntityBase
StringRef	name_

const char *	object_id_c_str_ {nullptr}

const char *	icon_c_str_ {nullptr}

uint32_t	object_id_hash_ {}

Device *	device_ {}

struct esphome::EntityBase::EntityFlags	flags_

Additional Inherited Members
Data Fields inherited from esphome::media_player::MediaPlayer
MediaPlayerState	state {MEDIA_PLAYER_STATE_NONE}

float	volume {1.0f}

Detailed Description

Definition at line 42 of file speaker_media_player.h.

Member Function Documentation

◆ control()

void esphome::speaker::SpeakerMediaPlayer::control ( const media_player::MediaPlayerCall & call )

overrideprotectedvirtual

Implements esphome::media_player::MediaPlayer.

Definition at line 428 of file speaker_media_player.cpp.

◆ get_mute_trigger()

Trigger * esphome::speaker::SpeakerMediaPlayer::get_mute_trigger ( ) const

inline

Definition at line 73 of file speaker_media_player.h.

◆ get_setup_priority()

float esphome::speaker::SpeakerMediaPlayer::get_setup_priority ( ) const

inlineoverridevirtual

Reimplemented from esphome::Component.

Definition at line 44 of file speaker_media_player.h.

◆ get_traits()

media_player::MediaPlayerTraits esphome::speaker::SpeakerMediaPlayer::get_traits ( )

overridevirtual

Implements esphome::media_player::MediaPlayer.

Definition at line 475 of file speaker_media_player.cpp.

◆ get_unmute_trigger()

Trigger * esphome::speaker::SpeakerMediaPlayer::get_unmute_trigger ( ) const

inline

Definition at line 74 of file speaker_media_player.h.

◆ get_volume_trigger()

Trigger< float > * esphome::speaker::SpeakerMediaPlayer::get_volume_trigger ( ) const

inline

Definition at line 75 of file speaker_media_player.h.

◆ is_muted()

bool esphome::speaker::SpeakerMediaPlayer::is_muted ( ) const

inlineoverridevirtual

Reimplemented from esphome::media_player::MediaPlayer.

Definition at line 50 of file speaker_media_player.h.

◆ loop()

void esphome::speaker::SpeakerMediaPlayer::loop ( )

overridevirtual

Reimplemented from esphome::Component.

Definition at line 303 of file speaker_media_player.cpp.

◆ play_file()

void esphome::speaker::SpeakerMediaPlayer::play_file	(	audio::AudioFile *	media_file,
		bool	announcement,
		bool	enqueue )

Definition at line 410 of file speaker_media_player.cpp.

◆ save_volume_restore_state_()

void esphome::speaker::SpeakerMediaPlayer::save_volume_restore_state_ ( )

protected

Saves the current volume and mute state to the flash for restoration.

Definition at line 496 of file speaker_media_player.cpp.

◆ set_announcement_format()

void esphome::speaker::SpeakerMediaPlayer::set_announcement_format ( const media_player::MediaPlayerSupportedFormat & announcement_format )

inline

Definition at line 65 of file speaker_media_player.h.

◆ set_announcement_speaker()

void esphome::speaker::SpeakerMediaPlayer::set_announcement_speaker ( Speaker * announcement_speaker )

inline

Definition at line 64 of file speaker_media_player.h.

◆ set_buffer_size()

void esphome::speaker::SpeakerMediaPlayer::set_buffer_size ( size_t buffer_size )

inline

Definition at line 52 of file speaker_media_player.h.

◆ set_media_format()

void esphome::speaker::SpeakerMediaPlayer::set_media_format ( const media_player::MediaPlayerSupportedFormat & media_format )

inline

Definition at line 69 of file speaker_media_player.h.

◆ set_media_speaker()

void esphome::speaker::SpeakerMediaPlayer::set_media_speaker ( Speaker * media_speaker )

inline

Definition at line 68 of file speaker_media_player.h.

◆ set_mute_state_()

void esphome::speaker::SpeakerMediaPlayer::set_mute_state_ ( bool mute_state )

protected

Sets the mute state.

Restores previous volume if unmuting. Always saves volume/mute state to flash for restoration.

Parameters

mute_state If true, audio will be muted. If false, audio will be unmuted

Definition at line 503 of file speaker_media_player.cpp.

◆ set_playlist_delay_ms()

void esphome::speaker::SpeakerMediaPlayer::set_playlist_delay_ms	(	AudioPipelineType	pipeline_type,
		uint32_t	delay_ms )

Definition at line 112 of file speaker_media_player.cpp.

◆ set_task_stack_in_psram()

void esphome::speaker::SpeakerMediaPlayer::set_task_stack_in_psram ( bool task_stack_in_psram )

inline

Definition at line 53 of file speaker_media_player.h.

◆ set_volume_()

void esphome::speaker::SpeakerMediaPlayer::set_volume_	(	float	volume,
		bool	publish = true )

protected

Updates this->volume and saves volume/mute state to flash for restortation if publish is true.

Definition at line 525 of file speaker_media_player.cpp.

◆ set_volume_increment()

void esphome::speaker::SpeakerMediaPlayer::set_volume_increment ( float volume_increment )

inline

Definition at line 56 of file speaker_media_player.h.

◆ set_volume_initial()

void esphome::speaker::SpeakerMediaPlayer::set_volume_initial ( float volume_initial )

inline

Definition at line 59 of file speaker_media_player.h.

◆ set_volume_max()

void esphome::speaker::SpeakerMediaPlayer::set_volume_max ( float volume_max )

inline

Definition at line 61 of file speaker_media_player.h.

◆ set_volume_min()

void esphome::speaker::SpeakerMediaPlayer::set_volume_min ( float volume_min )

inline

Definition at line 62 of file speaker_media_player.h.

◆ setup()

void esphome::speaker::SpeakerMediaPlayer::setup ( )

overridevirtual

Reimplemented from esphome::Component.

Definition at line 53 of file speaker_media_player.cpp.

◆ single_pipeline_()

bool esphome::speaker::SpeakerMediaPlayer::single_pipeline_ ( )

inlineprotected

Returns true if the media player has only the announcement pipeline defined, false if both the announcement and media pipelines are defined.

Definition at line 99 of file speaker_media_player.h.

◆ watch_media_commands_()

void esphome::speaker::SpeakerMediaPlayer::watch_media_commands_ ( )

protected

Definition at line 123 of file speaker_media_player.cpp.

Field Documentation

◆ announcement_format_

optional<media_player::MediaPlayerSupportedFormat> esphome::speaker::SpeakerMediaPlayer::announcement_format_

protected

Definition at line 114 of file speaker_media_player.h.

◆ announcement_pipeline_

std::unique_ptr<AudioPipeline> esphome::speaker::SpeakerMediaPlayer::announcement_pipeline_

protected

Definition at line 104 of file speaker_media_player.h.

◆ announcement_pipeline_state_

AudioPipelineState esphome::speaker::SpeakerMediaPlayer::announcement_pipeline_state_ {AudioPipelineState::STOPPED}

protected

Definition at line 115 of file speaker_media_player.h.

◆ announcement_playlist_

std::deque<PlaylistItem> esphome::speaker::SpeakerMediaPlayer::announcement_playlist_

protected

Definition at line 121 of file speaker_media_player.h.

◆ announcement_playlist_delay_ms_

uint32_t esphome::speaker::SpeakerMediaPlayer::announcement_playlist_delay_ms_ {0}

protected

Definition at line 117 of file speaker_media_player.h.

◆ announcement_repeat_one_

bool esphome::speaker::SpeakerMediaPlayer::announcement_repeat_one_ {false}

protected

Definition at line 116 of file speaker_media_player.h.

◆ announcement_speaker_

Speaker* esphome::speaker::SpeakerMediaPlayer::announcement_speaker_ {nullptr}

protected

Definition at line 107 of file speaker_media_player.h.

◆ buffer_size_

size_t esphome::speaker::SpeakerMediaPlayer::buffer_size_

protected

Definition at line 124 of file speaker_media_player.h.

◆ is_muted_

bool esphome::speaker::SpeakerMediaPlayer::is_muted_ {false}

protected

Definition at line 129 of file speaker_media_player.h.

◆ is_paused_

bool esphome::speaker::SpeakerMediaPlayer::is_paused_ {false}

protected

Definition at line 128 of file speaker_media_player.h.

◆ media_control_command_queue_

QueueHandle_t esphome::speaker::SpeakerMediaPlayer::media_control_command_queue_

protected

Definition at line 119 of file speaker_media_player.h.

◆ media_format_

optional<media_player::MediaPlayerSupportedFormat> esphome::speaker::SpeakerMediaPlayer::media_format_

protected

Definition at line 109 of file speaker_media_player.h.

◆ media_pipeline_

std::unique_ptr<AudioPipeline> esphome::speaker::SpeakerMediaPlayer::media_pipeline_

protected

Definition at line 105 of file speaker_media_player.h.

◆ media_pipeline_state_

AudioPipelineState esphome::speaker::SpeakerMediaPlayer::media_pipeline_state_ {AudioPipelineState::STOPPED}

protected

Definition at line 110 of file speaker_media_player.h.

◆ media_playlist_

std::deque<PlaylistItem> esphome::speaker::SpeakerMediaPlayer::media_playlist_

protected

Definition at line 122 of file speaker_media_player.h.

◆ media_playlist_delay_ms_

uint32_t esphome::speaker::SpeakerMediaPlayer::media_playlist_delay_ms_ {0}

protected

Definition at line 112 of file speaker_media_player.h.

◆ media_repeat_one_

bool esphome::speaker::SpeakerMediaPlayer::media_repeat_one_ {false}

protected

Definition at line 111 of file speaker_media_player.h.

◆ media_speaker_

Speaker* esphome::speaker::SpeakerMediaPlayer::media_speaker_ {nullptr}

protected

Definition at line 106 of file speaker_media_player.h.

◆ mute_trigger_

Trigger* esphome::speaker::SpeakerMediaPlayer::mute_trigger_ = new Trigger<>()

protected

Definition at line 143 of file speaker_media_player.h.

◆ pref_

ESPPreferenceObject esphome::speaker::SpeakerMediaPlayer::pref_

protected

Definition at line 141 of file speaker_media_player.h.

◆ task_stack_in_psram_

bool esphome::speaker::SpeakerMediaPlayer::task_stack_in_psram_

protected

Definition at line 126 of file speaker_media_player.h.

◆ unmute_trigger_

Trigger* esphome::speaker::SpeakerMediaPlayer::unmute_trigger_ = new Trigger<>()

protected

Definition at line 144 of file speaker_media_player.h.

◆ volume_increment_

float esphome::speaker::SpeakerMediaPlayer::volume_increment_

protected

Definition at line 132 of file speaker_media_player.h.

◆ volume_initial_

float esphome::speaker::SpeakerMediaPlayer::volume_initial_

protected

Definition at line 135 of file speaker_media_player.h.

◆ volume_max_

float esphome::speaker::SpeakerMediaPlayer::volume_max_

protected

Definition at line 137 of file speaker_media_player.h.

◆ volume_min_

float esphome::speaker::SpeakerMediaPlayer::volume_min_

protected

Definition at line 138 of file speaker_media_player.h.

◆ volume_trigger_

Trigger<float>* esphome::speaker::SpeakerMediaPlayer::volume_trigger_ = new Trigger<float>()

protected

Definition at line 145 of file speaker_media_player.h.

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

esphome/components/speaker/media_player/speaker_media_player.h
esphome/components/speaker/media_player/speaker_media_player.cpp

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ control()

◆ get_mute_trigger()

◆ get_setup_priority()

◆ get_traits()

◆ get_unmute_trigger()

◆ get_volume_trigger()

◆ is_muted()

◆ loop()

◆ play_file()

◆ save_volume_restore_state_()

◆ set_announcement_format()

◆ set_announcement_speaker()

◆ set_buffer_size()

◆ set_media_format()

◆ set_media_speaker()

◆ set_mute_state_()

◆ set_playlist_delay_ms()

◆ set_task_stack_in_psram()

◆ set_volume_()

◆ set_volume_increment()

◆ set_volume_initial()

◆ set_volume_max()

◆ set_volume_min()

◆ setup()

◆ single_pipeline_()

◆ watch_media_commands_()

Field Documentation

◆ announcement_format_

◆ announcement_pipeline_

◆ announcement_pipeline_state_

◆ announcement_playlist_

◆ announcement_playlist_delay_ms_

◆ announcement_repeat_one_

◆ announcement_speaker_

◆ buffer_size_

◆ is_muted_

◆ is_paused_

◆ media_control_command_queue_

◆ media_format_

◆ media_pipeline_

◆ media_pipeline_state_

◆ media_playlist_

◆ media_playlist_delay_ms_

◆ media_repeat_one_

◆ media_speaker_

◆ mute_trigger_

◆ pref_

◆ task_stack_in_psram_

◆ unmute_trigger_

◆ volume_increment_

◆ volume_initial_

◆ volume_max_

◆ volume_min_

◆ volume_trigger_