...
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 |
1.9 | 2022-12-13 | JS | Add argument details to |
2.0 | 2023-08-14 | JS | Fix typo in Album Art table |
2.1 | 2023-12-07 | JS | Add |
2.2 | 2024-01-19 | JS | Add preliminary queue modification and |
2.3 | 2024-03-07 | JS | Improve art request information |
2.4 | 2024-08-14 | AC | Add Trigger Info |
| Table of Contents | ||||
|---|---|---|---|---|
|
...
SetXmlMode Lists tells the MMS to send any lists as XML instead of text mode. This is recommended if the control client supports XML. This command takes a string argument where that argument is None, or Lists, or All.
SetEncoding 65001 tells the MMS to send data as UTF-8. There are other encodings available but 65001 will be the encoding of choice most of the time.
...
Clear the queue with ClearNowPlaying. Passing False as an argument will clear the queue and stop playback of any station based content. Passing True or no argument will clear the queue and stop any queue based content from playing back but will not disrupt playback for station based content.
Triggers
Some servers are equipped with Input and Output Triggers. Input triggers are activated by adding a voltage to the input pin (5 -24V AC or DC). Output triggers will supply a voltage on the output pin (12VDC 100mA max).
Relevant Commands
Turn on/off an output trigger with SetOutputTrigger <indexOfTrigger> <true/false> , where <indexOfTrigger> is in trigger order independent of the trigger label. IE. Trigger Out A would have <indexOfTrigger> of 1.
Example:
Turn on Trigger Out A: SetOutputTrigger 1 true
Turn off Trigger Out C: SetOutputTrigger 3 false
Relevant Events
There are some events for Input Triggers. Each Input Trigger does have one event, TriggerIn1 through TriggerIn<x>, where the event is true when voltage is applied to the input pin.
Album Art
BaseWebUrl provides the protocol, address, and port portions of the URL to retrieve art from. For example: http://192.168.0.59:5005.
...