MLMatrixSwitcher Plugin

From Cinemar Wiki
Jump to: navigation, search

About

This plugin allows control of your matrix switcher device.


Software Requirements

  • MainLobby 3
  • MLServer 3
  • MLMatrixSwitcher plugin
  • Hardware specific driver


Supported Hardware

  • VideoStorm
CRM84, CRM84D, CRM62, CRM62D, CRM88
  • Neothings
Avalon, Borrego, Concord
  • Sonance
Navigator
  • AudioAuthority
1156, 1166
  • Gefen
4x4 HDTV Matrix

Release Notes

The commands documented here are available to all suppored models however, each model of matrix switcher requires a hardware specific driver that allows control of that particular model as well as providing additional commands that are more specific to each device.

Available Drivers


MLServeCmd

Power

{MLServeCmd}Script Usage

MLServeCmd.MLMatrixSwitcher|Id~Power~State


(Literal)

MLServeCmd.MLMatrixSwitcher|1~Power~On

MLServeCmd.MLMatrixSwitcher|Switcher_001~Power~Off

MLServeCmd.MLMatrixSwitcher|004~Power~Toggle


Parameters

Id = The ID number or alias assigned within plugin.
State = The desired switcher power state.
Values : On,Off,Toggle

Returns

Nothing


Description

Sets the switchers power to the desired state.


Notes


Switch

{MLServeCmd}Script Usage

MLMatrixSwitcher|Id~Switch~Board~Input~Output


(Literal)

MLMatrixSwitcher|1~Switch~All~1~1

MLMatrixSwitcher|Switcher_001~Switch~DVID~3~1

MLMatrixSwitcher|002~Switch~VID~Kitchen~off

MLMatrixSwitcher|002~Switch~VOL~1~<<volume>>

MLMatrixSwitcher|002~Switch~VOLUP~1

MLMatrixSwitcher|002~Switch~VOLDOWN~1

MLMatrixSwitcher|002~Switch~MuteON~1

MLMatrixSwitcher|002~Switch~MuteOff~1

MLMatrixSwitcher|002~Switch~MuteToggle~1



Parameters

Id = The switchers number or alias assigned in the plugin.
Board = The board to switch.
Values : All = Digital coax video
Input = The number or alias of the input source to be used.
Output = The number or alias of the output to be used. This parameter may also be "Off", this will turn off the input source.

Returns

Nothing.


Description

This command switches the specified input to be sent to the specified output.


Notes


Setup

{MLServeCmd}Script Usage

MLServeCmd.MLMatrixSwitcher|Id~Setup~Option~State


(Literal)

MLServeCmd.MLMatrixSwitcher|1~Setup~L~On

MLServeCmd.MLMatrixSwitcher|001~Setup~L~Off

MLServeCmd.MLMatrixSwitcher|Switcher_001~Setup~~Off


Parameters

Id = The switchers number or alias assigned in the plugin.
Option = The setup variable you would like to change.
Values : L = Lights
State = The new state of the specified setup option.
Values : On,Off,Toggle


Returns

Nothing.


Description

This command sets the devices setup variables.


Notes


GetStatus

{MLServeCmd}Script Usage

MLServeCmd.MLMatrixSwitcher|Id~GetStatus


(Literal)

MLServeCmd.MLMatrixSwitcher|1~GetStatus

MLServeCmd.MLMatrixSwitcher|Switcher_001~GetStatus


Parameters

Id = The ID number or alias assigned within plugin.

Returns

Nothing


Description

Polls the Switcher and sets all variables.


Notes


Cycle

{MLServeCmd}Script Usage

MLServeCmd.MLMatrixSwitcher|Id~Cycle~Output~Direction


(Literal)

MLServeCmd.MLMatrixSwitcher|1~Cycle~Next

MLServeCmd.MLMatrixSwitcher|002~Cycle~Previous

MLServeCmd.MLMatrixSwitcher|Switcher_001~Cycle~Next


Parameters

Id = The switcher number or alias assigned in MLMatrixSwitcher.
Output = The number or alias of the output zone to use.
Direction = The direction to move to get the next input source.
Values: Next,Previous


Returns

Nothing.


Description

This command cycles the input source for the specified output zone in the specified direction.


Notes

This command will not cycle through the outputs for the optional HD card.

MLServer Variables

MLMatrixSwitcher_{{Id}}_Power

Description: The power state of the switcher

Values: On,Off


MLMatrixSwitcher_{{Id}}_Lights

Description: The state of the lights on the switcher.

Values: On,Off


MLMatrixSwitcher_{{Id}}_Video_Out_{{Output}}

Description: The input that the specified video output has selected.

Values: 1-8.


MLMatrixSwitcher_{{Id}}_Audio_Out_{{Output}}

Description: The input that the specified audio output has selected.

Values: 1-8.