Viz Mosart Media Router Guide
Version 5.4 | Published October 04, 2023 ©
The Media Router Service Configuration
The service configuration XML file contains the following information:
-
Services: A list over the protocols that will be active. The following protocols are available:
-
MosartMediaRouterService - Service used to connect to the Viz Mosart service via a proprietary protocol.
-
ProBelMediaRouterService - Service allowing Media Router to be controlled via the Probel router protocol, SW-P-08
-
RestMediaRouterService - Service allowing Media Router to be controlled via a proprietary REST protocol
-
-
Database: The Media Router database specification.
-
Currently supported is a file repository where the Media Router database is stored as a single xml file. Default named MediaRouterDB.xml
-
-
Service Properties: A set of properties controlling the behavior of the corresponding services
-
Properties: A set of properties controlling the behavior of the Media Router Service (MosartMediaRouterService)
Example Service Configuration
The Media Router service configuration is stored in a single xml file as shown below:
<?xml version="1.0" encoding="utf-8" ?><MediaRouterConfig> <!-- MMR SERVICES: CONFIGURATION OF ACTIVE PROTOCOLS --> <Services> <Service type="MosartMediaRouterService" /> <Service name="vsm" type="ProBelMediaRouterSerialService" configuration="Type=ProBelMessageServerTransporter;Port=8123" /> <Service type="RestMediaRouterService" /> </Services> <!-- MMR Database configuration using single xml file --> <Database type="File" name="File" configuration="MediaRouterDB.xml" /> <!-- SERVICE PROPERTIES --> <ServiceProperties name="vsm"> <!-- use name attribute to identify corresponding service --> <item name="Mode" value="Router"/> <item name="UpdateCurrentSalvoCrosspoints" value = "true"/> <item name="DisableControllerStatusResponse" value = "true"/> </ServiceProperties> <!-- MosartMediaRouterService PROPERTIES --> <Properties> <!-- MMR MASTER / SLAVE PROPERTIES --> <item name="Id" value="MR1" /> <item name="PreferredMaster" value="True" /> <item name="Slave" value="Name=MR2;Server=localhost;Port=8192" /> <item name="AutoFailover" value="True" /> <!-- MOSART SERVER REDUNDANCY PROPERTIES --> <item name="MirrorMode" value="True" /> <item name="MirrorModeMaster" value="Active" /> <item name="SynchronizedMirroring" value="False" /> <!-- GENERAL PROPERTIES --> <item name="AutoTake" value="False" /> <item name="BackupOnStartUp" value="True" /> <!-- MMR REST PROTOCOL PROPERTIES --> <item name="UseAuthorisation" value="False" /> </Properties></MediaRouterConfig>MosartMediaRouterService
One service item of type “MosartMediaRouterService” shall be part of the list of services in order to communicate with Viz Mosart Services. Configuration of the MosartMediaRouterService is done using the Properties section of the MMR service configuration file. The following properties are available:
|
Property |
Description |
Default |
|
AutoFailover |
Set to true if a slave in a master/slave redundancy setup shall take over control automatically when detecting connectivity problems to the master |
true |
|
AutoTake |
Set to true if all pending crossspoints automatically should be considered as valid. I.e. a corresponding crosspoints set in the CurrentSalvo |
false |
|
BackupOnStartUp |
If set a backup of the MMR database will automatically be made when the MMR service is started. Backup files are placed in a directory named MediaRouter. The directory is located in the same directory as the MMR database. |
true |
|
Id |
Unique identity of the MMR Service instance. Used when two MMR Service instance are used in a master/slave redundancy setup. |
GUID |
|
LocalServer |
For testing only. Set to true if the MMR service should run locally without any valid network attached. |
false |
|
MirrorMode |
Set to true to activate mirror mode. If mirror mode is activated then all crosspoints set on a Mosart server in a redundancy setup will also be sent to the other Mosart server. Hence ensuring that the configuration of the two Mosart servers are equal. |
false |
|
MirrorModeMaster |
In mirror mode, determines when crosspoints set for one Mosart server in a redundancy setup should be reflected to the other Mosart server. Options:
|
Active |
|
PreferredMaster |
In a MMR redundancy setup set this to true for the MMR Service instance which should be the main or master service. |
false |
|
Slave |
Connectionstring to the other MMR instance in a master/slave redundancy setup. Syntax: “Name=<id>”;Server=<hostname>;Port=<port>” where:
|
empty = no redundancy setup |
|
SynchronizedMirroring |
If set and in mirror mode any crosspoint set on a Mosart server will be reflected to the other Mosart server. Regardless whether the Mosart server is active or not. |
false |
|
UseAuthorisation |
Used to activate authorisation for the MMR REST protocol (4) |
false |
ProBelMediaRouterService
Used to add control of Media Router via the Probel SW-P-08 protocol. The ProBel service itself is configured using a corresponding ServiceProperties section or via the connection string given by the “configuration” attribute. The following properties are available:
|
Property |
Description |
Default |
|
Name |
Identifies the service and the corresponding ServiceProperties section. Note that Name is also used to tag log messages related to the service. |
|
|
Type |
Identifies the how to communicate with the controlling ProBel device. The following options are available: ProBelMessageClientTransporter - In this case Media Router connects to the controlling device using a tcp/ip connection. Use Server and Port properties to configure the tcp/ip connection. This is the most common type when connection to a VSM system. ProBelMessageSerialTransporter - Same as ProBelMessageClientTransporter but uses a serial connection. Use ComPort to identify the COM port. ProBelMessageServerTransporter - In this case Media Router listens to connecting devices supporting the ProBel protocol. I.e. Media Router acts like a real router. Use the Port property to specify the listening port. This is common type when connecting to a BFE-KSE system. |
|
|
Port |
Used by Client and Server Transporter types to identify the tcp/ip port. |
10000 |
|
ComPort |
Used by Serial Transporter type to identify the serial COM port |
COM1 |
|
Server |
Used by Client Transporter type to identify the host of the controlling ProBel device. |
localhost |
|
Mode |
Identifies how crosspoint changes from the controlling device shall be handled. Only crosspoints that will change the current state of Media Router will lead to any configuration changes. The following options are available: Router - In this case the Media Router is treated as a physical router:
ControlPanel - In this case the Media Router is treated by the ProBel controlling device as “a control panel” used to visualize the current state:
|
Router |
|
UpdateCurrentSalvoCrosspoints |
If set will copy any changes to the Media Router “PendingSalvo” to the Media Router “CurrentSalvo”. This is normally used when Mode=”Router” and when it is desirable to treat the pending salvo as the current state. |
False |
|
DisableCrosspointChange |
If set to true notification of crosspoint changes to the ProBel controlling device is disabled. Otherwise all crosspoint changes are forwarded to the controlling ProBel device according to the value of the Mode property |
False |
|
StateSalvo |
Specifies the internal Media Router salvo used to track changes for ProBel responses. If set to empty string the internal Media Router salvo will be selected according to the value of the Mode property. |
CurrentSalvo |
|
SignalSalvoChangeDelay |
Minimum delay between crosspoint messages from the ProBel controlling device for treating the messages to be part of the same salvo. |
100 ms |
|
DisableControllerStatusResponse |
If set to true will disable any response to the SW-P-08 command: Dual Controller Status Request Message (08). Required when connected to vsm |
False |
|
DefaultSourcePort |
Port used in Crosspoint Tally Dump Message (22) to denote a not connected destination outport. |
-1 |
RestMediaRouterService
Enables the control of Media Router using Viz Mosart Media Router REST protocol.
Default url for Media Router REST commands is as follows:
http://[hostname]:[port]/MosartMediaRouter/Rest.svc/<command>?<params>
where:
-
hostname: Host name where the Media Router service is running
-
port: TCP/IP port for the Media Router REST service. Default: 8094
-
command: REST command to be processed
-
params: Optional parameters for the command.
The port may be changed via the MMediaRouterService.exe.config configuration file as part of the Media Router service installation.
|
Command |
Description |
|
clients |
Retrieves information of all clients. |
|
sources |
Retrieves information of all sources. |
|
inports |
Retrieves information of all inports or inports connected to a given source |
|
outports |
Retrieves information of all outports or outports connected to a given client |
|
salvos |
Retrieves information of a single or multiple salvos |
|
current |
Retrieves information of the current state of the router |
|
pending |
Retrieves information of the pending state of the router |
|
config |
Retrieves information of the current or salvo specific configuration for a given client |
|
crosspoints |
Retrieves information of changed crosspoints from a given timestamp |
|
setcrosspoint |
Sets a specified crosspoint |
|
setsalvo |
Fires a specified salvo |
|
status |
Returns current Media Router status |
For a complete list of REST commands see the Media Router REST Protocol.