Card Features
Features and functionality index.
Card layout is comprised of a header, content, and footer areas.
This area is used to display a title that represents the card as a whole (e.g. "My SoundTouch Info").
The header will not be shown if the title content is empty or not configured.
This area is used to display selected section content. Please refer to the Section Content topic below for more details about the different sections.
This area is used to display section selection icons if multiple sections of the card are enabled.
The footer will not be shown if only one section is selected.
Sections are enabled / disabled via Card Configuration.
Multiple sections can be enabled in the card, but only one section is displayed at a time in the content area. A section is selected for display by clicking on its icon located in the footer area. In most cases, the section content is refreshed when you switch to the section.
A single section can be enabled in the card, which will only show content for that section.This configuration allows you to show the different sections next to each other (in a horizontal stack lets say) by adding multiple instances of the card with different sections enabled.
By default, the Device Presets and Recently Played sections of the card are enabled.
The following are detailed explanations of the individual sections.
This section will display information about the media content that is currently playing, as well as the ability to control playback.
The following controls are available for controlling playback: play / pause, next track, previous track, shuffle, and repeat. Seek is also available via the progress bar. The player controls area can be completely hidden, or hide / show individual control buttons as desired.
The following volume related controls are available: mute, and a slider control to adjust volume to any amount between 0 - 100 percent. The volume controls area can be completely hidden, or hide / show individual volume control buttons as desired.
You can also control the background opacity of the header status area and the controls area.
This section will display Station favorites from the Pandora music service.
You must have the Pandora music service configured on the SoundTouch device in order for the card to access Pandora Stations. The Pandora music service can be added and configured via the Bose SoundTouch App. The SoundTouch device limits you to one Pandora music service user account per device, which must match the Pandora source account configured in the card.
The card accesses the Pandora music service via the SoundTouch device. There is no direct communication from the card to the Pandora music service; the SoundTouch device makes requests to and receives responses from the Pandora music service.
Pandora Stations are retrieved from the SoundTouch device using the PANDORA source. The stations are retrieved in real time by the device (not cached), so any stations you just added via the Pandora web or mobile player should show up immediately upon the next refresh of the media list in the card.
Pandora Stations are presented to the user in a Media Browser format. An item may be selected for play immediately by clicking on the item.
This section will display Presets that are stored on the SoundTouch device.
Device Presets can be set via the SoundTouch App, or by pressing a physical button on the device (if the model supports it).
Device Presets are retrieved from the SoundTouch device using the SoundTouchPlus preset_list service. The presets are retrieved in real time by the device (not cached), so any preset changes you just made via the SoundTouch App or from the device should show up immediately. The card will also update if the SoundTouchPlus integration detects a preset list change in real-time (e.g. when a preset is set via the SoundTouch App, or physical button press).
Device Presets are presented to the user in a Media Browser format. An item may be selected for play immediately by clicking on the item. The media browser also supports setting a preset to the currently playing content; simply press and hold a preset item for 2 seconds, then release and the preset will be stored. Note that the currently playing content item must be marked as isPresetable in order for it to be stored as a preset.
This section will display User Presets that are defined in the card configuration.
User Presets are presented to the user in a Media Browser format. An item may be selected for play immediately by clicking on the item.
Please refer to the User Preset Configuration wiki document for examples of how to define user preset content items.
This section will display Recently Played items that are stored on the SoundTouch device.
Recently Played items are retrieved from the SoundTouch device using the SoundTouchPlus recent_list service. The items are retrieved in real time by the device (not cached). The card will also update if the SoundTouchPlus integration detects a recently played list change in real-time.
Recently played items are presented to the user in a Media Browser format. An item may be selected for play immediately by clicking on the item.
Most of the various section displays in the card utilize a media browser for displaying media content items. This media browser functionality is similar to the Home Assistant Media Browser functionality in how it looks, but it behaves a little bit differently under the covers.
Here are a few features of the media browser:
-
supports item click functionality to play the given content. The item is immediately selected for play once it is clicked.
-
supports item click and hold functionality for some section types. For example, the Device Presets media browser allows a preset to be set to the currently playing media by clicking and holding the preset slot item for @ 2 seconds.
-
supports both icon (see Figure 1a) and list (see Figure 1b) formats. For the icon format, the number of icons in the row is configurable. The size of the icons is also responsive, in that they will expand / shrink in size to fill the available space.
-
supports custom image url's based on the track title, so that you can manually override the image that is displayed for a named track if you like. This also works well for recently played items, as the SoundTouch device automatically removes cover art image url's from the recently played list due to copyright agreements with the various music services.
Figure 1a - Media Items Icon Format
Figure 1b - Media Items List Format
