#include <audio_file_media_source.h>

Inheritance diagram for esphome::audio_file::AudioFileMediaSource:

Public Member Functions
void	setup () override

void	loop () override

void	dump_config () override

bool	play_uri (const std::string &uri) override

void	handle_command (media_source::MediaSourceCommand command) override

bool	can_handle (const std::string &uri) const override

void	set_task_stack_in_psram (bool task_stack_in_psram)

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.

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)

Public Member Functions inherited from esphome::media_source::MediaSource
virtual	~MediaSource ()=default

virtual bool	has_internal_playlist () const
	Whether this source manages its own playlist internally Smart sources that handle next/previous/repeat/shuffle should override this to return true.

MediaSourceState	get_state () const
	Get current playback state.

void	set_listener (MediaSourceListener *listener)
	Set the listener that receives callbacks from this source.

bool	has_listener () const
	Check if a listener has been registered.

size_t	write_output (const uint8_t *data, size_t length, uint32_t timeout_ms, const audio::AudioStreamInfo &stream_info)
	Write audio data to the listener.

virtual void	notify_volume_changed (float volume)
	Notify the source that volume changed Simple sources ignore this.

virtual void	notify_mute_changed (bool is_muted)
	Notify the source that mute state changed Simple sources ignore this.

virtual void	notify_audio_played (uint32_t frames, int64_t timestamp)
	Notify the source about audio that has been played Called when the speaker reports that audio frames have been written to the DAC.

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

Protected Attributes
audio::AudioFile *	current_file_ {nullptr}

AudioFileDecodingState	decoding_state_ {AudioFileDecodingState::IDLE}

EventGroupHandle_t	event_group_ {nullptr}

StaticTask	decode_task_

bool	task_stack_in_psram_ {false}

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

Additional Inherited Members
Protected Member Functions inherited from esphome::Component
void	call_loop_ ()

virtual void	call_setup ()

void	call_dump_config_ ()

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 Member Functions inherited from esphome::media_source::MediaSource
void	set_state_ (MediaSourceState state)
	Update state and notify listener This is the only way to change state_, ensuring listener notifications always fire.

Detailed Description

Definition at line 24 of file audio_file_media_source.h.

Member Function Documentation

◆ can_handle()

bool esphome::audio_file::AudioFileMediaSource::can_handle ( const std::string & uri ) const

inlineoverridevirtual

Implements esphome::media_source::MediaSource.

Definition at line 33 of file audio_file_media_source.h.

◆ decode_task()

void esphome::audio_file::AudioFileMediaSource::decode_task ( void * params )

staticprotected

Definition at line 195 of file audio_file_media_source.cpp.

◆ dump_config()

void esphome::audio_file::AudioFileMediaSource::dump_config ( )

overridevirtual

Reimplemented from esphome::Component.

Definition at line 47 of file audio_file_media_source.cpp.

◆ handle_command()

void esphome::audio_file::AudioFileMediaSource::handle_command ( media_source::MediaSourceCommand command )

overridevirtual

Implements esphome::media_source::MediaSource.

Definition at line 175 of file audio_file_media_source.cpp.

◆ loop()

void esphome::audio_file::AudioFileMediaSource::loop ( )

overridevirtual

Reimplemented from esphome::Component.

Definition at line 63 of file audio_file_media_source.cpp.

◆ play_uri()

bool esphome::audio_file::AudioFileMediaSource::play_uri ( const std::string & uri )

overridevirtual

Implements esphome::media_source::MediaSource.

Definition at line 140 of file audio_file_media_source.cpp.

◆ set_task_stack_in_psram()

void esphome::audio_file::AudioFileMediaSource::set_task_stack_in_psram ( bool task_stack_in_psram )

inline

Definition at line 35 of file audio_file_media_source.h.

◆ setup()

void esphome::audio_file::AudioFileMediaSource::setup ( )

overridevirtual

Reimplemented from esphome::Component.

Definition at line 52 of file audio_file_media_source.cpp.

Field Documentation

◆ current_file_

audio::AudioFile* esphome::audio_file::AudioFileMediaSource::current_file_ {nullptr}

protected

Definition at line 40 of file audio_file_media_source.h.

◆ decode_task_

StaticTask esphome::audio_file::AudioFileMediaSource::decode_task_

protected

Definition at line 43 of file audio_file_media_source.h.

◆ decoding_state_

AudioFileDecodingState esphome::audio_file::AudioFileMediaSource::decoding_state_ {AudioFileDecodingState::IDLE}

protected

Definition at line 41 of file audio_file_media_source.h.

◆ event_group_

EventGroupHandle_t esphome::audio_file::AudioFileMediaSource::event_group_ {nullptr}

protected

Definition at line 42 of file audio_file_media_source.h.

◆ task_stack_in_psram_

bool esphome::audio_file::AudioFileMediaSource::task_stack_in_psram_ {false}

protected

Definition at line 45 of file audio_file_media_source.h.

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

esphome/components/audio_file/media_source/audio_file_media_source.h
esphome/components/audio_file/media_source/audio_file_media_source.cpp

Public Member Functions

Static Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ can_handle()

◆ decode_task()

◆ dump_config()

◆ handle_command()

◆ loop()

◆ play_uri()

◆ set_task_stack_in_psram()

◆ setup()

Field Documentation

◆ current_file_

◆ decode_task_

◆ decoding_state_

◆ event_group_

◆ task_stack_in_psram_