Content

Summary

This document provides information about the (...) protocol implementation for VSM.

Status of Driver	APPROVED
Component for Driver	GADGETSERVER
Release (Build) of Component	vsmGadgetserver 5.4.237
Revision of Implementation	1.0.0.3

Name/Type of 3rd Party API	Magnum Router Control API
Version of 3rd Party API
Additional 3rd Party information

Connection

Connection Type	TCP/ IP
Default Port	5766

Supported Features

A routing interface to the Evertz EXE Router.

Supported Commands

Resource	Command	Description
Handshake	hello	Initiate authentication with the server.
Keep-Alive	ping	Requests server to notify the client that it is up and receiving messages.
Interrogate Destination Name	get.dst.range.name	Query the names currently assigned to each destination in the given range.
Interrogate Destination Range	get.dst.range.src	Query the source currently on each destination in the given range.
Interrogate Source Name	get.src.range.name	Query the names currently assigned to each source in the given range.
Route	route	Routes the given source(s) to the given destination(s).
Lock Destination	dst.lock	Locks the given destination(s) on all levels, preventing all users from routing on those destinations until they are unlocked.
Unlock Destination	dst.unlock	Clears any lock on the given destination(s), allowing any user to route to them. [Only the user who locked the destination, or one with 'Admin' privileges, may unlock a destination]
Protect Destination	dst.protect	Protects the given destination(s) on all levels, preventing all users except the user protecting the destination(s) from routing on those destinations until they are unlocked. Protects are removed if the client who initiated the protect disconnects.
Unprotect Destination	dst.unprotect	Clears any protects on the given destination(s), allowing any user to route to them. [Only the user who protected the destination, or one with 'Admin' privileges, may unprotect a destination]
Route Update	update.route	Notify client that the source or lock state of a route has been modified.

Configuration Details

The video layer is on index 1. All audio layers will get mapped into one single layer on index 2.

The user can define the size of the audio layerm which represents the size of a single audio layer. This value will be multiplied by 25, which is currently the max layer count for audio. A mapping file is generated for the audio layers. Each audio layer can be moved within the global vsm audio layer via the <offset> </offset> tag. Download the mapping file, edit and upload again.

<?xml version="1.0" encoding="utf-8" standalone="yes"?>
<mapping>
  <identifier>Magnum System</identifier>
  <children>
    <indexMappingRegion>
      <name>Audio Layer 0</name>
      <offset>0</offset>
      <usage>Any</usage>
      <capacity>16</capacity>
    </indexMappingRegion>
    <indexMappingRegion>
      <name>Audio Layer 1</name>
      <offset>16</offset>
      <usage>Any</usage>
      <capacity>16</capacity>
    </indexMappingRegion>
    <indexMappingRegion>
      <name>Audio Layer 2</name>
      <offset>32</offset>
      <usage>Any</usage>
      <capacity>16</capacity>
    </indexMappingRegion>
    <indexMappingRegion>
      <name>Audio Layer 3</name>
      <offset>48</offset>
      <usage>Any</usage>
      <capacity>16</capacity>
    </indexMappingRegion>
    <indexMappingRegion>
      <name>Audio Layer 4</name>
      <offset>64</offset>
      <usage>Any</usage>
      <capacity>16</capacity>
    </indexMappingRegion>
    <indexMappingRegion>
      <name>Audio Layer 5</name>
      <offset>80</offset>
      <usage>Any</usage>
      <capacity>16</capacity>
    </indexMappingRegion>
    .....

XML

Known Issues

There are currently no known issues with the implementation.

Evertz Magnum Router Control