Describes a Sonos favorite in the household.
Parameters
See the Control documentation for descriptions of parameters in the header. See the table below for descriptions of parameters in the body.
| Parameter | Type | Value |
|---|---|---|
id |
string | An identifier for the favorite. |
name |
string | A user-identifiable name. |
description |
string | (Optional) Provides more context to the user. |
type |
enum (itemType) | The SMAPI itemType. This is not yet implemented. |
imageUrl |
URL | (Optional) A single image URL. The default image for the favorite. |
imageCompilation |
array (URL) | (Optional) Some favorites are compilations of multiple content. In this case, multiple images may be associated with the favorite. A client application can create an image compilation from these URLs. This is not yet implemented. |
service |
service | (Optional) Identifies the content provider. |