Inheritance diagram for homeassistant.components.esphome.media_player.EsphomeMediaPlayer:

Collaboration diagram for homeassistant.components.esphome.media_player.EsphomeMediaPlayer:

Public Member Functions
BrowseMedia	async_browse_media (self, MediaType\|str\|None media_content_type=None, str\|None media_content_id=None)

None	async_media_pause (self)

None	async_media_play (self)

None	async_media_stop (self)

None	async_mute_volume (self, bool mute)

None	async_play_media (self, MediaType\|str media_type, str media_id, **Any kwargs)

None	async_set_volume_level (self, float volume)

None	async_will_remove_from_hass (self)

bool	is_volume_muted (self)

MediaPlayerState\|None	state (self)

float\|None	volume_level (self)

Public Member Functions inherited from homeassistant.components.esphome.entity.EsphomeEntity
None	__init__ (self, RuntimeEntryData entry_data, str domain, EntityInfo entity_info, type[_StateT] state_type)

None	async_added_to_hass (self)

Public Member Functions inherited from homeassistant.helpers.entity.Entity
None	__init_subclass__ (cls, **Any kwargs)

str	__repr__ (self)

None	add_to_platform_abort (self)

None	add_to_platform_finish (self)

None	add_to_platform_start (self, HomeAssistant hass, EntityPlatform platform, asyncio.Semaphore\|None parallel_updates)

bool	assumed_state (self)

None	async_device_update (self, bool warning=True)

None	async_internal_added_to_hass (self)

None	async_internal_will_remove_from_hass (self)

None	async_on_remove (self, CALLBACK_TYPE func)

None	async_registry_entry_updated (self)

None	async_remove (self, *bool force_remove=False)

None	async_removed_from_registry (self)

None	async_schedule_update_ha_state (self, bool force_refresh=False)

None	async_set_context (self, Context context)

None	async_update_ha_state (self, bool force_refresh=False)

None	async_write_ha_state (self)

str\|None	attribution (self)

bool	available (self)

DeviceInfo\|None	device_info (self)

bool	enabled (self)

EntityCategory\|None	entity_category (self)

bool	entity_registry_enabled_default (self)

bool	entity_registry_visible_default (self)

Mapping[str, Any]\|None	extra_state_attributes (self)

bool	force_update (self)

HassJobType	get_hassjob_type (self, str function_name)

er.EntityOptionsType\|None	get_initial_entity_options (self)

bool	has_entity_name (self)

str\|None	icon (self)

str\|UndefinedType\|None	name (self)

None	schedule_update_ha_state (self, bool force_refresh=False)

bool	should_poll (self)

str\|None	suggested_object_id (self)

str\|None	translation_key (self)

Mapping[str, str]	translation_placeholders (self)

str\|None	unique_id (self)

str\|None	unit_of_measurement (self)

bool	use_device_name (self)

Public Member Functions inherited from homeassistant.helpers.entity.CachedProperties
None	__init__ (cls, str name, tuple[type,...] bases, dict[Any, Any] namespace, **Any kwargs)

Any	__new__ (mcs, str name, tuple[type,...] bases, dict[Any, Any] namespace, set[str]\|None cached_properties=None, **Any kwargs)

Public Member Functions inherited from homeassistant.components.media_player.MediaPlayerEntity
str	access_token (self)

str\|None	app_id (self)

str\|None	app_name (self)

None	async_clear_playlist (self)

tuple[bytes\|None, str\|None]	async_get_browse_image (self, str media_content_type, str media_content_id, str\|None media_image_id=None)

tuple[bytes\|None, str\|None]	async_get_media_image (self)

None	async_join_players (self, list[str] group_members)

None	async_media_next_track (self)

None	async_media_play_pause (self)

None	async_media_previous_track (self)

None	async_media_seek (self, float position)

None	async_select_sound_mode (self, str sound_mode)

None	async_select_source (self, str source)

None	async_set_repeat (self, RepeatMode repeat)

None	async_set_shuffle (self, bool shuffle)

None	async_toggle (self)

None	async_turn_off (self)

None	async_turn_on (self)

None	async_unjoin_player (self)

None	async_volume_down (self)

None	async_volume_up (self)

dict[str, Any]	capability_attributes (self)

None	clear_playlist (self)

MediaPlayerDeviceClass\|None	device_class (self)

str\|None	entity_picture (self)

str	get_browse_image_url (self, str media_content_type, str media_content_id, str\|None media_image_id=None)

list[str]\|None	group_members (self)

None	join_players (self, list[str] group_members)

str\|None	media_album_artist (self)

str\|None	media_album_name (self)

str\|None	media_artist (self)

str\|None	media_channel (self)

str\|None	media_content_id (self)

MediaType\|str\|None	media_content_type (self)

int\|None	media_duration (self)

str\|None	media_episode (self)

str\|None	media_image_hash (self)

str\|None	media_image_local (self)

bool	media_image_remotely_accessible (self)

str\|None	media_image_url (self)

None	media_next_track (self)

None	media_pause (self)

None	media_play (self)

str\|None	media_playlist (self)

int\|None	media_position (self)

dt.datetime\|None	media_position_updated_at (self)

None	media_previous_track (self)

str\|None	media_season (self)

None	media_seek (self, float position)

str\|None	media_series_title (self)

None	media_stop (self)

str\|None	media_title (self)

int\|None	media_track (self)

None	mute_volume (self, bool mute)

None	play_media (self, MediaType\|str media_type, str media_id, **Any kwargs)

RepeatMode\|str\|None	repeat (self)

None	select_sound_mode (self, str sound_mode)

None	select_source (self, str source)

None	set_repeat (self, RepeatMode repeat)

None	set_shuffle (self, bool shuffle)

None	set_volume_level (self, float volume)

bool\|None	shuffle (self)

str\|None	sound_mode (self)

list[str]\|None	sound_mode_list (self)

str\|None	source (self)

list[str]\|None	source_list (self)

dict[str, Any]	state_attributes (self)

bool	support_clear_playlist (self)

bool	support_grouping (self)

bool	support_next_track (self)

bool	support_pause (self)

bool	support_play (self)

bool	support_play_media (self)

bool	support_previous_track (self)

bool	support_seek (self)

bool	support_select_sound_mode (self)

bool	support_select_source (self)

bool	support_shuffle_set (self)

bool	support_stop (self)

bool	support_volume_mute (self)

bool	support_volume_set (self)

MediaPlayerEntityFeature	supported_features (self)

MediaPlayerEntityFeature	supported_features_compat (self)

None	turn_off (self)

None	turn_on (self)

None	unjoin_player (self)

float	volume_step (self)

Private Member Functions
str\|None	_get_proxy_url (self, list[MediaPlayerSupportedFormat] supported_formats, str url, bool announcement)

None	_on_static_info_update (self, EntityInfo static_info)

Private Attributes
	_attr_supported_features

Static Private Attributes
	_attr_device_class = MediaPlayerDeviceClass.SPEAKER

Additional Inherited Members
Public Attributes inherited from homeassistant.components.esphome.entity.EsphomeEntity
	entity_id

Public Attributes inherited from homeassistant.helpers.entity.Entity
	device_entry

	entity_id

	hass

	parallel_updates

	platform

	registry_entry

Public Attributes inherited from homeassistant.components.media_player.MediaPlayerEntity
	state

Static Public Attributes inherited from homeassistant.helpers.entity.Entity
	bool

	EntityPlatform

	HomeAssistant

	None

	StateInfo

	StateType

	str

Static Public Attributes inherited from homeassistant.components.media_player.MediaPlayerEntity
	bool

	MediaPlayerEntityFeature

	None

Detailed Description

A media player implementation for esphome.

Definition at line 57 of file media_player.py.

Member Function Documentation

◆ _get_proxy_url()

str \| None homeassistant.components.esphome.media_player.EsphomeMediaPlayer._get_proxy_url	(		self,
		list[MediaPlayerSupportedFormat]	supported_formats,
		str	url,
		bool	announcement
	)

private

Get URL for ffmpeg proxy.

Definition at line 142 of file media_player.py.

◆ _on_static_info_update()

None homeassistant.components.esphome.media_player.EsphomeMediaPlayer._on_static_info_update	(		self,
		EntityInfo	static_info
	)

private

Set attrs from static info.

Reimplemented from homeassistant.components.esphome.entity.EsphomeEntity.

Definition at line 65 of file media_player.py.

◆ async_browse_media()

BrowseMedia homeassistant.components.esphome.media_player.EsphomeMediaPlayer.async_browse_media	(		self,
		MediaType \| str \| None	media_content_type = `None`,
		str \| None	media_content_id = `None`
	)

Implement the websocket media browsing helper.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 205 of file media_player.py.

◆ async_media_pause()

None homeassistant.components.esphome.media_player.EsphomeMediaPlayer.async_media_pause ( self )

Send pause command.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 223 of file media_player.py.

◆ async_media_play()

None homeassistant.components.esphome.media_player.EsphomeMediaPlayer.async_media_play ( self )

Send play command.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 228 of file media_player.py.

◆ async_media_stop()

None homeassistant.components.esphome.media_player.EsphomeMediaPlayer.async_media_stop ( self )

Send stop command.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 233 of file media_player.py.

◆ async_mute_volume()

None homeassistant.components.esphome.media_player.EsphomeMediaPlayer.async_mute_volume	(		self,
		bool	mute
	)

Mute the volume.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 238 of file media_player.py.

◆ async_play_media()

None homeassistant.components.esphome.media_player.EsphomeMediaPlayer.async_play_media	(		self,
		MediaType \| str	media_type,
		str	media_id,
		**Any	kwargs
	)

Send the play command with media url to the media player.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 102 of file media_player.py.

◆ async_set_volume_level()

None homeassistant.components.esphome.media_player.EsphomeMediaPlayer.async_set_volume_level	(		self,
		float	volume
	)

Set volume level, range 0..1.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 218 of file media_player.py.

◆ async_will_remove_from_hass()

None homeassistant.components.esphome.media_player.EsphomeMediaPlayer.async_will_remove_from_hass ( self )

Handle entity being removed.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 137 of file media_player.py.

◆ is_volume_muted()

bool homeassistant.components.esphome.media_player.EsphomeMediaPlayer.is_volume_muted ( self )

Return true if volume is muted.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 91 of file media_player.py.

◆ state()

MediaPlayerState | None homeassistant.components.esphome.media_player.EsphomeMediaPlayer.state ( self )

Return current state.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 85 of file media_player.py.

◆ volume_level()

float | None homeassistant.components.esphome.media_player.EsphomeMediaPlayer.volume_level ( self )

Volume level of the media player (0..1).

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 97 of file media_player.py.

Member Data Documentation

◆ _attr_device_class

homeassistant.components.esphome.media_player.EsphomeMediaPlayer._attr_device_class = MediaPlayerDeviceClass.SPEAKER

staticprivate

Definition at line 62 of file media_player.py.

◆ _attr_supported_features

homeassistant.components.esphome.media_player.EsphomeMediaPlayer._attr_supported_features

private

Definition at line 78 of file media_player.py.

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

core/homeassistant/components/esphome/media_player.py

Home Assistant Unofficial Reference 2024.12.1

Public Member Functions

Private Member Functions

Private Attributes

Static Private Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ _get_proxy_url()

◆ _on_static_info_update()

◆ async_browse_media()

◆ async_media_pause()

◆ async_media_play()

◆ async_media_stop()

◆ async_mute_volume()

◆ async_play_media()

◆ async_set_volume_level()

◆ async_will_remove_from_hass()

◆ is_volume_muted()

◆ state()

◆ volume_level()

Member Data Documentation

◆ _attr_device_class

◆ _attr_supported_features