{"type":"doc","content":[{"type":"heading","attrs":{"level":1},"content":[{"text":"Controlling Mirage Audio System","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":1800.0,"localId":"e29e0034-9ddc-4eef-a146-7d54588d14dc"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[48.0]},"content":[{"type":"paragraph","content":[{"text":"Version","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[60.0]},"content":[{"type":"paragraph","content":[{"text":"Publication Date","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[48.0]},"content":[{"type":"paragraph","content":[{"text":"Author","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[604.0]},"content":[{"type":"paragraph","content":[{"text":"Notes","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[48.0]},"content":[{"type":"paragraph","content":[{"text":"1.0","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[60.0]},"content":[{"type":"paragraph","content":[{"text":"2017-11-14","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[48.0]},"content":[{"type":"paragraph","content":[{"text":"JS","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[604.0]},"content":[{"type":"paragraph","content":[{"text":"Initial Release","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[48.0]},"content":[{"type":"paragraph","content":[{"text":"1.1","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[60.0]},"content":[{"type":"paragraph","content":[{"text":"2020-09-15","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[48.0]},"content":[{"type":"paragraph","content":[{"text":"JS","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[604.0]},"content":[{"type":"paragraph","content":[{"text":"Added details about service account selection and the Top Menu","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[48.0]},"content":[{"type":"paragraph","content":[{"text":"1.2","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[60.0]},"content":[{"type":"paragraph","content":[{"text":"2021-08-06","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[48.0]},"content":[{"type":"paragraph","content":[{"text":"JS","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[604.0]},"content":[{"type":"paragraph","content":[{"text":"Additional details about ","type":"text"},{"text":"SetServiceAccount","type":"text","marks":[{"type":"code"}]},{"text":"; updates to JSON API to include details about multi-client situations","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[48.0]},"content":[{"type":"paragraph","content":[{"text":"1.3","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[60.0]},"content":[{"type":"paragraph","content":[{"text":"2021-08-06","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[48.0]},"content":[{"type":"paragraph","content":[{"text":"JS","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[604.0]},"content":[{"type":"paragraph","content":[{"text":"Add browsing sub-section to JSON API section","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[48.0]},"content":[{"type":"paragraph","content":[{"text":"1.4","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[60.0]},"content":[{"type":"paragraph","content":[{"text":"2021-08-31","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[48.0]},"content":[{"type":"paragraph","content":[{"text":"JS","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[604.0]},"content":[{"type":"paragraph","content":[{"text":"Add detail on browse command structure in JSON API section","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[48.0]},"content":[{"type":"paragraph","content":[{"text":"1.5","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[60.0]},"content":[{"type":"paragraph","content":[{"text":"2021-09-04","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[48.0]},"content":[{"type":"paragraph","content":[{"text":"JS","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[604.0]},"content":[{"type":"paragraph","content":[{"text":"Add ","type":"text"},{"text":"PlayPlaylist","type":"text","marks":[{"type":"code"}]},{"text":" command","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[48.0]},"content":[{"type":"paragraph","content":[{"text":"1.6","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[60.0]},"content":[{"type":"paragraph","content":[{"text":"2021-09-07","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[48.0]},"content":[{"type":"paragraph","content":[{"text":"JS","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[604.0]},"content":[{"type":"paragraph","content":[{"text":"Add events that describe changes to Presets and Playlists","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[48.0]},"content":[{"type":"paragraph","content":[{"text":"1.7","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[60.0]},"content":[{"type":"paragraph","content":[{"text":"2021-09-09","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[48.0]},"content":[{"type":"paragraph","content":[{"text":"JS","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[604.0]},"content":[{"type":"paragraph","content":[{"text":"Add ","type":"text"},{"text":"MediaControl","type":"text","marks":[{"type":"code"}]},{"text":" and ","type":"text"},{"text":"PlayState","type":"text","marks":[{"type":"code"}]},{"text":" events","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[48.0]},"content":[{"type":"paragraph","content":[{"text":"1.8","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[60.0]},"content":[{"type":"paragraph","content":[{"text":"2022-10-04","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[48.0]},"content":[{"type":"paragraph","content":[{"text":"AC","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[604.0]},"content":[{"type":"paragraph","content":[{"text":"Add Scene commands","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[48.0]},"content":[{"type":"paragraph","content":[{"text":"1.9","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[60.0]},"content":[{"type":"paragraph","content":[{"text":"2022-12-13","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[48.0]},"content":[{"type":"paragraph","content":[{"text":"JS","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[604.0]},"content":[{"type":"paragraph","content":[{"text":"Add argument details to ","type":"text"},{"text":"ClearNowPlaying","type":"text","marks":[{"type":"code"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[48.0]},"content":[{"type":"paragraph","content":[{"text":"2.0","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[60.0]},"content":[{"type":"paragraph","content":[{"text":"2023-08-14","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[48.0]},"content":[{"type":"paragraph","content":[{"text":"JS","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[604.0]},"content":[{"type":"paragraph","content":[{"text":"Fix typo in Album Art table","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[48.0]},"content":[{"type":"paragraph","content":[{"text":"2.1","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[60.0]},"content":[{"type":"paragraph","content":[{"text":"2023-12-07","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[48.0]},"content":[{"type":"paragraph","content":[{"text":"JS","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[604.0]},"content":[{"type":"paragraph","content":[{"text":"Add ","type":"text"},{"text":"SetVolume","type":"text","marks":[{"type":"code"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[48.0]},"content":[{"type":"paragraph","content":[{"text":"2.2","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[60.0]},"content":[{"type":"paragraph","content":[{"text":"2024-01-19","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[48.0]},"content":[{"type":"paragraph","content":[{"text":"JS","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[604.0]},"content":[{"type":"paragraph","content":[{"text":"Add preliminary queue modification and ","type":"text"},{"text":"supports_","type":"text","marks":[{"type":"code"}]},{"text":" information","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[48.0]},"content":[{"type":"paragraph","content":[{"text":"2.3","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[60.0]},"content":[{"type":"paragraph","content":[{"text":"2024-03-07","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[48.0]},"content":[{"type":"paragraph","content":[{"text":"JS","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[604.0]},"content":[{"type":"paragraph","content":[{"text":"Improve art request information","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[48.0]},"content":[{"type":"paragraph","content":[{"text":"2.4","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[60.0]},"content":[{"type":"paragraph","content":[{"text":"2024-08-14","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[48.0]},"content":[{"type":"paragraph","content":[{"text":"AC","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[604.0]},"content":[{"type":"paragraph","content":[{"text":"Add Trigger Info","type":"text"}]}]}]}]},{"type":"extension","attrs":{"layout":"default","extensionType":"com.atlassian.confluence.macro.core","extensionKey":"toc","parameters":{"macroParams":{"minLevel":{"value":"1"},"maxLevel":{"value":"7"}},"macroMetadata":{"macroId":{"value":"e5d86807-d453-4fa0-a002-32cc838872b1"},"schemaVersion":{"value":"1"},"title":"Table of Contents"}},"localId":"fb474bcc-8dde-412a-a2b4-477f40f5245d"}},{"type":"heading","attrs":{"level":3},"content":[{"text":"Introduction","type":"text"}]},{"type":"paragraph","content":[{"text":"This document is intended to extend and eventually replace ","type":"text"},{"text":"this","type":"text","marks":[{"type":"link","attrs":{"href":"http://www.autonomic-controls.com/documents/mcs30/mcs_3.0_IP_Control_Protocol.pdf"}}]},{"text":" document. Please refer to that PDF for an extensive accounting of all commands that existed at the time of its creation.","type":"text"}]},{"type":"paragraph","content":[{"text":"We categorize control of a Mirage Media Server (MMS) into four categories:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Connecting and the ","type":"text"},{"text":"preamble","type":"text","marks":[{"type":"em"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Events","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Control","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Browsing & content selection","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Presets","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Playlists","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Now Playing","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Album Art","type":"text"}]}]}]},{"type":"paragraph","content":[{"text":"For information regarding using the HTTP JSON API endpoints, see the end of this document.","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Connecting","type":"text"}]},{"type":"paragraph","content":[{"text":"An MMS is controlled via a socket or telnet connection to port 5004 on the device's IP address. Commands sent and responses received are terminated with a carriage return and a line feed. Commands commonly used in a connection preamble will be briefly defined here but will have a more complete definition later.","type":"text"}]},{"type":"paragraph","content":[{"text":"A typical initialization sequence looks like:","type":"text"}]},{"type":"codeBlock","content":[{"text":"SetClientType DemoClient\nSetClientVersion 1.0.0.0\nSetHost 192.168.0.100\nSetXmlMode Lists\nSetEncoding 65001\nSetInstance Player_A\nSubscribeEvents\nGetStatus","type":"text"}]},{"type":"paragraph","content":[{"text":"SetClientType DemoClient","type":"text","marks":[{"type":"code"}]},{"text":" identifies the control client to the MMS. This command takes a single string argument.","type":"text"}]},{"type":"paragraph","content":[{"text":"SetClientVersion 1.0.0.0","type":"text","marks":[{"type":"code"}]},{"text":" allows the control client to set a version. We ","type":"text"},{"text":"strongly","type":"text","marks":[{"type":"em"}]},{"text":" recommend setting a client version. This will allow the server to react to client version changes if necessary. This command takes a version string in the format ","type":"text"},{"text":"MAJOR.MINOR.BUILD.REVISION","type":"text","marks":[{"type":"strong"}]}]},{"type":"paragraph","content":[{"text":"SetHost 192.168.0.100","type":"text","marks":[{"type":"code"}]},{"text":" tells the server which address the control client connected on. This is useful if the control client is connecting through a external connection where the address it used might be a web address. We recommend setting this value always. This command takes a single string argument.","type":"text"}]},{"type":"paragraph","content":[{"text":"SetXmlMode Lists","type":"text","marks":[{"type":"code"}]},{"text":" 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 ","type":"text"},{"text":"None","type":"text","marks":[{"type":"code"}]},{"text":" or ","type":"text"},{"text":"Lists","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]},{"type":"paragraph","content":[{"text":"SetEncoding 65001","type":"text","marks":[{"type":"code"}]},{"text":" tells the MMS to send data as UTF-8. There are other encodings available but ","type":"text"},{"text":"65001","type":"text","marks":[{"type":"code"}]},{"text":" will be the encoding of choice most of the time.","type":"text"}]},{"type":"paragraph","content":[{"text":"SetInstance Player_A","type":"text","marks":[{"type":"code"}]},{"text":" sets which output subsequent browse and control commands are intended for.","type":"text"}]},{"type":"paragraph","content":[{"text":"SubscribeEvents","type":"text","marks":[{"type":"code"}]},{"text":" tells the MMS to send events related to the currently selected instance as they occur. This command takes an optional boolean argument or a comma delimited list of events to limit the subscription to. If missing, the value is assumed to be ","type":"text"},{"text":"true","type":"text","marks":[{"type":"code"}]},{"text":", which subscribes the control client to all events. The client will remain subscribed for the duration of its connection. The subscription will follow the client from instance to instance. No resubscription is necessary. Events for the selected or default instance are pushed to the connected client. To get events from another instance, see ","type":"text"},{"text":"SetInstance","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]},{"type":"paragraph","content":[{"text":"GetStatus","type":"text","marks":[{"type":"code"}]},{"text":" requests that all events related to the selected instance be sent now.","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Setting Additional Options","type":"text"}]},{"type":"paragraph","content":[{"text":"In some cases, especially when writing a control client not known to MMS, it may be necessary to set some additional options that MMS presumes for known clients. Use the ","type":"text"},{"text":"SetOption","type":"text","marks":[{"type":"code"}]},{"text":" command during the connection preamble. Here are list of those options:","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":1176.0,"localId":"033e1c39-4f36-4e04-9bd8-b191ff3a30ad"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Option","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Purpose","type":"text","marks":[{"type":"strong"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"supports_playnow=true","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Indicates to MMS that the client supports the more advanced queue modification strategies described in the ","type":"text"},{"text":"Modifying the Queue section","type":"text","marks":[{"type":"link","attrs":{"href":"#Modifying-the-Queue"}}]},{"text":" below","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"supports_inputbox=true","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Indicates to MMS that the client supports Input and Message Box UI events","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"supports_urls=true","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Indicates to MMS that the client supports Page type Navigate events where MMS needs the client to open the indicated URL in a web browser","type":"text"}]}]}]}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Events","type":"text"}]},{"type":"paragraph","content":[{"text":"The MMS communicates data back to its control clients through events. These events carry information about the current state of the server. They can also be used to request input from the user. Some events inform the control client about the availability of various functions while others tell the control client to take some action.","type":"text"}]},{"type":"paragraph","content":[{"text":"Events follow a simple format:","type":"text"}]},{"type":"codeBlock","content":[{"text":"EventReason Source Event=Value","type":"text"}]},{"type":"paragraph","content":[{"text":"and will look like:","type":"text"}]},{"type":"codeBlock","content":[{"text":"StateChanged Player_A TrackTime=121","type":"text"}]},{"type":"paragraph","content":[{"text":"or","type":"text"}]},{"type":"codeBlock","content":[{"text":"ReportState Player_A TrackTime=121","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Metadata Events","type":"text"}]},{"type":"paragraph","content":[{"text":"There are four lines of metadata and four metadata labels.","type":"text"}]},{"type":"paragraph","content":[{"text":"MetaData1","type":"text","marks":[{"type":"code"}]},{"text":" is generally reserved for radio station names or for track count data.","type":"text"}]},{"type":"paragraph","content":[{"text":"MetaData2","type":"text","marks":[{"type":"code"}]},{"text":" is generally reserved for the artist name.","type":"text"}]},{"type":"paragraph","content":[{"text":"MetaData3","type":"text","marks":[{"type":"code"}]},{"text":" is generally reserved for the album name.","type":"text"}]},{"type":"paragraph","content":[{"text":"MetaData4","type":"text","marks":[{"type":"code"}]},{"text":" is generally reserved for the track name.","type":"text"}]},{"type":"paragraph","content":[{"text":"MetaLabelx","type":"text","marks":[{"type":"code"}]},{"text":" events will always provide the label for the corresponding ","type":"text"},{"text":"MetaDatax","type":"text","marks":[{"type":"code"}]},{"text":" field. ","type":"text"},{"text":"MetaLabel1","type":"text","marks":[{"type":"code"}]},{"text":" follows ","type":"text"},{"text":"MetaData1","type":"text","marks":[{"type":"code"}]},{"text":", ","type":"text"},{"text":"MetaLabel2","type":"text","marks":[{"type":"code"}]},{"text":" follows ","type":"text"},{"text":"MetaData2","type":"text","marks":[{"type":"code"}]},{"text":", etc. There are four ","type":"text"},{"text":"MetaLabelx","type":"text","marks":[{"type":"code"}]},{"text":" events","type":"text"}]},{"type":"paragraph","content":[{"text":"An example of these events:","type":"text"}]},{"type":"codeBlock","content":[{"text":"ReportState Player_A MetaLabel1=\nReportState Player_A MetaData1=Pandora: Stevie Ray Vaughan Radio\nReportState Player_A MetaLabel2=Artist\nReportState Player_A MetaData2=Stevie Ray Vaughan\nReportState Player_A MetaLabel3=Album\nReportState Player_A MetaData3=Texas Flood (Legacy Edition)\nReportState Player_A MetaLabel4=Track\nReportState Player_A MetaData4=Texas Flood","type":"text"}]},{"type":"paragraph","content":[{"text":"Now Playing Art is handled by providing a few separate events.","type":"text"}]},{"type":"paragraph","content":[{"text":"NowPlayingGuid","type":"text","marks":[{"type":"code"}]},{"text":" provides the ID of the now playing item. For example, ","type":"text"},{"text":"{20dd901a-b092-3386-dc16-6b56f38a811e}","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"BaseWebUrl","type":"text","marks":[{"type":"code"}]},{"text":" provides the protocol, address, and port portions of the URL to retrieve art from. For example: ","type":"text"},{"text":"","type":"text"}]},{"type":"paragraph","content":[{"text":"For further details, see the Album Art section below.","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Track Time","type":"text"}]},{"type":"paragraph","content":[{"text":"Track time is provided in seconds. A track duration ","type":"text"},{"text":"may","type":"text","marks":[{"type":"em"}]},{"text":" be provided, depending on the source of the content.","type":"text"}]},{"type":"paragraph","content":[{"text":"TrackTime","type":"text","marks":[{"type":"code"}]},{"text":" indicates track position in seconds as a non-negative integer.","type":"text"}]},{"type":"paragraph","content":[{"text":"TrackDuration","type":"text","marks":[{"type":"code"}]},{"text":" indicates the total number of seconds in the track as a non-negative integer.","type":"text"}]},{"type":"paragraph","content":[{"text":"In cases where the content does not have a total time (like a broadcast radio station from TuneIn), ","type":"text"},{"text":"TrackDuration","type":"text","marks":[{"type":"code"}]},{"text":" will be ","type":"text"},{"text":"0","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]},{"type":"paragraph","content":[{"text":"In such cases where the MMS has neither a track length nor a current track position, both ","type":"text"},{"text":"TrackTime","type":"text","marks":[{"type":"code"}]},{"text":" and ","type":"text"},{"text":"TrackDuration","type":"text","marks":[{"type":"code"}]},{"text":" will be ","type":"text"},{"text":"0","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Playback Events","type":"text"}]},{"type":"paragraph","content":[{"text":"MediaControl","type":"text","marks":[{"type":"code"}]},{"text":" and ","type":"text"},{"text":"PlayState","type":"text","marks":[{"type":"code"}]},{"text":" both indicate the play state of the output. They have slightly different values but ultimately have the same meaning.","type":"text"}]},{"type":"paragraph","content":[{"text":"PlayState","type":"text","marks":[{"type":"code"}]},{"text":" will be one of the following: ","type":"text"},{"text":"Playing","type":"text","marks":[{"type":"code"}]},{"text":", ","type":"text"},{"text":"Paused","type":"text","marks":[{"type":"code"}]},{"text":", or ","type":"text"},{"text":"Stopped","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"MediaControl","type":"text","marks":[{"type":"code"}]},{"text":" will be one of the following: ","type":"text"},{"text":"Play","type":"text","marks":[{"type":"code"}]},{"text":", ","type":"text"},{"text":"Pause","type":"text","marks":[{"type":"code"}]},{"text":", or ","type":"text"},{"text":"Stop","type":"text","marks":[{"type":"code"}]}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Flags","type":"text"}]},{"type":"paragraph","content":[{"text":"All these events hold a ","type":"text"},{"text":"true","type":"text","marks":[{"type":"code"}]},{"text":"|","type":"text"},{"text":"false","type":"text","marks":[{"type":"code"}]},{"text":" value and indicate whether a certain functionality is available.","type":"text"}]},{"type":"paragraph","content":[{"text":"Back","type":"text","marks":[{"type":"code"}]},{"text":" defines whether or not there is anything in the navigation stack. If true, use ","type":"text"},{"text":"Back ","type":"text","marks":[{"type":"code"}]},{"text":" to jump back ","type":"text"},{"text":"","type":"text","marks":[{"type":"code"}]},{"text":" number of pages. The navigation stack begins with ","type":"text"},{"text":"0","type":"text","marks":[{"type":"code"}]},{"text":". ","type":"text"},{"text":"0","type":"text","marks":[{"type":"code"}]},{"text":" is the current page.","type":"text"}]},{"type":"paragraph","content":[{"text":"BrowseNowPlayingAvailable","type":"text","marks":[{"type":"code"}]},{"text":" defines whether a queue is available to browse. This will be ","type":"text"},{"text":"true","type":"text","marks":[{"type":"code"}]},{"text":" when the queue has more than ","type":"text"},{"text":"0","type":"text","marks":[{"type":"code"}]},{"text":" items even the now playing item is a radio station.","type":"text"}]},{"type":"paragraph","content":[{"text":"ContextMenu","type":"text","marks":[{"type":"code"}]},{"text":" defines whether or not ","type":"text"},{"text":"AckButton CONTEXT","type":"text","marks":[{"type":"code"}]},{"text":" is a valid command and the TuneBridge™ button should be shown.","type":"text"}]},{"type":"paragraph","content":[{"text":"Mute","type":"text","marks":[{"type":"code"}]},{"text":" defines whether or not the set instance is muted.","type":"text"}]},{"type":"paragraph","content":[{"text":"PlayPauseAvailable","type":"text","marks":[{"type":"code"}]},{"text":" defines whether or not the ","type":"text"},{"text":"Play","type":"text","marks":[{"type":"code"}]},{"text":", ","type":"text"},{"text":"Pause","type":"text","marks":[{"type":"code"}]},{"text":", and ","type":"text"},{"text":"PlayPause","type":"text","marks":[{"type":"code"}]},{"text":" are valid and the Play or Pause button should be shown.","type":"text"}]},{"type":"paragraph","content":[{"text":"RepeatAvailable","type":"text","marks":[{"type":"code"}]},{"text":" defines whether or not ","type":"text"},{"text":"Repeat","type":"text","marks":[{"type":"code"}]},{"text":" is a valid command and the Repeat button should be shown.","type":"text"}]},{"type":"paragraph","content":[{"text":"Repeat","type":"text","marks":[{"type":"code"}]},{"text":" defines whether Repeat is enabled or disabled.","type":"text"}]},{"type":"paragraph","content":[{"text":"SeekAvailable","type":"text","marks":[{"type":"code"}]},{"text":" defines whether or not ","type":"text"},{"text":"Seek","type":"text","marks":[{"type":"code"}]},{"text":" is a valid command and the scrubbing thumb should be shown on the track progress meter.","type":"text"}]},{"type":"paragraph","content":[{"text":"ShuffleAvailable","type":"text","marks":[{"type":"code"}]},{"text":" defines whether or not ","type":"text"},{"text":"Shuffle","type":"text","marks":[{"type":"code"}]},{"text":" is a valid command and the Shuffle button should be shown.","type":"text"}]},{"type":"paragraph","content":[{"text":"Shuffle","type":"text","marks":[{"type":"code"}]},{"text":" defines whether or not Shuffle is enabled or disabled.","type":"text"}]},{"type":"paragraph","content":[{"text":"SkipNextAvailable","type":"text","marks":[{"type":"code"}]},{"text":" defines whether or not ","type":"text"},{"text":"SkipNext","type":"text","marks":[{"type":"code"}]},{"text":" is a valid command and the Skip Next button should be shown.","type":"text"}]},{"type":"paragraph","content":[{"text":"SkipPrevAvailable","type":"text","marks":[{"type":"code"}]},{"text":" defines whether or not ","type":"text"},{"text":"SkipPrevious","type":"text","marks":[{"type":"code"}]},{"text":" is a valid command and the Skip Previous button should be shown.","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Multistate Flags","type":"text"}]},{"type":"paragraph","content":[{"text":"Some values have more than two states and therefore cannot be represented as ","type":"text"},{"text":"true","type":"text","marks":[{"type":"code"}]},{"text":"|","type":"text"},{"text":"false","type":"text","marks":[{"type":"code"}]},{"text":" values.","type":"text"}]},{"type":"paragraph","content":[{"text":"ThumbsUp","type":"text","marks":[{"type":"code"}]},{"text":" indicates the state of the Thumbs Up button and whether the ","type":"text"},{"text":"ThumbsUp","type":"text","marks":[{"type":"code"}]},{"text":" command is available. ","type":"text"},{"text":"ThumbsDown","type":"text","marks":[{"type":"code"}]},{"text":" is identical to ","type":"text"},{"text":"ThumbsUp","type":"text","marks":[{"type":"code"}]},{"text":", replacing ","type":"text"},{"text":"Up","type":"text","marks":[{"type":"code"}]},{"text":" with ","type":"text"},{"text":"Down","type":"text","marks":[{"type":"code"}]},{"text":" in all cases. Possible states are ","type":"text"},{"text":"-1","type":"text","marks":[{"type":"code"}]},{"text":", ","type":"text"},{"text":"0","type":"text","marks":[{"type":"code"}]},{"text":", and ","type":"text"},{"text":"1","type":"text","marks":[{"type":"code"}]},{"text":" where:","type":"text"}]},{"type":"paragraph","content":[{"text":"-1","type":"text","marks":[{"type":"code"}]},{"text":" indicates the button is disabled and the command is not available.","type":"text"}]},{"type":"paragraph","content":[{"text":"0","type":"text","marks":[{"type":"code"}]},{"text":" indicates the button is enabled but not set and the command is available.","type":"text"}]},{"type":"paragraph","content":[{"text":"1","type":"text","marks":[{"type":"code"}]},{"text":" indicates the button is both enabled and set and the command is available.","type":"text"}]},{"type":"paragraph","content":[{"text":"At the time of writing, no online service still uses a Stars rating system. However...","type":"text"}]},{"type":"paragraph","content":[{"text":"Stars","type":"text","marks":[{"type":"code"}]},{"text":" indicates the state of the stars and whether the ","type":"text"},{"text":"SetStars","type":"text","marks":[{"type":"code"}]},{"text":" command is available. States range from ","type":"text"},{"text":"-1","type":"text","marks":[{"type":"code"}]},{"text":" to ","type":"text"},{"text":"5","type":"text","marks":[{"type":"code"}]},{"text":" where:","type":"text"}]},{"type":"paragraph","content":[{"text":"-1","type":"text","marks":[{"type":"code"}]},{"text":" indicates stars are disabled and the command is not available.","type":"text"}]},{"type":"paragraph","content":[{"text":"0","type":"text","marks":[{"type":"code"}]},{"text":" - ","type":"text"},{"text":"5","type":"text","marks":[{"type":"code"}]},{"text":" indicate stars are enabled and should be showing the number of stars indicated in the value. The command is also available.","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Control","type":"text"}]},{"type":"paragraph","content":[{"text":"Play","type":"text","marks":[{"type":"code"}]},{"text":" will tell the MMS to play.","type":"text"}]},{"type":"paragraph","content":[{"text":"Pause","type":"text","marks":[{"type":"code"}]},{"text":" will tell the MMS to pause.","type":"text"}]},{"type":"paragraph","content":[{"text":"PlayPause","type":"text","marks":[{"type":"code"}]},{"text":" will toggle the play state between play and pause.","type":"text"}]},{"type":"paragraph","content":[{"text":"Seek ","type":"text","marks":[{"type":"code"}]},{"text":" where ","type":"text"},{"text":"","type":"text","marks":[{"type":"code"}]},{"text":" is either a non-negative integer between ","type":"text"},{"text":"0","type":"text","marks":[{"type":"code"}]},{"text":" and the value of ","type":"text"},{"text":"TrackDuration","type":"text","marks":[{"type":"code"}]},{"text":" or a negative integer between ","type":"text"},{"text":"-1","type":"text","marks":[{"type":"code"}]},{"text":" and ","type":"text"},{"text":"-1 * ","type":"text","marks":[{"type":"code"}]},{"text":". When ","type":"text"},{"text":"","type":"text","marks":[{"type":"code"}]},{"text":" is non-negative, the playback position will be moved relative to the ","type":"text"},{"text":"start","type":"text","marks":[{"type":"strong"}]},{"text":" of the track. When ","type":"text"},{"text":"","type":"text","marks":[{"type":"code"}]},{"text":" is negative, the playback position will be moved relative to the ","type":"text"},{"text":"end","type":"text","marks":[{"type":"strong"}]},{"text":" of the track.","type":"text"}]},{"type":"paragraph","content":[{"text":"SkipNext","type":"text","marks":[{"type":"code"}]},{"text":" skips to the next track. This command is governed by the ","type":"text"},{"text":"SkipNextAvailable","type":"text","marks":[{"type":"code"}]},{"text":" event.","type":"text"}]},{"type":"paragraph","content":[{"text":"SkipPrevious","type":"text","marks":[{"type":"code"}]},{"text":" skips to the previous track if the value of ","type":"text"},{"text":"TrackTime","type":"text","marks":[{"type":"code"}]},{"text":" is less than ","type":"text"},{"text":"5","type":"text","marks":[{"type":"code"}]},{"text":". Otherwise, it restarts the current track if allowed by the given service. This command is governed by the ","type":"text"},{"text":"SkipPrevAvailable","type":"text","marks":[{"type":"code"}]},{"text":" event.","type":"text"}]},{"type":"paragraph","content":[{"text":"ThumbsUp","type":"text","marks":[{"type":"code"}]},{"text":" toggles the ","type":"text"},{"text":"ThumbsUp","type":"text","marks":[{"type":"code"}]},{"text":" state between ","type":"text"},{"text":"0","type":"text","marks":[{"type":"code"}]},{"text":" and ","type":"text"},{"text":"1","type":"text","marks":[{"type":"code"}]},{"text":". This command is governed by the ","type":"text"},{"text":"ThumbsUp","type":"text","marks":[{"type":"code"}]},{"text":" event.","type":"text"}]},{"type":"paragraph","content":[{"text":"ThumbsDown","type":"text","marks":[{"type":"code"}]},{"text":" toggles the ","type":"text"},{"text":"ThumbsDown","type":"text","marks":[{"type":"code"}]},{"text":" state between ","type":"text"},{"text":"0","type":"text","marks":[{"type":"code"}]},{"text":" and ","type":"text"},{"text":"1","type":"text","marks":[{"type":"code"}]},{"text":". This command is governed by the ","type":"text"},{"text":"ThumbsDown","type":"text","marks":[{"type":"code"}]},{"text":" event. On some services, setting the ","type":"text"},{"text":"ThumbsDown","type":"text","marks":[{"type":"code"}]},{"text":" state to ","type":"text"},{"text":"1","type":"text","marks":[{"type":"code"}]},{"text":" will also skip to the next track.","type":"text"}]},{"type":"paragraph","content":[{"text":"SetVolume","type":"text","marks":[{"type":"code"}]},{"text":" 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.","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Browsing","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Basics","type":"text"}]},{"type":"paragraph","content":[{"text":"All browsing on an MMS is done through the same basic format.","type":"text"}]},{"type":"paragraph","content":[{"text":"Browse ","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"where ","type":"text"},{"text":"","type":"text","marks":[{"type":"code"}]},{"text":" is the target browse type, ","type":"text"},{"text":"","type":"text","marks":[{"type":"code"}]},{"text":" is the one-based index the returned list should start from, and ","type":"text"},{"text":"","type":"text","marks":[{"type":"code"}]},{"text":" is the number of items the returned list should contain at most. For example:","type":"text"}]},{"type":"paragraph","content":[{"text":"BrowseArtists 1 10","type":"text","marks":[{"type":"code"}]},{"text":" will return ","type":"text"},{"text":"10","type":"text","marks":[{"type":"code"}]},{"text":" artists starting at item ","type":"text"},{"text":"1","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]},{"type":"paragraph","content":[{"text":"BrowseArtists 11 10","type":"text","marks":[{"type":"code"}]},{"text":" will return ","type":"text"},{"text":"10","type":"text","marks":[{"type":"code"}]},{"text":" artists starting at item ","type":"text"},{"text":"11","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]},{"type":"paragraph","content":[{"text":"Depending on whether ","type":"text"},{"text":"SetXMLMode","type":"text","marks":[{"type":"code"}]},{"text":" is set, the response may be in either text mode or XML mode. As above, we strongly recommend XML if the control environment supports it as it offers more information.","type":"text"}]},{"type":"paragraph","content":[{"text":"Every browse item has a default action based on its type. We'll go over these default actions later on. These default actions can be superseded with attributes on each item.","type":"text"}]},{"type":"paragraph","content":[{"text":"action","type":"text","marks":[{"type":"code"}]},{"text":" defines the secondary action to perform if the user presses the the action button for that item.","type":"text"}]},{"type":"paragraph","content":[{"text":"listAction","type":"text","marks":[{"type":"code"}]},{"text":" defines the action to perform if the user presses the list item itself.","type":"text"}]},{"type":"paragraph","content":[{"text":"browseAction","type":"text","marks":[{"type":"code"}]},{"text":" defines the action to perform ","type":"text"},{"text":"after","type":"text","marks":[{"type":"strong"}]},{"text":" doing the default action for that item or doing the ","type":"text"},{"text":"listAction","type":"text","marks":[{"type":"code"}]},{"text":" if one exists.","type":"text"}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"Other list item attributes","type":"text"}]},{"type":"paragraph","content":[{"text":"artGuid","type":"text","marks":[{"type":"code"}]},{"text":" provides the guid to use if displaying art in the browse (See the Album Art section below). If this attribute is missing, use the value of the ","type":"text"},{"text":"guid","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]},{"type":"paragraph","content":[{"text":"button","type":"text","marks":[{"type":"code"}]},{"text":" provides an integer value that indicates which secondary action to offer on that item. The value of this attribute is defined by this table","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":1800.0,"localId":"a4f7479b-4d7b-44e4-bc25-ff4d53a154db"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[51.0]},"content":[{"type":"paragraph","content":[{"text":"Value","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[709.0]},"content":[{"type":"paragraph","content":[{"text":"Function","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[51.0]},"content":[{"type":"paragraph","content":[{"text":"0","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[709.0]},"content":[{"type":"paragraph","content":[{"text":"Off","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[51.0]},"content":[{"type":"paragraph","content":[{"text":"1","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[709.0]},"content":[{"type":"paragraph","content":[{"text":"Add","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[51.0]},"content":[{"type":"paragraph","content":[{"text":"2","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[709.0]},"content":[{"type":"paragraph","content":[{"text":"Delete","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[51.0]},"content":[{"type":"paragraph","content":[{"text":"3","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[709.0]},"content":[{"type":"paragraph","content":[{"text":"Play","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[51.0]},"content":[{"type":"paragraph","content":[{"text":"4","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[709.0]},"content":[{"type":"paragraph","content":[{"text":"Power","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[51.0]},"content":[{"type":"paragraph","content":[{"text":"5","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[709.0]},"content":[{"type":"paragraph","content":[{"text":"PowerOn","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[51.0]},"content":[{"type":"paragraph","content":[{"text":"6","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[709.0]},"content":[{"type":"paragraph","content":[{"text":"Edit","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[51.0]},"content":[{"type":"paragraph","content":[{"text":"7","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[709.0]},"content":[{"type":"paragraph","content":[{"text":"AllTracks","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[51.0]},"content":[{"type":"paragraph","content":[{"text":"8","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[709.0]},"content":[{"type":"paragraph","content":[{"text":"ShuffleAll","type":"text"}]}]}]}]},{"type":"paragraph","content":[{"text":"dna","type":"text","marks":[{"type":"code"}]},{"text":" provides the name of the attribute containing the value to use for display.","type":"text"}]},{"type":"paragraph","content":[{"text":"guid","type":"text","marks":[{"type":"code"}]},{"text":" provides the item's ID for use in any action.","type":"text"}]},{"type":"paragraph","content":[{"text":"hasChildren","type":"text","marks":[{"type":"code"}]},{"text":" indicates whether that menu item is a branch (","type":"text"},{"text":"1","type":"text","marks":[{"type":"code"}]},{"text":") or a leaf (","type":"text"},{"text":"0","type":"text","marks":[{"type":"code"}]},{"text":").","type":"text"}]},{"type":"paragraph","content":[{"text":"name","type":"text","marks":[{"type":"code"}]},{"text":" provides the name of the item.","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Picklists","type":"text"}]},{"type":"paragraph","content":[{"text":"Picklists are a way for the server to generically present a list to the control client without the control client needing any additional information about that menu. All online content uses Picklists. Some local menus are Picklists. Given their frequency, we must go over them first.","type":"text"}]},{"type":"paragraph","content":[{"text":"Picklists are always browsed using the ","type":"text"},{"text":"BrowsePicklist","type":"text","marks":[{"type":"code"}]},{"text":" command. In some cases, performing an item's ","type":"text"},{"text":"action","type":"text","marks":[{"type":"code"}]},{"text":", ","type":"text"},{"text":"listAction","type":"text","marks":[{"type":"code"}]},{"text":", or ","type":"text"},{"text":"browseAction","type":"text","marks":[{"type":"code"}]},{"text":" might result in a Picklist when that item's default action would not. A good example of this is when selecting local content for playback. The list items each have a ","type":"text"},{"text":"listAction","type":"text","marks":[{"type":"code"}]},{"text":" that results in an intent clarification menu as a picklist that is sent to the client without the need of ","type":"text"},{"text":"BrowsePicklist","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]},{"type":"paragraph","content":[{"text":"Picklist items are selected with the ","type":"text"},{"text":"AckPickItem ","type":"text","marks":[{"type":"code"}]},{"text":" command if there is no ","type":"text"},{"text":"listAction","type":"text","marks":[{"type":"code"}]},{"text":" attribute present.","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Local Content","type":"text"}]},{"type":"paragraph","content":[{"text":"Local content can be browsed in whatever order is desired by the control client. However, most clients follow this pattern:","type":"text"}]},{"type":"paragraph","content":[{"text":"Albums => Tracks","type":"text"}]},{"type":"paragraph","content":[{"text":"Artists => Albums => Tracks","type":"text"}]},{"type":"paragraph","content":[{"text":"Composers => Tracks","type":"text"}]},{"type":"paragraph","content":[{"text":"Favorites","type":"text"}]},{"type":"paragraph","content":[{"text":"Genres => Albums => Tracks","type":"text"}]},{"type":"paragraph","content":[{"text":"Playlists => Tracks","type":"text"}]},{"type":"paragraph","content":[{"text":"To browse a top level list, simply clear the Music Filter using ","type":"text"},{"text":"SetMusicFilter Clear","type":"text","marks":[{"type":"code"}]},{"text":", then send the appropriate Browse command. Valid commands are listed at the bottom of this section.","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Online Content","type":"text"}]},{"type":"paragraph","content":[{"text":"All online sources are Picklist trees branching from ","type":"text"},{"text":"BrowseRadioSources","type":"text","marks":[{"type":"code"}]},{"text":". The response to ","type":"text"},{"text":"BrowseRadioSources","type":"text","marks":[{"type":"code"}]},{"text":" is a list of ","type":"text"},{"text":"RadioSources","type":"text","marks":[{"type":"code"}]},{"text":". To select a specific service, use ","type":"text"},{"text":"SetRadioFilter Source=","type":"text","marks":[{"type":"code"}]},{"text":". Subsequently, use the value of the intended online service. This example assumes ","type":"text"},{"text":"SetPickListCount","type":"text","marks":[{"type":"code"}]},{"text":" has been set. The example browses Pandora.","type":"text"}]},{"type":"codeBlock","content":[{"text":"SetXmlMode Lists\n\nBrowseRadioSources\n\n \n \n \n \n \n \n \n \n \n\n\nSetRadioFilter Source=fbbcedb1-af64-4c3f-bfe5-000000000010\nBrowseRadioStations\n\n \n \n \n \n \n \n \n \n \n \n","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Choosing Default Online Accounts","type":"text"}]},{"type":"paragraph","content":[{"text":"To ease access to preferred accounts, we support selecting an account to be preselected in a streaming services' menu. This setting must be reapplied when the control client reconnects as its lifetime is that of the connection. This capability is supported always but only useful if more than one account per service is configured.","type":"text"}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"Retrieving Available Accounts","type":"text"}]},{"type":"paragraph","content":[{"text":"To select a specific account, a list of available accounts is required. The ","type":"text"},{"text":"BrowseServiceAccounts","type":"text","marks":[{"type":"code"}]},{"text":" command works just like all the other commands. Paging is supported but not necessary as it is unlikely that there are more accounts than can be processed in a single chunk.","type":"text"}]},{"type":"codeBlock","content":[{"text":"BrowseServiceAccounts\n\n\n \n \n \n \n \n","type":"text"}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"Setting The Preferred Account","type":"text"}]},{"type":"paragraph","content":[{"text":"Setting the preferred account for a given service requires both the service's guid (obtained via the ","type":"text"},{"text":"BrowseRadioSources","type":"text","marks":[{"type":"code"}]},{"text":" command) and the account's guid (obtained via the ","type":"text"},{"text":"BrowseServiceAccounts","type":"text","marks":[{"type":"code"}]},{"text":" command). Use both values when using the ","type":"text"},{"text":"SetServiceAccount","type":"text","marks":[{"type":"code"}]},{"text":" command. Here, we select the ","type":"text"},{"text":"pandora@example.com","type":"text","marks":[{"type":"code"}]},{"text":" account for the Pandora service.","type":"text"}]},{"type":"codeBlock","content":[{"text":"SetServiceAccount fbbcedb1-af64-4c3f-bfe5-000000000010 751b4184-589a-36e4-9637-b0df383c6ecc","type":"text"}]},{"type":"paragraph","content":[{"text":"Subsequently, browsing the top menu for Pandora will be that account.","type":"text"}]},{"type":"paragraph","content":[{"text":"This command can also be latching per output. This means that it is possible to set a given account as default on a given output of an MMS. Do this by appending ","type":"text"},{"text":"False","type":"text","marks":[{"type":"code"}]},{"text":" to the end of the above command. For example:","type":"text"}]},{"type":"codeBlock","content":[{"text":"SetServiceAccount fbbcedb1-af64-4c3f-bfe5-000000000010 751b4184-589a-36e4-9637-b0df383c6ecc False","type":"text"}]},{"type":"paragraph","content":[{"text":"Clearing latched accounts for a service or all services on an output can be done with the following two commands:","type":"text"}]},{"type":"codeBlock","content":[{"text":"SetServiceAccount Service Clear False","type":"text"}]},{"type":"paragraph","content":[{"text":"where ","type":"text"},{"text":"Service","type":"text","marks":[{"type":"code"}]},{"text":" is replaced by the name or GUID of the streaming service","type":"text"}]},{"type":"paragraph","content":[{"text":"or","type":"text"}]},{"type":"codeBlock","content":[{"text":"SetServiceAccount Clear Clear False","type":"text"}]},{"type":"paragraph","content":[{"text":"More details on this command can be found ","type":"text"},{"text":"in this article","type":"text","marks":[{"type":"link","attrs":{"href":"https://autonomic.atlassian.net/l/c/BcKs6G0b"}}]},{"text":".","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Valid Browse Commands","type":"text"}]},{"type":"paragraph","content":[{"text":"BrowseAlbums","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"BrowseArtists","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"BrowseComposers","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"BrowseFavorites","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"BrowseGenres","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"BrowseNowPlaying","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"BrowsePicklist","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"BrowsePlaylists","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"BrowseRadioSources","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"BrowseTitles","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"BrowseTopMenu","type":"text","marks":[{"type":"code"}]}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"Browse Top Menu","type":"text"}]},{"type":"paragraph","content":[{"text":"The ","type":"text"},{"text":"BrowseTopMenu","type":"text","marks":[{"type":"code"}]},{"text":" command supports some non-standard uses. Simply, it can take an additional argument that is neither a start or count value to indicate that the request is actually for the content within a node available as a child to the default response. Subsequently, the picklist response can be handled like any other picklist. This greatly simplifies the handler requirements for a control client.","type":"text"}]},{"type":"codeBlock","content":[{"text":"BrowseTopMenu\n\n\n \n \n \n \n \n \n \n \n \n","type":"text"}]},{"type":"paragraph","content":[{"text":"To specify a different root, use ","type":"text"},{"text":"BrowseTopMenu itemGuid=","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]},{"type":"codeBlock","content":[{"text":"BrowseTopMenu itemGuid=fbbcedb1-af64-4c3f-bfe5-000000000010\n\n\n \n \n \n \n \n \n \n \n \n \n","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Initiating playback with Content","type":"text"}]},{"type":"paragraph","content":[{"text":"The end result of browsing content on MMS is, of course, the initiation of content playback.","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Directly Addressable Content","type":"text"}]},{"type":"paragraph","content":[{"text":"Any directly addressable content (local content, presets, playlists, scenes) can be recalled at any time without context or prior browse. Use the ","type":"text"},{"text":"Play ","type":"text","marks":[{"type":"code"}]},{"text":" command to do so. For example, to play an ","type":"text"},{"text":"Album","type":"text","marks":[{"type":"code"}]},{"text":", use ","type":"text"},{"text":"PlayAlbum ","type":"text","marks":[{"type":"code"}]},{"text":". For a ","type":"text"},{"text":"Playlist","type":"text","marks":[{"type":"code"}]},{"text":", use ","type":"text"},{"text":"PlayPlaylist ","type":"text","marks":[{"type":"code"}]},{"text":". The full list of directly addressable content is as follows:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Albums","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Artists","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Composers","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Genres","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Playlists","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Presets","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Scenes","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Titles","type":"text"}]}]}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Modifying the Queue","type":"text"}]},{"type":"paragraph","content":[{"text":"Initiating playback with an existing queue can be done in several ways that allow for queue construction or replacement. The available options and each option’s protocol verb are:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Play Next (","type":"text"},{"text":"Next","type":"text","marks":[{"type":"code"}]},{"text":")","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Insert the addressed content after the currently playing track","type":"text"}]}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Play Now (","type":"text"},{"text":"Now","type":"text","marks":[{"type":"code"}]},{"text":")","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Insert the addressed content after the currently playing track and perform a skip","type":"text"}]}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Replace Queue (","type":"text"},{"text":"Replace","type":"text","marks":[{"type":"code"}]},{"text":")","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Replace the entire queue with the addressed content","type":"text"}]}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Add To Queue (","type":"text"},{"text":"AddToQueue","type":"text","marks":[{"type":"code"}]},{"text":")","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Append the addressed content to the end of the queue","type":"text"}]}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Add To Playlist (","type":"text"},{"text":"AddToPlaylist","type":"text","marks":[{"type":"code"}]},{"text":")","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Append the addressed content to the end of a playlist as selected from the subsequently provided menu","type":"text"}]}]}]}]}]},{"type":"paragraph","content":[{"text":"While all of these options are always available, the options are condensed to those unique actions and presented to the connected client in a number of ways. In other words, when the queue is empty, the only presented option is Now because there is nothing to modify. Sending ","type":"text"},{"text":"Replace","type":"text","marks":[{"type":"code"}]},{"text":" in such a scenario would perform the same exact action as ","type":"text"},{"text":"Now","type":"text","marks":[{"type":"code"}]},{"text":". The list of options is communicated to the connected client via the ","type":"text"},{"text":"LocalQueueOptions","type":"text","marks":[{"type":"code"}]},{"text":" status event or as a menu when indicating playback via the ","type":"text"},{"text":"ClarifyTitleIntent","type":"text","marks":[{"type":"code"}]},{"text":" command. To ensure MMS knows the client supports this functionality, be sure to indicate as such by sending ","type":"text"},{"text":"SetOption supports_playnow=true","type":"text","marks":[{"type":"code"}]},{"text":" during the preamble. See the ","type":"text"},{"text":"Setting Additional Options","type":"text","marks":[{"type":"link","attrs":{"href":"#Setting-Additional-Options"}}]},{"text":" section above for more details.","type":"text"}]},{"type":"paragraph","content":[{"text":"The intended option is communicated to the server by appending it to the end of the ","type":"text"},{"text":"Play","type":"text","marks":[{"type":"code"}]},{"text":" command after the container’s GUID. For example, ","type":"text"},{"text":"PlayAlbum c8507e3c-a5c0-4503-bd87-0b711580987e Replace","type":"text","marks":[{"type":"code"}]},{"text":". For items where a ","type":"text"},{"text":"listAction","type":"text","marks":[{"type":"code"}]},{"text":" is provided and that ","type":"text"},{"text":"listAction","type":"text","marks":[{"type":"code"}]},{"text":" is ","type":"text"},{"text":"ClarifyTitleIntent","type":"text","marks":[{"type":"code"}]},{"text":", append the verb to the end of that command. For example, ","type":"text"},{"text":"ClarifyTitleIntent 1609d2f0-b7c8-4996-9a48-4f434ad436e0 Next","type":"text","marks":[{"type":"code"}]},{"text":". Leaving the verb off will result in a menu for the user to select from unless there is only one action available, in which case MMS will perform that action.","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Presets","type":"text"}]},{"type":"paragraph","content":[{"text":"To store a Preset, use the ","type":"text"},{"text":"StorePreset","type":"text","marks":[{"type":"code"}]},{"text":" command. This command takes an optional double-quoted name argument. If the name argument is specified, the MMS will store the Preset 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. As with all protocol commands, each command should be terminated with a carriage return and a line feed (\\r\\n).","type":"text"}]},{"type":"paragraph","content":[{"text":"Examples:","type":"text"}]},{"type":"paragraph","content":[{"text":"StorePreset","type":"text","marks":[{"type":"code"}]},{"text":" - This will be responded to with an InputBox from the server.","type":"text"}]},{"type":"paragraph","content":[{"text":"StorePreset \"Party Time\"","type":"text","marks":[{"type":"code"}]},{"text":" - This will save a Preset called Party Time","type":"text"}]},{"type":"paragraph","content":[{"text":"To recall a Preset, use the RecallPreset command. This command takes either the double-quoted name of the Preset or the unique ID of the Preset. To get either of these, please see the BrowseFavorites command, described below. Recalling a Preset will replace the state of the selected Instance with the state stored in the Preset. As with all protocol commands, each command should be terminated with a carriage return and a line feed (\\r\\n).","type":"text"}]},{"type":"paragraph","content":[{"text":"Examples:","type":"text"}]},{"type":"paragraph","content":[{"text":"RecallPreset \"Party Time\"","type":"text","marks":[{"type":"code"}]},{"text":" - This recalls the Preset by name","type":"text"}]},{"type":"paragraph","content":[{"text":"RecallPreset 9f9c8919-f939-d67a-dce2-cb049a4ead99","type":"text","marks":[{"type":"code"}]},{"text":" - This recalls the Preset by unique ID","type":"text"}]},{"type":"paragraph","content":[{"text":"Edit a preset with ","type":"text"},{"text":"EditPreset nameOrId","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"Rename a preset with ","type":"text"},{"text":"RenamePreset nameOrId newName","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"Delete a preset with ","type":"text"},{"text":"DeletePreset nameOrId","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"To browse available Presets, use the ","type":"text"},{"text":"BrowseFavorites","type":"text","marks":[{"type":"code"}]},{"text":" or ","type":"text"},{"text":"BrowsePresets","type":"text","marks":[{"type":"code"}]},{"text":" commands. This Browse command adheres to the same pattern as all other Browse commands.","type":"text"}]},{"type":"paragraph","content":[{"text":"This feature was once called Snapshot.","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Relevant Events","type":"text"}]},{"type":"paragraph","content":[{"text":"There are some events that indicate changes to favorites to the control client.","type":"text"}]},{"type":"paragraph","content":[{"text":"FavoritesChanged","type":"text","marks":[{"type":"code"}]},{"text":" will be sent whenever any change is made to any preset. It will always be ","type":"text"},{"text":"true","type":"text","marks":[{"type":"code"}]},{"text":". Simply receiving it is sufficient to rebrowse presets.","type":"text"}]},{"type":"paragraph","content":[{"text":"FavoritesCount","type":"text","marks":[{"type":"code"}]},{"text":" will be sent whenever the number of presets changes.","type":"text"}]},{"type":"paragraph"},{"type":"paragraph","content":[{"text":"FavoritesCount","type":"text","marks":[{"type":"code"}]},{"text":" differs from ","type":"text"},{"text":"FavoritesChanged","type":"text","marks":[{"type":"code"}]},{"text":" in that it will only be sent when a preset is added or deleted while ","type":"text"},{"text":"FavoritesChanged","type":"text","marks":[{"type":"code"}]},{"text":" includes name changes.","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Scenes","type":"text"}]},{"type":"paragraph","content":[{"text":"To store a Scene, use the ","type":"text"},{"text":"StoreScene","type":"text","marks":[{"type":"code"}]},{"text":" 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).","type":"text"}]},{"type":"paragraph","content":[{"text":"Examples:","type":"text"}]},{"type":"paragraph","content":[{"text":"StoreScene","type":"text","marks":[{"type":"code"}]},{"text":" - This will be responded to with an InputBox from the server.","type":"text"}]},{"type":"paragraph","content":[{"text":"StoreScene \"Party Time\"","type":"text","marks":[{"type":"code"}]},{"text":" - This will save a Scene called Party Time","type":"text"}]},{"type":"paragraph","content":[{"text":"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).","type":"text"}]},{"type":"paragraph","content":[{"text":"Examples:","type":"text"}]},{"type":"paragraph","content":[{"text":"RecallScene \"DinnerTime\"","type":"text","marks":[{"type":"code"}]},{"text":" - This recalls the Scene by name","type":"text"}]},{"type":"paragraph","content":[{"text":"RecallScene 9f9c8919-f939-d67a-dce2-cb049a4ead99","type":"text","marks":[{"type":"code"}]},{"text":" - This recalls the Scene by unique ID ","type":"text"}]},{"type":"paragraph","content":[{"text":"Delete a Scene with ","type":"text"},{"text":"DeleteScene nameOrId","type":"text","marks":[{"type":"code"}]}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Relevant Events","type":"text"}]},{"type":"paragraph","content":[{"text":"There are some events that indicate changes to scenes to the control client.","type":"text"}]},{"type":"paragraph","content":[{"text":"ScenesChanged","type":"text","marks":[{"type":"code"}]},{"text":" will be sent whenever any change is made to any scene. It will always be ","type":"text"},{"text":"true","type":"text","marks":[{"type":"code"}]},{"text":". Simply receiving it is sufficient to rebrowse scenes.","type":"text"}]},{"type":"paragraph","content":[{"text":"ScenesCount","type":"text","marks":[{"type":"code"}]},{"text":" will be sent whenever the number of scenes changes.","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Playlists","type":"text"}]},{"type":"paragraph","content":[{"text":"Playlists are browsed with ","type":"text"},{"text":"BrowsePlaylists","type":"text","marks":[{"type":"code"}]},{"text":". This command adheres to the same pattern as all Browse commands.","type":"text"}]},{"type":"paragraph","content":[{"text":"Rename a playlist with ","type":"text"},{"text":"RenamePlaylist oldName newName","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"Delete a playlist with ","type":"text"},{"text":"DeletePlaylist nameOrId","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"Reorder tracks within a playlist with ","type":"text"},{"text":"ReorderPlaylist playlistId srceTrackId destTrackId","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"A playlist can be directly played with ","type":"text"},{"text":"PlayPlaylist nameOrId","type":"text","marks":[{"type":"code"}]}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Relevant Events","type":"text"}]},{"type":"paragraph","content":[{"text":"There are some events that indicate changes to favorites to the control client.","type":"text"}]},{"type":"paragraph","content":[{"text":"PlaylistsChanged","type":"text","marks":[{"type":"code"}]},{"text":" will be sent whenever any change is made to any playlist. It will always be ","type":"text"},{"text":"true","type":"text","marks":[{"type":"code"}]},{"text":". Simply receiving it is sufficient to rebrowse playlists.","type":"text"}]},{"type":"paragraph","content":[{"text":"PlaylistCount","type":"text","marks":[{"type":"code"}]},{"text":" will be sent whenever the number of playlists changes.","type":"text"}]},{"type":"paragraph"},{"type":"paragraph","content":[{"text":"PlaylistCount","type":"text","marks":[{"type":"code"}]},{"text":" differs from ","type":"text"},{"text":"PlaylistsChanged","type":"text","marks":[{"type":"code"}]},{"text":" in that it will only be sent when a playlist is added or deleted while ","type":"text"},{"text":"PlaylistsChanged","type":"text","marks":[{"type":"code"}]},{"text":" includes name changes.","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Now Playing","type":"text"}]},{"type":"paragraph","content":[{"text":"The now playing queue can be browsed with ","type":"text"},{"text":"BrowseNowPlaying","type":"text","marks":[{"type":"code"}]},{"text":". Only browse the queue if the ","type":"text"},{"text":"BrowseNowPlayingAvailable","type":"text","marks":[{"type":"code"}]},{"text":" event is ","type":"text"},{"text":"true","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]},{"type":"paragraph","content":[{"text":"All now playing indexes are 1 based.","type":"text"}]},{"type":"paragraph","content":[{"text":"Change songs by using ","type":"text"},{"text":"JumpToNowPlayingitem ","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]},{"type":"paragraph","content":[{"text":"Reorder the queue with ","type":"text"},{"text":"ReorderNowPlaying ","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]},{"type":"paragraph","content":[{"text":"Remove a song with ","type":"text"},{"text":"RemoveNowPlayingItem ","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]},{"type":"paragraph","content":[{"text":"Clear the queue with ","type":"text"},{"text":"ClearNowPlaying","type":"text","marks":[{"type":"code"}]},{"text":". Passing ","type":"text"},{"text":"False","type":"text","marks":[{"type":"code"}]},{"text":" as an argument will clear the queue and stop playback of any station based content. Passing ","type":"text"},{"text":"True","type":"text","marks":[{"type":"code"}]},{"text":" or no argument will clear the queue and stop any queue based content from playing back but ","type":"text"},{"text":"will not disrupt playback for station based content","type":"text","marks":[{"type":"strong"}]},{"text":".","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Triggers","type":"text"}]},{"type":"paragraph","content":[{"text":"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). ","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Relevant Commands","type":"text"}]},{"type":"paragraph","content":[{"text":"Turn on/off an output trigger with ","type":"text"},{"text":"SetOutputTrigger ","type":"text","marks":[{"type":"code"}]},{"text":" , where ","type":"text"},{"text":"","type":"text","marks":[{"type":"code"}]},{"text":" is in trigger order independent of the trigger label. IE. Trigger Out A would have ","type":"text"},{"text":"","type":"text","marks":[{"type":"code"}]},{"text":" of 1.","type":"text"}]},{"type":"paragraph","content":[{"text":"Example:","type":"text"}]},{"type":"paragraph","content":[{"text":"Turn on Trigger Out A: ","type":"text"},{"text":"SetOutputTrigger 1 true","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"Turn off Trigger Out C: ","type":"text"},{"text":"SetOutputTrigger 3 false","type":"text","marks":[{"type":"code"}]}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Relevant Events","type":"text"}]},{"type":"paragraph","content":[{"text":"There are some events for Input Triggers. Each Input Trigger does have one event, ","type":"text"},{"text":"TriggerIn1 through TriggerIn","type":"text","marks":[{"type":"code"}]},{"text":", where the event is true when voltage is applied to the input pin. ","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Album Art","type":"text"}]},{"type":"paragraph","content":[{"text":"BaseWebUrl","type":"text","marks":[{"type":"code"}]},{"text":" provides the protocol, address, and port portions of the URL to retrieve art from. For example: ","type":"text"},{"text":"http://192.168.0.59:5005","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]},{"type":"paragraph","content":[{"text":"The specific handler on the MMS is called ","type":"text"},{"text":"getart","type":"text","marks":[{"type":"code"}]},{"text":" so an example of a base for retrieving art would be ","type":"text"},{"text":"http://192.168.0.59:5005/getart?...","type":"text","marks":[{"type":"code"}]},{"text":". Always include the ID of the item. If constructing the URL manually rather than using the value of ","type":"text"},{"text":"BaseWebUrl","type":"text","marks":[{"type":"code"}]},{"text":", it is acceptable to leave the port off the request. For example ","type":"text"},{"text":"http://192.168.0.59/getart?...","type":"text","marks":[{"type":"code"}]},{"text":". Requests for ","type":"text"},{"text":"/getart","type":"text","marks":[{"type":"code"}]},{"text":" on port ","type":"text"},{"text":"80","type":"text","marks":[{"type":"code"}]},{"text":" are processed the same as requests on port ","type":"text"},{"text":"5005.","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"To construct the full URL to get art, use the above values along with the below options.","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":1800.0,"localId":"3adab688-702f-4e84-b8ac-378b82c6d754"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[254.0]},"content":[{"type":"paragraph","content":[{"text":"Option","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[253.0]},"content":[{"type":"paragraph","content":[{"text":"Purpose","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[253.0]},"content":[{"type":"paragraph","content":[{"text":"Possible Values","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[254.0]},"content":[{"type":"paragraph","content":[{"text":"c","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[253.0]},"content":[{"type":"paragraph","content":[{"text":"constrain","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[253.0]},"content":[{"type":"paragraph","content":[{"text":"0=size image to fit height and width","type":"text"}]},{"type":"paragraph","content":[{"text":"1=constrain to dimension and maintain aspect ratio","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[254.0]},"content":[{"type":"paragraph","content":[{"text":"guid","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[253.0]},"content":[{"type":"paragraph","content":[{"text":"unique id of the album, artist, genre, title, etc","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[253.0]},"content":[{"type":"paragraph"}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[254.0]},"content":[{"type":"paragraph","content":[{"text":"fmt","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[253.0]},"content":[{"type":"paragraph","content":[{"text":"image format. Valid values are ","type":"text"},{"text":"png","type":"text","marks":[{"type":"code"}]},{"text":" or ","type":"text"},{"text":"jpg","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[253.0]},"content":[{"type":"paragraph"}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[254.0]},"content":[{"type":"paragraph","content":[{"text":"instance","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[253.0]},"content":[{"type":"paragraph","content":[{"text":"the instance GUID","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[253.0]},"content":[{"type":"paragraph"}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[254.0]},"content":[{"type":"paragraph","content":[{"text":"h","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[253.0]},"content":[{"type":"paragraph","content":[{"text":"image height","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[253.0]},"content":[{"type":"paragraph"}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[254.0]},"content":[{"type":"paragraph","content":[{"text":"w","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[253.0]},"content":[{"type":"paragraph","content":[{"text":"image width","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[253.0]},"content":[{"type":"paragraph"}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[254.0]},"content":[{"type":"paragraph","content":[{"text":"rfle","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[253.0]},"content":[{"type":"paragraph","content":[{"text":"reflection elevation","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[253.0]},"content":[{"type":"paragraph"}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[254.0]},"content":[{"type":"paragraph","content":[{"text":"rflh","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[253.0]},"content":[{"type":"paragraph","content":[{"text":"reflection height","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[253.0]},"content":[{"type":"paragraph"}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[254.0]},"content":[{"type":"paragraph","content":[{"text":"rflo","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[253.0]},"content":[{"type":"paragraph","content":[{"text":"reflection opacity","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[253.0]},"content":[{"type":"paragraph"}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[254.0]},"content":[{"type":"paragraph","content":[{"text":"rz","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[253.0]},"content":[{"type":"paragraph","content":[{"text":"reflection rotation (z axis)","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[253.0]},"content":[{"type":"paragraph"}]}]}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"JSON HTTP API","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"General Information","type":"text"}]},{"type":"paragraph","content":[{"text":"The root endpoint for all HTTP API communication is ","type":"text"},{"text":"http://ipOrNameOfServer/api/","type":"text","marks":[{"type":"code"}]},{"text":". A ","type":"text"},{"text":"GET","type":"text","marks":[{"type":"code"}]},{"text":" request to this endpoint will receive a JSON response containing three arrays: ","type":"text"},{"text":"events","type":"text","marks":[{"type":"code"}]},{"text":", ","type":"text"},{"text":"browse","type":"text","marks":[{"type":"code"}]},{"text":", and ","type":"text"},{"text":"messages","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Response","type":"text"}]},{"type":"paragraph","content":[{"text":"events","type":"text","marks":[{"type":"code"}]},{"text":" contains ","type":"text"},{"text":"name","type":"text","marks":[{"type":"code"}]},{"text":",","type":"text"},{"text":"value","type":"text","marks":[{"type":"code"}]},{"text":" pairs where the event names are the same as the previously described IP protocol and values carry the same meaning per event.","type":"text"}]},{"type":"paragraph","content":[{"text":"browse","type":"text","marks":[{"type":"code"}]},{"text":" contains the response to any browse commands made on separate ","type":"text"},{"text":"GET","type":"text","marks":[{"type":"code"}]},{"text":" requests to this same endpoint. This will discussed more later.","type":"text"}]},{"type":"paragraph","content":[{"text":"messages","type":"text","marks":[{"type":"code"}]},{"text":" contains generic messages.","type":"text"}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"{\n events: [\n {\n name: \"TrackTime\",\n value: 369\n }\n ],\n browse: null,\n messages: null\n}","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Sending commands","type":"text"}]},{"type":"paragraph","content":[{"text":"To send commands, simply replace any spaces in the command as it would be used in the IP protocol with a ","type":"text"},{"text":"/","type":"text","marks":[{"type":"code"}]},{"text":". For example, if the IP command is ","type":"text"},{"text":"SubscribeEvents True","type":"text","marks":[{"type":"code"}]},{"text":", a ","type":"text"},{"text":"GET","type":"text","marks":[{"type":"code"}]},{"text":" to ","type":"text"},{"text":"http://ipOrNameOfServer/api/SubscribeEvents/True","type":"text","marks":[{"type":"code"}]},{"text":" would execute that command. Be sure to URL encode any parameters to ensure no invalid characters","type":"text"}]},{"type":"paragraph","content":[{"text":"It's important to remember that there is a fundamental difference between the HTTP JSON API and the IP protocol in that HTTP communications are ","type":"text"},{"text":"NOT","type":"text","marks":[{"type":"strong"}]},{"text":" guaranteed to be processed in the order the control client sends them as they are all transmitted on different sockets. The server may receive them out of order. To handle this and to force sets of commands to be processed in order, make use of the ","type":"text"},{"text":"Script","type":"text","marks":[{"type":"code"}]},{"text":" command. This command allows several commands to executed in a specific order by transmitting them all at once. When using the ","type":"text"},{"text":"Script","type":"text","marks":[{"type":"code"}]},{"text":" command, be sure to URL encode each (sub)command entirely as it is a ","type":"text"},{"text":"parameter","type":"text","marks":[{"type":"em"}]},{"text":" rather than a command. For example, if we wanted to set the target instance and subscribe to events in that order, we would do ","type":"text"},{"text":"http://ipOrNameOfServer/api/Script/SetInstance%20Player_A/SubscribeEvents%20True","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]},{"type":"paragraph","content":[{"text":"Regardless of the command sent, the response will be received in the next request to the bare endpoint ","type":"text"},{"text":"http://ipOrNameOfServer/api/","type":"text","marks":[{"type":"code"}]},{"text":". To ensure communicates between clients and the server are properly routed, be sure to include a query string containing ","type":"text"},{"text":"clientId=","type":"text","marks":[{"type":"code"}]},{"text":". For example: ","type":"text"},{"text":"clientId=0a5926cc-e68f-4f82-92c4-ba148dfab6c9","type":"text","marks":[{"type":"code"}]},{"text":". This ensures that multiple clients can send and receive without interfering with each other. Leaving the ","type":"text"},{"text":"clientId","type":"text","marks":[{"type":"code"}]},{"text":" out of command requests and/or polling requests will cause inter-client cross talk.","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Browsing","type":"text"}]},{"type":"paragraph","content":[{"text":"Browsing through HTTP works nearly identically as through a regular socket. Send browse commands in the fashion described in ","type":"text"},{"text":"Sending Commands","type":"text","marks":[{"type":"strong"}]},{"text":".","type":"text"}]},{"type":"paragraph"},{"type":"paragraph","content":[{"text":"In these examples, we’re sending ","type":"text"},{"text":"BrowsePresets 1 10","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]},{"type":"paragraph","content":[{"text":"If sending a single command, separate the command and arguments with ","type":"text"},{"text":"/","type":"text","marks":[{"type":"code"}]},{"text":":","type":"text"}]},{"type":"codeBlock","content":[{"text":"http://ipOrNameOfServer/api/BrowsePresets/1/10","type":"text"}]},{"type":"paragraph"},{"type":"paragraph","content":[{"text":"If sending as part of a script, URL encode the entire command and pass it as an argument to ","type":"text"},{"text":"Script","type":"text","marks":[{"type":"code"}]},{"text":":","type":"text"}]},{"type":"codeBlock","content":[{"text":"http://ipOrNameOfServer/api/Script/SetMusicFilter%20Clear/SetRadioFilter%20Clear/BrowsePresets%201%2010/","type":"text"}]},{"type":"paragraph"},{"type":"paragraph","content":[{"text":"Expect the next poll to ","type":"text"},{"text":"/api","type":"text","marks":[{"type":"code"}]},{"text":" to contain data like this:","type":"text"}]},{"type":"paragraph"},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"{\n \"events\": null,\n \"browse\": {\n \"Total\": 1,\n \"Ok\": true,\n \"TextOrErrorMessage\": null,\n \"Start\": 1,\n \"Items\": [{\n \"isSearchable\": false,\n \"LastModifiedTime\": \"\\/Date(-62135578800000-0500)\\/\",\n \"UniqueName\": \"REVENGER - Evil Electro / Dark Synthwave / Cyberpunk / Industrial / Dark Electro Music Mix\",\n \"ArtistName\": \"\",\n \"DynamicPresetSource\": \"Spotify\",\n \"ArtUrl\": \"https://i.scdn.co/image/ab67706c0000bebb90f018c58b9509bb401932de\",\n \"Name\": \"REVENGER - Evil Electro / Dark Synthwave / Cyberpunk / Industrial / Dark Electro Music Mix\",\n \"IsUnknown\": false,\n \"IsNowPlaying\": false,\n \"IsSearchable\": false,\n \"Guid\": \"7fdd0454-7a91-ade4-b051-537cd180f84e\",\n \"ArtGuid\": \"4cb8139b-bbb5-4b14-58c3-e87d02f5090b\",\n \"MediaObjectType\": \"Favorite\",\n \"ExtraAttributes\": {\n \"button\": \"6\",\n \"action\": \"EditPreset\"\n },\n \"MediaInfoButtonState\": \"Edit\",\n \"Action\": \"EditPreset\",\n \"ListAction\": null,\n \"BrowseAction\": null,\n \"ActiveUser\": \"00000000-0000-0000-0000-000000000000\"\n }],\n \"ExtraAttributes\": {\n \"art\": \"false\",\n \"alpha\": \"false\",\n \"displayAs\": \"List\",\n \"caption\": \"Favorites\"\n },\n \"Caption\": \"Favorites\",\n \"SupportsNowPlaying\": false,\n \"AlphaSort\": false,\n \"MessageId\": \"BrowseFavorites\",\n \"TimeoutInMilliseconds\": 5000,\n \"MsgSource\": 0\n },\n \"messages\": null,\n \"controls\": null\n}","type":"text"}]},{"type":"paragraph"}],"version":1}