homeassistant.components.spotify.browse_media Namespace Reference

Classes
class	BrowsableMedia
class	ItemPayload
class	MissingMediaInformation
class	UnknownMediaType

Functions
ItemPayload	_get_album_item_payload (SimplifiedAlbum album)
ItemPayload	_get_artist_item_payload (Artist artist)
ItemPayload	_get_episode_item_payload (SimplifiedEpisode episode)
ItemPayload	_get_playlist_item_payload (BasePlaylist playlist)
ItemPayload	_get_track_item_payload (SimplifiedTrack track, bool show_thumbnails=True)
BrowseMedia	async_browse_media (HomeAssistant hass, str|None media_content_type, str|None media_content_id, *bool can_play_artist=True)
BrowseMedia	async_browse_media_internal (HomeAssistant hass, SpotifyClient spotify, str|None media_content_type, str|None media_content_id, *bool can_play_artist=True)
BrowseMedia|None	build_item_response (SpotifyClient spotify, dict[str, str|None] payload, *bool can_play_artist)
BrowseMedia	item_payload (ItemPayload item, *bool can_play_artist)
BrowseMedia	library_payload (*bool can_play_artist)

Variables
	_LOGGER = logging.getLogger(__name__)
int	BROWSE_LIMIT = 48
dictionary	LIBRARY_MAP

Detailed Description

Support for Spotify media browsing.

Function Documentation

_get_album_item_payload()

ItemPayload homeassistant.components.spotify.browse_media._get_album_item_payload ( SimplifiedAlbum  album )

private

Definition at line 58 of file browse_media.py.

_get_artist_item_payload()

ItemPayload homeassistant.components.spotify.browse_media._get_artist_item_payload ( Artist  artist )

private

Definition at line 48 of file browse_media.py.

_get_episode_item_payload()

ItemPayload homeassistant.components.spotify.browse_media._get_episode_item_payload ( SimplifiedEpisode  episode )

private

Definition at line 94 of file browse_media.py.

_get_playlist_item_payload()

ItemPayload homeassistant.components.spotify.browse_media._get_playlist_item_payload ( BasePlaylist  playlist )

private

Definition at line 68 of file browse_media.py.

_get_track_item_payload()

ItemPayload homeassistant.components.spotify.browse_media._get_track_item_payload ( SimplifiedTrack  track, bool   show_thumbnails = True  )

private

Definition at line 78 of file browse_media.py.

async_browse_media()

BrowseMedia homeassistant.components.spotify.browse_media.async_browse_media	(	HomeAssistant	hass,
		str | None	media_content_type,
		str | None	media_content_id,
		*bool	can_play_artist = True
	)

Browse Spotify media.

Definition at line 187 of file browse_media.py.

async_browse_media_internal()

BrowseMedia homeassistant.components.spotify.browse_media.async_browse_media_internal	(	HomeAssistant	hass,
		SpotifyClient	spotify,
		str | None	media_content_type,
		str | None	media_content_id,
		*bool	can_play_artist = True
	)

Browse spotify media.

Definition at line 264 of file browse_media.py.

build_item_response()

BrowseMedia | None homeassistant.components.spotify.browse_media.build_item_response	(	SpotifyClient	spotify,
		dict[str, str | None]	payload,
		*bool	can_play_artist
	)

Create response payload for the provided media query.

Definition at line 294 of file browse_media.py.

item_payload()

BrowseMedia homeassistant.components.spotify.browse_media.item_payload	(	ItemPayload	item,
		*bool	can_play_artist
	)

Create response payload for a single media item.

Used by async_browse_media.

Definition at line 429 of file browse_media.py.

library_payload()

BrowseMedia homeassistant.components.spotify.browse_media.library_payload

(

*bool

can_play_artist

)

Create response payload to describe contents of a specific library.

Used by async_browse_media.

Definition at line 464 of file browse_media.py.

Variable Documentation

_LOGGER

homeassistant.components.spotify.browse_media._LOGGER = logging.getLogger(__name__)

private

Definition at line 35 of file browse_media.py.

BROWSE_LIMIT

int homeassistant.components.spotify.browse_media.BROWSE_LIMIT = 48

Definition at line 32 of file browse_media.py.

LIBRARY_MAP

dictionary homeassistant.components.spotify.browse_media.LIBRARY_MAP

Initial value:

=  {
    BrowsableMedia.CURRENT_USER_PLAYLISTS.value: "Playlists",
    BrowsableMedia.CURRENT_USER_FOLLOWED_ARTISTS.value: "Artists",
    BrowsableMedia.CURRENT_USER_SAVED_ALBUMS.value: "Albums",
    BrowsableMedia.CURRENT_USER_SAVED_TRACKS.value: "Tracks",
    BrowsableMedia.CURRENT_USER_SAVED_SHOWS.value: "Podcasts",
    BrowsableMedia.CURRENT_USER_RECENTLY_PLAYED.value: "Recently played",
    BrowsableMedia.CURRENT_USER_TOP_ARTISTS.value: "Top Artists",
    BrowsableMedia.CURRENT_USER_TOP_TRACKS.value: "Top Tracks",
    BrowsableMedia.NEW_RELEASES.value: "New Releases",
}

Definition at line 118 of file browse_media.py.