Skip to content

Media Library Browser

Todd Lucas edited this page Feb 26, 2024 · 12 revisions

Media Library Browsing support was enabled with the 1.0.1 release version of the integration. It includes various types of Spotify media content, as well as recently played items.

The following library index node content is supported:

How it Looks

Requirements

A Spotify Premium account is required to control a Spotify Connect media player(s).

The SpotifyWebApiPython library is used to make queries to the Spotify Web API for data gathering.

Customized Icon

A custom icon (or logo) can be displayed for each library index item by adding the images to the \config\www\images\ location with a filename format or spotifyplus_medialib_<NAME>.png, where <NAME> is the index entry name. For example, the "Playlists" entry image file name would be spotifyplus_medialib_playlists.png. The specified images will be displayed in the HA media browser index page. A stock icon image will be displayed if a custom image is not found for an index entry.

Playlists

Displays the playlists owned or followed by the Spotify user.

This will allow you to select a media item for play on the device by tapping on the play overlay icon of the media item. You can also display the contents of the playlist by tappping on the media item image outside of the play overlay icon.

How it Looks

Playlist Index Page

Playlist Detail Page

How it Works

The list of items is queried from the Spotify Web API using the GetPlaylistFavorites method, and returned to the media browser for display. Cover art images (if any) are in the form of url links, supplied by the music service for each item.

Customized Icon

A custom icon (or logo) can be displayed for this library index entry by adding the image to the \config\www\images\ location with a filename of spotifyplus_medialib_playlists.png. The specified image will be displayed in the HA media browser index page. A stock icon will be displayed if a custom image is not found for an index entry.

Artists

Displays the Spotify user's followed artists.

This will allow you to select a media item for play on the device by tapping on the play overlay icon of the media item. You can also display the artist's albums by tappping on the media item image outside of the play overlay icon.

How it Looks

Artist Index Page

Artist Albums Page

Artist Album Tracks Page

How it Works

The list of items is queried from the Spotify Web API using the GetArtistsFollowed method, and returned to the media browser for display. Cover art images (if any) are in the form of url links, supplied by the music service for each item.

Customized Icon

A custom icon (or logo) can be displayed for this library index entry by adding the image to the \config\www\images\ location with a filename of spotifyplus_medialib_artists.png. The specified image will be displayed in the HA media browser index page. A stock icon will be displayed if a custom image is not found for an index entry.

Albums

Displays the Spotify user's album favorites.

This will allow you to select a media item for play on the device by tapping on the play overlay icon of the media item. You can also display the album's tracks by tappping on the media item image outside of the play overlay icon.

How it Looks

Album Index Page

Album Tracks Page

How it Works

The list of items is queried from the Spotify Web API using the GetAlbumFavorites method, and returned to the media browser for display. Cover art images (if any) are in the form of url links, supplied by the music service for each item.

Customized Icon

A custom icon (or logo) can be displayed for this library index entry by adding the image to the \config\www\images\ location with a filename of spotifyplus_medialib_albums.png. The specified image will be displayed in the HA media browser index page. A stock icon will be displayed if a custom image is not found for an index entry.

Tracks

Displays the Spotify user's track favorites.

This will allow you to select a media item for play on the device by tapping on the play overlay icon of the media item.

How it Looks

Tracks Index Page

How it Works

The list of items is queried from the Spotify Web API using the GetTrackFavorites method, and returned to the media browser for display. Cover art images (if any) are in the form of url links, supplied by the music service for each item.

Customized Icon

A custom icon (or logo) can be displayed for this library index entry by adding the image to the \config\www\images\ location with a filename of spotifyplus_medialib_tracks.png. The specified image will be displayed in the HA media browser index page. A stock icon will be displayed if a custom image is not found for an index entry.

Podcasts

Displays the Spotify user's podcast (aka show) favorites.

This will allow you to select a media item for play on the device by tapping on the play overlay icon of the media item.

How it Looks

Podcasts Index Page

Podcasts Episode Page

How it Works

The list of items is queried from the Spotify Web API using the GetShowFavorites method, and returned to the media browser for display. Cover art images (if any) are in the form of url links, supplied by the music service for each item.

Customized Icon

A custom icon (or logo) can be displayed for this library index entry by adding the image to the \config\www\images\ location with a filename of spotifyplus_medialib_podcasts.png. The specified image will be displayed in the HA media browser index page. A stock icon will be displayed if a custom image is not found for an index entry.

Top Artists

Displays the Spotify user's top artists based on calculated affinity.

This will allow you to select a media item for play on the device by tapping on the play overlay icon of the media item. You can also display the artist's albums by tappping on the media item image outside of the play overlay icon.

How it Looks

Top Artists Index Page

Top Artist Albums Page

Top Artist Album Tracks Page

How it Works

The list of items is queried from the Spotify Web API using the GetUsersTopArtists method, and returned to the media browser for display. Cover art images (if any) are in the form of url links, supplied by the music service for each item.

Customized Icon

A custom icon (or logo) can be displayed for this library index entry by adding the image to the \config\www\images\ location with a filename of spotifyplus_medialib_top_artists.png. The specified image will be displayed in the HA media browser index page. A stock icon will be displayed if a custom image is not found for an index entry.

Top Tracks

Displays the Spotify user's top tracks based on calculated affinity.

This will allow you to select a media item for play on the device by tapping on the play overlay icon of the media item.

How it Looks

Top Tracks Index Page

How it Works

The list of items is queried from the Spotify Web API using the GetUsersTopTracks method, and returned to the media browser for display. Cover art images (if any) are in the form of url links, supplied by the music service for each item.

Customized Icon

A custom icon (or logo) can be displayed for this library index entry by adding the image to the \config\www\images\ location with a filename of spotifyplus_medialib_top_tracks.png. The specified image will be displayed in the HA media browser index page. A stock icon will be displayed if a custom image is not found for an index entry.

Featured Playlists

Displays a list of Spotify featured playlists (shown, for example, on a Spotify player's 'Browse' tab).

This will allow you to select a media item for play on the device by tapping on the play overlay icon of the media item. You can also display the contents of the playlist by tappping on the media item image outside of the play overlay icon.

How it Looks

Playlist Index Page

Playlist Detail Page

How it Works

The list of items is queried from the Spotify Web API using the GetFeaturedPlaylists method, and returned to the media browser for display. Cover art images (if any) are in the form of url links, supplied by the music service for each item.

Customized Icon

A custom icon (or logo) can be displayed for this library index entry by adding the image to the \config\www\images\ location with a filename of spotifyplus_medialib_featured_playlists.png. The specified image will be displayed in the HA media browser index page. A stock icon will be displayed if a custom image is not found for an index entry.

New Releases

Displays new album releases featured in Spotify.

This will allow you to select a media item for play on the device by tapping on the play overlay icon of the media item. You can also display the album's tracks by tappping on the media item image outside of the play overlay icon.

How it Looks

New Releases Index Page

New Releases Tracks Page

How it Works

The list of items is queried from the Spotify Web API using the GetAlbumNewReleases method, and returned to the media browser for display. Cover art images (if any) are in the form of url links, supplied by the music service for each item.

Customized Icon

A custom icon (or logo) can be displayed for this library index entry by adding the image to the \config\www\images\ location with a filename of spotifyplus_medialib_new_releases.png. The specified image will be displayed in the HA media browser index page. A stock icon will be displayed if a custom image is not found for an index entry.

Categories

Displays a list of Spotify categories (aka genres), and subsequent playlists tagged with a particular category.

This will allow you to select a category to display playlists that have been tagged with that category. It will then allow you to select a media item for play on the device by tapping on the play overlay icon of the media item. You can also display the playlist's tracks by tappping on the media item image outside of the play overlay icon.

How it Looks

Category Index Page

Category Playlists Page

Category Playlist Tracks Page

How it Works

The list of items is queried from the Spotify Web API using the GetBrowseCategorys method, and returned to the media browser for display. Cover art images (if any) are in the form of url links, supplied by the music service for each item.

The category playlist of items is queried from the Spotify Web API using the GetCategoryPlaylists method, and returned to the media browser for display. Cover art images (if any) are in the form of url links, supplied by the music service for each item. The playlists for the category is qu

Customized Icon

A custom icon (or logo) can be displayed for this library index entry by adding the image to the \config\www\images\ location with a filename of spotifyplus_medialib_categories.png. The specified image will be displayed in the HA media browser index page. A stock icon will be displayed if a custom image is not found for an index entry.

Made For You Playlists

Displays the "Made For You" category playlists, which are created by the Spotify AI engine for the user based on their listening habits.

This will allow you to select a media item for play on the device by tapping on the play overlay icon of the media item. You can also display the contents of the playlist by tappping on the media item image outside of the play overlay icon.

How it Looks

Made For You Playlist Index Page

Made For You Playlist Tracks Page

How it Works

The list of items is queried from the Spotify Web API using the GetCategoryPlaylists method, and returned to the media browser for display. Cover art images (if any) are in the form of url links, supplied by the music service for each item.

Customized Icon

A custom icon (or logo) can be displayed for this library index entry by adding the image to the \config\www\images\ location with a filename of spotifyplus_medialib_made_for_you.png. The specified image will be displayed in the HA media browser index page. A stock icon will be displayed if a custom image is not found for an index entry.

Recently Played

Displays the current Spotify Player recently played list for a given device.

This will allow you to select a media item for play on the device by tapping on the play overlay icon of the media item.

How it Looks

How it Works

The list of recently played items is queried from the Spotify Web API, and returned to the media browser for display. Cover art images (if any) are in the form of url links, supplied by the music service for each item.

Customized Icon

A custom icon (or logo) can be displayed for this library index entry by adding the image to the \config\www\images\ location with a filename of spotifyplus_medialib_recently_played.png. The specified image will be displayed in the HA media browser index page. A stock icon will be displayed if a custom image is not found for an index entry.