Thin adapter media source for Sendspin. More...

#include <sendspin_media_source.h>

Inheritance diagram for esphome::sendspin_::SendspinMediaSource:

Public Member Functions
void	setup () override

void	dump_config () override

void	set_static_delay_adjustable (bool adjustable)

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

bool	has_internal_playlist () const override

void	notify_volume_changed (float volume) override

void	notify_mute_changed (bool is_muted) override

void	notify_audio_played (uint32_t frames, int64_t timestamp) override

Public Member Functions inherited from esphome::sendspin_::SendspinChild
float	get_setup_priority () const override

Public Member Functions inherited from esphome::Component
virtual void	loop ()
	This method will be called repeatedly.

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::Parented< SendspinHub >
	Parented ()

	Parented (SendspinHub *parent)

SendspinHub *	get_parent () const
	Get the parent of this object.

void	set_parent (SendspinHub *parent)
	Set the parent of this object.

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

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.

Protected Member Functions
size_t	on_audio_write (uint8_t *data, size_t length, uint32_t timeout_ms) override
	Writes decoded PCM audio to ESPHome's media source output pipeline.

void	on_stream_start () override
	Called when a new audio stream starts (main loop thread).

void	on_stream_end () override
	Called when the audio stream ends (main loop thread).

void	on_volume_changed (uint8_t volume) override
	Called when volume changes (main loop thread).

void	on_mute_changed (bool muted) override
	Called when mute state changes (main loop thread).

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.

Protected Attributes
sendspin::PlayerRole *	player_role_ {nullptr}

float	cached_volume_ {0.0f}

bool	cached_muted_ {false}

bool	pending_start_ {false}

bool	static_delay_adjustable_ {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_

Protected Attributes inherited from esphome::Parented< SendspinHub >
SendspinHub *	parent_

Detailed Description

Thin adapter media source for Sendspin.

Implements PlayerRoleListener to receive audio data from the sendspin-cpp library's SyncTask and bridges it to ESPHome's MediaSource output pipeline. Also forwards transport commands to the hub's controller role.

Definition at line 20 of file sendspin_media_source.h.

Member Function Documentation

◆ can_handle()

bool esphome::sendspin_::SendspinMediaSource::can_handle ( const std::string & uri ) const

overridevirtual

Implements esphome::media_source::MediaSource.

Definition at line 44 of file sendspin_media_source.cpp.

◆ dump_config()

void esphome::sendspin_::SendspinMediaSource::dump_config ( )

overridevirtual

Reimplemented from esphome::Component.

Definition at line 30 of file sendspin_media_source.cpp.

◆ handle_command()

void esphome::sendspin_::SendspinMediaSource::handle_command ( media_source::MediaSourceCommand command )

overridevirtual

Implements esphome::media_source::MediaSource.

Definition at line 84 of file sendspin_media_source.cpp.

◆ has_internal_playlist()

bool esphome::sendspin_::SendspinMediaSource::has_internal_playlist ( ) const

inlineoverridevirtual

Reimplemented from esphome::media_source::MediaSource.

Definition at line 33 of file sendspin_media_source.h.

◆ notify_audio_played()

void esphome::sendspin_::SendspinMediaSource::notify_audio_played	(	uint32_t	frames,
		int64_t	timestamp )

overridevirtual

Reimplemented from esphome::media_source::MediaSource.

Definition at line 145 of file sendspin_media_source.cpp.

◆ notify_mute_changed()

void esphome::sendspin_::SendspinMediaSource::notify_mute_changed ( bool is_muted )

overridevirtual

Reimplemented from esphome::media_source::MediaSource.

Definition at line 136 of file sendspin_media_source.cpp.

◆ notify_volume_changed()

void esphome::sendspin_::SendspinMediaSource::notify_volume_changed ( float volume )

overridevirtual

Reimplemented from esphome::media_source::MediaSource.

Definition at line 128 of file sendspin_media_source.cpp.

◆ on_audio_write()

size_t esphome::sendspin_::SendspinMediaSource::on_audio_write	(	uint8_t *	data,
		size_t	length,
		uint32_t	timeout_ms )

overrideprotected

Writes decoded PCM audio to ESPHome's media source output pipeline.

Called from the sync task's background thread.

Definition at line 154 of file sendspin_media_source.cpp.

◆ on_mute_changed()

void esphome::sendspin_::SendspinMediaSource::on_mute_changed ( bool muted )

overrideprotected

Called when mute state changes (main loop thread).

Definition at line 195 of file sendspin_media_source.cpp.

◆ on_stream_end()

void esphome::sendspin_::SendspinMediaSource::on_stream_end ( )

overrideprotected

Called when the audio stream ends (main loop thread).

Definition at line 184 of file sendspin_media_source.cpp.

◆ on_stream_start()

void esphome::sendspin_::SendspinMediaSource::on_stream_start ( )

overrideprotected

Called when a new audio stream starts (main loop thread).

Definition at line 172 of file sendspin_media_source.cpp.

◆ on_volume_changed()

void esphome::sendspin_::SendspinMediaSource::on_volume_changed ( uint8_t volume )

overrideprotected

Called when volume changes (main loop thread).

Definition at line 192 of file sendspin_media_source.cpp.

◆ play_uri()

bool esphome::sendspin_::SendspinMediaSource::play_uri ( const std::string & uri )

overridevirtual

Implements esphome::media_source::MediaSource.

Definition at line 47 of file sendspin_media_source.cpp.

◆ set_static_delay_adjustable()

void esphome::sendspin_::SendspinMediaSource::set_static_delay_adjustable ( bool adjustable )

Definition at line 35 of file sendspin_media_source.cpp.

◆ setup()

void esphome::sendspin_::SendspinMediaSource::setup ( )

overridevirtual

Reimplemented from esphome::Component.

Definition at line 16 of file sendspin_media_source.cpp.

Field Documentation

◆ cached_muted_

bool esphome::sendspin_::SendspinMediaSource::cached_muted_ {false}

protected

Definition at line 62 of file sendspin_media_source.h.

◆ cached_volume_

float esphome::sendspin_::SendspinMediaSource::cached_volume_ {0.0f}

protected

Definition at line 60 of file sendspin_media_source.h.

◆ pending_start_

bool esphome::sendspin_::SendspinMediaSource::pending_start_ {false}

protected

Definition at line 63 of file sendspin_media_source.h.

◆ player_role_

sendspin::PlayerRole* esphome::sendspin_::SendspinMediaSource::player_role_ {nullptr}

protected

Definition at line 58 of file sendspin_media_source.h.

◆ static_delay_adjustable_

bool esphome::sendspin_::SendspinMediaSource::static_delay_adjustable_ {false}

protected

Definition at line 64 of file sendspin_media_source.h.

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

esphome/components/sendspin/media_source/sendspin_media_source.h
esphome/components/sendspin/media_source/sendspin_media_source.cpp

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Function Documentation

◆ can_handle()

◆ dump_config()

◆ handle_command()

◆ has_internal_playlist()

◆ notify_audio_played()

◆ notify_mute_changed()

◆ notify_volume_changed()

◆ on_audio_write()

◆ on_mute_changed()

◆ on_stream_end()

◆ on_stream_start()

◆ on_volume_changed()

◆ play_uri()

◆ set_static_delay_adjustable()

◆ setup()

Field Documentation

◆ cached_muted_

◆ cached_volume_

◆ pending_start_

◆ player_role_

◆ static_delay_adjustable_