Inherits homeassistant.helpers.entity.Entity, cached_properties, and CACHED_PROPERTIES_WITH_ATTR_.

Collaboration diagram for homeassistant.components.media_player.MediaPlayerEntity:

[legend]

Public Member Functions
str	access_token (self)

str\|None	app_id (self)

str\|None	app_name (self)

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

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_pause (self)

None	async_media_play (self)

None	async_media_play_pause (self)

None	async_media_previous_track (self)

None	async_media_seek (self, float position)

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_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_set_volume_level (self, float volume)

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)

bool\|None	is_volume_muted (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)

MediaPlayerState\|None	state (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\|None	volume_level (self)

float	volume_step (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_added_to_hass (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_will_remove_from_hass (self)

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 Attributes
	state

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

	entity_id

	hass

	parallel_updates

	platform

	registry_entry

Static Public Attributes
	bool

	MediaPlayerEntityFeature

	None

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

	EntityPlatform

	HomeAssistant

	None

	StateInfo

	StateType

	str

Private Member Functions
tuple[bytes\|None, str\|None]	_async_fetch_image (self, str url)

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

Private Attributes
	_access_token

Static Private Attributes
	_entity_component_unrecorded_attributes

Detailed Description

ABC for media player entities.

Definition at line 513 of file __init__.py.

Member Function Documentation

◆ _async_fetch_image()

tuple[bytes \| None, str \| None] homeassistant.components.media_player.MediaPlayerEntity._async_fetch_image	(		self,
		str	url
	)

private

Retrieve an image.

Reimplemented in homeassistant.components.webostv.media_player.LgWebOSMediaPlayerEntity.

Definition at line 1190 of file __init__.py.

◆ _async_fetch_image_from_cache()

tuple[bytes \| None, str \| None] homeassistant.components.media_player.MediaPlayerEntity._async_fetch_image_from_cache	(		self,
		str	url
	)

private

Fetch image.

Images are cached in memory (the images are typically 10-100kB in size).

Definition at line 1161 of file __init__.py.

◆ access_token()

str homeassistant.components.media_player.MediaPlayerEntity.access_token ( self )

Access token for this media player.

Definition at line 580 of file __init__.py.

◆ app_id()

str | None homeassistant.components.media_player.MediaPlayerEntity.app_id ( self )

ID of the current running app.

Reimplemented in homeassistant.components.vizio.media_player.VizioDevice, homeassistant.components.universal.media_player.UniversalMediaPlayer, homeassistant.components.roku.media_player.RokuMediaPlayer, homeassistant.components.cast.media_player.CastMediaPlayerEntity, and homeassistant.components.apple_tv.media_player.AppleTvMediaPlayer.

Definition at line 727 of file __init__.py.

◆ app_name()

str | None homeassistant.components.media_player.MediaPlayerEntity.app_name ( self )

Name of the current running app.

Reimplemented in homeassistant.components.universal.media_player.UniversalMediaPlayer, homeassistant.components.roku.media_player.RokuMediaPlayer, homeassistant.components.emby.media_player.EmbyDevice, homeassistant.components.cast.media_player.CastMediaPlayerEntity, and homeassistant.components.apple_tv.media_player.AppleTvMediaPlayer.

Definition at line 732 of file __init__.py.

◆ async_browse_media()

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

Return a BrowseMedia instance.

The BrowseMedia instance will be used by the
"media_player/browse_media" websocket command.

Definition at line 1133 of file __init__.py.

◆ async_clear_playlist()

None homeassistant.components.media_player.MediaPlayerEntity.async_clear_playlist ( self )

Clear players playlist.

Definition at line 903 of file __init__.py.

◆ async_get_browse_image()

tuple[bytes \| None, str \| None] homeassistant.components.media_player.MediaPlayerEntity.async_get_browse_image	(		self,
		str	media_content_type,
		str	media_content_id,
		str \| None	media_image_id = `None`
	)

Optionally fetch internally accessible image for media browser.

Must be implemented by integration.

Definition at line 664 of file __init__.py.

◆ async_get_media_image()

tuple[bytes | None, str | None] homeassistant.components.media_player.MediaPlayerEntity.async_get_media_image ( self )

Fetch media image of current playing image.

Reimplemented in homeassistant.components.philips_js.media_player.PhilipsTVMediaPlayer, homeassistant.components.mpd.media_player.MpdDevice, homeassistant.components.clementine.media_player.ClementineDevice, homeassistant.components.apple_tv.media_player.AppleTvMediaPlayer, and homeassistant.components.androidtv.media_player.ADBDevice.

Definition at line 657 of file __init__.py.

◆ async_join_players()

None homeassistant.components.media_player.MediaPlayerEntity.async_join_players	(		self,
		list[str]	group_members
	)

Join `group_members` as a player group with the current player.

Reimplemented in homeassistant.components.yamaha_musiccast.media_player.MusicCastMediaPlayer, homeassistant.components.squeezebox.media_player.SqueezeBoxMediaPlayerEntity, homeassistant.components.sonos.media_player.SonosMediaPlayerEntity, homeassistant.components.music_assistant.media_player.MusicAssistantPlayer, homeassistant.components.linkplay.media_player.LinkPlayMediaPlayerEntity, homeassistant.components.heos.media_player.HeosMediaPlayer, and homeassistant.components.bang_olufsen.media_player.BangOlufsenMediaPlayer.

Definition at line 1149 of file __init__.py.

◆ async_media_next_track()

None homeassistant.components.media_player.MediaPlayerEntity.async_media_next_track ( self )

Send next track command.

Definition at line 857 of file __init__.py.

◆ async_media_pause()

None homeassistant.components.media_player.MediaPlayerEntity.async_media_pause ( self )

Send pause command.

Definition at line 833 of file __init__.py.

◆ async_media_play()

None homeassistant.components.media_player.MediaPlayerEntity.async_media_play ( self )

Send play command.

Definition at line 825 of file __init__.py.

◆ async_media_play_pause()

None homeassistant.components.media_player.MediaPlayerEntity.async_media_play_pause ( self )

Play or pause the media player.

Definition at line 1061 of file __init__.py.

◆ async_media_previous_track()

None homeassistant.components.media_player.MediaPlayerEntity.async_media_previous_track ( self )

Send previous track command.

Definition at line 849 of file __init__.py.

◆ async_media_seek()

None homeassistant.components.media_player.MediaPlayerEntity.async_media_seek	(		self,
		float	position
	)

Send seek command.

Definition at line 865 of file __init__.py.

◆ async_media_stop()

None homeassistant.components.media_player.MediaPlayerEntity.async_media_stop ( self )

Send stop command.

Definition at line 841 of file __init__.py.

◆ async_mute_volume()

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

Mute the volume.

Definition at line 809 of file __init__.py.

◆ async_play_media()

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

Play a piece of media.

Definition at line 875 of file __init__.py.

◆ async_select_sound_mode()

None homeassistant.components.media_player.MediaPlayerEntity.async_select_sound_mode	(		self,
		str	sound_mode
	)

Select sound mode.

Definition at line 895 of file __init__.py.

◆ async_select_source()

None homeassistant.components.media_player.MediaPlayerEntity.async_select_source	(		self,
		str	source
	)

Select input source.

Definition at line 887 of file __init__.py.

◆ async_set_repeat()

None homeassistant.components.media_player.MediaPlayerEntity.async_set_repeat	(		self,
		RepeatMode	repeat
	)

Set repeat mode.

Definition at line 919 of file __init__.py.

◆ async_set_shuffle()

None homeassistant.components.media_player.MediaPlayerEntity.async_set_shuffle	(		self,
		bool	shuffle
	)

Enable/disable shuffle mode.

Definition at line 911 of file __init__.py.

◆ async_set_volume_level()

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

Set volume level, range 0..1.

Definition at line 817 of file __init__.py.

◆ async_toggle()

None homeassistant.components.media_player.MediaPlayerEntity.async_toggle ( self )

Toggle the power on the media player.

Reimplemented in homeassistant.components.universal.media_player.UniversalMediaPlayer, homeassistant.components.ps4.media_player.PS4Device, homeassistant.components.forked_daapd.media_player.ForkedDaapdMaster, and homeassistant.components.forked_daapd.media_player.ForkedDaapdZone.

Definition at line 1010 of file __init__.py.

◆ async_turn_off()

None homeassistant.components.media_player.MediaPlayerEntity.async_turn_off ( self )

Turn the media player off.

Definition at line 801 of file __init__.py.

◆ async_turn_on()

None homeassistant.components.media_player.MediaPlayerEntity.async_turn_on ( self )

Turn the media player on.

Definition at line 793 of file __init__.py.

◆ async_unjoin_player()

None homeassistant.components.media_player.MediaPlayerEntity.async_unjoin_player ( self )

Remove this player from any group.

Reimplemented in homeassistant.components.yamaha_musiccast.media_player.MusicCastMediaPlayer, homeassistant.components.squeezebox.media_player.SqueezeBoxMediaPlayerEntity, homeassistant.components.sonos.media_player.SonosMediaPlayerEntity, homeassistant.components.music_assistant.media_player.MusicAssistantPlayer, homeassistant.components.linkplay.media_player.LinkPlayMediaPlayerEntity, homeassistant.components.heos.media_player.HeosMediaPlayer, and homeassistant.components.bang_olufsen.media_player.BangOlufsenMediaPlayer.

Definition at line 1157 of file __init__.py.

◆ async_volume_down()

None homeassistant.components.media_player.MediaPlayerEntity.async_volume_down ( self )

Turn volume down for media player.

This method is a coroutine.

Definition at line 1043 of file __init__.py.

◆ async_volume_up()

None homeassistant.components.media_player.MediaPlayerEntity.async_volume_up ( self )

Turn volume up for media player.

This method is a coroutine.

Definition at line 1025 of file __init__.py.

◆ capability_attributes()

dict[str, Any] homeassistant.components.media_player.MediaPlayerEntity.capability_attributes ( self )

Return capability attributes.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 1095 of file __init__.py.

◆ clear_playlist()

None homeassistant.components.media_player.MediaPlayerEntity.clear_playlist ( self )

Clear players playlist.

Reimplemented in homeassistant.components.sonos.media_player.SonosMediaPlayerEntity, homeassistant.components.hdmi_cec.media_player.CecPlayerEntity, and homeassistant.components.demo.media_player.DemoMusicPlayer.

Definition at line 899 of file __init__.py.

◆ device_class()

MediaPlayerDeviceClass | None homeassistant.components.media_player.MediaPlayerEntity.device_class ( self )

Return the class of this entity.

Reimplemented from homeassistant.helpers.entity.Entity.

Reimplemented in homeassistant.components.control4.media_player.Control4Room.

Definition at line 566 of file __init__.py.

◆ entity_picture()

str | None homeassistant.components.media_player.MediaPlayerEntity.entity_picture ( self )

Return image of the media playing.

Reimplemented from homeassistant.helpers.entity.Entity.

Reimplemented in homeassistant.components.universal.media_player.UniversalMediaPlayer, and homeassistant.components.ps4.media_player.PS4Device.

Definition at line 1073 of file __init__.py.

◆ get_browse_image_url()

str homeassistant.components.media_player.MediaPlayerEntity.get_browse_image_url	(		self,
		str	media_content_type,
		str	media_content_id,
		str \| None	media_image_id = `None`
	)

Generate an url for a media browser image.

Definition at line 1194 of file __init__.py.

◆ group_members()

list[str] | None homeassistant.components.media_player.MediaPlayerEntity.group_members ( self )

List of members which are currently grouped together.

Reimplemented in homeassistant.components.yamaha_musiccast.media_player.MusicCastMediaPlayer, homeassistant.components.squeezebox.media_player.SqueezeBoxMediaPlayerEntity, homeassistant.components.sonos.media_player.SonosMediaPlayerEntity, homeassistant.components.roon.media_player.RoonDevice, homeassistant.components.linkplay.media_player.LinkPlayMediaPlayerEntity, and homeassistant.components.heos.media_player.HeosMediaPlayer.

Definition at line 767 of file __init__.py.

◆ is_volume_muted()

bool | None homeassistant.components.media_player.MediaPlayerEntity.is_volume_muted ( self )

Boolean if volume is currently muted.

Definition at line 604 of file __init__.py.

◆ join_players()

None homeassistant.components.media_player.MediaPlayerEntity.join_players	(		self,
		list[str]	group_members
	)

Join `group_members` as a player group with the current player.

Reimplemented in homeassistant.components.roon.media_player.RoonDevice, and homeassistant.components.demo.media_player.DemoMusicPlayer.

Definition at line 1145 of file __init__.py.

◆ media_album_artist()

str | None homeassistant.components.media_player.MediaPlayerEntity.media_album_artist ( self )

Album artist of current playing media, music track only.

Definition at line 692 of file __init__.py.

◆ media_album_name()

str | None homeassistant.components.media_player.MediaPlayerEntity.media_album_name ( self )

Album name of current playing media, music track only.

Definition at line 687 of file __init__.py.

◆ media_artist()

str | None homeassistant.components.media_player.MediaPlayerEntity.media_artist ( self )

Artist of current playing media, music track only.

Definition at line 682 of file __init__.py.

◆ media_channel()

str | None homeassistant.components.media_player.MediaPlayerEntity.media_channel ( self )

Channel currently playing.

Definition at line 717 of file __init__.py.

◆ media_content_id()

str | None homeassistant.components.media_player.MediaPlayerEntity.media_content_id ( self )

Content ID of current playing media.

Definition at line 609 of file __init__.py.

◆ media_content_type()

MediaType | str | None homeassistant.components.media_player.MediaPlayerEntity.media_content_type ( self )

Content type of current playing media.

Definition at line 614 of file __init__.py.

◆ media_duration()

int | None homeassistant.components.media_player.MediaPlayerEntity.media_duration ( self )

Duration of current playing media in seconds.

Definition at line 619 of file __init__.py.

◆ media_episode()

str | None homeassistant.components.media_player.MediaPlayerEntity.media_episode ( self )

Episode of current playing media, TV show only.

Reimplemented in homeassistant.components.universal.media_player.UniversalMediaPlayer, homeassistant.components.plex.media_player.PlexMediaPlayer, homeassistant.components.emby.media_player.EmbyDevice, homeassistant.components.demo.media_player.DemoTVShowPlayer, homeassistant.components.cast.media_player.CastMediaPlayerEntity, and homeassistant.components.apple_tv.media_player.AppleTvMediaPlayer.

Definition at line 712 of file __init__.py.

◆ media_image_hash()

str | None homeassistant.components.media_player.MediaPlayerEntity.media_image_hash ( self )

Hash value for media image.

Reimplemented in homeassistant.components.mpd.media_player.MpdDevice, and homeassistant.components.apple_tv.media_player.AppleTvMediaPlayer.

Definition at line 647 of file __init__.py.

◆ media_image_local()

str | None homeassistant.components.media_player.MediaPlayerEntity.media_image_local ( self )

Return local url to media image.

Definition at line 1084 of file __init__.py.

◆ media_image_remotely_accessible()

bool homeassistant.components.media_player.MediaPlayerEntity.media_image_remotely_accessible ( self )

If the image url is remotely accessible.

Reimplemented in homeassistant.components.xbox.media_player.XboxMediaPlayer, and homeassistant.components.bang_olufsen.media_player.BangOlufsenMediaPlayer.

Definition at line 642 of file __init__.py.

◆ media_image_url()

str | None homeassistant.components.media_player.MediaPlayerEntity.media_image_url ( self )

Image url of current playing media.

Definition at line 637 of file __init__.py.

◆ media_next_track()

None homeassistant.components.media_player.MediaPlayerEntity.media_next_track ( self )

Send next track command.

Definition at line 853 of file __init__.py.

◆ media_pause()

None homeassistant.components.media_player.MediaPlayerEntity.media_pause ( self )

Send pause command.

Definition at line 829 of file __init__.py.

◆ media_play()

None homeassistant.components.media_player.MediaPlayerEntity.media_play ( self )

Send play command.

Definition at line 821 of file __init__.py.

◆ media_playlist()

str | None homeassistant.components.media_player.MediaPlayerEntity.media_playlist ( self )

Title of Playlist currently playing.

Reimplemented in homeassistant.components.universal.media_player.UniversalMediaPlayer, homeassistant.components.tessie.media_player.TessieMediaEntity, homeassistant.components.spotify.media_player.SpotifyMediaPlayer, homeassistant.components.sonos.media_player.SonosMediaPlayerEntity, homeassistant.components.sisyphus.media_player.SisyphusPlayer, and homeassistant.components.itunes.media_player.ItunesDevice.

Definition at line 722 of file __init__.py.

◆ media_position()

int | None homeassistant.components.media_player.MediaPlayerEntity.media_position ( self )

Position of current playing media in seconds.

Definition at line 624 of file __init__.py.

◆ media_position_updated_at()

dt.datetime | None homeassistant.components.media_player.MediaPlayerEntity.media_position_updated_at ( self )

When was the position of the current playing media valid.

Returns value from homeassistant.util.dt.utcnow().

Definition at line 629 of file __init__.py.

◆ media_previous_track()

None homeassistant.components.media_player.MediaPlayerEntity.media_previous_track ( self )

Send previous track command.

Definition at line 845 of file __init__.py.

◆ media_season()

str | None homeassistant.components.media_player.MediaPlayerEntity.media_season ( self )

Season of current playing media, TV show only.

Reimplemented in homeassistant.components.universal.media_player.UniversalMediaPlayer, homeassistant.components.plex.media_player.PlexMediaPlayer, homeassistant.components.emby.media_player.EmbyDevice, homeassistant.components.cast.media_player.CastMediaPlayerEntity, and homeassistant.components.apple_tv.media_player.AppleTvMediaPlayer.

Definition at line 707 of file __init__.py.

◆ media_seek()

None homeassistant.components.media_player.MediaPlayerEntity.media_seek	(		self,
		float	position
	)

Send seek command.

Definition at line 861 of file __init__.py.

◆ media_series_title()

str | None homeassistant.components.media_player.MediaPlayerEntity.media_series_title ( self )

Title of series of current playing media, TV show only.

Reimplemented in homeassistant.components.universal.media_player.UniversalMediaPlayer, homeassistant.components.plex.media_player.PlexMediaPlayer, homeassistant.components.emby.media_player.EmbyDevice, homeassistant.components.directv.media_player.DIRECTVMediaPlayer, homeassistant.components.cast.media_player.CastMediaPlayerEntity, and homeassistant.components.apple_tv.media_player.AppleTvMediaPlayer.

Definition at line 702 of file __init__.py.

◆ media_stop()

None homeassistant.components.media_player.MediaPlayerEntity.media_stop ( self )

Send stop command.

Definition at line 837 of file __init__.py.

◆ media_title()

str | None homeassistant.components.media_player.MediaPlayerEntity.media_title ( self )

Title of current playing media.

Definition at line 677 of file __init__.py.

◆ media_track()

int | None homeassistant.components.media_player.MediaPlayerEntity.media_track ( self )

Track number of current playing media, music track only.

Definition at line 697 of file __init__.py.

◆ mute_volume()

None homeassistant.components.media_player.MediaPlayerEntity.mute_volume	(		self,
		bool	mute
	)

Mute the volume.

Definition at line 805 of file __init__.py.

◆ play_media()

None homeassistant.components.media_player.MediaPlayerEntity.play_media	(		self,
		MediaType \| str	media_type,
		str	media_id,
		**Any	kwargs
	)

Play a piece of media.

Definition at line 869 of file __init__.py.

◆ repeat()

RepeatMode | str | None homeassistant.components.media_player.MediaPlayerEntity.repeat ( self )

Return current repeat mode.

Definition at line 762 of file __init__.py.

◆ select_sound_mode()

None homeassistant.components.media_player.MediaPlayerEntity.select_sound_mode	(		self,
		str	sound_mode
	)

Select sound mode.

Reimplemented in homeassistant.components.yamaha.media_player.YamahaDeviceZone, homeassistant.components.lg_soundbar.media_player.LGDevice, and homeassistant.components.demo.media_player.AbstractDemoPlayer.

Definition at line 891 of file __init__.py.

◆ select_source()

None homeassistant.components.media_player.MediaPlayerEntity.select_source	(		self,
		str	source
	)

Select input source.

Definition at line 883 of file __init__.py.

◆ set_repeat()

None homeassistant.components.media_player.MediaPlayerEntity.set_repeat	(		self,
		RepeatMode	repeat
	)

Set repeat mode.

Reimplemented in homeassistant.components.sonos.media_player.SonosMediaPlayerEntity, homeassistant.components.roon.media_player.RoonDevice, and homeassistant.components.demo.media_player.DemoMusicPlayer.

Definition at line 915 of file __init__.py.

◆ set_shuffle()

None homeassistant.components.media_player.MediaPlayerEntity.set_shuffle	(		self,
		bool	shuffle
	)

Enable/disable shuffle mode.

Reimplemented in homeassistant.components.sonos.media_player.SonosMediaPlayerEntity, homeassistant.components.roon.media_player.RoonDevice, homeassistant.components.itunes.media_player.ItunesDevice, and homeassistant.components.demo.media_player.AbstractDemoPlayer.

Definition at line 907 of file __init__.py.

◆ set_volume_level()

None homeassistant.components.media_player.MediaPlayerEntity.set_volume_level	(		self,
		float	volume
	)

Set volume level, range 0..1.

Definition at line 813 of file __init__.py.

◆ shuffle()

bool | None homeassistant.components.media_player.MediaPlayerEntity.shuffle ( self )

Boolean if shuffle is enabled.

Definition at line 757 of file __init__.py.

◆ sound_mode()

str | None homeassistant.components.media_player.MediaPlayerEntity.sound_mode ( self )

Name of the current sound mode.

Reimplemented in homeassistant.components.yamaha_musiccast.media_player.MusicCastMediaPlayer, homeassistant.components.universal.media_player.UniversalMediaPlayer, homeassistant.components.songpal.media_player.SongpalEntity, homeassistant.components.lg_soundbar.media_player.LGDevice, homeassistant.components.devialet.media_player.DevialetMediaPlayerEntity, homeassistant.components.denonavr.media_player.DenonDevice, and homeassistant.components.arcam_fmj.media_player.ArcamFmj.

Definition at line 747 of file __init__.py.

◆ sound_mode_list()

list[str] | None homeassistant.components.media_player.MediaPlayerEntity.sound_mode_list ( self )

List of available sound modes.

Reimplemented in homeassistant.components.yamaha_musiccast.media_player.MusicCastMediaPlayer, homeassistant.components.universal.media_player.UniversalMediaPlayer, homeassistant.components.songpal.media_player.SongpalEntity, homeassistant.components.lg_soundbar.media_player.LGDevice, and homeassistant.components.arcam_fmj.media_player.ArcamFmj.

Definition at line 752 of file __init__.py.

◆ source()

str | None homeassistant.components.media_player.MediaPlayerEntity.source ( self )

Name of the current input source.

Definition at line 737 of file __init__.py.

◆ source_list()

list[str] | None homeassistant.components.media_player.MediaPlayerEntity.source_list ( self )

List of available input sources.

Definition at line 742 of file __init__.py.

◆ state()

MediaPlayerState | None homeassistant.components.media_player.MediaPlayerEntity.state ( self )

State of the player.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 575 of file __init__.py.

◆ state_attributes()

dict[str, Any] homeassistant.components.media_player.MediaPlayerEntity.state_attributes ( self )

Return the state attributes.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 1114 of file __init__.py.

◆ support_clear_playlist()

bool homeassistant.components.media_player.MediaPlayerEntity.support_clear_playlist ( self )

Boolean if clear playlist command supported.

Definition at line 994 of file __init__.py.

◆ support_grouping()

bool homeassistant.components.media_player.MediaPlayerEntity.support_grouping ( self )

Boolean if player grouping is supported.

Definition at line 1006 of file __init__.py.

◆ support_next_track()

bool homeassistant.components.media_player.MediaPlayerEntity.support_next_track ( self )

Boolean if next track command supported.

Definition at line 968 of file __init__.py.

◆ support_pause()

bool homeassistant.components.media_player.MediaPlayerEntity.support_pause ( self )

Boolean if pause is supported.

Definition at line 932 of file __init__.py.

◆ support_play()

bool homeassistant.components.media_player.MediaPlayerEntity.support_play ( self )

Boolean if play is supported.

Definition at line 926 of file __init__.py.

◆ support_play_media()

bool homeassistant.components.media_player.MediaPlayerEntity.support_play_media ( self )

Boolean if play media command supported.

Definition at line 974 of file __init__.py.

◆ support_previous_track()

bool homeassistant.components.media_player.MediaPlayerEntity.support_previous_track ( self )

Boolean if previous track command supported.

Definition at line 962 of file __init__.py.

◆ support_seek()

bool homeassistant.components.media_player.MediaPlayerEntity.support_seek ( self )

Boolean if seek is supported.

Definition at line 944 of file __init__.py.

◆ support_select_sound_mode()

bool homeassistant.components.media_player.MediaPlayerEntity.support_select_sound_mode ( self )

Boolean if select sound mode command supported.

Definition at line 986 of file __init__.py.

◆ support_select_source()

bool homeassistant.components.media_player.MediaPlayerEntity.support_select_source ( self )

Boolean if select source command supported.

Definition at line 980 of file __init__.py.

◆ support_shuffle_set()

bool homeassistant.components.media_player.MediaPlayerEntity.support_shuffle_set ( self )

Boolean if shuffle is supported.

Definition at line 1000 of file __init__.py.

◆ support_stop()

bool homeassistant.components.media_player.MediaPlayerEntity.support_stop ( self )

Boolean if stop is supported.

Definition at line 938 of file __init__.py.

◆ support_volume_mute()

bool homeassistant.components.media_player.MediaPlayerEntity.support_volume_mute ( self )

Boolean if muting volume is supported.

Definition at line 956 of file __init__.py.

◆ support_volume_set()

bool homeassistant.components.media_player.MediaPlayerEntity.support_volume_set ( self )

Boolean if setting volume is supported.

Definition at line 950 of file __init__.py.

◆ supported_features()

MediaPlayerEntityFeature homeassistant.components.media_player.MediaPlayerEntity.supported_features ( self )

Flag media player features that are supported.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 772 of file __init__.py.

◆ supported_features_compat()

MediaPlayerEntityFeature homeassistant.components.media_player.MediaPlayerEntity.supported_features_compat ( self )

Return the supported features as MediaPlayerEntityFeature.

Remove this compatibility shim in 2025.1 or later.

Definition at line 777 of file __init__.py.

◆ turn_off()

None homeassistant.components.media_player.MediaPlayerEntity.turn_off ( self )

Turn the media player off.

Definition at line 797 of file __init__.py.

◆ turn_on()

None homeassistant.components.media_player.MediaPlayerEntity.turn_on ( self )

Turn the media player on.

Definition at line 789 of file __init__.py.

◆ unjoin_player()

None homeassistant.components.media_player.MediaPlayerEntity.unjoin_player ( self )

Remove this player from any group.

Reimplemented in homeassistant.components.roon.media_player.RoonDevice, and homeassistant.components.demo.media_player.DemoMusicPlayer.

Definition at line 1153 of file __init__.py.

◆ volume_level()

float | None homeassistant.components.media_player.MediaPlayerEntity.volume_level ( self )

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

Definition at line 587 of file __init__.py.

◆ volume_step()

float homeassistant.components.media_player.MediaPlayerEntity.volume_step ( self )

Return the step to be used by the volume_up and volume_down services.

Definition at line 592 of file __init__.py.

Member Data Documentation

◆ _access_token

homeassistant.components.media_player.MediaPlayerEntity._access_token

private

Definition at line 583 of file __init__.py.

◆ _entity_component_unrecorded_attributes

homeassistant.components.media_player.MediaPlayerEntity._entity_component_unrecorded_attributes

staticprivate

Definition at line 516 of file __init__.py.

◆ bool

homeassistant.components.media_player.MediaPlayerEntity.bool

static

Definition at line 544 of file __init__.py.

◆ MediaPlayerEntityFeature

homeassistant.components.media_player.MediaPlayerEntity.MediaPlayerEntityFeature

static

Definition at line 560 of file __init__.py.

◆ None

homeassistant.components.media_player.MediaPlayerEntity.None

static

Definition at line 528 of file __init__.py.

◆ state

homeassistant.components.media_player.MediaPlayerEntity.state

Definition at line 1067 of file __init__.py.

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

core/homeassistant/components/media_player/__init__.py

Home Assistant Unofficial Reference 2024.12.1

Public Member Functions

Public Attributes

Static Public Attributes

Private Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Member Function Documentation

◆ _async_fetch_image()

◆ _async_fetch_image_from_cache()

◆ access_token()

◆ app_id()

◆ app_name()

◆ async_browse_media()

◆ async_clear_playlist()

◆ async_get_browse_image()

◆ async_get_media_image()

◆ async_join_players()

◆ async_media_next_track()

◆ async_media_pause()

◆ async_media_play()

◆ async_media_play_pause()

◆ async_media_previous_track()

◆ async_media_seek()

◆ async_media_stop()

◆ async_mute_volume()

◆ async_play_media()

◆ async_select_sound_mode()

◆ async_select_source()

◆ async_set_repeat()

◆ async_set_shuffle()

◆ async_set_volume_level()

◆ async_toggle()

◆ async_turn_off()

◆ async_turn_on()

◆ async_unjoin_player()

◆ async_volume_down()

◆ async_volume_up()

◆ capability_attributes()

◆ clear_playlist()

◆ device_class()

◆ entity_picture()

◆ get_browse_image_url()

◆ group_members()

◆ is_volume_muted()

◆ join_players()

◆ media_album_artist()

◆ media_album_name()

◆ media_artist()

◆ media_channel()

◆ media_content_id()

◆ media_content_type()

◆ media_duration()

◆ media_episode()

◆ media_image_hash()

◆ media_image_local()

◆ media_image_remotely_accessible()

◆ media_image_url()

◆ media_next_track()

◆ media_pause()

◆ media_play()

◆ media_playlist()

◆ media_position()

◆ media_position_updated_at()

◆ media_previous_track()

◆ media_season()

◆ media_seek()

◆ media_series_title()

◆ media_stop()

◆ media_title()

◆ media_track()

◆ mute_volume()

◆ play_media()

◆ repeat()

◆ select_sound_mode()

◆ select_source()

◆ set_repeat()

◆ set_shuffle()

◆ set_volume_level()

◆ shuffle()