[ 1.0.27 ] * Updated Devices section to remove device entries that wish to be hidden as specified by SpotifyPlus integration configuration "hide devices" option.

  * Added ability to play recently played tracks starting from selected track, which will now automatically add the following tracks (up to 50) to the player queue.  Prior to this, only the selected track would play and then play would stop.  Note that the 50 track limitation is a Spotify Web API limit.
  * Added ability to play player queue tracks starting from selected track, which will now automatically add the following tracks (up to 50) to the player queue.  Prior to this, only the selected track would play and then play would stop.  Note that the 50 track limitation is a Spotify Web API limit.

Author: thlucas1

CHANGELOG.md

@@ -6,13 +6,19 @@ Change are listed in reverse chronological order (newest to oldest).
 
 <span class="changelog">
 
+###### [ 1.0.27 ] - 2024/12/28
+
+  * Updated Devices section to remove device entries that wish to be hidden as specified by SpotifyPlus integration configuration "hide devices" option.
+  * Added ability to play recently played tracks starting from selected track, which will now automatically add the following tracks (up to 50) to the player queue.  Prior to this, only the selected track would play and then play would stop.  Note that the 50 track limitation is a Spotify Web API limit.
+  * Added ability to play player queue tracks starting from selected track, which will now automatically add the following tracks (up to 50) to the player queue.  Prior to this, only the selected track would play and then play would stop.  Note that the 50 track limitation is a Spotify Web API limit.
+
 ###### [ 1.0.26 ] - 2024/12/24
 
   * Added `playerBackgroundImageSize` config option that specifies the size of the player background image.  Defaults to "100% 100%"; More info can be found on the [wiki docs](https://github.com/thlucas1/spotifyplus_card/wiki/Configuration-Options#playerbackgroundimagesize).
 
 ###### [ 1.0.25 ] - 2024/12/23
 
-  * Ability to play track favorites starting from selected favorite track, which will now automatically add the following tracks (up to 50) to the player queue.  Prior to this, only the selected track would play and then play would stop.  Note that the 50 track limitation is a Spotify Web API limit.
+  * Added ability to play track favorites starting from selected favorite track, which will now automatically add the following tracks (up to 50) to the player queue.  Prior to this, only the selected track would play and then play would stop.  Note that the 50 track limitation is a Spotify Web API limit.
 
 ###### [ 1.0.24 ] - 2024/12/22
 

src/components/player-body-queue.ts

@@ -1,3 +1,8 @@
+// debug logging.
+import Debug from 'debug/src/browser.js';
+import { DEBUG_APP_NAME } from '../constants';
+const debuglog = Debug(DEBUG_APP_NAME + ":player-body-queue");
+
 // lovelace card imports.
 import { css, html, TemplateResult } from 'lit';
 import { state } from 'lit/decorators.js';
@@ -9,14 +14,11 @@ import {
 import { sharedStylesGrid } from '../styles/shared-styles-grid.js';
 import { sharedStylesMediaInfo } from '../styles/shared-styles-media-info.js';
 import { sharedStylesFavActions } from '../styles/shared-styles-fav-actions.js';
+import { getMediaListTrackUrisRemaining } from '../utils/media-browser-utils.js';
 import { PlayerBodyBase } from './player-body-base';
 import { MediaPlayer } from '../model/media-player';
-import { IPlayerQueueInfo } from '../types/spotifyplus/player-queue-info.js';
-
-// debug logging.
-import Debug from 'debug/src/browser.js';
-import { DEBUG_APP_NAME } from '../constants';
-const debuglog = Debug(DEBUG_APP_NAME + ":player-body-queue");
+import { IPlayerQueueInfo } from '../types/spotifyplus/player-queue-info';
+import { ITrack } from '../types/spotifyplus/track';
 
 /**
  * Track actions.
@@ -214,11 +216,19 @@ export class PlayerBodyQueue extends PlayerBodyBase {
 
       } else if (action == Actions.TrackPlay) {
 
-        await this.spotifyPlusService.Card_PlayMediaBrowserItem(this.player, item);
+        // build track uri list from media list.
+        const { uris } = getMediaListTrackUrisRemaining(this.queueInfo?.queue as ITrack[], item);
+        
+        // play media item.
+        this.spotifyPlusService.PlayerMediaPlayTracks(this.player.id, uris.join(","));
         this.progressHide();
 
-      }
+      } else {
 
+        // no action selected - hide progress indicator.
+        this.progressHide();
+
+      }
       return true;
 
     }

src/components/player-controls.ts

@@ -34,7 +34,7 @@ import Debug from 'debug/src/browser.js';
 import { DEBUG_APP_NAME } from '../constants';
 const debuglog = Debug(DEBUG_APP_NAME + ":player-controls");
 
-const { NEXT_TRACK, PAUSE, PLAY, PREVIOUS_TRACK, REPEAT_SET, SHUFFLE_SET, TURN_ON } = MediaPlayerEntityFeature;
+const { NEXT_TRACK, PAUSE, PLAY, PREVIOUS_TRACK, REPEAT_SET, SHUFFLE_SET, TURN_ON, TURN_OFF } = MediaPlayerEntityFeature;
 const ACTION_FAVES = 900000000000;
 const PLAY_QUEUE = 990000000000;
 
@@ -102,6 +102,7 @@ class PlayerControls extends LitElement {
           <spc-player-volume hide=${stopped} .store=${this.store} .player=${this.player} class="player-volume-container"></spc-player-volume>
           <div class="iconsPower">
               <ha-icon-button @click=${() => this.onClickAction(TURN_ON)}        hide=${this.hideFeature(TURN_ON)}        .path=${mdiPower} label="Turn On" style=${this.styleIcon(colorPower)}></ha-icon-button>
+              <ha-icon-button @click=${() => this.onClickAction(TURN_OFF)}       hide=${this.hideFeature(TURN_OFF)}       .path=${mdiPower} label="Turn Off"></ha-icon-button>
           </div>
       </div>
   `;
@@ -458,9 +459,9 @@ class PlayerControls extends LitElement {
 
         await this.mediaControlService.shuffle_set(this.player, !this.player.attributes.shuffle);
 
-        //} else if (action == TURN_OFF) {
+      } else if (action == TURN_OFF) {
 
-        //  this.mediaControlService.turn_off(this.player);
+        await this.mediaControlService.turn_off(this.player);
 
       } else if (action == TURN_ON) {
 
@@ -554,14 +555,15 @@ class PlayerControls extends LitElement {
         return true; // hide icon
       }
 
-    //} else if (feature == TURN_OFF) {
+    } else if (feature == TURN_OFF) {
 
-    //  if (this.player.supportsFeature(TURN_OFF)) {
-    //    if (![MediaPlayerState.OFF, MediaPlayerState.UNKNOWN, MediaPlayerState.STANDBY].includes(this.player.state)) {
-    //      return nothing; // show icon
-    //    }
-    //    return true; // hide icon
-    //  }
+      // this should only be allowed if the player state is IDLE.
+      if (this.player.supportsFeature(TURN_OFF)) {
+        if ([MediaPlayerState.IDLE].includes(this.player.state)) {
+          return (this.config.playerVolumeControlsHidePower) ? true : nothing;
+        }
+        return true; // hide icon
+      }
 
     }
 

src/constants.ts

@@ -1,7 +1,7 @@
 import { css } from 'lit';
 
 /** current version of the card. */
-export const CARD_VERSION = '1.0.26';
+export const CARD_VERSION = '1.0.27';
 
 /** SpotifyPlus integration domain identifier. */
 export const DOMAIN_SPOTIFYPLUS = 'spotifyplus';

src/sections/device-browser.ts

@@ -204,8 +204,11 @@ export class DeviceBrowser extends FavBrowserBase {
         const refresh = this.refreshDeviceList || false;  // refresh device list (defaults to cached list).
         const sortResult = true;  // true to sort returned items; otherwise, false
 
+        // get source items to omit.
+        const sourceListHide = player.attributes.sp_source_list_hide || [];
+
         // call the service to retrieve the media list.
-        this.spotifyPlusService.GetSpotifyConnectDevices(player.id, refresh, sortResult)
+        this.spotifyPlusService.GetSpotifyConnectDevices(player.id, refresh, sortResult, sourceListHide)
           .then(result => {
 
             // load media list results.

src/sections/recent-browser.ts

@@ -1,3 +1,8 @@
+// debug logging.
+import Debug from 'debug/src/browser.js';
+import { DEBUG_APP_NAME } from '../constants';
+const debuglog = Debug(DEBUG_APP_NAME + ":recent-browser");
+
 // lovelace card imports.
 import { html, TemplateResult } from 'lit';
 import { customElement } from 'lit/decorators.js';
@@ -9,7 +14,7 @@ import '../components/track-actions';
 import { FavBrowserBase } from './fav-browser-base';
 import { Section } from '../types/section';
 import { MediaPlayer } from '../model/media-player';
-import { formatTitleInfo } from '../utils/media-browser-utils';
+import { formatTitleInfo, getMediaListTrackUrisRemaining } from '../utils/media-browser-utils';
 import { getUtcNowTimestamp } from '../utils/utils';
 import { GetTracks } from '../types/spotifyplus/track-page-saved';
 import { ITrack } from '../types/spotifyplus/track';
@@ -96,6 +101,55 @@ export class RecentBrowser extends FavBrowserBase {
   }
 
 
+
+
+  /**
+   * Handles the `item-selected` event fired when a media browser item is clicked.
+   * 
+   * @param evArgs Event arguments that contain the media item that was clicked on.
+   */
+  protected override onItemSelected(evArgs: CustomEvent) {
+
+    if (debuglog.enabled) {
+      debuglog("onItemSelected - media item selected:\n%s",
+        JSON.stringify(evArgs.detail, null, 2),
+      );
+    }
+
+    try {
+
+      // show progress indicator.
+      this.progressShow();
+
+      // set media item reference.
+      const mediaItem = evArgs.detail as ITrack;
+
+      // build track uri list from media list.
+      const { uris } = getMediaListTrackUrisRemaining(this.mediaList || [], mediaItem);
+
+      // play media item.
+      this.spotifyPlusService.PlayerMediaPlayTracks(this.player.id, uris.join(","));
+
+      // show player section.
+      this.store.card.SetSection(Section.PLAYER);
+
+    }
+    catch (error) {
+
+      // set error message and reset scroll position to zero so the message is displayed.
+      this.alertErrorSet("Could not play media item.  " + (error as Error).message);
+      this.mediaBrowserContentElement.scrollTop = 0;
+
+    }
+    finally {
+
+      // hide progress indicator.
+      this.progressHide();
+
+    }
+  }
+
+
   /**
    * Updates the mediaList display.
    */

src/sections/track-fav-browser.ts

@@ -14,7 +14,7 @@ import '../components/track-actions';
 import { FavBrowserBase } from './fav-browser-base';
 import { Section } from '../types/section';
 import { MediaPlayer } from '../model/media-player';
-import { formatTitleInfo } from '../utils/media-browser-utils';
+import { formatTitleInfo, getMediaListTrackUrisRemaining } from '../utils/media-browser-utils';
 import { getUtcNowTimestamp } from '../utils/utils';
 import { GetTracks } from '../types/spotifyplus/track-page-saved';
 import { ITrack } from '../types/spotifyplus/track';
@@ -116,43 +116,14 @@ export class TrackFavBrowser extends FavBrowserBase {
 
     try {
 
+      // show progress indicator.
+      this.progressShow();
+
       // set media item reference.
       const mediaItem = evArgs.detail as ITrack;
 
-      // build track uri list from favorites list.
-      // note that Spotify web api can only play 50 tracks max.
-      const maxItems = 50;
-      const uris = new Array<string>();
-      const names = new Array<string>();
-      let count = 0;
-      let startFound = false;
-
-      for (const item of (this.mediaList || [])) {
-
-        if (item.uri == mediaItem.uri) {
-          startFound = true;
-        }
-
-        if (startFound) {
-          uris.push(item.uri);
-          names.push(item.name);
-          count += 1;
-          if (count >= maxItems) {
-            break;
-          }
-        }
-
-      }
-
-      // trace.
-      if (debuglog.enabled) {
-        debuglog("onItemSelected - tracks to play:\n%s",
-          JSON.stringify(names, null, 2),
-        );
-      }
-
-      // show progress indicator.
-      this.progressShow();
+      // build track uri list from media list.
+      const { uris } = getMediaListTrackUrisRemaining(this.mediaList || [], mediaItem);
 
       // play media item.
       this.spotifyPlusService.PlayerMediaPlayTracks(this.player.id, uris.join(","));
@@ -174,8 +145,6 @@ export class TrackFavBrowser extends FavBrowserBase {
       this.progressHide();
 
     }
-
-
   }
 
 

src/services/spotifyplus-service.ts

@@ -2261,12 +2261,14 @@ export class SpotifyPlusService {
    * 
    * @param refresh True to return real-time information from the spotify zeroconf api and update the cache; otherwise, False to just return the cached value.
    * @param sort_result True to sort the items by name; otherwise, False to leave the items in the same order they were returned in by the Spotify Zeroconf API.  Default is true.
+   * @param source_list_hide List of device names to hide from the source list (colon delimited).
    * @returns A SpotifyConnectDevices object.
   */
   public async GetSpotifyConnectDevices(
     entity_id: string,
     refresh: boolean | null = null,
     sort_result: boolean | null = null,
+    source_list_hide: Array<string> | null = null,
   ): Promise<ISpotifyConnectDevices> {
 
     try {
@@ -2302,8 +2304,18 @@ export class SpotifyPlusService {
       // get the "result" portion of the response, and convert it to a type.
       const responseObj = response["result"] as ISpotifyConnectDevices;
 
-      // set image_url property based on device type.
+      // process all items returned.
       if ((responseObj != null) && (responseObj.Items != null)) {
+
+        // remove source items that are hidden (based on SpotifyPlus config options);
+        // we have to do this in reverse order, due to iteration of the array.
+        for (let i = responseObj.Items.length - 1; i >= 0; i--) {
+          if (source_list_hide?.includes(responseObj.Items[i].Name.toLowerCase())) {
+            responseObj.Items.splice(i, 1);
+          }
+        }
+
+        // set image_url property based on device type.
         responseObj.Items.forEach(item => {
           // set image_url path using mdi icons for common sources.
           const sourceCompare = (item.Name || "").toLocaleLowerCase();

src/types/spotifyplus-hass-entity-attributes.ts

@@ -50,6 +50,11 @@ export declare type SpotifyPlusHassEntityAttributes = HassEntityAttributesMediaP
    */
   sp_playlist_uri?: string;
 
+  /**
+   * List of device names (in lower-case) to hide from the source list.
+   */
+  sp_source_list_hide?: Array<string>;
+
   /**
    * True if the track / episode has explicit content; otherwise, false.
    */