Sonos favorites include any content favorited by listeners in the Sonos app. These can include tracks and playlists from each service in the household. The Sonos app filters favorites into different swim lanes in My Sonos. See My Sonos in the Explore our products, The Sonos app section in the Sonos user guide for details.
The favorites namespace enables your app or hardware integration to enumerate the list of Sonos favorites in a household and load one to start playback. Favorites do not include non-playable containers pinned to My Sonos or Sonos playlists.
Content services can also expose their favorites in their integrations in the Sonos app. This namespace does not show those favorites. Add favorites for details.
Note: As a best practice, use the favorites and playlists namespaces together if you use them. The Sonos app combines the results of these two namespaces in different swim lanes. If you don’t use these together, users may think some of their content is missing in your integration.
The tables below list the commands and events available in the favorites namespace.
Commands
| Command | Description |
|---|---|
getFavorites |
Get the list of favorites for a household. |
loadFavorite |
Activate a favorite within the default playback session. Operates as if the listener selected the favorite using the Sonos app. This command interrupts any active private playback sessions. |
subscribe |
Subscribe to events in the favorites namespace. |
unsubscribe |
Unsubscribe from events in the favorites namespace. |
Object
| Object | Description |
|---|---|
favorite |
Describes a Sonos favorite in the household. See the Save your favorites section in the Sonos user guide and Add favorites for details. |