Programmatically using Presets

Updated: 12/1/2014
Category: Mirage Media Server -> Control Protocol
Products: Mirage Media Servers MMS-2, MMS-2A, MMS-5, MMS-5A 

As of the 5.1.x.x firmware release, the MMS product line supports Presets. This capability allows the current state of an output on the server to be stored and then recalled to any output at any time. A Preset stores the current queue and the current playing item (a track from the queue, a Pandora station, etc). Presets can be browsed, stored, and recalled programmatically.

To store a Preset, use the StorePreset 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).

Examples:

• StorePreset

  • This will be responded to with an InputBox from the server.

• StorePreset "Party Time"

  • This will save a Preset called Party Time

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).

Examples:

• RecallPreset "Party Time"

  • This recalls the Preset by name

• RecallPreset 9f9c8919-f939-d67a-dce2-cb049a4ead99

  • This recalls the Preset by unique ID

To browse available Presets, use the BrowseFavorites command. This command can be send without arguments or with <start> and <count> arguments. If <start> is send, <count> must be sent as well. <start> indicates the position in the list of Presets to start listing. <count> indicates how many to return. If sent without arguments, the MMS will return the entire list. As with all protocol commands, each command should be terminated with a carriage return and a line feed (\r\n).

Examples:

• BrowseFavorites

  • This will return the entire list of Presets

• BrowseFavorites 1 10

  • This will return 10 Presets starting at the first Preset

• BrowseFavorites 11 10

  • This will return 10 Presets starting at the 11th Preset

This feature was once called Snapshot.