Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

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 SetServiceAccount; updates to JSON API to include details about multi-client situations

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 PlayPlaylist command

1.6

2021-09-07

JS

Add events that describe changes to Presets and Playlists

1.7

2021-09-09

JS

Add MediaControl and PlayState events

1.8

2022-10-04

AC

Add Scene commands

1.9

2022-12-13

JS

Add argument details to ClearNowPlaying

2.0

2023-08-14

JS

Fix typo in Album Art table

2.1

2023-12-07

JS

Add SetVolume

Table of Contents
minLevel1
maxLevel7

...

ThumbsDown toggles the ThumbsDown state between 0 and 1. This command is governed by the ThumbsDown event. On some services, setting the ThumbsDown state to 1 will also skip to the next track.

SetVolume sets the volume on the selected output. It takes a single integer argument from 0-50. The selected output must be in variable gain mode, as configured on the System tab of the device’s configuration page.

Browsing

Basics

All browsing on an MMS is done through the same basic format.

...

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.

...

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

1=constrain to dimension and maintain aspect ratio

guid

unique id of the album, artist, genre, title, etc

fmt

image format. Valid values are png or jpg

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

...