{"type":"doc","content":[{"type":"heading","attrs":{"level":2},"content":[{"text":"Overview","type":"text"}]},{"type":"paragraph","content":[{"text":"When a Mirage Media Streamer (MMS) and a Mirage Amplifier or Mirage Amplifiers are paired together, they become a Mirage Audio System (MAS). As with MMS control, the API is fairly simple. We strongly recommend using XML mode for all list browsing. With this API, you can control a MAS's Zones, Sources, and Zone Groups.","type":"text"}]},{"type":"paragraph","content":[{"text":"In all examples, ","type":"text"},{"text":"-->","type":"text","marks":[{"type":"code"}]},{"text":" indicates a messages to the server and ","type":"text"},{"text":"<--","type":"text","marks":[{"type":"code"}]},{"text":" indicates a response. XML responses will be formatted for readability although they will be transmitted compressed to a single line in real communications","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Establishing a Connection","type":"text"}]},{"type":"paragraph","content":[{"text":"In most scenarios, MRAD communication is done through port 5006 on the server over a TCP socket. We recommend setting a number of options and settings to improve the experience and to configure the communications between your client and the server.","type":"text"}]},{"type":"paragraph","content":[{"text":"On ","type":"text"},{"text":"A","type":"text","marks":[{"type":"code"}]},{"text":" series servers, you have to switch protocol modes using the ","type":"text"},{"text":"*","type":"text","marks":[{"type":"code"}]},{"text":" command and this command should be the first command you send. However, this command is safe to send to ","type":"text"},{"text":"e","type":"text","marks":[{"type":"code"}]},{"text":" series servers with no ill effect.","type":"text"}]},{"type":"paragraph","content":[{"text":"The ","type":"text"},{"text":"SetClientType","type":"text","marks":[{"type":"code"}]},{"text":" command takes an arbitrary string argument that sets the connection's type. This allows the MMS to react to different client types if necessary.","type":"text"}]},{"type":"paragraph","content":[{"text":"As described elsewhere, you'll want all lists to be sent as XML, so send the ","type":"text"},{"text":"SetXmlMode Lists","type":"text","marks":[{"type":"code"}]},{"text":" command.","type":"text"}]},{"type":"paragraph","content":[{"text":"You can also set the encoding of the communications. Most control systems are UTF-8 compatible, so we recommend sending ","type":"text"},{"text":"SetEncoding 65001","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]},{"type":"paragraph","content":[{"text":"To be sure the MMS knows which address you accessed it through, be sure to use the ","type":"text"},{"text":"SetHost","type":"text","marks":[{"type":"code"}]},{"text":" command, sending the address you connected to. For example: ","type":"text"},{"text":"SetHost 192.168.0.53","type":"text","marks":[{"type":"code"}]},{"text":" or ","type":"text"},{"text":"SetHost foo.homeowner.com","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"To be sure the MMS notifies you of any status changes during your connection's lifetime, be sure to use some form of ","type":"text"},{"text":"SubscribeEvents","type":"text","marks":[{"type":"code"}]},{"text":". This command is described below in the ","type":"text"},{"text":"Events","type":"text","marks":[{"type":"strong"}]},{"text":" section.","type":"text"}]},{"type":"paragraph","content":[{"text":"To be sure you have the current state of the server, be sure to send ","type":"text"},{"text":"GetStatus","type":"text","marks":[{"type":"code"}]},{"text":". This command is also described below in the ","type":"text"},{"text":"Events","type":"text","marks":[{"type":"strong"}]},{"text":" section.","type":"text"}]},{"type":"paragraph","content":[{"text":"We recommend requesting Sources, Zones, and Zone Groups upon your initial connection by sending ","type":"text"},{"text":"BrowseSources","type":"text","marks":[{"type":"code"}]},{"text":", ","type":"text"},{"text":"BrowseZones","type":"text","marks":[{"type":"code"}]},{"text":", and ","type":"text"},{"text":"BrowseZoneGroups","type":"text","marks":[{"type":"code"}]},{"text":". These commands are described below in the ","type":"text"},{"text":"Browsing Zones, Sources, and Zone Groups","type":"text","marks":[{"type":"strong"}]},{"text":" section.","type":"text"}]},{"type":"paragraph","content":[{"text":"A full preamble example:","type":"text"}]},{"type":"codeBlock","content":[{"text":"--> *\n--> SetClientType DemoClient\n--> SetEncoding 65001\n--> SetXMLMode Lists\n--> SetHost 192.168.0.53\n--> SubscribeEvents Smart\n--> GetStatus\n--> BrowseSources\n--> BrowseZones\n--> BrowseZoneGroups","type":"text"}]},{"type":"paragraph"},{"type":"heading","attrs":{"level":3},"content":[{"text":"The Relationship Between 5004 and 5006","type":"text"}]},{"type":"paragraph","content":[{"text":"When connected to an instance on port 5004, events will be published that will instruct the control client where to go for MRAD. These events are ","type":"text"},{"text":"MRADServer","type":"text","marks":[{"type":"code"}]},{"text":" and ","type":"text"},{"text":"MRADSource","type":"text","marks":[{"type":"code"}]},{"text":". ","type":"text"},{"text":"MRADServer","type":"text","marks":[{"type":"code"}]},{"text":" tells the client the IP and port to connect to for MRAD control. ","type":"text"},{"text":"MRADSource","type":"text","marks":[{"type":"code"}]},{"text":" tells the client which source in MRAD represents the current MMS instance. On port 5006, events (described in detail below in the ","type":"text"},{"text":"Events","type":"text","marks":[{"type":"strong"}]},{"text":" section) ","type":"text"},{"text":"MCSControl","type":"text","marks":[{"type":"code"}]},{"text":", ","type":"text"},{"text":"MCSInstance","type":"text","marks":[{"type":"code"}]},{"text":", and ","type":"text"},{"text":"MCSWebPort","type":"text","marks":[{"type":"code"}]},{"text":" describe the inverse relationship.","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Single Socket Communications","type":"text"}]},{"type":"paragraph","content":[{"text":"On all modern MMS firmware (5.35.x.x and higher), it is possible to make a single connection to the MMS control port (","type":"text"},{"text":"5004","type":"text","marks":[{"type":"code"}]},{"text":") and use that socket for both MMS control and MRAD control. To utilize this functionality, make your connection normally, then send ","type":"text"},{"text":"SetOption Supports_SingleSocket=True","type":"text","marks":[{"type":"code"}]},{"text":". Subsequently, the MMS will proxy commands and feedback to and from MRAD. Any commands sent that are prepended with ","type":"text"},{"text":"MRAD.","type":"text","marks":[{"type":"code"}]},{"text":" will be handled by MRAD and any ","type":"text"},{"text":"events","type":"text","marks":[{"type":"em"}]},{"text":" MRAD sends will be prepended with ","type":"text"},{"text":"MRAD.","type":"text","marks":[{"type":"code"}]},{"text":". Browse responses will not be prepended as they are unique to MRAD and therefore can not be confused as MMS responses.","type":"text"}]},{"type":"paragraph","content":[{"text":"Setting this option is not necessary on eSeries MMSs. The firmware will automatically configure the connection in this mode the first time a command prepended with ","type":"text"},{"text":"MRAD.","type":"text","marks":[{"type":"code"}]},{"text":" is recevied.","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Definition of Terms","type":"text"}]},{"type":"paragraph","content":[{"text":"Zone: a physical output on the amplifier, after the matrix. A zone selects sources. There are some special cases where a zone is pre-matrix output and can't be grouped with other zones.","type":"text"}]},{"type":"paragraph","content":[{"text":"Source: an output of the MMS. This can be one physical output, many physical outputs, and/or a network stream (eAudioCast). A source is selected into a zone or zones.","type":"text"}]},{"type":"paragraph","content":[{"text":"Zone Group: a set of zones that have the same source selected. There are two types of zone groups, hard groups and soft groups.","type":"text"}]},{"type":"paragraph","content":[{"text":"Hard Group: a set of zones that are grouped on the amplifier for at least their selected source and optionally power and volume.","type":"text"}]},{"type":"paragraph","content":[{"text":"Soft Group: a set of zones that are grouped by virtue of having the same source selected. A soft group can contain a hard group or hard groups.","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Events","type":"text"}]},{"type":"paragraph","content":[{"text":"As with MMS control, MRAD control offers an event driven and asynchronous communications protocol. Events about the currently selected zone and source are pushed to the control client if configured to do so. Data about other zones is also pushed, but more information is available for the currently selected zone. To request that events be pushed to you, use the ","type":"text"},{"text":"SubscribeEvents","type":"text","marks":[{"type":"code"}]},{"text":" command. This command takes 1 to ","type":"text"},{"text":"n","type":"text","marks":[{"type":"em"}]},{"text":" comma delimited arguments. If you pass ","type":"text"},{"text":"true","type":"text","marks":[{"type":"code"}]},{"text":" or ","type":"text"},{"text":"false","type":"text","marks":[{"type":"code"}]},{"text":", event subscription will be enabled or disabled for all events. If you pass a comma delimited list of named events, you'll be subscribed to those events only. For example, if you only care about volume and power events, you could do ","type":"text"},{"text":"SubscribeEvents Power,Volume","type":"text","marks":[{"type":"code"}]},{"text":". It's important to note that the the list of events does not have spaces in it. Events will always be sent in one of these two formats:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"StateChanged =","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"ReportState =","type":"text","marks":[{"type":"code"}]}]}]}]},{"type":"paragraph","content":[{"text":"If you're communicating to the MRAD system through an MMS connection and the Single Socket option, all events will be prepended with ","type":"text"},{"text":"MRAD.","type":"text","marks":[{"type":"code"}]},{"text":" (as described above) like so:","type":"text"}]},{"type":"paragraph","content":[{"text":"MRAD.StateChanged =","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"Examples of both formats:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"ReportState Zone_1 Volume=3","type":"text","marks":[{"type":"code"}]},{"text":" or ","type":"text"},{"text":"StateChanged Zone_1 Volume=3","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"MRAD.ReportState Zone_1 Volume=3","type":"text","marks":[{"type":"code"}]},{"text":" or ","type":"text"},{"text":"MRAD.StateChanged Zone_1 Volume=3","type":"text","marks":[{"type":"code"}]}]}]}]},{"type":"paragraph","content":[{"text":"To request a full status report, use ","type":"text"},{"text":"GetStatus","type":"text","marks":[{"type":"code"}]},{"text":" command (","type":"text"},{"text":"MRAD.GetStatus","type":"text","marks":[{"type":"code"}]},{"text":" in Single Socket mode). The response will simply be a set of events pushed to you all at once.","type":"text"}]},{"type":"paragraph","content":[{"text":"It's important to keep track of these System events:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"ActiveSource","type":"text","marks":[{"type":"code"}]},{"text":": which source is does the ","type":"text"},{"text":"ActiveZone","type":"text","marks":[{"type":"code"}]},{"text":" have selected.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"ActiveZone","type":"text","marks":[{"type":"code"}]},{"text":": which zone is currently selected by this control client.","type":"text"}]}]}]},{"type":"paragraph","content":[{"text":"It's important to keep track of these Zone events. Events are available for every zone unless otherwise noted.","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"MaxVolume","type":"text","marks":[{"type":"code"}]},{"text":": the maximum volume for the ","type":"text"},{"text":"ActiveZone","type":"text","marks":[{"type":"code"}]},{"text":". This event is only available for the ","type":"text"},{"text":"ActiveZone","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"MinVolume","type":"text","marks":[{"type":"code"}]},{"text":": the minimum volume for the ","type":"text"},{"text":"ActiveZone","type":"text","marks":[{"type":"code"}]},{"text":". This event is only available for the ","type":"text"},{"text":"ActiveZone","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Mute","type":"text","marks":[{"type":"code"}]},{"text":": ","type":"text"},{"text":"True","type":"text","marks":[{"type":"code"}]},{"text":" if the zone indicated by the event is muted, ","type":"text"},{"text":"False","type":"text","marks":[{"type":"code"}]},{"text":" otherwise.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"PowerOn","type":"text","marks":[{"type":"code"}]},{"text":": ","type":"text"},{"text":"True","type":"text","marks":[{"type":"code"}]},{"text":" if the zone indicated by the event is powered on, ","type":"text"},{"text":"False","type":"text","marks":[{"type":"code"}]},{"text":" otherwise.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"SourceId","type":"text","marks":[{"type":"code"}]},{"text":": an integer value indicating which source is selected by ","type":"text"},{"text":"ActiveZone","type":"text","marks":[{"type":"code"}]},{"text":". This event is only available for the ","type":"text"},{"text":"ActiveZone","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Volume","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"ZoneGroupId","type":"text","marks":[{"type":"code"}]},{"text":": the guid of the ZoneGroup that contains ","type":"text"},{"text":"ActiveZone","type":"text","marks":[{"type":"code"}]},{"text":". This event is only available for the ","type":"text"},{"text":"ActiveZone","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"ZoneGuid","type":"text","marks":[{"type":"code"}]},{"text":": the guid of ","type":"text"},{"text":"ActiveZone","type":"text","marks":[{"type":"code"}]},{"text":" itself. This event is only available for the ","type":"text"},{"text":"ActiveZone","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"ZoneId","type":"text","marks":[{"type":"code"}]},{"text":": the integer id of ","type":"text"},{"text":"ActiveZone","type":"text","marks":[{"type":"code"}]},{"text":" itself. This corresponds to the numbered output on the physical amplifier. This event is only available for the ","type":"text"},{"text":"ActiveZone","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"ZoneName","type":"text","marks":[{"type":"code"}]},{"text":": the string name of ","type":"text"},{"text":"ActiveZone","type":"text","marks":[{"type":"code"}]},{"text":" itself. This corresponds to the output on the physical amplifier. This event is only available for the ","type":"text"},{"text":"ActiveZone","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]}]},{"type":"paragraph","content":[{"text":"It's important to keep track of these Source events. These events are only available for the ","type":"text"},{"text":"ActiveSource","type":"text","marks":[{"type":"code"}]},{"text":":","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"MCSControl","type":"text","marks":[{"type":"code"}]},{"text":": this event tells you the IP and port to connect to in order to control the MMS instance that corresponds to this MRAD source, if one exists. For example, ","type":"text"},{"text":"192.168.0.53:5004","type":"text","marks":[{"type":"code"}]},{"text":". Not relevant if using single socket mode.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"MCSInstance","type":"text","marks":[{"type":"code"}]},{"text":": this event tells you what to set as the MMS instance in order to control the MMS instance that corresponds to this MRAD source, if one exists.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"MCSWebPort","type":"text","marks":[{"type":"code"}]},{"text":": this events tells what IP and port to use as the host for any HTTP requests to MMS.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"NuVoSmartSource","type":"text","marks":[{"type":"code"}]},{"text":": ","type":"text"},{"text":"True","type":"text","marks":[{"type":"code"}]},{"text":" if the source is an MMS instance, ","type":"text"},{"text":"False","type":"text","marks":[{"type":"code"}]},{"text":" otherwise.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"SourceGuid","type":"text","marks":[{"type":"code"}]},{"text":": the guid of the Source itself.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"SourceId","type":"text","marks":[{"type":"code"}]},{"text":": the integer id of ","type":"text"},{"text":"ActiveSource","type":"text","marks":[{"type":"code"}]},{"text":" itself. On ","type":"text"},{"text":"A","type":"text","marks":[{"type":"code"}]},{"text":" series servers, this corresponds to the physical input on the amp that is selected. On ","type":"text"},{"text":"e","type":"text","marks":[{"type":"code"}]},{"text":" series servers, this value has a more complex meaning. If the MMS instance is wired physically to an input on the Mirage Amplifier, this event's value has the same meaning as on ","type":"text"},{"text":"A","type":"text","marks":[{"type":"code"}]},{"text":" series servers. Otherwise, the source ID indicates both which source on the amplifier and which eSeries device, ordinally positioned in the System, the source resides on.","type":"text"}]}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Browsing Zones, Sources, and Zone Groups","type":"text"}]},{"type":"paragraph","content":[{"text":"MRAD browse commands function similarly to MMS browse commands. ","type":"text"},{"text":"BrowseZones","type":"text","marks":[{"type":"code"}]},{"text":", ","type":"text"},{"text":"BrowseSources","type":"text","marks":[{"type":"code"}]},{"text":", and ","type":"text"},{"text":"BrowseZoneGroups","type":"text","marks":[{"type":"code"}]},{"text":" all take either 0 or 2 arguments. However, given the relatively low number of items in any one response, it's safe to request all items by making an argument-less request. Always use ","type":"text"},{"text":"SetXmlMode Lists","type":"text","marks":[{"type":"code"}]},{"text":" if your environment supports XML processing as the responses will carry far more information. As with MMS browse commands, limit the response to a subset of items by specifying ","type":"text"},{"text":"start","type":"text","marks":[{"type":"code"}]},{"text":" and ","type":"text"},{"text":"count","type":"text","marks":[{"type":"code"}]},{"text":". For example, ","type":"text"},{"text":"BrowseZones 1 2","type":"text","marks":[{"type":"code"}]},{"text":". All XML responses are sent as one single line of data. We've formatted them here for readability.","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Zones","type":"text"}]},{"type":"paragraph","content":[{"text":"BrowseZones","type":"text","marks":[{"type":"code"}]},{"text":" returns the list of zones available to the MMS. If all zones have the default names, all zones will be listed. If any zone has a non-default name, then zones with non-default names will be listed. On ","type":"text"},{"text":"e","type":"text","marks":[{"type":"code"}]},{"text":" series, there is an additional command to see all zones regardless of name: ","type":"text"},{"text":"BrowseAllZones","type":"text","marks":[{"type":"code"}]},{"text":". It functions identically to ","type":"text"},{"text":"BrowseZones","type":"text","marks":[{"type":"code"}]},{"text":" except that it always returns all zones.","type":"text"}]},{"type":"codeBlock","content":[{"text":"--> BrowseZones\n<-- \n \n \n \n \n","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Sources","type":"text"}]},{"type":"paragraph","content":[{"text":"BrowseSources","type":"text","marks":[{"type":"code"}]},{"text":" returns the list of sources available to the currently selected zone. If all sources have the default names, all sources will be listed. If any source has a non-default name, then sources with non-default names will be listed. On ","type":"text"},{"text":"e","type":"text","marks":[{"type":"code"}]},{"text":" series, there is an additional command to see all sources regardless of name: ","type":"text"},{"text":"BrowseAllSources","type":"text","marks":[{"type":"code"}]},{"text":". It functions identically to ","type":"text"},{"text":"BrowseSources","type":"text","marks":[{"type":"code"}]},{"text":" except that it always returns all sources.","type":"text"}]},{"type":"codeBlock","content":[{"text":"--> BrowseSources\n<-- \n \n \n \n \n \n \n \n \n","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Zone Groups","type":"text"}]},{"type":"paragraph","content":[{"text":"BrowseZonesGroups","type":"text","marks":[{"type":"code"}]},{"text":" returns the list of zone groups (adhering to the definition above) on the MMS. Once browsed once an active connection, it is not necessary to ask again. Any changes to this list will be pushed to you as they occur. If the connection closes for any reason, re-requesting this list once will reinitiate that process. You'll notice that this response has a few extra attributes in the root node.","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"srceAvail","type":"text","marks":[{"type":"code"}]},{"text":": ","type":"text"},{"text":"0","type":"text","marks":[{"type":"code"}]},{"text":" if no unused MMS source is available, ","type":"text"},{"text":"1","type":"text","marks":[{"type":"code"}]},{"text":" if an unused MMS source is available","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"srceId","type":"text","marks":[{"type":"code"}]},{"text":": the guid of the available MMS source, if available.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"srceMmsAddr","type":"text","marks":[{"type":"code"}]},{"text":": the IP and port of the MMS the source resides.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"srceMmsInst","type":"text","marks":[{"type":"code"}]},{"text":": a unique name for the MMS instance that the source represents.","type":"text"}]}]}]},{"type":"codeBlock","content":[{"text":"--> BrowseZoneGroups\n<-- \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Setting Current Zone and Source","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Setting Current Zone","type":"text"}]},{"type":"paragraph","content":[{"text":"To set your connection's current zone, use the ","type":"text"},{"text":"SetZone","type":"text","marks":[{"type":"code"}]},{"text":" command. This command takes a single argument. This argument can be the ","type":"text"},{"text":"Id","type":"text","marks":[{"type":"code"}]},{"text":" or ","type":"text"},{"text":"Guid","type":"text","marks":[{"type":"code"}]},{"text":" or ","type":"text"},{"text":"Name","type":"text","marks":[{"type":"code"}]},{"text":" of the target zone. After setting your zone, it's recommended that you do a ","type":"text"},{"text":"GetStatus","type":"text","marks":[{"type":"code"}]},{"text":" to ensure you have the latest information regarding that zone.","type":"text"}]},{"type":"paragraph","content":[{"text":"For example:","type":"text"}]},{"type":"codeBlock","content":[{"text":"--> SetZone 3\n--> GetStatus","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Setting Current Source","type":"text"}]},{"type":"paragraph","content":[{"text":"To set your current zone's source, use the ","type":"text"},{"text":"SetSource","type":"text","marks":[{"type":"code"}]},{"text":" command. This command takes a single argument but the valid options for that argument are different on ","type":"text"},{"text":"A","type":"text","marks":[{"type":"code"}]},{"text":" series and ","type":"text"},{"text":"e","type":"text","marks":[{"type":"code"}]},{"text":" series. On ","type":"text"},{"text":"A","type":"text","marks":[{"type":"code"}]},{"text":" series, this command takes the ","type":"text"},{"text":"Id","type":"text","marks":[{"type":"code"}]},{"text":" or ","type":"text"},{"text":"Guid","type":"text","marks":[{"type":"code"}]},{"text":" or ","type":"text"},{"text":"Name","type":"text","marks":[{"type":"code"}]},{"text":" of a source. On ","type":"text"},{"text":"e","type":"text","marks":[{"type":"code"}]},{"text":" series, this command takes the ","type":"text"},{"text":"Guid","type":"text","marks":[{"type":"code"}]},{"text":" of a source only. After setting your source, it's recommended that you do a ","type":"text"},{"text":"GetStatus","type":"text","marks":[{"type":"code"}]},{"text":" to ensure you have the latest information regarding that source.","type":"text"}]},{"type":"paragraph","content":[{"text":"For example:","type":"text"}]},{"type":"codeBlock","content":[{"text":"--> SetSource 00000007-a259-4cda-a715-94915436337e\n--> GetStatus","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Setting Zone Volume and Mute","type":"text"}]},{"type":"paragraph","content":[{"text":"To set the volume of your currently selected zone, send ","type":"text"},{"text":"Volume ","type":"text","marks":[{"type":"code"}]},{"text":" where ","type":"text"},{"text":"","type":"text","marks":[{"type":"code"}]},{"text":" is an integer between ","type":"text"},{"text":"MinVolume","type":"text","marks":[{"type":"code"}]},{"text":" and ","type":"text"},{"text":"MaxVolume","type":"text","marks":[{"type":"code"}]},{"text":". To set the volume of another zone, use the same command, appending the target zone's ","type":"text"},{"text":"Id","type":"text","marks":[{"type":"code"}]},{"text":", ","type":"text"},{"text":"Guid","type":"text","marks":[{"type":"code"}]},{"text":", or ","type":"text"},{"text":"Name","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]},{"type":"paragraph","content":[{"text":"For example:","type":"text"}]},{"type":"codeBlock","content":[{"text":"--> Volume 24","type":"text"}]},{"type":"paragraph","content":[{"text":"OR","type":"text"}]},{"type":"codeBlock","content":[{"text":"--> Volume 24 00030000-a259-4cda-a715-94915436337e","type":"text"}]},{"type":"paragraph","content":[{"text":"To do a volume up on your currently selected zone, send ","type":"text"},{"text":"VolumeUp","type":"text","marks":[{"type":"code"}]},{"text":". To do a volume up on another zone, use the same command, appending the target zone's ","type":"text"},{"text":"Id","type":"text","marks":[{"type":"code"}]},{"text":", ","type":"text"},{"text":"Guid","type":"text","marks":[{"type":"code"}]},{"text":", or ","type":"text"},{"text":"Name","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]},{"type":"paragraph","content":[{"text":"For example:","type":"text"}]},{"type":"codeBlock","content":[{"text":"--> VolumeUp","type":"text"}]},{"type":"paragraph","content":[{"text":"OR","type":"text"}]},{"type":"codeBlock","content":[{"text":"--> VolumeUp 00030000-a259-4cda-a715-94915436337e","type":"text"}]},{"type":"paragraph","content":[{"text":"To do a volume down on your currently selected zone, send ","type":"text"},{"text":"VolumeDown","type":"text","marks":[{"type":"code"}]},{"text":". To do a volume down on another zone, use the same command, appending the target zone's ","type":"text"},{"text":"Id","type":"text","marks":[{"type":"code"}]},{"text":", ","type":"text"},{"text":"Guid","type":"text","marks":[{"type":"code"}]},{"text":", or ","type":"text"},{"text":"Name","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]},{"type":"paragraph","content":[{"text":"For example:","type":"text"}]},{"type":"codeBlock","content":[{"text":"--> VolumeDown","type":"text"}]},{"type":"paragraph","content":[{"text":"OR","type":"text"}]},{"type":"codeBlock","content":[{"text":"--> VolumeDown 00030000-a259-4cda-a715-94915436337e","type":"text"}]},{"type":"paragraph","content":[{"text":"To set the mute state on your currently selected zone, send ","type":"text"},{"text":"Mute ","type":"text","marks":[{"type":"code"}]},{"text":" where ","type":"text"},{"text":"","type":"text","marks":[{"type":"code"}]},{"text":" is ","type":"text"},{"text":"true","type":"text","marks":[{"type":"code"}]},{"text":", or ","type":"text"},{"text":"false","type":"text","marks":[{"type":"code"}]},{"text":", or ","type":"text"},{"text":"toggle","type":"text","marks":[{"type":"code"}]},{"text":". To set the mute state of another zone, use the same command, appending the target zone's ","type":"text"},{"text":"Id","type":"text","marks":[{"type":"code"}]},{"text":", ","type":"text"},{"text":"Guid","type":"text","marks":[{"type":"code"}]},{"text":", or ","type":"text"},{"text":"Name","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]},{"type":"paragraph","content":[{"text":"For example:","type":"text"}]},{"type":"codeBlock","content":[{"text":"--> Mute Toggle","type":"text"}]},{"type":"paragraph","content":[{"text":"OR","type":"text"}]},{"type":"codeBlock","content":[{"text":"--> Mute Toggle 00030000-a259-4cda-a715-94915436337e","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Working with Zone Groups","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Building or modifying Zone Groups","type":"text"}]},{"type":"paragraph","content":[{"text":"As described above, a Zone Group is a set of zones that have the same Source selected. There are several ways to configure a zone group. The simplest way to to simply set more than one zone to the same source. However, there is a ","type":"text"},{"text":"SetZoneGroup","type":"text","marks":[{"type":"code"}]},{"text":" command that takes a comma delimited list of zones, among other things. This command has a few different formats for arguments, taking either 2 or 3 arguments.","type":"text"}]},{"type":"paragraph","content":[{"text":"If constructing a new zone group, you'll need to specify a source by GUID. In this case, the command will take three arguments: ","type":"text"},{"text":"SetZoneGroup guidOfFirstZoneInGroup memberZone1,memberZone2,memberZoneN sourceGuid","type":"text","marks":[{"type":"code"}]},{"text":". The source guid is the ","type":"text"},{"text":"srceId","type":"text","marks":[{"type":"code"}]},{"text":" value from the root node of the ","type":"text"},{"text":"BrowseZoneGroups","type":"text","marks":[{"type":"code"}]},{"text":" response or push.","type":"text"}]},{"type":"paragraph","content":[{"text":"For example:","type":"text"}]},{"type":"codeBlock","content":[{"text":"--> SetZoneGroup 00020000-a259-4cda-a715-94915436337e 00020000-a259-4cda-a715-94915436337e,00030000-a259-4cda-a715-94915436337e 00000007-a259-4cda-a715-94915436337e","type":"text"}]},{"type":"paragraph","content":[{"text":"If modifying an existing zone group, use 2 arguments instead, where the first argument is the guid of the zone group itself and the second argument is the new list of zones it should contain.","type":"text"}]},{"type":"paragraph","content":[{"text":"For example:","type":"text"}]},{"type":"codeBlock","content":[{"text":"--> SetZoneGroup 00000000-0007-0000-0000-000000000000 00010000-a259-4cda-a715-94915436337e,00020000-a259-4cda-a715-94915436337e","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Setting Zone Group Volume and Mute","type":"text"}]},{"type":"paragraph","content":[{"text":"Setting zone group volume and mute state functions identically to doing so for an individual zone except that the zone group's ","type":"text"},{"text":"Guid","type":"text","marks":[{"type":"code"}]},{"text":" is substituted for the second argument in the command.","type":"text"}]},{"type":"paragraph","content":[{"text":"For example:","type":"text"}]},{"type":"codeBlock","content":[{"text":"--> VolumeUp 00000000-0007-0000-0000-000000000000","type":"text"}]}],"version":1}