MLKVHD8 Plugin

From Cinemar Wiki
Jump to: navigation, search

Knox Video HD-8 Plug-In Documentation

Overview

The following paragraphs detail the installation, configuration and usage of the Main Lobby / ML Server Knox Video HD-8 Plug-In.

Installation and Configuration

This plug-in is capable of supporting a Knox video HD-8 A/V Distribution system attached to a PC serial port or a Global Cache GC100 style serial port.

Installation

Copy the MLKVHD-8.dll file to the MLServer plug-ins folder. This is typically located in the C:\Program Files\MLServer\Plugins folder. After copying the file to the folder you must register the plug-in with Windows. You may use the following command to register the plug-in: RegSvr32 “C:\Program Files\MLServer\Plugins\MLKVHD-8.dll”

Configuration

This plug-in must be configured prior to using it in a Main Lobby scene. Highlight the MLKVHD-8 plug-in in MLServer and click on the Settings button to bring up the HD-8 configuration screen. You will be presented with a tabbed dialog box of configuration settings as shown in Figure 1.

The Event Log Tab

This tab is used to collect and view the status of the plug-in while is use. This is a diagnostic feature and is useful during the initial setup of the plug-in. Click on the Start Logging button to enable the display of plug-in events while the plug-in is in use. See Figure 1.

The Serial Tab

Use this tab to configure the serial port that will be used to control the HD-8 distribution system. You can use either a PC serial port or a Global Cache serial port. If you use a Global Cache serial port make sure you configure the serial port using the Global Cache web interface. The serial port that is currently enabled will be used to control the receiver.

Supported Commands

Routing Audio and Video

ML Server Command:

RouteAV~Zone~VSource~ASource

Where

Zone = Zone number (1..8)

VSource = Video Source (1..8, 0 = Off)

ASource = Audio Source (1..8, 0 = Off) Optional. If not specified then Audio source will be the same as the video source.

Routing Video

ML Server Command:

RouteVideo~Zone~VSource

Where

Zone = Zone number (1..8)

VSource = Video Source (1..8, 0 = Off)

Routing Audio

ML Server Command:

RouteAudio~Zone~ASource

Where

Zone = Zone number (1..8)

ASource = Audio Source (1..8, 0 = Off)

Routing IR

ML Server Command:

RouteIR~Zone~IRSource

Where

Zone = Zone number (1..8)

IRSource = IR Source (1..8, 0 = Off)

Muting a Zone

ML Server Command:

Mute~Zone~MState

Where

Zone = Zone number (1..8)

MState = Mute State (On, Off)

Changing Zone Volume

ML Server Command:

Volume~Zone~VState

Where

Zone = Zone number (1..8)

VState = Volume State (Up, Down)

Setting Zone Volume

ML Server Command:

SetVolume~Zone~Volume

Where

Zone = Zone number (1..8)

Volume = Volume (0..100)

Getting Zone Status

ML Server Command:

GetStatus~Zone

Where

Zone = Zone number (1..8)

ML Server Two-Way Support

The Knox Video HD-8 distribution system will update status message whenever a GetStatus command is sent to the device. This plug-in will automatically create ML Server variables based upon the reported data.

The following variables will be created:

KVHD-8_z_VSource = (0..8)

KVHD-8_z_VSourceName = ASCII String

KVHD-8_z_ASource = (0..8)

KVHD-8_z_ASourceName = ASCII String

KVHD-8_z_IRSource = (1..8, ?)

KVHD-8_z_IRName = ASCII String

KVHD-8_z_Volume = (0..100)

KVHD-8_z_Mute = (0,1)

KVHD-8_z_ZoneName = ASCII String

Where z = Zone number (1..8)