Inheritance diagram for homeassistant.components.spotify.media_player.SpotifyMediaPlayer:

Collaboration diagram for homeassistant.components.spotify.media_player.SpotifyMediaPlayer:

Public Member Functions
None	__init__ (self, SpotifyCoordinator coordinator, DataUpdateCoordinator[list[Device]] device_coordinator)

None	async_added_to_hass (self)

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

None	async_media_next_track (self)

None	async_media_pause (self)

None	async_media_play (self)

None	async_media_previous_track (self)

None	async_media_seek (self, float position)

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

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)

PlaybackState\|None	currently_playing (self)

str	media_album_name (self, Item item)

str	media_artist (self, Item item)

str	media_content_id (self, Item item)

str	media_content_type (self, Item item)

int	media_duration (self, Item item)

str\|None	media_image_url (self, Item item)

str\|None	media_playlist (self)

int\|None	media_position (self)

dt.datetime\|None	media_position_updated_at (self)

str	media_title (self, Item item)

int\|None	media_track (self, Item item)

RepeatMode\|None	repeat (self)

bool\|None	shuffle (self)

str\|None	source (self)

list[str]\|None	source_list (self)

MediaPlayerState	state (self)

MediaPlayerEntityFeature	supported_features (self)

float\|None	volume_level (self)

Public Member Functions inherited from homeassistant.components.spotify.entity.SpotifyEntity
None	__init__ (self, SpotifyCoordinator coordinator)

Public Member Functions inherited from homeassistant.helpers.update_coordinator.CoordinatorEntity
None	__init__ (self, _DataUpdateCoordinatorT coordinator, Any context=None)

None	async_update (self)

bool	available (self)

Public Member Functions inherited from homeassistant.components.spotify.coordinator.SpotifyCoordinator
None	__init__ (self, HomeAssistant hass, SpotifyClient client)

Public Member Functions inherited from homeassistant.helpers.update_coordinator.DataUpdateCoordinator
None	__init__ (self, HomeAssistant hass, logging.Logger logger, *config_entries.ConfigEntry\|None\|UndefinedType config_entry=UNDEFINED, str name, timedelta\|None update_interval=None, Callable[[], Awaitable[_DataT]]\|None update_method=None, Callable[[], Awaitable[None]]\|None setup_method=None, Debouncer[Coroutine[Any, Any, None]]\|None request_refresh_debouncer=None, bool always_update=True)

Callable[[], None]	async_add_listener (self, CALLBACK_TYPE update_callback, Any context=None)

None	async_config_entry_first_refresh (self)

Generator[Any]	async_contexts (self)

None	async_refresh (self)

None	async_register_shutdown (self)

None	async_request_refresh (self)

None	async_set_update_error (self, Exception err)

None	async_set_updated_data (self, _DataT data)

None	async_shutdown (self)

None	async_update_listeners (self)

timedelta\|None	update_interval (self)

None	update_interval (self, timedelta\|None value)

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

None	async_media_stop (self)

None	async_mute_volume (self, bool mute)

None	async_select_sound_mode (self, str sound_mode)

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)

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)

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)

str\|None	sound_mode (self)

list[str]\|None	sound_mode_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_compat (self)

None	turn_off (self)

None	turn_on (self)

None	unjoin_player (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_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
	devices

Public Attributes inherited from homeassistant.components.spotify.coordinator.SpotifyCoordinator
	client

	current_user

Public Attributes inherited from homeassistant.helpers.update_coordinator.DataUpdateCoordinator
	always_update

	config_entry

	data

	hass

	last_exception

	last_update_success

	logger

	name

	setup_method

	update_interval

	update_method

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

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

	entity_id

	hass

	parallel_updates

	platform

	registry_entry

Private Member Functions
None	_handle_devices_update (self)

Private Attributes
	_attr_unique_id

Static Private Attributes
bool	_attr_media_image_remotely_accessible = False

	_attr_name = None

string	_attr_translation_key = "spotify"

Additional Inherited Members
Static Public Attributes inherited from homeassistant.components.spotify.coordinator.SpotifyCoordinatorData
	bool

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

	MediaPlayerEntityFeature

	None

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

	EntityPlatform

	HomeAssistant

	None

	StateInfo

	StateType

	str

Detailed Description

Representation of a Spotify controller.

Definition at line 111 of file media_player.py.

Constructor & Destructor Documentation

◆ init()

None homeassistant.components.spotify.media_player.SpotifyMediaPlayer.__init__	(		self,
		SpotifyCoordinator	coordinator,
		DataUpdateCoordinator[list[Device]]	device_coordinator
	)

Initialize.

Definition at line 118 of file media_player.py.

Member Function Documentation

◆ _handle_devices_update()

None homeassistant.components.spotify.media_player.SpotifyMediaPlayer._handle_devices_update ( self )

private

Handle updated data from the coordinator.

Definition at line 396 of file media_player.py.

◆ async_added_to_hass()

None homeassistant.components.spotify.media_player.SpotifyMediaPlayer.async_added_to_hass ( self )

When entity is added to hass.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 402 of file media_player.py.

◆ async_browse_media()

BrowseMedia homeassistant.components.spotify.media_player.SpotifyMediaPlayer.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 381 of file media_player.py.

◆ async_media_next_track()

None homeassistant.components.spotify.media_player.SpotifyMediaPlayer.async_media_next_track ( self )

Skip to next track.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 306 of file media_player.py.

◆ async_media_pause()

None homeassistant.components.spotify.media_player.SpotifyMediaPlayer.async_media_pause ( self )

Pause playback.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 296 of file media_player.py.

◆ async_media_play()

None homeassistant.components.spotify.media_player.SpotifyMediaPlayer.async_media_play ( self )

Start or resume playback.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 291 of file media_player.py.

◆ async_media_previous_track()

None homeassistant.components.spotify.media_player.SpotifyMediaPlayer.async_media_previous_track ( self )

Skip to previous track.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 301 of file media_player.py.

◆ async_media_seek()

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

Send seek command.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 311 of file media_player.py.

◆ async_play_media()

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

Play media.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 316 of file media_player.py.

◆ async_select_source()

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

Select playback device.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 360 of file media_player.py.

◆ async_set_repeat()

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

Set repeat mode.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 375 of file media_player.py.

◆ async_set_shuffle()

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

Enable/Disable shuffle mode.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 370 of file media_player.py.

◆ async_set_volume_level()

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

Set the volume level.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 286 of file media_player.py.

◆ currently_playing()

PlaybackState | None homeassistant.components.spotify.media_player.SpotifyMediaPlayer.currently_playing ( self )

Return the current playback.

Definition at line 129 of file media_player.py.

◆ media_album_name()

str homeassistant.components.spotify.media_player.SpotifyMediaPlayer.media_album_name	(		self,
		Item	item
	)

Return the media album.

Definition at line 229 of file media_player.py.

◆ media_artist()

str homeassistant.components.spotify.media_player.SpotifyMediaPlayer.media_artist	(		self,
		Item	item
	)

Return the media artist.

Definition at line 216 of file media_player.py.

◆ media_content_id()

str homeassistant.components.spotify.media_player.SpotifyMediaPlayer.media_content_id	(		self,
		Item	item
	)

Return the media URL.

Definition at line 160 of file media_player.py.

◆ media_content_type()

str homeassistant.components.spotify.media_player.SpotifyMediaPlayer.media_content_type	(		self,
		Item	item
	)

Return the media type.

Definition at line 166 of file media_player.py.

◆ media_duration()

int homeassistant.components.spotify.media_player.SpotifyMediaPlayer.media_duration	(		self,
		Item	item
	)

Duration of current playing media in seconds.

Definition at line 172 of file media_player.py.

◆ media_image_url()

str \| None homeassistant.components.spotify.media_player.SpotifyMediaPlayer.media_image_url	(		self,
		Item	item
	)

Return the media image URL.

Definition at line 192 of file media_player.py.

◆ media_playlist()

str | None homeassistant.components.spotify.media_player.SpotifyMediaPlayer.media_playlist ( self )

Title of Playlist currently playing.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 251 of file media_player.py.

◆ media_position()

int | None homeassistant.components.spotify.media_player.SpotifyMediaPlayer.media_position ( self )

Position of current playing media in seconds.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 177 of file media_player.py.

◆ media_position_updated_at()

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

When was the position of the current playing media valid.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 184 of file media_player.py.

◆ media_title()

str homeassistant.components.spotify.media_player.SpotifyMediaPlayer.media_title	(		self,
		Item	item
	)

Return the media title.

Definition at line 210 of file media_player.py.

◆ media_track()

int \| None homeassistant.components.spotify.media_player.SpotifyMediaPlayer.media_track	(		self,
		Item	item
	)

Track number of current playing media, music track only.

Definition at line 242 of file media_player.py.

◆ repeat()

RepeatMode | None homeassistant.components.spotify.media_player.SpotifyMediaPlayer.repeat ( self )

Return current repeat mode.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 279 of file media_player.py.

◆ shuffle()

bool | None homeassistant.components.spotify.media_player.SpotifyMediaPlayer.shuffle ( self )

Shuffling state.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 272 of file media_player.py.

◆ source()

str | None homeassistant.components.spotify.media_player.SpotifyMediaPlayer.source ( self )

Return the current playback device.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 260 of file media_player.py.

◆ source_list()

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

Return a list of source devices.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 267 of file media_player.py.

◆ state()

MediaPlayerState homeassistant.components.spotify.media_player.SpotifyMediaPlayer.state ( self )

Return the playback state.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 143 of file media_player.py.

◆ supported_features()

MediaPlayerEntityFeature homeassistant.components.spotify.media_player.SpotifyMediaPlayer.supported_features ( self )

Return the supported features.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 134 of file media_player.py.

◆ volume_level()

float | None homeassistant.components.spotify.media_player.SpotifyMediaPlayer.volume_level ( self )

Return the device volume.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 152 of file media_player.py.

Member Data Documentation

◆ _attr_media_image_remotely_accessible

bool homeassistant.components.spotify.media_player.SpotifyMediaPlayer._attr_media_image_remotely_accessible = False

staticprivate

Definition at line 114 of file media_player.py.

◆ _attr_name

homeassistant.components.spotify.media_player.SpotifyMediaPlayer._attr_name = None

staticprivate

Definition at line 115 of file media_player.py.

◆ _attr_translation_key

string homeassistant.components.spotify.media_player.SpotifyMediaPlayer._attr_translation_key = "spotify"

staticprivate

Definition at line 116 of file media_player.py.

◆ _attr_unique_id

homeassistant.components.spotify.media_player.SpotifyMediaPlayer._attr_unique_id

private

Definition at line 126 of file media_player.py.

◆ devices

homeassistant.components.spotify.media_player.SpotifyMediaPlayer.devices

Definition at line 125 of file media_player.py.

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

core/homeassistant/components/spotify/media_player.py

Home Assistant Unofficial Reference 2024.12.1

Public Member Functions

Public Attributes

Private Member Functions

Private Attributes

Static Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __init__()

Member Function Documentation

◆ _handle_devices_update()

◆ async_added_to_hass()

◆ async_browse_media()

◆ async_media_next_track()

◆ async_media_pause()

◆ async_media_play()

◆ async_media_previous_track()

◆ async_media_seek()

◆ async_play_media()

◆ async_select_source()

◆ async_set_repeat()

◆ async_set_shuffle()

◆ async_set_volume_level()

◆ currently_playing()

◆ media_album_name()

◆ media_artist()

◆ media_content_id()

◆ media_content_type()

◆ media_duration()

◆ media_image_url()

◆ media_playlist()

◆ media_position()

◆ media_position_updated_at()

◆ media_title()

◆ media_track()

◆ repeat()

◆ shuffle()

◆ source()

◆ source_list()

◆ state()

◆ supported_features()

◆ volume_level()

Member Data Documentation

◆ _attr_media_image_remotely_accessible

◆ _attr_name

◆ _attr_translation_key

◆ _attr_unique_id

◆ devices

◆ init()