Controlling Mirage Audio System
Version | Publication Date | Author | Notes |
|---|---|---|---|
1.0 | 2017-11-14 | JS | Initial Release |
1.1 | 2020-09-15 | JS | Added details about service account selection and the Top Menu |
1.2 | 2021-08-06 | JS | Additional details about |
1.3 | 2021-08-06 | JS | Add browsing sub-section to JSON API section |
1.4 | 2021-08-31 | JS | Add detail on browse command structure in JSON API section |
1.5 | 2021-09-04 | JS | Add |
1.6 | 2021-09-07 | JS | Add events that describe changes to Presets and Playlists |
1.7 | 2021-09-09 | JS | Add |
1.8 | 2022-10-04 | AC | Add Scene commands |
| Table of Contents | ||||
|---|---|---|---|---|
|
...
button provides an integer value that indicates which secondary action to offer on that item. The value of this attribute is defined by this table
Value | Function |
|---|---|
0 | Off |
1 | Add |
2 | Delete |
3 | Play |
4 | Power |
5 | PowerOn |
6 | Edit |
7 | AllTracks |
8 | ShuffleAll |
dna provides the name of the attribute containing the value to use for display.
...
FavoritesCount differs from FavoritesChanged in that it will only be sent when a preset is added or deleted while FavoritesChanged includes name changes.
Scenes
To store a Scene, use the StoreScene command. This command takes an optional double-quoted name argument. If the name argument is specified, the MMS will store the Scene with that name. If no name is specified, the MMS will prompt for a name using an InputBox. InputBoxes are natively supported by all our control system drivers. The scene will save with the currently playing content for the selected instance in the currently playing Zones alternatively current instance at the current volume levels. As with all protocol commands, each command should be terminated with a carriage return and a line feed (\r\n).
Examples:
StoreScene - This will be responded to with an InputBox from the server.
StoreScene "Party Time" - This will save a Scene called Party Time
To recall a Scene, use the RecallScene command. This command takes either the double-quoted name of the Scene or the unique ID of the Scene. To get either of these, please see the BrowseScenes command, described below. Recalling a Scene will turn on and set the volume in the Zones/Instance contained in the Scene and replace the state of the instance with the state stored in the Scene. Note that when using Autonomic amps, the instance for playback might be different from the currently selected instance. As with all protocol commands, each command should be terminated with a carriage return and a line feed (\r\n).
Examples:
RecallScene "DinnerTime" - This recalls the Scene by name
RecallScene 9f9c8919-f939-d67a-dce2-cb049a4ead99 - This recalls the Scene by unique ID
Delete a Scene with DeleteScene nameOrId
Relevant Events
There are some events that indicate changes to scenes to the control client.
ScenesChanged will be sent whenever any change is made to any scene. It will always be true. Simply receiving it is sufficient to rebrowse scenes.
ScenesCount will be sent whenever the number of scenes changes.
Playlists
Playlists are browsed with BrowsePlaylists. This command adheres to the same pattern as all Browse commands.
...
A playlist can be directly played with PlayPlaylist nameOrId
Relevant Events
There are some events that indicate changes to favorites to the control client.
...
To construct the full URL to get art, use the above values along with the below options.
Option | Purpose | Possible Values |
|---|---|---|
c | constrain | 0=size image to fit height and width</br>1=constrain to dimension and maintain aspect ratio |
guid | unique id of the album, artist, genre, title, etc | |
fmt | image format. Valid values are | |
instance | the instance GUID | |
h | image height | |
w | image width | |
rfle | reflection elevation | |
rflh | reflection height | |
rflo | reflection opacity | |
rz | reflection rotation (z axis) |
JSON HTTP API
General Information
...