#include <audio_http_media_source.h>

Inheritance diagram for esphome::audio_http::AudioHTTPMediaSource:

Public Member Functions
void	setup () override

void	loop () override

void	dump_config () override

void	set_buffer_size (size_t buffer_size)

void	set_task_stack_in_psram (bool task_stack_in_psram)

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

size_t	on_audio_write (const uint8_t *data, size_t length, uint32_t timeout_ms) override

void	on_stream_info (const micro_decoder::AudioStreamInfo &info) override

void	on_state_change (micro_decoder::DecoderState state) override

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.

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, uint32_t &threshold_ms_out)

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.

Protected Attributes
std::unique_ptr< micro_decoder::DecoderSource >	decoder_

audio::AudioStreamInfo	stream_info_

size_t	buffer_size_ {50000}

std::atomic< bool >	pause_ {false}

bool	decoder_task_stack_in_psram_ {false}

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

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

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 (const char *name)
	Cancel an interval function.

bool	cancel_interval (uint32_t id)

bool	cancel_interval (InternalSchedulerID id)

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 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 (const char *name)
	Cancel a timeout function.

bool	cancel_timeout (uint32_t id)

bool	cancel_timeout (InternalSchedulerID id)

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.

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

bool	cancel_defer (const char *name)
	Cancel a defer callback using the specified name, name must not be empty.

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.

void	request_play_uri_ (const std::string &uri)
	Request the orchestrator to play a new URI.

void	request_volume_ (float volume)
	Request the orchestrator to change volume.

void	request_mute_ (bool is_muted)
	Request the orchestrator to change mute state.

Detailed Description

Definition at line 26 of file audio_http_media_source.h.

Member Function Documentation

◆ can_handle()

bool esphome::audio_http::AudioHTTPMediaSource::can_handle ( const std::string & uri ) const

overridevirtual

Implements esphome::media_source::MediaSource.

Definition at line 65 of file audio_http_media_source.cpp.

◆ dump_config()

void esphome::audio_http::AudioHTTPMediaSource::dump_config ( )

overridevirtual

Reimplemented from esphome::Component.

Definition at line 29 of file audio_http_media_source.cpp.

◆ handle_command()

void esphome::audio_http::AudioHTTPMediaSource::handle_command ( media_source::MediaSourceCommand command )

overridevirtual

Implements esphome::media_source::MediaSource.

Definition at line 98 of file audio_http_media_source.cpp.

◆ loop()

void esphome::audio_http::AudioHTTPMediaSource::loop ( )

overridevirtual

Reimplemented from esphome::Component.

Definition at line 63 of file audio_http_media_source.cpp.

◆ on_audio_write()

size_t esphome::audio_http::AudioHTTPMediaSource::on_audio_write	(	const uint8_t *	data,
		size_t	length,
		uint32_t	timeout_ms )

override

Definition at line 129 of file audio_http_media_source.cpp.

◆ on_state_change()

void esphome::audio_http::AudioHTTPMediaSource::on_state_change ( micro_decoder::DecoderState state )

override

Definition at line 144 of file audio_http_media_source.cpp.

◆ on_stream_info()

void esphome::audio_http::AudioHTTPMediaSource::on_stream_info ( const micro_decoder::AudioStreamInfo & info )

override

Definition at line 138 of file audio_http_media_source.cpp.

◆ play_uri()

bool esphome::audio_http::AudioHTTPMediaSource::play_uri ( const std::string & uri )

overridevirtual

Implements esphome::media_source::MediaSource.

Definition at line 70 of file audio_http_media_source.cpp.

◆ set_buffer_size()

void esphome::audio_http::AudioHTTPMediaSource::set_buffer_size ( size_t buffer_size )

inline

Definition at line 34 of file audio_http_media_source.h.

◆ set_task_stack_in_psram()

void esphome::audio_http::AudioHTTPMediaSource::set_task_stack_in_psram ( bool task_stack_in_psram )

inline

Definition at line 35 of file audio_http_media_source.h.

◆ setup()

void esphome::audio_http::AudioHTTPMediaSource::setup ( )

overridevirtual

Reimplemented from esphome::Component.

Definition at line 37 of file audio_http_media_source.cpp.

Field Documentation

◆ buffer_size_

size_t esphome::audio_http::AudioHTTPMediaSource::buffer_size_ {50000}

protected

Definition at line 51 of file audio_http_media_source.h.

◆ decoder_

std::unique_ptr<micro_decoder::DecoderSource> esphome::audio_http::AudioHTTPMediaSource::decoder_

protected

Definition at line 48 of file audio_http_media_source.h.

◆ decoder_task_stack_in_psram_

bool esphome::audio_http::AudioHTTPMediaSource::decoder_task_stack_in_psram_ {false}

protected

Definition at line 56 of file audio_http_media_source.h.

◆ pause_

std::atomic<bool> esphome::audio_http::AudioHTTPMediaSource::pause_ {false}

protected

Definition at line 55 of file audio_http_media_source.h.

◆ stream_info_

audio::AudioStreamInfo esphome::audio_http::AudioHTTPMediaSource::stream_info_

protected

Definition at line 49 of file audio_http_media_source.h.

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

esphome/components/audio_http/audio_http_media_source.h
esphome/components/audio_http/audio_http_media_source.cpp

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ can_handle()

◆ dump_config()

◆ handle_command()

◆ loop()

◆ on_audio_write()

◆ on_state_change()

◆ on_stream_info()

◆ play_uri()

◆ set_buffer_size()

◆ set_task_stack_in_psram()

◆ setup()

Field Documentation

◆ buffer_size_

◆ decoder_

◆ decoder_task_stack_in_psram_

◆ pause_

◆ stream_info_