MLSuite16 Plugin

From Cinemar Wiki
Jump to: navigation, search

About

The MLSuite16 plugin works with the ADA Suite 16 matrix switcher.


System Requirements

Software Requirements

MLServer 3

MainLobby 3

ADA Suite16 Controller Driver

Supported Hardware

ADA Suite16


ADA Suite16 Keypad Integration

This document describes how to setup your MLSuite16 plugin and your ADA Suite16 system to allow MLServeCmd's to be sent when a Keypad button is pressed.

It is not possible within the ADA Suite16 system to determine exactly which keypad a button press as taken place on, so we have decided to allow users to send MLServeCmds based on what button was pressed and what source the keypad is currently controlling. That is to say that when a keypad button is pressed, the command that that keypad sends out is captured by the Suite16 plugin, and an MLServeCmd can be sent based on what button is pressed and what source that command is controlling. If multiple keypads are set to control the same source the same MLServeCmd will be sent regaurdless of exatcly whick keypad the button was pressed on.


Definitions

A "Unit" refers to a collection of sources. In most cases this is the WH2000 wireharness.

A "Unit Source" refers to any controllable device that can attach to the unit. "Unit Address" refers to the address assigned to unit sources. All devices with address 1 are said to be on unit 1 even if this does not match the actual harware configuration. It is generally a good practice though to assign the same address to all devices attached to the same WH2000 wireharness.

Example:

You have two IRL5000 units, one of them will have address 1 the other have address 2. Regaurdless of how many WH2000 wireharnesses are used the 1st IRL device is said to be on unit 1 and the 2nd on unit 2 so you would need to add two units in the MLSuite16 plugin.

Installation

Download the most recent version of the plugin [MLSuite16]

Hardware Setup

In order to be able to read commands sent to the ADA Suite16 system from the keypads it is necessary to install a secondary ISOCATII unit. The settings for the secondary ISOCATII unit is as follows:

Primary Iso-cat II - ADA Communication

Button 1-Down Button 2-Down Button 3 Down Button 4-Up


Secondary Iso-cat II - KP Feedback and Sending Song Text

Button 1-Up Button 2-Down Button 3-Down Button 4-Up


Software Setup

Select the port of the secondary ISOCATII unit in the MLSuite16 plugin and click connect. If you would like this connection to be made on MLServer start up check the "On Start?" box.

Adding A Unit

1. Open the MLSuite16 plugin.

2. Click the "MLServeCmd" item in the top menu bar. A new window will now appear.

3. Click the "Add" button in the Units frame. A new window will now appear.

4. Select the Address of the new unit from the list.

5. Ener the alias of the new unit in the text field.

6. Click the "Ok" button.


Adding A Unit Source

1. Open the MLSuite16 plugin.

2. Click the "MLServeCmd" item in the to menu bar. A new window will now appear.

3. Select the unit the sources are attached to in the "Units" frame.

4. Click the "Add" button in the "Unit Sources" frame. A new window will now appear.

5. Select the number of the unit source from the list.

6. Enter the alias of the unit source in the text field. (This is defaulted to Unit_xxx_Source_xxx)

7. Select the type of source from the list. (This is defaulted to ADA Tuner)

8. Select the unit the source is attached to. (This is defaulted to the seleced unit when the adding process was started)

9. Click the "Ok" button.


Assigning an MLServeCmd to a Keypad Button Press

1. Open the MLSuite16 pluing.

2. Click the "MLServeCmd" item in the to menu bar. A new window will now appear.

3. Select the unit the unit source is on from the "Units" frame. (This will populate the unit sources frame with the sources you have added to that unit)

4. Select the unit source from the "Unit Sources" frame. (This will display another frame on the right that shows all button presses available for this particular kepad button)

5. If assigning an MLServeCmd to an "ADA Tuner" select the module of the tuner from the drop down list.

If assigning an MLServeCmd to an "IRL500" select the port the source is on from the drop down list.

6. Select the button press you wish to assign the MLServeCmd to from the buttons list.

7. Enter the MLSerrveCmd in the "MLServeCmd" text field.

It is generally a good idea to test the assigned command at this point. To do this, simply go to a keypad that can control the desired source. Select the source and press the button the MLServeCmd was assigned to. You should then see the command being sent in the MLServer log.

MLServer Commands

MLServeCmd

Global Commands


SetPartyInput

{MLServeCmd}Script Usage

MLServeCmd.MLSuite16|Global~SetPartyInput~<<Party#>>~<<Input#>>

(Literal)

MLServeCmd.MLSuite16|Global~SetPartyInput~1~3

MLServeCmd.MLSuite16|Global~SetPartyInput~2~16

Parameters

Party# = The party to have the input assigned.

Values: 1-4

Input# = The input to assign.

Values: 1-16

Returns

Nothing.

Description:

This command sets the specified party to use the specified input.

Notes:


FactoryDefault

{MLServeCmd}Script Usage

MLServeCmd.MLSuite16|Global~FactoryDefault

(Literal)

MLServeCmd.MLSuite16|Global~FactoryDefault

MLServeCmd.MLSuite16|Global~FactoryDefault

Parameters

None

Returns

Nothing.

Description:

This command restores the unit to the factory default settings.

Notes:


SetInputTrim

{MLServeCmd}Script Usage

MLServeCmd.MLSuite16|Global~SetInputTrim~<<Input#>>~<<Trim Val>>

(Literal)

MLServeCmd.MLSuite16|Global~SetInputTrim~3~40

MLServeCmd.MLSuite16|Global~SetInputTrim~1~10

Parameters

Input# = The input to set the volume trim value.

Values: 1-16

Trim Val. = The trim value to assign.

Values: 0-80

Returns

Nothing.

Description:

This command sets the input volume trim level on the specified input.

Notes:


PageGroup

{MLServeCmd}Script Usage

MLServeCmd.MLSuite16|Global~PageGroup~<<Group#>>~<Exclusion*>>

(Literal)

MLServeCmd.MLSuite16|Global~PageGroup~2

MLServeCmd.MLSuite16|Global~PageGroup~3~1

Parameters

Group# = The group to page.

Values: 1-6

Exclusion = The room # to exclude from the paging.

Optional Values: 1-99

Returns

Nothing.

Description:

This command pages the specified group excluding the specified room.

Notes:


PageRoom

{MLServeCmd}Script Usage

MLServeCmd.MLSuite16|Global~PageRoom~<<Room#>>

(Literal)

MLServeCmd.MLSuite16|Global~PageRoom~3

MLServeCmd.MLSuite16|Global~PageRoom~5

Parameters

Room# = The room to page.

Values: 1-99

Returns

Nothing.

Description:

This command pages the specified room.

Notes:


AutoPagingOn

{MLServeCmd}Script Usage

MLServeCmd.MLSuite16|Global~AutoPagingOn~<<Room#>>

(Literal)

MLServeCmd.MLSuite16|Global~AutoPagingOn~3

MLServeCmd.MLSuite16|Global~AutoPagingOn~5

Parameters

Room# = The room to page.

Values: 1-99

Returns

Nothing.

Description:

This command enables auto paging in the specified room.

Notes:


AutoPagingOff

{MLServeCmd}Script Usage

MLServeCmd.MLSuite16|Global~AutoPagingOff~<<Room#>>

(Literal)

MLServeCmd.MLSuite16|Global~AutoPagingOff~3

MLServeCmd.MLSuite16|Global~AutoPagingOff~5

Parameters

Room# = The room to page.

Values: 1-99

Returns

Nothing.

Description:

This command disables auto paging in the specified room.

Notes:


AllPagingOff

{MLServeCmd}Script Usage

MLServeCmd.MLSuite16|Global~AllPaginOff

(Literal)

MLServeCmd.MLSuite16|Global~AllPagingOff

MLServeCmd.MLSuite16|Global~AllPagingOff

Parameters

None

Returns

Nothing.

Description:

This command stops all paging.

Notes:


Video Commands


SetRoomInput

{MLServeCmd}Script Usage

MLServeCmd.MLSuite16|Video~SetRoomInput~<<Room#>>~<<Input#>>

(Literal)

MLServeCmd.MLSuite16|Video~SetRoomInput~1~4

MLServeCmd.MLSuite16|Video~SetRoomInput~3~2

Parameters

Room# = The room to set the input.

Values: 1-96

Input# = The input to be assigned to the room.

Values: 0-16

Returns

Nothing.

Description:

This command sets the specified rooms input source.

Notes:

When the input# is 0 the room video input is set to off.


ActivateTrigger

{MLServeCmd}Script Usage

MLServeCmd.MLSuite16|Video~ActivateTrigger~<<Trigger#>>

(Literal)

MLServeCmd.MLSuite16|Video~ActivateTrigger~2

MLServeCmd.MLSuite16|Video~ActivateTrigger~4

Parameters

Trigger# = The trigger to activate

Values: 1-4

Returns

Nothing.

Description:

This command activates the specified video trigger.

Notes:


EnableTrigger

{MLServeCmd}Script Usage

MLServeCmd.MLSuite16|Video~EnableTrigger~<<Trigger#>>

(Literal)

MLServeCmd.MLSuite16|Video~EnableTrigger~2

MLServeCmd.MLSuite16|Video~EnableTrigger~4

Parameters

Trigger# = The trigger to enable.

Values: 1-4

Returns

Nothing.

Description:

This command enables the specified video trigger.

Notes:


DisableTrigger

{MLServeCmd}Script Usage

MLServeCmd.MLSuite16|Video~DisableTrigger~<<Trigger#>>

(Literal)

MLServeCmd.MLSuite16|Video~DisableTrigger~2

MLServeCmd.MLSuite16|Video~DisableTrigger~4

Parameters

Trigger# = The trigger to disable.

Values: 1-4

Returns

Nothing.

Description:

This command disables the specified video trigger.

Notes:


SetTriggerInput

{MLServeCmd}Script Usage

MLServeCmd.MLSuite16|Video~SetTriggerInput~<<Trigger#>>~<<Input#>>~<<State>>

(Literal)

MLServeCmd.MLSuite16|Video~SetTriggerInput~1~5

MLServeCmd.MLSuite16|Video~SetTriggerInput~3~1

Parameters

Trigger# = The trigger to set the input on.

Values: 1-4

Input# = The input to be assigned to the trigger.

Values: 1-16

State = The new state of the input trigger.

Values: On, Off

Returns

Nothing.

Description:

This command sets the specified triggers specified input to the specified state.

Notes:


SetRoomTrigger

{MLServeCmd}Script Usage

MLServeCmd.MLSuite16|Video~SetRoomTrigger~<<Room#>><<Trigger#>>~<<State>>

(Literal)

MLServeCmd.MLSuite16|Video~SetRoomTrigger~1~4

MLServeCmd.MLSuite16|Video~SetRoomTrigger~3~1

Parameters

Room# = The room to assign the trigger to.

Values: 1-96

Trigger# = The trigger to assign to the room.

Values: 1-4

State = The new state of the room trigger.

Values: On, Off

Returns

Nothing.

Description:

This command sets the specified rooms specified trigger to the specified state.

Notes:


SetRoomVideoFollow

{MLServeCmd}Script Usage

MLServeCmd.MLSuite16|Video~SetRoomVideoFollow~<<Room#>>~<<Input#>>~<<State>>

(Literal)

MLServeCmd.MLSuite16|Video~SetRoomVideoFollow~1~5

MLServeCmd.MLSuite16|Video~SetRoomVideoFollow~3~1

Parameters

Room# = The room to set the video follow.

Values: 1-96

Input# = The video input to follow.

Values: 1-16

State = The new state of the room trigger.

Values: On, Off

Returns

Nothing.

Description:

This command sets the specified video input to follow the audio input in the specified room to the

specified state.

Notes:


Room Commands


VolumeUp

{MLServeCmd}Script Usage

MLServeCmd.MLSuite16|Room~VolumeUp~<<Room#>>

(Literal)

MLServeCmd.MLSuite16|Room~VolumeUp~3

MLServeCmd.MLSuite16|Room~VolumeUp~20

Parameters

Room# = The room to increase the volume in.

Values: 1-99

Returns

Nothing.

Description:

This command increments the volume in the specified room by 1.

Notes:


VolumeDown

{MLServeCmd}Script Usage

MLServeCmd.MLSuite16|Room~VolumeDown~<<Room#>>

(Literal)

MLServeCmd.MLSuite16|Room~VolumeDown~3

MLServeCmd.MLSuite16|Room~VolumeDown~20

Parameters

Room# = The room to decrease the volume in.

Values: 1-99

Returns

Nothing.

Description:

This command decrements the volume in the specified room by 1.

Notes:


VolumeDirect

{MLServeCmd}Script Usage

MLServeCmd.MLSuite16|Room~VolumeDirect~<<Room#>>~<<Volume>>

(Literal)

MLServeCmd.MLSuite16|Room~VolumeUp~3~50

MLServeCmd.MLSuite16|Room~VolumeUp~20~10

Parameters

Room# = The room to set the volume in.

Values: 1-99

Volume = The volume to set the room to.

Values: 0-80

Returns

Nothing.

Description:

This command sets the volume in the specified room to the specified level.

Notes:


VolumeMax

{MLServeCmd}Script Usage

MLServeCmd.MLSuite16|Room~VolumeMax~<<Room#>>~<<Volume>>

(Literal)

MLServeCmd.MLSuite16|Room~VolumeMax~3~70

MLServeCmd.MLSuite16|Room~VolumeUp~20~33

Parameters

Room# = The room to set the maximum volume in.

Values: 1-99

Volume = The maximum volume level to be set.

Values: 10-80

Returns

Nothing.

Description:

This command sets the maximum volume in the specified room to the specified level.

Notes:


Mute

{MLServeCmd}Script Usage

MLServeCmd.MLSuite16|Room~Mute~<<Room#>>

(Literal)

MLServeCmd.MLSuite16|Room~Mute~3

MLServeCmd.MLSuite16|Room~Mute~20

Parameters

Room# = The room to mute.

Values: 1-99

Returns

Nothing.

Description:

This command mutes the specified room.

Notes:


UnMute

{MLServeCmd}Script Usage

MLServeCmd.MLSuite16|Room~UnMute~<<Room#>>

(Literal)

MLServeCmd.MLSuite16|Room~UnMute~3

MLServeCmd.MLSuite16|Room~UnMute~20

Parameters

Room# = The room to unmute.

Values: 1-99

Returns

Nothing.

Description:

This command unmutes

the specified room.

Notes:


ToggleMute

{MLServeCmd}Script Usage

MLServeCmd.MLSuite16|Room~ToggleMute~<<Room#>>

(Literal)

MLServeCmd.MLSuite16|Room~ToggleMute~3

MLServeCmd.MLSuite16|Room~ToggleMute~20

Parameters

Room# = The room to toggle the mute state in.

Values: 1-99

Returns

Nothing.

Description:

This command toggles the mute state in the specified room.

Notes:


SetOnVolume

{MLServeCmd}Script Usage

MLServeCmd.MLSuite16|Room~SetOnVolume~<<Room#>>~<<Mode>>

(Literal)

MLServeCmd.MLSuite16|Room~SetOnVolume~3~Last

MLServeCmd.MLSuite16|Room~SetOnVolume~20~Recall

Parameters

Room# = The room to set the on volume in.

Values: 1-99

Mode = The volume to use when the room is turned on.

Values: Last, Recall

Returns

Nothing.

Description:

This command sets the initial volume to use when the room is turned on.

When Last is specified as the mode, the room will use the last used volume level.

When Recall is specified as the mode, the room will use Volume preset 1.

Notes:


SetInput

{MLServeCmd}Script Usage

MLServeCmd.MLSuite16|Room~SetInput~<<Room#>>~<<Input#>>

(Literal)

MLServeCmd.MLSuite16|Room~SetInput~3

MLServeCmd.MLSuite16|Room~SetInput~20

Parameters

Room# = The room to set the input in.

Values: 1-99

Input# = The input to assign to the room.

Values: 1-16

Returns

Nothing.

Description:

This command sets the specified room to the specified input.

Notes:


Off

{MLServeCmd}Script Usage

MLServeCmd.MLSuite16|Room~Off~<<Room#>>

(Literal)

MLServeCmd.MLSuite16|Room~Off~3

MLServeCmd.MLSuite16|Room~Off~20

Parameters

Room# = The room to turn off.

Values: 1-99

Returns

Nothing.

Description:

This command turns the specified room off.

Notes:


Alloff

{MLServeCmd}Script Usage

MLServeCmd.MLSuite16|Room~Alloff

(Literal)

MLServeCmd.MLSuite16|Room~Alloff

MLServeCmd.MLSuite16|Room~Alloff

Parameters

None.

Returns

Nothing.

Description:

This command turns all rooms off.

Notes:


AddPartyGroup

{MLServeCmd}Script Usage

MLServeCmd.MLSuite16|Room~AddPartyGroup~<<Room#>>~<<Party#>>

(Literal)

MLServeCmd.MLSuite16|Room~AddPartyGroup~3~2

MLServeCmd.MLSuite16|Room~AddPartyGroup~20~1

Parameters

Room# = The room to add to the party.

Values: 1-99

Party# = the party number to add the room to.

Values: 1-4

Returns

Nothing.

Description:

This command sets the specified room to be included in the specified party group.

Notes:


RemovePartyGroup

{MLServeCmd}Script Usage

MLServeCmd.MLSuite16|Room~RemoveParty~<<Room#>>~<<Party#>>

(Literal)

MLServeCmd.MLSuite16|Room~RemvoePartyGroup~3~2

MLServeCmd.MLSuite16|Room~RemovePartyGroup~20~4

Parameters

Room# = The room to remove from the party group.

Values: 1-99

Party# = The party group to remove the room from.

Values: 1-4

Returns

Nothing.

Description:

This command removes the specified room from the specified party group.

Notes:


InputUp

{MLServeCmd}Script Usage

MLServeCmd.MLSuite16|Room~InputUp~<<Room#>>

(Literal)

MLServeCmd.MLSuite16|Room~InputUp~3

MLServeCmd.MLSuite16|Room~InputUp~20

Parameters

Room# = The room to change the input in.

Values: 1-99

Returns

Nothing.

Description:

This command sets the specified room to the next input.

Notes:


InputDown

{MLServeCmd}Script Usage

MLServeCmd.MLSuite16|Room~InputDown~<<Room#>>

(Literal)

MLServeCmd.MLSuite16|Room~InputDown~3

MLServeCmd.MLSuite16|Room~InputDown~20

Parameters

Room# = The room to change the input in.

Values: 1-99

Returns

Nothing.

Description:

This command sets the specified room to the previous input.

Notes:


AddPageGroup

{MLServeCmd}Script Usage

MLServeCmd.MLSuite16|Room~AddPageGroup~<<Room#>>~<<Page#>>

(Literal)

MLServeCmd.MLSuite16|Room~AddPageGroup~3~8

MLServeCmd.MLSuite16|Room~AddPageGroup~20~2

Parameters

Room# = The room to change the input in.

Values: 1-99

Page# = The page group to add the room to.

Values: 1-8

Returns

Nothing.

Description:

This command adds the specified room to the specified page group.

Notes:


RemovePageGroup

{MLServeCmd}Script Usage

MLServeCmd.MLSuite16|Room~RemovePageGroup~<<Room#>>~<<Page#>>

(Literal)

MLServeCmd.MLSuite16|Room~RemovePageGroup~3~8

MLServeCmd.MLSuite16|Room~RemovePageGroup~20~2

Parameters

Room# = The room to change the input in.

Values: 1-99

Page# = The page group to remove the room from.

Values: 1-8

Returns

Nothing.

Description:

This command removes the specified room from the specified page group.

Notes:


PageVolume

{MLServeCmd}Script Usage

MLServeCmd.MLSuite16|Room~PageVolume~<<Room#>>~<<Volume>>

(Literal)

MLServeCmd.MLSuite16|Room~PageVolume~3~75

MLServeCmd.MLSuite16|Room~PageVolume~20~33

Parameters

Room# = The room to change the input in.

Values: 1-99

Volume = The page volume to assign to the room.

Values: 0-40

Returns

Nothing.

Description:

This command sets the paging volume to the specified level in the specified room.

Notes:


StereoMode

{MLServeCmd}Script Usage

MLServeCmd.MLSuite16|Room~StereoMode~<<Room#>>

(Literal)

MLServeCmd.MLSuite16|Room~StereoMode~3

MLServeCmd.MLSuite16|Room~StereoMode~20

Parameters

Room# = The room to change to stereo mode.

Values: 1-99

Returns

Nothing.

Description:

This command set the specified room to stereo mode.

Notes:


MonoLeftMode

{MLServeCmd}Script Usage

MLServeCmd.MLSuite16|Room~MonoLeftMode~<<Room#>>

(Literal)

MLServeCmd.MLSuite16|Room~MonoLeftMode~3

MLServeCmd.MLSuite16|Room~MonoLeftMode~20

Parameters

Room# = The room to set to mono left mode.

Values: 1-99

Returns

Nothing.

Description:

This command sets the specified room to mono left mode.

Notes:


MonoRightMode

{MLServeCmd}Script Usage

MLServeCmd.MLSuite16|Room~MonoRightMode~<<Room#>>

(Literal)

MLServeCmd.MLSuite16|Room~MonoRightMode~3

MLServeCmd.MLSuite16|Room~MonoRightMode~20

Parameters

Room# = The room to set to mono right mode.

Values: 1-99

Returns

Nothing.

Description:

This command sets the specified room to mono right mode.

Notes:


BalanceLeft

{MLServeCmd}Script Usage

MLServeCmd.MLSuite16|Room~BalanceLeft~<<Room#>>

(Literal)

MLServeCmd.MLSuite16|Room~BalanceLeft~3

MLServeCmd.MLSuite16|Room~BalanceLeft~20

Parameters

Room# = The room to set adjust the balance in.

Values: 1-99

Returns

Nothing.

Description:

This command adjusts the balance in the specified room 1 to the left.

Notes:


BalanceRight

{MLServeCmd}Script Usage

MLServeCmd.MLSuite16|Room~BalanceRight~<<Room#>>

(Literal)

MLServeCmd.MLSuite16|Room~BalanceRight~3

MLServeCmd.MLSuite16|Room~BalanceRight~20

Parameters

Room# = The room to set adjust the balance in.

Values: 1-99

Returns

Nothing.

Description:

This command adjusts the balance in the specified room 1 to the right.

Notes:


BalanceEqual

{MLServeCmd}Script Usage

MLServeCmd.MLSuite16|Room~BalanceEqual~<<Room#>>

(Literal)

MLServeCmd.MLSuite16|Room~BalanceEqual~3

MLServeCmd.MLSuite16|Room~BalanceEqual~20

Parameters

Room# = The room to set adjust the balance in.

Values: 1-99

Returns

Nothing.

Description:

This command adjusts the balance in the specified room to be equal.

Notes:


TrebleUp

{MLServeCmd}Script Usage

MLServeCmd.MLSuite16|Room~TrebleUp~<<Room#>>

(Literal)

MLServeCmd.MLSuite16|Room~TrebleUp~3

MLServeCmd.MLMatrixSwitcher001~Room~TrebleUp~20

Parameters

Room# = The room to increment the treble in.

Values: 1-99

Returns

Nothing.

Description:

This command increments the treble in the specified room by 1.

Notes:


TrebleDown

{MLServeCmd}Script Usage

MLServeCmd.MLSuite16|Room~TrebleDown~<<Room#>>

(Literal)

MLServeCmd.MLSuite16|Room~TrebleDown~3

MLServeCmd.MLSuite16|Room~TrebleDown~20

Parameters

Room# = The room to decrement the treble in.

Values: 1-99

Returns

Nothing.

Description:

This command decrements the treble in the specified room by 1.

Notes:


TrebleDirect

{MLServeCmd}Script Usage

MLServeCmd.MLSuite16|Room~TrebleDown~<<Room#>>~<<Treble>>

(Literal)

MLServeCmd.MLSuite16|Room~TrebleDown~3~12

MLServeCmd.MLSuite16|Room~TrebleDown~20~12

Parameters

Room# = The room to decrement the treble in.

Values: 1-99

Treble = The new treble level.

Values: 12

12

Returns

Nothing.

Description:

This command sets the treble in the specified room to the specified level.

Notes:


BassUp

{MLServeCmd}Script Usage

MLServeCmd.MLSuite16|Room~BassUp~<<Room#>>

(Literal)

MLServeCmd.MLSuite16|Room~BassUp~3

MLServeCmd.MLSuite16|Room~BassUp~20

Parameters

Room# = The room to increment the bass in.

Values: 1-99

Returns

Nothing.

Description:

This command increments the bass in the specified room by 1.

Notes:


BassDown

{MLServeCmd}Script Usage

MLServeCmd.MLSuite16|Room~BassDown~<<Room#>>

(Literal)

MLServeCmd.MLSuite16|Room~BassDown~3

MLServeCmd.MLSuite16|Room~BassDown~20

Parameters

Room# = The room to decrement the bass in.

Values: 1-99

Returns

Nothing.

Description:

This command decrements the bass in the specified room by 1.

Notes:


BassDirect

{MLServeCmd}Script Usage

MLServeCmd.MLSuite16|Room~BassDirect~<<Room#>>~<<Bass>>

(Literal)

MLServeCmd.MLSuite16|Room~BassDown~3

MLServeCmd.MLSuite16|Room~BassDown~20

Parameters

Room# = The room to decrement the bass in.

Values: 1-99

Bass = The new bass level.

Values: 1-2

12

Returns

Nothing.

Description:

This command sets the bass in the specified room to the specified level.

Notes:


LoudnessOn

{MLServeCmd}Script Usage

MLServeCmd.MLSuite16|Room~LoudnessOn~<<Room#>>

(Literal)

MLServeCmd.MLSuite16|Room~LoudnessOn~3

MLServeCmd.MLSuite16|Room~LoudnessOn~20

Parameters

Room# = The room to turn the loudness on in.

Values: 1-99

Returns

Nothing.

Description:

This command turns the loudness on in the specified room.

Notes:


LoudnessOff

{MLServeCmd}Script Usage

MLServeCmd.MLSuite16|Room~LoudnessOff~<<Room#>>

(Literal)

MLServeCmd.MLSuite16|Room~LoudnessOff~3

MLServeCmd.MLSuite16|Room~LoudnessOff~20

Parameters

Room# = The room to turn the loudness off in.

Values: 1-99

Returns

Nothing.

Description:

This command turns the loudness off in the specified room.

Notes:


StereoENHOn

{MLServeCmd}Script Usage

MLServeCmd.MLSuite16|Room~StereoENHOn~<<Room#>>

(Literal)

MLServeCmd.MLSuite16|Room~StereoENHOn~3

MLServeCmd.MLSuite16|Room~StereoENHOn~20

Parameters

Room# = The room to turn the stereo ENH on in.

Values: 1-99

Returns

Nothing.

Description:

This command turns the stereo ENH on in the specified room.

Notes:


StereoENHOff

{MLServeCmd}Script Usage

MLServeCmd.MLSuite16|Room~StereoENHOff~<<Room#>>

(Literal)

MLServeCmd.MLSuite16|Room~StereoENHOff~3

MLServeCmd.MLSuite16|Room~StereoENHOff~20

Parameters

Room# = The room to turn the stereo ENH off in.

Values: 1-99

Returns

Nothing.

Description:

This command turns the stereo ENH off in the specified room.

Notes:


VolumeStore

{MLServeCmd}Script Usage

MLServeCmd.MLSuite16|Room~VolumeStore~<<Room#>>~<<Preset#>>

(Literal)

MLServeCmd.MLSuite16|Room~VolumeStore~3~1

MLServeCmd.MLSuite16|Room~VolumeStore~20~3

Parameters

Room# = The room in which to store the current volume.

Values: 1-99

Preset# = The preset to store the current volume in

Values: 1-4

Returns

Nothing.

Description:

This command stores the specified rooms current volume level in the specified preset.

Notes:


VolumeRecall

{MLServeCmd}Script Usage

MLServeCmd.MLSuite16|Room~VolumeRecall~<<Room#>>~<<Preset#>>

(Literal)

MLServeCmd.MLSuite16|Room~VolumeRecall~3~1

MLServeCmd.MLSuite16|Room~VolumeRecall~20~3

Parameters

Room# = The room in which to recall a volume level.

Values: 1-99

Preset# = The preset to recall.

Values: 1-4

Returns

Nothing.

Description:

This command sets the volume in the specified room to the level in the specified preset.

Notes:


ToneStore

{MLServeCmd}Script Usage

MLServeCmd.MLSuite16|Room~ToneStore~<<Room#>>~<<Preset#>>

(Literal)

MLServeCmd.MLSuite16|Room~ToneStore~3~1

MLServeCmd.MLSuite16|Room~ToneStore~20~3

Parameters

Room# = The room in which to store the current tone.

Values: 1-99

Preset# = The preset to store the current tone in

Values: 1Returns

Nothing.

Description:

This command stores the specified rooms current tone in the specified preset.

Notes:


ToneRecall

{MLServeCmd}Script Usage

MLServeCmd.MLSuite16|Room~ToneRecall~<<Room#>>~<<Preset#>>

(Literal)

MLServeCmd.MLSuite16|Room~ToneRecall~3~1

MLServeCmd.MLSuite16|Room~ToneRecall~20~3

Parameters

Room# = The room in which to recall a tone.

Values: 1-99

Preset# = The preset to recall.

Values: 1-4

Returns

Nothing.

Description:

This command sets the tone in the specified room to the specified preset.

Notes:


BalanceStore

{MLServeCmd}Script Usage

MLServeCmd.MLSuite16|Room~BalanceStore~<<Room#>>~<<Preset#>>

(Literal)

MLServeCmd.MLSuite16|Room~BalanceStore~3~1

MLServeCmd.MLSuite16|Room~BalanceStore~20~2

Parameters

Room# = The room in which to store the current balance.

Values: 1-99

Preset# = The preset to store the current balance in

Values: 1-2

Returns

Nothing.

Description:

This command stores the specified rooms current balance in the specified preset.

Notes:


BalanceRecall

{MLServeCmd}Script Usage

MLServeCmd.MLSuite16|Room~BalanceRecall~<<Room#>>~<<Preset#>>

(Literal)

MLServeCmd.MLSuite16|Room~BalanceRecall~3~1

MLServeCmd.MLSuite16|Room~BalanceRecall~20~2

Parameters

Room# = The room in which to recall a balance level.

Values: 1-99

Preset# = The preset to recall.

Values: 1-2

Returns

Nothing.

Description:

This command sets the balance in the specified room to the level in the specified preset.

Notes:


Tuner Commands


SetBusSwitch

{MLServeCmd}Script Usage

MLServeCmd.MLSuite16|Tuner~SetBusSwitch~<<BusSwitch>>

(Literal)

MLServeCmd.MLSuite16|Tuner~SetBusSwitch~1

MLServeCmd.MLSuite16|Tuner~SetBusSwitch~15

Parameters

BusSwitch = The new bus switch to use.

Values: 1-15

Returns

None.

Description:

This command set the bus switch to be used by the device.

Notes:


TuneUp

{MLServeCmd}Script Usage

MLServeCmd.MLSuite16|Tuner~TuneUp~<<Slot#>>

(Literal)

MLServeCmd.MLSuite16|Tuner~TuneUp~1

MLServeCmd.MLSuite16|Tuner~TuneUp~3

Parameters

Slot# = The slot number of the tuner.

Values: 1-4

Returns

The new frequency of the tuner will be returned in the tuner feedback line variables.

Description:

This command increments the frequency of the tuner in the specified slot.

Notes:

This command is only valid for AM/FM and HD tuners.


TuneDown

{MLServeCmd}Script Usage

MLServeCmd.MLSuite16|Tuner~TuneDown~<<Slot#>>

(Literal)

MLServeCmd.MLSuite16|Tuner~TuneDown~1

MLServeCmd.MLSuite16|Tuner~TuneDown~3

Parameters

Slot# = The slot number of the tuner.

Values: 1-4

Returns

The new frequency of the tuner will be returned in the tuner feedback line variables.

Description:

This command decrements the frequency of the tuner in the specified slot.

Notes:

This command is only valid for AM/FM and HD tuners.


SeekUp

{MLServeCmd}Script Usage

MLServeCmd.MLSuite16|Tuner~SeekUp~<<Slot#>>

(Literal)

MLServeCmd.MLSuite16|Tuner~SeekUp~1

MLServeCmd.MLSuite16|Tuner~SeekUp~3

Parameters

Slot# = The slot number of the tuner.

Values: 1-4

Returns

The new frequency of the tuner will be returned in the tuner feedback line variables.

Description:

This command increments the frequency of the tuner in the specified slot.

Notes:

This command is only valid for AM/FM and HD tuners.


SeekDown

{MLServeCmd}Script Usage

MLServeCmd.MLSuite16|Tuner~SeekDown~<<Slot#>>

(Literal)

MLServeCmd.MLSuite16|Tuner~SeekDown~1

MLServeCmd.MLSuite16|Tuner~SeekDown~3

Parameters

Slot# = The slot number of the tuner.

Values: 1-4

Returns

The new frequency of the tuner will be returned in the tuner feedback line variables.

Description:

This command decrements the frequency of the tuner in the specified slot.

Notes:

This command is only valid for AM/FM and HD tuners.


PresetUp

{MLServeCmd}Script Usage

MLServeCmd.MLSuite16|Tuner~PresetUp~<<Slot#>>

(Literal)

MLServeCmd.MLSuite16|Tuner~PresetUp~1

MLServeCmd.MLSuite16|Tuner~PresetUp~3

Parameters

Slot# = The slot number of the tuner.

Values: 1-4

Returns

The new frequency of the tuner along with the preset label will be returned in the tuner feedback

line variables.

Description:

This command increments the preset frequency of the tuner in the specified slot.

Notes:


PresetDown

{MLServeCmd}Script Usage

MLServeCmd.MLSuite16|Tuner~PresetDown~<<Slot#>>

(Literal)

MLServeCmd.MLSuite16|Tuner~PresetDown~1

MLServeCmd.MLSuite16|Tuner~PresetDown~3

Parameters

Slot# = The slot number of the tuner.

Values: 1-4

Returns

The new frequency of the tuner along with the preset label will be returned in the tuner feedback

line variables.

Description:

This command decrements the preset frequency of the tuner in the specified slot.

Notes:


GetFilter

{MLServeCmd}Script Usage

MLServeCmd.MLSuite16|Tuner~GetFilter~<<Slot#>>

(Literal)

MLServeCmd.MLSuite16|Tuner~GetFilter~1

MLServeCmd.MLSuite16|Tuner~GetFilter~3

Parameters

Slot# = The slot number of the tuner.

Values: 1-4

Returns

The current filter with be returned in the tuner feedback line variables.

Description:

This command gets the filter of the tuner in the specified slot.

Notes:

This command is only valid for AM/FM and HD tuners.


ToggleFilter

{MLServeCmd}Script Usage

MLServeCmd.MLSuite16|Tuner~ToggleFilter~<<Slot#>>

(Literal)

MLServeCmd.MLSuite16|Tuner~TogglerFilter~1

MLServeCmd.MLSuite16|Tuner~TogglerFilter~3

Parameters

Slot# = The slot number of the tuner.

Values: 1-4

Returns

The current filter with be returned in the tuner feedback line variables.

Description:

This command toggles the filter of the tuner in the specified slot.

Notes:

This command is only valid for AM/FM and HD tuners.


GetDeemphasis

{MLServeCmd}Script Usage

MLServeCmd.MLSuite16|Tuner~GetDeemphasis~<<Slot#>>

(Literal)

MLServeCmd.MLSuite16|Tuner~GetDeemphasis~1

MLServeCmd.MLSuite16|Tuner~GetDeemphasis~3

Parameters

Slot# = The slot number of the tuner.

Values: 1-4

Returns

The deemphasis state of the tuner in the tuner feedback line variables.

Description:

This command gets the deemphasis state of the tuner in the specified slot.

Notes:

This command is only valid for AM/FM tuners.


ToggleDeemphasis

{MLServeCmd}Script Usage

MLServeCmd.MLSuite16|Tuner~ToggleDeemphasis~<<Slot#>>

(Literal)

MLServeCmd.MLSuite16|Tuner~ToggleDeemphasis~1

MLServeCmd.MLSuite16|Tuner~ToggleDeemphasis~3

Parameters

Slot# = The slot number of the tuner.

Values: 1-4

Returns

The current deemphasis with be returned in the tuner feedback line variables.

Description:

This command toggles the deemphasis of the tuner in the specified slot.

Notes:

This command is only valid for AM/FM tuners.


ToggleStereoMone

{MLServeCmd}Script Usage

MLServeCmd.MLSuite16|Tuner~ToggleStereoMono~<<Slot#>>

(Literal)

MLServeCmd.MLSuite16|Tuner~ToggleStereoMono~1

MLServeCmd.MLSuite16|Tuner~ToggleStereoMono~3

Parameters

Slot# = The slot number of the tuner.

Values: 1-4

Returns

The current stereo/mono state will be returned in the tuner feedback line variables.

Description:

This command toggles the stereo/mono state of the tuner in the specified slot.

Notes:

This command is only valid for AM/FM tuners.


ToggleBand

{MLServeCmd}Script Usage

MLServeCmd.MLSuite16|Tuner~ToggleBand~<<Slot#>>

(Literal)

MLServeCmd.MLSuite16|Tuner~ToggleBand~1

MLServeCmd.MLSuite16|Tuner~ToggleBand~3

Parameters

Slot# = The slot number of the tuner.

Values: 1-4

Returns

The current frequency and band will be returned in the tuner feedback line variables.

Description:

This command toggles the band of the tuner in the specified slot.

Notes:

This command is only valid for AM/FM and HD tuners.


GetMode

{MLServeCmd}Script Usage

MLServeCmd.MLSuite16|Tuner~GetMode~<<Slot#>>

(Literal)

MLServeCmd.MLSuite16|Tuner~GetMode~1

MLServeCmd.MLSuite16|Tuner~GetMode~3

Parameters

Slot# = The slot number of the tuner.

Values: 1-4

Returns

The mode of the tuner is returned in the tuner feedback line variables.

Description:

This command gets the current mode of the tuner in the specified slot.

Notes:

This command is only valid for HD tuners.


DigitalMode

{MLServeCmd}Script Usage

MLServeCmd.MLSuite16|Tuner~DigitalMode~<<Slot#>>

(Literal)

MLServeCmd.MLSuite16|Tuner~DigitalMode~1

MLServeCmd.MLSuite16|Tuner~DigitalMode~3

Parameters

Slot# = The slot number of the tuner.

Values: 1-4

Returns

The current mode is returned in the tuner feedback line variables.

Description:

This command sets the current mode of the tuner in the specified slot to digital.

Notes:

This command is only valid for HD tuners.


AnalogMode

{MLServeCmd}Script Usage

MLServeCmd.MLSuite16|Tuner~AnalogMode~<<Slot#>>

(Literal)

MLServeCmd.MLSuite16|Tuner~AnalogMode~1

MLServeCmd.MLSuite16|Tuner~AnalogMode~3

Parameters

Slot# = The slot number of the tuner.

Values: 1-4

Returns

The current mode is returned in the tuner feedback line variables.

Description:

This command sets the current mode of the tuner in the specified slot to analog.

Notes:

This command is only valid for HD tuners.


MonoMode

{MLServeCmd}Script Usage

MLServeCmd.MLSuite16|Tuner~MonoMode~<<Slot#>>

(Literal)

MLServeCmd.MLSuite16|Tuner~MonoMode~1

MLServeCmd.MLSuite16|Tuner~MonoMode~3

Parameters

Slot# = The slot number of the tuner.

Values: 1-4

Returns

The current mode is returned in the tuner feedback line variables.

Description:

This command sets the current mode of the tuner in the specified slot to mono.

Notes:

This command is only valid for HD tuners.


ToggleMode

{MLServeCmd}Script Usage

MLServeCmd.MLSuite16|Tuner~ToggleMode~<<Slot#>>

(Literal)

MLServeCmd.MLSuite16|Tuner~ToggleMode~1

MLServeCmd.MLSuite16|Tuner~ToggleMode~3

Parameters

Slot# = The slot number of the tuner.

Values: 1-4

Returns

Nothing.

Description:

This command toggles the current mode of the tuner in the specified slot.

Notes:

This command is only valid for HD tuners.


DirectAMBand

{MLServeCmd}Script Usage

MLServeCmd.MLSuite16|Tuner~DirectAMBand~<<Slot#>>

(Literal)

MLServeCmd.MLSuite16|Tuner~DirectAMBand~1

MLServeCmd.MLSuite16|Tuner~DirectAMBand~3

Parameters

Slot# = The slot number of the tuner.

Values: 1-4

Returns

The current frequency and band is returned in the tuner feedback line variables.

Description:

This command sets the current band of the tuner in the specified slot to AM.

Notes:

This command is only valid for HD tuners.


DirectFMBand

{MLServeCmd}Script Usage

MLServeCmd.MLSuite16|Tuner~DirectFMBand~<<Slot#>>

(Literal)

MLServeCmd.MLSuite16|Tuner~DirectFMBand~1

MLServeCmd.MLSuite16|Tuner~DirectFMBand~3

Parameters

Slot# = The slot number of the tuner.

Values: 1-4

Returns

The current frequency and band is returned in the tuner feedback line variables.

Description:

This command sets the current band of the tuner in the specified slot to FM.

Notes:

This command is only valid for HD tuners.


DirectWXBand

{MLServeCmd}Script Usage

MLServeCmd.MLSuite16|Tuner~DirectWXBand~<<Slot#>>

(Literal)

MLServeCmd.MLSuite16|Tuner~DirectWXBand~1

MLServeCmd.MLSuite16|Tuner~DirectWXBand~3

Parameters

Slot# = The slot number of the tuner.

Values: 1-4

Returns

The current frequency and band is returned in the tuner feedback line variables.

Description:

This command sets the current band of the tuner in the specified slot to WX.

Notes:

This command is only valid for HD tuners.


CategoryUp

{MLServeCmd}Script Usage

MLServeCmd.MLSuite16|Tuner~CategoryUp~<<Slot#>>

(Literal)

MLServeCmd.MLSuite16|Tuner~CategoryUp~1

MLServeCmd.MLSuite16|Tuner~CategoryUp~3

Parameters

Slot# = The slot number of the tuner.

Values: 1-4

Returns

The current category will be returned in the tuner feedback line variables.

Description:

This command increments the category of the tuner in the specified slot.

Notes:

This command is only valid for XM and Sirius tuners.


CategoryDown

{MLServeCmd}Script Usage

MLServeCmd.MLSuite16|Tuner~CategoryDown~<<Slot#>>

(Literal)

MLServeCmd.MLSuite16|Tuner~CategoryDown~1

MLServeCmd.MLSuite16|Tuner~CategoryDown~3

Parameters

Slot# = The slot number of the tuner.

Values: 1-4

Returns

The current category will be returned in the tuner feedback line variables.

Description:

This command decrements the category of the tuner in the specified slot.

Notes:

This command is only valid for XM and Sirius tuners.


StationUp

{MLServeCmd}Script Usage

MLServeCmd.MLSuite16|Tuner~StationUp~<<Slot#>>

(Literal)

MLServeCmd.MLSuite16|Tuner~StationUp~1

MLServeCmd.MLSuite16|Tuner~StationUp~3

Parameters

Slot# = The slot number of the tuner.

Values: 1-4

Returns

The current station will be returned in the tuner feedback line variables.

Description:

This command increments the station of the tuner in the specified slot.

Notes:

This command is only valid for XM and Sirius tuners.


StationDown

{MLServeCmd}Script Usage

MLServeCmd.MLSuite16|Tuner~StationDown~<<Slot#>>

(Literal)

MLServeCmd.MLSuite16|Tuner~StationDown~1

MLServeCmd.MLSuite16|Tuner~StationDown~3

Parameters

Slot# = The slot number of the tuner.

Values: 1-4

Returns

The current station will be returned in the tuner feedback line variables.

Description:

This command decrements the category of the tuner in the specified slot.

Notes:

This command is only valid for XM and Sirius tuners.


ChannelUp

{MLServeCmd}Script Usage

MLServeCmd.MLSuite16|Tuner~ChannelUp~<<Slot#>>

(Literal)

MLServeCmd.MLSuite16|Tuner~ChannelUp~1

MLServeCmd.MLSuite16|Tuner~ChannelUp~3

Parameters

Slot# = The slot number of the tuner.

Values: 1-4

Returns

The current channel will be returned in the tuner feedback line variables.

Description:

This command increments the channel of the tuner in the specified slot.

Notes:

This command is only valid for XM and Sirius tuners.


ChannelDown

{MLServeCmd}Script Usage

MLServeCmd.MLSuite16|Tuner~ChannelDown~<<Slot#>>

(Literal)

MLServeCmd.MLSuite16|Tuner~ChannelDown~1

MLServeCmd.MLSuite16|Tuner~ChannelDown~3

Parameters

Slot# = The slot number of the tuner.

Values: 1-4

Returns

The current channel will be returned in the tuner feedback line variables.


Description:

This command decrements the category of the tuner in the specified slot.

Notes:

This command is only valid for XM and Sirius tuners.

Update

{MLServeCmd}Script Usage

MLServeCmd.MLSuite16|Tuner~Update~<<Slot#>>

(Literal)

MLServeCmd.MLSuite16|Tuner~Update~1

MLServeCmd.MLSuite16|Tuner~Update~3

Parameters

Slot# = The slot number of the tuner.

Values: 1-4

Returns

The current frequency and band of the tuner with be returned in the tuner feedback line variables.

Description:

This command updates the line item variables of the tuner in the specified slot.

Notes:


Keypad

{MLServeCmd}Script Usage

MLServeCmd.MLSuite16|Tuner~Keypad~<<Slot#>>~<<key>>

(Literal)

MLServeCmd.MLSuite16|Tuner~Keypad~1~2

MLServeCmd.MLSuite16|Tuner~Keypad~3~.

MLServeCmd.MLSuite16|Tuner~Keypad~2~8

Parameters

Slot# = The slot number of the tuner.

Values: 1-4

Key = The key to press on the keypad.

Values: 09,., Ent

Returns

The specified key will be returned in the tuner feedback line variables.

Description:

This command sends the specified key press to the tuner in the specified slot.

Notes:


KeypadDirect

{MLServeCmd}Script Usage

MLServeCmd.MLSuite16|Tuner~KeypadDirect~<<Slot#>>~<<Value>>

(Literal)

MLServeCmd.MLSuite16|Tuner~KeypadDirect~1~102.1

MLServeCmd.MLSuite16|Tuner~KeypadDirect~3~95.1

MLServeCmd.MLSuite16|Tuner~KeypadDirect~2~8

Parameters

Slot# = The slot number of the tuner.

Values: 1-4

Value = The value to send.

Values: 0999

Returns

Nothing.

Description:

This command sends the specified value to the tuner in the specified slot.

Notes:

This command is only valid for XM and Sirius tuners.


SetPreset

{MLServeCmd}Script Usage

MLServeCmd.MLSuite16|Tuner~SetPreset~<<Slot#>>~<<Preset#>>

(Literal)

MLServeCmd.MLSuite16|Tuner~SetPreset~1~2

MLServeCmd.MLSuite16|Tuner~SetPreset~3~8

Parameters

Slot# = The slot number of the tuner.

Values: 1-4

Preset# = The preset to be set.

Values: 1-30

Returns

Nothing.

Description:

This command sets the specified preset of the tuner in the specified slot to the current frequency.

Notes:

This command is only valid for HD tuners.

ClearPreset

{MLServeCmd}Script Usage

MLServeCmd.MLSuite16|Tuner~ClearPreset~<<Slot#>>~<<Preset#>>

(Literal)

MLServeCmd.MLSuite16|Tuner~ClearPreset~1~2

MLServeCmd.MLSuite16|Tuner~ClearPreset~3~8

Parameters

Slot# = The slot number of the tuner.

Values: 1-4

Preset# = The preset to be cleared.

Values: 1-30

Returns

Nothing.

Description:

This command clears the specified preset of the tuner in the specified slot.

Notes:

This command is only valid for HD tuners.


RecallPreset

{MLServeCmd}Script Usage

MLServeCmd.MLSuite16|Tuner~RecallPreset~<<Slot#>>~<<Preset#>>

(Literal)

MLServeCmd.MLSuite16|Tuner~RecallPreset~1~2

MLServeCmd.MLSuite16|Tuner~RecallPreset~3~8

Parameters

Slot# = The slot number of the tuner.

Values: 14

Preset# = The preset to be recalled.

Values: 130

Returns

Nothing.

Description:

This command sets the frequency of the tuner in the specified slot to the specified preset

frequency.

Notes:

This command is only valid for HD tuners.


PresetModeOn

{MLServeCmd}Script Usage

MLServeCmd.MLSuite16|Tuner~PresetModeOn~<<Slot#>>

(Literal)

MLServeCmd.MLSuite16|Tuner~PresetModeOn~1

MLServeCmd.MLSuite16|Tuner~PresetModeOn~3

Parameters

Slot# = The slot number of the tuner.

Values: 14

Returns

Nothing.

Description:

This command sets the tuner in the specified slot to preset mode.

Notes:


PresetModeOff

{MLServeCmd}Script Usage

MLServeCmd.MLSuite16|Tuner~PresetModeOff~<<Slot#>>

(Literal)

MLServeCmd.MLSuite16|Tuner~PresetModeOff~1

MLServeCmd.MLSuite16|Tuner~PresetModeOff~3

Parameters

Slot# = The slot number of the tuner.

Values: 14

Returns

Nothing.

Description:

This command exits preset mode for the tuner in the specified slot.

Notes:

This command is only valid when in preset mode.


SelectPresetUp

{MLServeCmd}Script Usage

MLServeCmd.MLSuite16|Tuner~SelectPresetUp~<<Slot#>>

(Literal)

MLServeCmd.MLSuite16|Tuner~SelectPresetUp~1

MLServeCmd.MLSuite16|Tuner~SelectPresetUp~3

Parameters


Slot# = The slot number of the tuner.

Values: 1-4

Returns

Nothing.

Description:

This command increments the selected preset in tuner in the specified slot.

Notes:

This command is only valid when in preset mode.


SelectPresetDown

{MLServeCmd}Script Usage

MLServeCmd.MLSuite16|Tuner~SelectPresetDown~<<Slot#>>

(Literal)

MLServeCmd.MLSuite16|Tuner~SelectPresetDown~1

MLServeCmd.MLSuite16|Tuner~SelectPresetDown~3

Parameters

Slot# = The slot number of the tuner.

Values: 1-4

Returns

Nothing.

Description:

This command decrements the selected preset in tuner in the specified slot.

Notes:

This command is only valid when in preset mode.


CharacterUp

{MLServeCmd}Script Usage

MLServeCmd.MLSuite16|Tuner~CharacterUp~<<Slot#>>

(Literal)

MLServeCmd.MLSuite16|Tuner~CharacterUp~1

MLServeCmd.MLSuite16|Tuner~CharacterUp~3

Parameters

Slot# = The slot number of the tuner.

Values: 1-4

Returns

Nothing.

Description:

This command increments the selected character in tuner in the specified slot.

Notes:

This command is only valid when in preset mode.


CharacterDown

{MLServeCmd}Script Usage

MLServeCmd.MLSuite16|Tuner~CharacterDown~<<Slot#>>

(Literal)

MLServeCmd.MLSuite16|Tuner~CharacterDown~1

MLServeCmd.MLSuite16|Tuner~CharacterDown~3

Parameters

Slot# = The slot number of the tuner.

Values: 1-4

Returns

Nothing.

Description:

This command decrements the selected character in tuner in the specified slot.

Notes:

This command is only valid when in preset mode.


Test

{MLServeCmd}Script Usage

MLServeCmd.MLSuite16|Tuner~Test~<<Slot#>>~<<Test#>>

(Literal)

MLServeCmd.MLSuite16|Tuner~Test~1~9

MLServeCmd.MLSuite16|Tuner~Test~3~4

Parameters

Slot# = The slot number of the tuner.

Values: 1-4

Test# = The number of the diagnostic test to run

Values: 1-9

Returns

The test results will be returned in the tuner feedback line variables.

Description:

This command runs the specified diagnostics test on tuner in the specified slot.

Notes:

This command is only valid for XM, and Sirius tuners.


EscapeTest

{MLServeCmd}Script Usage

MLServeCmd.MLSuite16|Tuner~EscapeTest~<<Slot#>>

(Literal)

MLServeCmd.MLSuite16|Tuner~EscapeTest~1

MLServeCmd.MLSuite16|Tuner~EscapeTest~3

Parameters

Slot# = The slot number of the tuner.

Values: 1-4

Returns

Nothing.

Description:

This command escapes the currently running diagnostics test on tuner in the specified slot.

Notes:

This command is only valid for HD, XM, and Sirius tuners.


SignalMeterOn

{MLServeCmd}Script Usage

MLServeCmd.MLSuite16|Tuner~SignalMeterOn~<<Slot#>>

(Literal)

MLServeCmd.MLSuite16|Tuner~SignalMeterOn~2

MLServeCmd.MLSuite16|Tuner~SignalMeterOn~3

Parameters

Slot# = The slot number of the tuner.

Values: 1-4

Returns

The current signal levels will be returned in the turner feedback line variables.

Description:

This command turns the signal meter on in the tuner in the specified slot.

Notes:

This command is only valid for HD tuners.


SignalMeterOff

{MLServeCmd}Script Usage

MLServeCmd.MLSuite16|Tuner~SignalMeterOff~<<Slot#>>

(Literal)

MLServeCmd.MLSuite16|Tuner~SignalMeterOff~3

MLServeCmd.MLSuite16|Tuner~SignalMeterOff~3

Parameters

Slot# = The slot number of the tuner.

Values: 1-4

Returns

Nothing.

Description:

This command turns the signal meter off in the tuner in the specified slot.

Notes:

SignalTest

{MLServeCmd}Script Usage

MLServeCmd.MLSuite16|Tuner~SignalTest~<<Slot#>>

(Literal)

MLServeCmd.MLSuite16|Tuner~SignalTest~4

MLServeCmd.MLSuite16|Tuner~SignalTest~3

Parameters

Slot# = The slot number of the tuner.

Values: 1-4

Returns

The test results will be returned in the tuner feedback line variables.

Description:

This command runs a signal test on in the tuner in the specified slot.

Notes:

This command is only valid with XM and Sirius tuners.


IncludeAM

{MLServeCmd}Script Usage

MLServeCmd.MLSuite16|Tuner~IncludAM~<<Slot#>>

(Literal)

MLServeCmd.MLSuite16|Tuner~IncludeAM~1

MLServeCmd.MLSuite16|Tuner~IncludeAM~3

Parameters

Slot# = The slot number of the tuner.

Values: 1-4

Returns

Nothing.

Description:

This command will include the AM band when toggling the tuner band.

Notes:

This command is only valid with HD tuners.


ExcludeAM

{MLServeCmd}Script Usage

MLServeCmd.MLSuite16|Tuner~ExcludAM~<<Slot#>>

(Literal)

MLServeCmd.MLSuite16|Tuner~ExcludeAM~2

MLServeCmd.MLSuite16|Tuner~ExcludeAM~3

Parameters

Slot# = The slot number of the tuner.

Values: 1-4

Returns

Nothing.

Description:

This command will exclude the AM band when toggling the tuner band.

Notes:

This command is only valid with HD tuners.


IncludeFM

{MLServeCmd}Script Usage

MLServeCmd.MLSuite16|Tuner~IncludFM~<<Slot#>>

(Literal)

MLServeCmd.MLSuite16|Tuner~IncludeFM~3

MLServeCmd.MLSuite16|Tuner~IncludeFM~3

Parameters

Slot# = The slot number of the tuner.

Values: 1-4

Returns

Nothing.

Description:

This command will include the AM band when toggling the tuner band.

Notes:

This command is only valid with HD tuners.


ExcludeFM

{MLServeCmd}Script Usage

MLServeCmd.MLSuite16|Tuner~ExcludFM~<<Slot#>>

(Literal)

MLServeCmd.MLSuite16|Tuner~ExcludeFM~4

MLServeCmd.MLSuite16|Tuner~ExcludeFM~3

Parameters

Slot# = The slot number of the tuner.

Values: 1-4

Returns

Nothing.

Description:

This command will exclude the FM band when toggling the tuner band.

Notes:

This command is only valid with HD tuners.


IncludeWX

{MLServeCmd}Script Usage

MLServeCmd.MLSuite16|Tuner~IncludWX~<<Slot#>>

(Literal)

MLServeCmd.MLSuite16|Tuner~IncludeWX~2

MLServeCmd.MLSuite16|Tuner~IncludeWX~3

Parameters

Slot# = The slot number of the tuner.

Values: 1-4

Returns

Nothing.

Description:

This command will include the WX band when toggling the tuner band.

Notes:

This command is only valid with HD tuners.


ExcludeWX

{MLServeCmd}Script Usage

MLServeCmd.MLSuite16|Tuner~ExcludWX~<<Slot#>>

(Literal)

MLServeCmd.MLSuite16|Tuner~ExcludeWX~1

MLServeCmd.MLSuite16|Tuner~ExcludeWX~3

Parameters

Slot# = The slot number of the tuner.

Values: 1-4

Returns

Nothing.

Description:

This command will include the WX band when toggling the tuner band.

Notes:

This command is only valid with HD tuners.


GetAMSeekLevel

{MLServeCmd}Script Usage

MLServeCmd.MLSuite16|Tuner~GetAMSeekLevel~<<Slot#>>

(Literal)

MLServeCmd.MLSuite16|Tuner~GetAMSeekLevel~4

MLServeCmd.MLSuite16|Tuner~GetAMSeekLevel~3

Parameters

Slot# = The slot number of the tuner.

Values: 1-4

Returns

The AM seek level of the tuner in the tuner feedback line variables.

Description:

This command gets the AM seek level of the tuner in the specified slot.

Notes:

This command is only valid with AM/FM tuners.


GetFMSeekLevel

{MLServeCmd}Script Usage

MLServeCmd.MLSuite16|Tuner~GetFMSeekLevel~<<Slot#>>

(Literal)

MLServeCmd.MLSuite16|Tuner~GetFMSeekLevel~2

MLServeCmd.MLSuite16|Tuner~GetFMSeekLevel~3

Parameters

Slot# = The slot number of the tuner.

Values: 1-4

Returns

The FM seek level of the tuner in the tuner feedback line variables.

Description:

This command gets the FM seek level of the tuner in the specified slot.

Notes:

This command is only valid with AM/FM tuners.


GetWXSeekLevel

{MLServeCmd}Script Usage

MLServeCmd.MLSuite16|Tuner~GetWXSeekLevel~<<Slot#>>

(Literal)

MLServeCmd.MLSuite16|Tuner~GetWXSeekLevel~2

MLServeCmd.MLSuite16|Tuner~GetWXSeekLevel~3

Parameters

Slot# = The slot number of the tuner.

Values: 1-4

Returns

The WX seek level of the tuner in the tuner feedback line variables.

Description:

This command gets the WX seek level of the tuner in the specified slot.

Notes:

This command is only valid with AM/FM tuners.


AMSeekUp

{MLServeCmd}Script Usage

MLServeCmd.MLSuite16|Tuner~AMSeekUp~<<Slot#>>

(Literal)

MLServeCmd.MLSuite16|Tuner~AMSeekUp~2

MLServeCmd.MLSuite16|Tuner~AMSeekUp~3

Parameters

Slot# = The slot number of the tuner.

Values: 1-4

Returns

The AM seek level of the tuner in the line item variables.

Description:

This command increments the AM frequency of the tuner in the specified slot.

Notes:

This command is only valid with AM/FM tuners.


AMSeekDown

{MLServeCmd}Script Usage

MLServeCmd.MLSuite16|Tuner~AMSeekDown~<<Slot#>>

(Literal)

MLServeCmd.MLSuite16|Tuner~AMSeekDown~2

MLServeCmd.MLSuite16|Tuner~AMSeekDown~3

Parameters

Slot# = The slot number of the tuner.

Values: 1-4

Returns

The AM seek level of the tuner in the tuner feedback line variables.

Description:

This command decrements the AM frequency of the tuner in the specified slot.

Notes:

This command is only valid with AM/FM tuners.


FMSeekUp

{MLServeCmd}Script Usage

MLServeCmd.MLSuite16|Tuner~FMSeekUp~<<Slot#>>

(Literal)

MLServeCmd.MLSuite16|Tuner~FMSeekUp~2

MLServeCmd.MLSuite16|Tuner~FMSeekUp~3

Parameters

Slot# = The slot number of the tuner.

Values: 1-4

Returns

The FM seek level of the tuner in the tuner feedback line variables.

Description:

This command increments the FM frequency of the tuner in the specified slot.

Notes:

This command is only valid with AM/FM tuners.


FMSeekDown

{MLServeCmd}Script Usage

MLServeCmd.MLSuite16|Tuner~FMSeekDown~<<Slot#>>

(Literal)

MLServeCmd.MLSuite16|Tuner~FMSeekDown~2

MLServeCmd.MLSuite16|Tuner~FMSeekDown~3

Parameters

Slot# = The slot number of the tuner.

Values: 1-4

Returns

The FM seek level of the tuner in the tuner feedback line variables.

Description:

This command decrements the FM frequency of the tuner in the specified slot.


Notes:

This command is only valid with AM/FM tuners.


WXSeekUp

{MLServeCmd}Script Usage

MLServeCmd.MLSuite16|Tuner~WXSeekUp~<<Slot#>>

(Literal)

MLServeCmd.MLSuite16|Tuner~WXSeekUp~2

MLServeCmd.MLSuite16|Tuner~WXSeekUp~3

Parameters

Slot# = The slot number of the tuner.

Values: 1-4

Returns

The WX seek level of the tuner in the tuner feedback line variables.

Description:

This command increments the WX frequency of the tuner in the specified slot.

Notes:

This command is only valid with AM/FM tuners.


WXSeekDown

{MLServeCmd}Script Usage


MLServeCmd.MLSuite16|Tuner~WXSeekDown~<<Slot#>>

(Literal)

MLServeCmd.MLSuite16|Tuner~WXSeekDown~2

MLServeCmd.MLSuite16|Tuner~WXSeekDown~3

Parameters

Slot# = The slot number of the tuner.

Values: 1-4

Returns

The WX seek level of the tuner in the tuner feedback line variables.

Description:

This command decrements the WX frequency of the tuner in the specified slot.

Notes:

This command is only valid with AM/FM tuners.


EnableSplitMode

{MLServeCmd}Script Usage

MLServeCmd.MLSuite16|Tuner~EnableSplitMode~<<Slot#>>

(Literal)

MLServeCmd.MLSuite16|Tuner~EnableSplitMode~2

MLServeCmd.MLSuite16|Tuner~EnableSplitMode~3

Parameters

Slot# = The slot number of the tuner.

Values: 1-4

Returns

Nothing.

Description:

This command enables split mode of the tuner in the specified slot.

Notes:

This command is only valid with HD tuners.


DisableSplitMode

{MLServeCmd}Script Usage

MLServeCmd.MLSuite16|Tuner~DisableSplitMode~<<Slot#>>

(Literal)

MLServeCmd.MLSuite16|Tuner~DisableSplitMode~2

MLServeCmd.MLSuite16|Tuner~DisableSplitMode~3

Parameters

Slot# = The slot number of the tuner.

Values: 1-4

Returns

Nothing.

Description:

This command disables split mode of the tuner in the specified slot.

Notes:

This command is only valid with HD tuners.


ToggleRBDS

{MLServeCmd}Script Usage

MLServeCmd.MLSuite16|Tuner~ToggleRBDS~<<Slot#>>

(Literal)

MLServeCmd.MLSuite16|Tuner~ToggleRBDS~2

MLServeCmd.MLSuite16|Tuner~ToggleRBDS~3

Parameters

Slot# = The slot number of the tuner.

Values: 1-4

Returns

Nothing.

Description:

This command toggles the RBDS of the tuner in the specified slot.

Notes:

This command is only valid with HD tuners.


GetRBDS

{MLServeCmd}Script Usage

MLServeCmd.MLSuite16|Tuner~GetRBDS~<<Slot#>>

(Literal)

MLServeCmd.MLSuite16|Tuner~GetRBDS~2

MLServeCmd.MLSuite16|Tuner~GetRBDS~3

Parameters

Slot# = The slot number of the tuner.

Values: 1-4

Returns

Nothing.

Description:

This command gets the RBDS of the tuner in the specified slot.

Notes:

This command is only valid with HD tuners.


GetBandToggle

{MLServeCmd}Script Usage

MLServeCmd.MLSuite16|Tuner~GetBandToggle~<<Slot#>>

(Literal)

MLServeCmd.MLSuite16|Tuner~GetBandToggle~2

MLServeCmd.MLSuite16|Tuner~GetBandToggle~3

Parameters

Slot# = The slot number of the tuner.

Values: 1-4

Returns

Nothing.

Description:

This command.

Notes:

This command is only valid with HD tuners.


GetFIPSCode

{MLServeCmd}Script Usage

MLServeCmd.MLSuite16|Tuner~GetFIPSCode~<<Slot#>>

(Literal)

MLServeCmd.MLSuite16|Tuner~GetFIPSCode~2

MLServeCmd.MLSuite16|Tuner~GetFIPSCode~3

Parameters

Slot# = The slot number of the tuner.

Values: 1-4

Returns

Nothing.

Description:

This command gets the FIPS code of the tuner in the specified slot.

Notes:

This command is only valid with HD tuners.


FIPSUp

{MLServeCmd}Script Usage

MLServeCmd.MLSuite16|Tuner~FIPSUp~<<Slot#>>~<<FIPS#>>

(Literal)

MLServeCmd.MLSuite16|Tuner~FIPSUp~2~1

MLServeCmd.MLSuite16|Tuner~FIPSUp~3~6

Parameters

Slot# = The slot number of the tuner.

Values: 1-4

FIPS# = The FIPS number to control.

Values: 1-6

Returns

Nothing.

Description:

This command .

Notes:

This command is only valid with HD tuners.


FIPSDown

{MLServeCmd}Script Usage

MLServeCmd.MLSuite16|Tuner~FIPSDown~<<Slot#>>~<<FIPS#>>

(Literal)

MLServeCmd.MLSuite16|Tuner~FIPSDown~2~1

MLServeCmd.MLSuite16|Tuner~FIPSDown~3~6

Parameters

Slot# = The slot number of the tuner.

Values: 1-4

FIPS# = The FIPS number to control.

Values: 1-6

Returns

Nothing.

Description:

This command .

Notes:

This command is only valid with HD tuners.


GetDPSVersion

{MLServeCmd}Script Usage

MLServeCmd.MLSuite16|Tuner~GetDPSVersion~<<Slot#>>

(Literal)

MLServeCmd.MLSuite16|Tuner~GetDPSVersion~2

MLServeCmd.MLSuite16|Tuner~GetDPSVersion~3

Parameters

Slot# = The slot number of the tuner.

Values: 1-4

Returns

Nothing.

Description:

This command gets the DPS version of the tuner in the specified slot.

Notes:

This command is only valid with HD tuners.


GetRadioID

{MLServeCmd}Script Usage

MLServeCmd.MLSuite16|Tuner~GetRadioID~<<Slot#>>

(Literal)

MLServeCmd.MLSuite16|Tuner~GetRadioID~2

MLServeCmd.MLSuite16|Tuner~GetRadioID~3

Parameters

Slot# = The slot number of the tuner.

Values: 1-4

Returns

Nothing.

Description:

This command gets the radio id of the tuner in the specified slot.

Notes:

This command is only valid with HD tuners.


GetVersion

{MLServeCmd}Script Usage

MLServeCmd.MLSuite16|Tuner~GetVersion~<<Slot#>>

(Literal)

MLServeCmd.MLSuite16|Tuner~GetVersion~2

MLServeCmd.MLSuite16|Tuner~GetVersion~3

Parameters

Slot# = The slot number of the tuner.

Values: 1-4

Returns

The version of the tuner in the line item variables.

Description:

This command gets the version of the tuner in the specified slot.

Notes:

Keypad Commands


SetText

MLServeCmd Script Usage:
MLServeCmd.MLSuite16|Keypad~SetText~<<SourceType>>~<<Text>>~<<*Param1>>~<<*Param2>>

Literal:
MLServeCmd.MLSuite16|Keypad~SetText~Tuner~This is my tuner~0~1
MLServeCmd.MLSuite16|Keypad~SetText~IRL~This is my IRL~1~1
MLServeCmd.MLSuite16|Keypad~SetText~SpecialCD~This is my CD~1

Parameters:
SourceType = Tuner,IRL, or SpecialCD
Text = The text to send to keypad
Param1 = The tuner bus(0-9), the IRL address(1-8) or the CD address(1-8)
Param2 = The tuner module(1-3), the IRL port(1-8) (Not required for CD sources)

Returns:
Nothing.

Description:
This command will set the display text on any keypad that is currently set to the source specified in the command.

Notes:

MLServer Variables

MLMatrixSwitcher_<< Switcher #>>_

Notes:



Bugs

New Feature Requests