Miranda KMV-3901 User manual

Kaleido Remote Control
Protocol (Gateway)
User’s Guide
M770-0900-115
Copyright 2011Miranda Technologies Inc.
Specications may be subject to change
Printed in Canada
Nov. 2011
Miranda
Technologies Inc.
3499 Douglas-B.-Floreani
St-Laurent, Québec,Canada H4S 2C6
Tel. [phone]
Fax. [phone]
www.miranda.com
Multi-Image
Display
Processor
Kaleido Remote Control Protocol (Gateway)

USER’S GUIDE
Kaleido Remote Control Protocol (Gateway)
Table of Contents
1Introduction.........................................................................................................................................1
1.1 Software Versions........................................................................................................................1
1.2 Remote Operation of the Kaleido-X Series or Kaleido-Alto/Quad/Quad-Dual Multi-Viewers .....1
1.3 Gateway Options for the Kaleido-K2 ...........................................................................................1
1.3.1 Internal Gateway.................................................................................................................2
1.3.2 MT-Gateway........................................................................................................................2
1.4 Remote Operation of the Kaleido-K2 via the Gateway................................................................3
2Gateway Commands..........................................................................................................................4
2.1 Index of Gateway Commands .....................................................................................................4
2.2 Document Conventions ...............................................................................................................6
2.3 Gateway Command Descriptions................................................................................................6
3A Typical Session.............................................................................................................................27
4Appendix: Kaleido-X Series Support History................................................................................31

USER’S GUIDE
Kaleido Remote Control Protocol (Gateway) | 1
Kaleido Remote Control Protocol (Gateway)
1 Introduction
Kaleido-K2, Kaleido Alto/Quad/Quad-Dual, Kaleido-X, Kaleido-X16, KMV-3901/3911, and Kaleido-IP
multi-viewers can execute commands received via a gateway, allowing third-party developers and
individual users remote access to some functions of the multi-viewer’s operating system. This document
describes the Gateway functionality, and defines the commands that are available.
In this document, the term Kaleido is used to describe features common to the Kaleido-K2, Kaleido-
Alto/Quad/Quad-Dual, and Kaleido-X series of multi-viewers. The term Kaleido-X series refers to the
Kaleido-X, Kaleido-X16, KMV-3901/3911, and Kaleido-IP multi-viewer models. Features exclusive to any
one of these products will be described using the full product name (e.g. Kaleido-K2, Kaleido-
Alto/Quad/Quad-Dual, Kaleido-X, Kaleido-X16, KMV-3901/3911, or Kaleido-IP).
1.1 Software Versions
The information in this document applies to software released up to the date of publication, beginning with
the versions given here for each Kaleido product:
Kaleido-X series:
Kaleido-X Software version 3.00 or later (see Appendix:
Kaleido-X Series Support History on page 31 for a detailed
breakdown by command and multi-viewer model)
Kaleido-Alto/Quad/Quad-Dual:
Kaleido-Alto/Quad/Quad-Dual Software version 3.01 or later
Kaleido-K2:
Kaleido Software version 5.30 or later
1.2 Remote Operation of the Kaleido-X Series or Kaleido-
Alto/Quad/Quad-Dual Multi-Viewers
For remote operation, the Ethernet port of the Kaleido-Alto/Quad/Quad-Dual and Kaleido-X series is
continuously available to communicate with a remote computer. The functionality is similar to the internal
gateway on the Kaleido-K2, but on a Kaleido-Alto/Quad/Quad-Dual or Kaleido-X series multi-viewer, the
Ethernet port is always ON and no configuration is required.
Kaleido-Alto/Quad/Quad-Dual and Kaleido-X series multi-viewer systems can execute XML commands
received via TCP/IP (Transmission Control Protocol/Internet Protocol). To send commands, you can use
a Terminal Emulation (telnet) program or create your own application using the language of your choice
(C++, Visual Basic, Java…). In Section 3 below, the use of HyperTerminal software will be described.
HyperTerminal is a Windows application that is typically installed on every Windows computer. (From the
Start menu, point to All Programs > Accessories > Communications, and then click HyperTerminal.)
This program will communicate with the multi-viewer system using communications port 13000.
1.3 Gateway Options for the Kaleido-K2
Two gateways are available for use with the Kaleido-K2:
The internal gateway is implemented within the Kaleido-K2 software

USER’S GUIDE
2| Kaleido Remote Control Protocol (Gateway)
The MT-Gateway runs as a Windows service on the Kaleido-K2’s operating system
Note: The internal gateway is the preferred gateway, and Miranda strongly recommends that it be used
instead of the MT-Gateway, as it is more robust. The MT-Gateway might be used for legacy applications
(the internal gateway was not available in early versions of the software), or in specific situations based
on design considerations, but its use is deprecated.
It is important to note that only one gateway can be operating at a time, and the user must manage the
gateway resources to ensure that this is the case.
1.3.1 Internal Gateway
The internal gateway is implemented in the Kaleido-K2 software itself, and is therefore internal to and
exclusively functional with a specific Kaleido-K2 frame.
The internal gateway is configured through the Kaleido.properties file, and is turned on or off by
editing that file. Here is how to do it:
1. From your Kaleido-K2’s desktop, double-click the icon My Computer.
2. Navigate to C:\iControl\Startup\and open the file Kaleido.properties using Notepad
(right-click the Kaleido.properties file, and then select Notepad from the Open With menu).
3. Search the file for either of the following lines:
activateInternalGateway=TRUE
activateInternalGateway=FALSE
If activateInternalGateway is TRUE, the internal gateway is ON by default at startup. Disable the
internal gateway at startup by replacing TRUE with FALSE in this line.
If activateInternalGateway is FALSE, the internal gateway is OFF by default at startup. Enable the
internal gateway at startup by replacing FALSE with TRUE in this line.
4. On the File menu, click Save to save your changes.
5. Close the Notepad editor.
6. Restart the Kaleido-K2.
The internal gateway supports all Kaleido/Gateway commands when connected via port 13000, and
supports only the <listnodes/> command when connected via port 10001. (The <listnodes/>
command is available on the Kaleido-K2 systems only.)
1.3.2 MT-Gateway
The MT-Gateway is shipped with current versions of the Kaleido-K2 in support of legacy applications, but
its use is not recommended.
As the MT-Gateway must not be running when you are using the internal gateway, verify that it is turned
off as follows:
1. On the Kaleido-K2, display the desktop (use the desktop icon on the menu bar).

USER’S GUIDE
Kaleido Remote Control Protocol (Gateway) | 3
2. Double-click the Services icon. The Services management console will appear. You can see if the
MT-Gateway service is running, and whether it is configured to start automatically when the Kaleido-
K2 is booted.
3. Right-click MT_Gateway and then click Properties on the shortcut menu.
4. Select Manual as the startup type, and then click OK.
5. Click the Stop Service button on the toolbar to turn the gateway off.
1.4 Remote Operation of the Kaleido-K2 via the Gateway
Kaleido-K2 can execute XML commands received via either the internal gateway (preferred) or the MT-
gateway (deprecated). In an environment containing many Kaleido-K2s, there is a gateway running on
each Kaleido-K2. Remember that in such an environment you should configure your system to have at
most two lookups running (please refer to the “How to configure the Kaleido-K2 in systems including more
than two units and application servers?” section of the Kaleido-K2 documentation for more information).
Commands are sent to the gateway via TCP/IP (Transmission Control Protocol/Internet Protocol), so you
can use a Terminal Emulation (telnet) program or create your own application using the language of your
choice (C++, Visual Basic, Java …). In section 3 below, the use of HyperTerminal software will be
described. HyperTerminal is a Windows application that is typically installed on every Windows computer.
(From the Start menu, point to All Programs > Accessories > Communications, and then click
HyperTerminal.) This program will communicate with the machine on which the gateway is running using
communications port 13000.

USER’S GUIDE
4| Kaleido Remote Control Protocol (Gateway)
2 Gateway Commands
Kaleido multi-viewers support the following commands through the Gateway access. Most of these apply
to all Kaleido multi-viewer models, but some only apply to one platform, as indicated in the list.
Furthermore, there may be differences in the use or syntax of some commands depending on the
platform. All of these points are clarified in the detailed description of each command that follows.
Note: All gateway commands must be followed by a carriage return. In scripts, add \n at the end of each
gateway command.
2.1 Index of Gateway Commands
The applicable Kaleido systems are indicated as follows:
Code
System
Multi-Viewer Models
KX
Kaleido-X Software
Kaleido-X, Kaleido-X16, KMV-3901/3911, Kaleido-IP
K2
Kaleido-K2 Software
Kaleido-K2
AQ
Kaleido-Alto/Quad/Quad-Dual
Kaleido-Alto, Kaleido-Quad, Kaleido-Quad-Dual
The star () symbol indicates a new command, or a command with new parameters.
Command
Applies to
Description
Page
openID
KX
K2
AQ
Opens a session with the specified Kaleido
6
closeID
KX
K2
AQ
Closes a previously opened session
7
getParameterInfo
KX
Gets the system name, or its software version
8
getKCurrentLayout
KX
K2
AQ
Gets the name of the current layout
8
setKCurrentLayout
KX
K2
AQ
Loads a specific layout
9
getKLayoutList
KX
K2
AQ
Gets the list of available layouts
9
getKRoom
KX
Gets information on how the heads are
positioned within the specified room
10
getKRoomList
KX
Gets the list of available rooms
12
setKStatusMessage
KX
K2
AQ
Sets a Gateway alarm to the specified state
12
setKUnlatch
KX
Acknowledges the global alarm for the specified
source (channel)
13
getKChannel
KX
Gets the source (channel) currently assigned to
the specified monitor
13

USER’S GUIDE
Kaleido Remote Control Protocol (Gateway) | 5
Command
Applies to
Description
Page
setKChannel
KX
K2
AQ
Associates a source (channel) to the specified
monitor
14
setKDynamicText
KX
K2
AQ
Sends text to the specified layout element
14
getKDynamicText
KX
Retrieves text from the specified layout element
15
getKMetaData
K2
Gets metadata from a MultiData component
15
setKTimer
KX
K2
AQ
Configures the specified countdown timer
16
setKTimer2
KX
K2
Configures the specified timer
17
setKTimerTrigger
KX
K2
AQ
Starts, stops or resets a countdown timer
18
setKFireAction
KX
K2
AQ
Fires the specified action
18
getKActionList
KX
Gets the list of available actions
18
setKEnableAlarmGroup
KX
K2
Enables an alarm group
19
setKDisableAlarmGroup
KX
K2
Disables an alarm group
19
setKSaveLayout
K2
AQ
Saves the current layout
19
getKAudioOut
KX
K2
AQ
Identifies the current audio output
20
setKAudioOut
KX
K2
AQ
Selects the audio to be monitored
21
getKAudioOutVolume
KX
K2
AQ
Gets the current audio monitoring output volume
22
setKAudioOutVolume
KX
K2
AQ
Sets the volume of the audio monitoring output
22
getKAudioOutMode
KX
K2
AQ
Gets the current audio monitoring output mode
23
setKAudioOutMode
KX
K2
AQ
Sets the audio monitoring output mode
23
setKVerticalOffset
AQ
Offsets the graphic from display
24
setKIcontrolMode
AQ
Enables/Disables mouse color keying over video
24
setKMouseColorA
AQ
Sets the mouse color to be keyed over the video
24
setKMouseColorB
AQ
Sets the mouse color to be keyed over the video
25
setKMouseColorC
AQ
Sets the mouse color to be keyed over the video
25

USER’S GUIDE
6| Kaleido Remote Control Protocol (Gateway)
2.2 Document Conventions
Each command in this document is presented in the following format:
[Command Name] [Applicable Kaleido Systems]
Command description.
The proper command syntax with variables.
Gateway Response –a list of possible answers:
a) For a successful execution of the command
b) For an unsuccessful execution of the command
Special notes for the command or specific platform.
2.3 Gateway Command Descriptions
Please note that the syntax must be exactly replicated when sending a command. Use the UTF-8 format
to send Unicode text messages via the Gateway.
openID KX K2 AQ
This command opens a session with the specified Kaleido.
Note: It is not necessary to open a session every time you want to send a command to the
Gateway. Since opening a session takes a few seconds, it is recommended that you keep a
session open as long as commands need to be sent.
<openID>IP_ADDRESS_0_4_0_0</openID>
On a Kaleido-X series multi-viewer:
To open a session without room context:
<openID/>
OR to open a session with a room context:
<openID>ROOM_NAME</openID>
OR to open a session with user privilege validation with MD5 password hash:
<openID>mirandagateway://USERNAME:PASSWORD_MD5_HASH@SYSTEM_NAME/RO
OM_NAME</openID>

USER’S GUIDE
Kaleido Remote Control Protocol (Gateway) | 7
OR to open a session with user privilege validation without MD5 password hash:
<openID>mirandagateway://USERNAME:CLEAR_PASSWORD
@SYSTEM_NAME/ROOM_NAME</openID>
Where:
oIP_ADDRESS is the IP address of your destination Kaleido frame.
oROOM_NAME is the room context for the session (see getKCurrentLayout,
setKCurrentLayout and getKLayoutList).
oUSERNAME is the username that will be used to validate permissions.
oPASSWORD_MD5_HASH is the md5 hash of the user password, encoded in base 64.
oFor information on md5 see http://www.ietf.org/rfc/rfc1321.txt.
oFor information on base 64 see RFC 3548.
oCLEAR_PASSWORD is the user password.
oSYSTEM_NAME is the system name as specified in XAdmin.
Gateway response:
<ack/>: The command was recognized by the Gateway.
<nack/>:
oThe Gateway was not able to recognize the command OR
oThe room name was invalid OR
oThe username does not match the provided password OR
oThe system name was invalid.
oThe IP_ADDRESS parameter is wrong.
closeID KX K2 AQ
This command closes a session with the specified Kaleido.
On a Kaleido-X series multi-viewer:
<closeID/>
On a Kaleido-K2 or Kaleido-Alto/Quad/Quad-Dual multi-viewer:
<closeID>IP_ADDRESS_0_4_0_0</closeID>
Where IP_ADDRESS is the IP address of the Kaleido-K2 or Kaleido-Alto/Quad/Quad-Dual.
Gateway response:
<ack/>: The command was recognized by the Gateway.

USER’S GUIDE
8| Kaleido Remote Control Protocol (Gateway)
<nack/>: The Gateway was not able to recognize the command.
Note: This command closes the current connection to the client via port 13000. This connection
must be re-established before another session can be opened. If you are using HyperTerminal, it
will automatically re-establish the previous connection if you begin typing new commands, but
other clients may require you to manually reconnect.
getParameterInfo KX
This command serves two purposes: it can retrieve the current system’s name, or the version of
the Kaleido-X Software installed on this system.
To obtain the software version, the command is:
<getParameterInfo>get key="softwareVersion"</getParameterInfo>
Gateway response:
<kParameterInfo>softwareVersion="Software Version"</kParameterInfo>
<nack/>: The Gateway was not able to recognize the command.
Example:
<kParameterInfo>softwareVersion="4.XX-build.102"</kParameterInfo>
To obtain the system name, the command is:
<getParameterInfo>get key=”systemName”</getParameterInfo>
Gateway response:
<kParameterInfo>systemName="System Name"</kParameterInfo>
<nack/>: The Gateway was not able to recognize the command.
Example:
<kParameterInfo>systemName="Cougar-X"</kParameterInfo>
getKCurrentLayout KX K2 AQ
This command retrieves the name of the current layout.
<getKCurrentLayout/>
Gateway response:
For a Kaleido-Alto/Quad/Quad-Dual multi-viewer:
<kCurrentLayout>Currentlayout.xml</kCurrentLayout>
For a Kaleido-K2 or a Kaleido-X series multi-viewer:

USER’S GUIDE
Kaleido Remote Control Protocol (Gateway) | 9
<kCurrentLayout>name="CurrentLayout.kg2"</kCurrentLayout>
<nack/>: The Gateway was not able to recognize the command.
Where CurrentLayout.kg2 is the name of the Layout currently in use by the Kaleido-K2 or
Kaleido-X series multi-viewer. For a Kaleido-Alto/Quad/Quad-Dual, the layout suffix is “.xml”
instead of “.kg2”.
Note: On a Kaleido-X series multi-viewer, the session must have a room context for the
command to be used. If the session was opened using the <openID/> command the gateway
will return <nack/>.
setKCurrentLayout KX K2 AQ
This command loads the specified layout.
<setKCurrentLayout>set LayoutToLoad.kg2</setKCurrentLayout>
Where LayoutToLoad is the name of the layout to load.
Notes:
This Layout must have been exported to the Kaleido prior to executing this command.
You can use the getKLayoutList command to retrieve the available layouts before
sending this command.
For a Kaleido-Alto/Quad/Quad-Dual multi-viewer, the layout suffix is “.xml” instead of
“.kg2”.
For a Kaleido-X series multi-viewer, if the session does not have a room context, the
layout name must be prefixed with the room name and a “/”.
Ex: <setKCurrentLayout>set Room1/Layout1.kg2</setKCurrentLayout>
Gateway response:
<ack/>: The command was recognized by the Gateway and the layout has been fully
loaded.
<nack/>: The Gateway was not able to recognize the command or the layout could not be
found.
getKLayoutList KX K2 AQ
This command returns the list of layouts that can be used on the Kaleido.
<getKLayoutList/>
Gateway response:
<kLayoutList> Layout1.kg2 Layout2.kg2 … AnAvailableLayout.kg2</kLayoutList>
Where: Layout1, Layout2 and AnAvailableLayout are the names of the layouts that are
available on the Kaleido system.

USER’S GUIDE
10 | Kaleido Remote Control Protocol (Gateway)
<nack/>: The Gateway was not able to recognize the command.
Notes:
For a Kaleido-X series multi-viewer, if the session does not have a room context, the
layout names will be prefixed with the room name and a “/”. If the session has a room
context, only layouts for that room will be returned and the layout names won't be
prefixed with the room name.
Example:
<kLayoutList>Room1/MAIN.kg2 Room1/BACKUP1.kg2
Room2/MAIN.kg2</kLayoutList>
For a Kaleido-Alto/Quad/Quad-Dual multi-viewer, the layout suffix is “.xml” instead of
“.kg2”.
getKRoom KX
This command is used to obtain information on how the heads are positioned relative to each
other within the specified room. For a session without room context, the command is:
<getKRoom>ROOM_NAME</getKRoom>
For a session with a room context, the command is:
<getKRoom/>
Gateway response:
The response is the specified room exactly as it is stored in the database but without the
XML header.
Example:
<room UUID="4afa6407-a753-11dc-9fb9-e3bbad2712e5"
beanType="monako.data.rooms" createdTime="1197313709663"
currentLayoutUrl="miranda.data.access:MultiHeadLayoutBean/d8b14b99-
8321-11dd-8648-49f166ea7203" friendlyName="Room1"
lastModifiedTime="1228233770264" path="/" readOnly="false"
version="824" xmlVersion="273114">
<defaultRoomPreferences>
<preferences>
<preference editable="true" editablePerUser="true" type="audioOut"
uid="audioOut"
value="miranda.monako.daq://local/data/master/9/card/head:0/port:Ana
log%20AES%20Audio%20Out"/>
<preference editable="true" editablePerUser="true" type="Preset"
uid="MultiHeadLayoutBean.10"
value="miranda.data.access:MultiHeadLayoutBean/3aadaaff-df2b-11dc-
86c6-b5c2f6a72665"/>
<preference editable="false" editablePerUser="true"
type="useLargeCursor" uid="useLargeCursor" value="true"/>

USER’S GUIDE
Kaleido Remote Control Protocol (Gateway) | 11
<preference editable="true" editablePerUser="true" type="Preset"
uid="MultiHeadLayoutBean.9"
value="miranda.data.access:MultiHeadLayoutBean/5a475f81-df1b-11dc-
a920-9d4ecc32cf8e"/>
...
</preferences>
</defaultRoomPreferences>
<heads>
<head allowDashboard="true" frameName="Cougar-X"
friendlyName="Default Display" headID="23" headNumber="1"
id="Cougar-X.23" logicalID="2" resolutionSettingsUuid="8af91a81-
0af1-11dd-a25a-f534b3d6b0d3" rotated="false" rotation="normal"
slotNumber="11">
<dimension x="1398" y="874"/>
<position x="4408" y="32"/>
<resolution height="1200" width="1920"/>
<rotDimension x="1398" y="874"/>
<rotResolution height="1200" width="1920"/>
</head>
<head allowDashboard="true" frameName="Cougar-X"
friendlyName="Default Display" headID="21" headNumber="1"
id="Cougar-X.21" logicalID="1" resolutionSettingsUuid="9016b92b-
cdbe-11db-ae68-a122768fdba0" rotated="false" rotation="normal"
slotNumber="10">
<dimension x="1400" y="875"/>
...
</head>
...
</heads>
</room>
<nack/>: The Gateway was not able to recognize the command.

USER’S GUIDE
12 | Kaleido Remote Control Protocol (Gateway)
getKRoomList KX
This command is used to obtain the list of rooms known to your multi-viewer system.
<getKRoomList/>
Gateway response:
<kRoomList><room>Room A</room><room>Room B</room></kRoomList>
<nack/>: The Gateway was not able to recognize the command.
setKStatusMessage KX K2 AQ
This command associates an Alarm state with an ID. The Kaleido can be configured to listen to
alarm status messages from the Gateway, and thus report the state it receives. This is a
convenient way of reporting Alarms to the Kaleido.
<setKStatusMessage>set id="ID" status="Status"
message="Message"</setKStatusMessage>
Where:
oID is the identifier that will receive the new state.
Note: Kaleido-Alto/Quad/Quad-Dual will only accept numeric values for this parameter,
in the range 0 to 1024. The Kaleido-K2 and Kaleido-X series do not have this limitation.
oStatus is any of the available statuses:
Status
Alternate (legacy)
status
Kaleido-X Series
Kaleido-K2/Alto/Quad/Quad-Dual
DISABLE
DISABLE
Disabled
Disabled
NORMAL
OK
Normal
OK
MINOR
WARNING
Minor
Warning
MAJOR
MAJOR
Major
(not supported)
CRITICAL
ERROR
Critical
Error
oTheMessage is reserved for future use, and is ignored.
Gateway response:
<ack/>: The command was recognized by the Gateway.
<nack/>: The Gateway was not able to recognize the command.

USER’S GUIDE
Kaleido Remote Control Protocol (Gateway) | 13
setKUnlatch KX
This command is used to acknowledge the global alarm for a given source (channel). It can also
be used to acknowledge specific alarms.
The command supports three parameter types: channelName, id or uri:
oIf channelName is specified, the global alarm associated with the specified source
(channel) will be acknowledged.
oIf uri is specified, the alarm with the specified URI will be acknowledged.
oIf id is specified then the gateway alarm with the specified ID will be acknowledged.
Note: Only one parameter can be specified, otherwise the Gateway will return <nack/>.
<setKUnlatch>set channelName="ChannelName"</setKUnlatch>
<setKUnlatch> set uri="AlarmURI"</setKUnlatch>
<setKUnlatch>set id="AlarmName"</setKUnlatch>
Gateway response:
<ack/>: The command was recognized by the Gateway.
<nack/>: The Gateway was not able to recognize the command.
Examples:
o<setKUnlatch>set channelName="/Input A/Channel 01"</setKUnlatch>
o<setKUnlatch>set
uri="miranda.monako.daq://local/data/master/3/card/av1/DTVCCData#dt
vccService1Presence"</setKUnlatch>
o<setKUnlatch>set id="my_gateway_alarm_1"</setKUnlatch>
getKChannel KX
Note: This command is currently supported on the Kaleido-IP multi-viewer models only.
This command is used to obtain the logical source (channel) currently assigned to the specified
monitor in the current layout.
<getKChannel>set monitor="MonitorName"</getKChannel>
Where MonitorName is the name of the monitor whose source you wish to obtain. The monitor
name must be prefixed with the room name and a “/” if the session does not have a room context.
Ex.: Room1/composite42. The monitor name is available in the XEdit layout (see Name, under
Assignments in the Properties tab).
Gateway response:
<kChannel>channelname="ChannelName"</kChannel>

USER’S GUIDE
14 | Kaleido Remote Control Protocol (Gateway)
Where ChannelName is the full path to the source (channel) currently assigned to the
specified monitor. Ex.: /Input A/Channel 1.
<nack/>: The Gateway was not able to recognize the command, or a parameter could not
be resolved.
setKChannel KX K2 AQ
This command is used to assign a logical source (channel) to the specified monitor in the current
layout.
<setKChannel>set channelname=ChannelName monitor=MonitorNumber
</setKChannel>
Where:
oChannelName is the name of the logical source you wish to assign to the specified
monitor. On a Kaleido-X series multi-viewer this is the full path to the source (channel).
Ex.: /Input A/Channel 1.
oMonitorNumber is the identifier of the monitor to which the source is to be assigned.
On a Kaleido-X series multi-viewer the monitor number must be prefixed with the room
name and a “/” if the session does not have a room context. Ex.:
Room1/composite42. The monitor name is available in the XEdit layout (Properties
> Assignments > Name).
Note: On the Kaleido-K2, to get the monitors’ identifiers for your current layout press the Tab key
on the keyboard, or the SELECT key on the RCP.
Gateway response:
<ack/>: The command was recognized by the Gateway.
<nack/>: The Gateway was not able to recognize the command, or a parameter could not
be resolved.
setKDynamicText KX K2 AQ
This command is used to set the text of a UMD or text label component that is configured to use
dynamic text. Note that the Service ID for this component must be set to “Gateway” when the
layout is created in KEdit/XEdit in order for this command to work.
<setKDynamicText>set address=Address text=NewText </setKDynamicText>
Where:
oAddress is the configured text address of the UMD or text label component.
Note: The Kaleido-Alto/Quad/Quad-Dual systems require a numeric value in the range
0-1024. The Kaleido-K2 and Kaleido-X series do not have this limitation.
oNewText is the text to display.
Gateway response:

USER’S GUIDE
Kaleido Remote Control Protocol (Gateway) | 15
<ack/>: The command was recognized by the Gateway.
<nack/>: The Gateway was not able to recognize the command.
getKDynamicText KX
This command is used to retrieve dynamic text previously sent to a multi-viewer by a third-party
device.
<getKDynamicText>set address=Address</getKDynamicText>
Where: Address is the configured text address of the UMD or text label component whose text
you wish to retrieve.
Gateway response:
<kDynamicText>RetrievedText</kDynamicText>
<nack/>: The Gateway was not able to recognize the command.
Note: This command will only return text that was previously set via the <setKDynamicText>
command.
getKMetaData K2
This command is used to get metadata that is assigned to a MultiData component assigned to a
text label in the Kaleido-K2. The Kaleido-K2 will return XDS, Dolby-E and video format data in
response to this command.
<getKMetaData>get dataname=MultiDataName </getKMetaData>
Where MultiDataName is the name of the MultiData source, as defined in the MultiData
Configuration panel.
Gateway response:
<kMetaData><error>MultiDataName not found</error></kMetaData>: the MultiData
entity does not exist in the Kaleido-K2.
<kMetaData><input id="1" stationID="1234" channelNumber="12"/> <input
id="2" stationID="RDS" channelNumber="25"/></kMetaData>
Where the returned information (shown in bold type here) is the data contents of the MultiData
element. This example shows a typical return of data; the actual data returned will depend upon
the configuration and definition of the MultiData component on the Kaleido-K2.
oThe response will be grouped by input, and the inputs sorted in ascending order (from
input 1 to 32).
oFor each input, all the data will be presented as attributes.

USER’S GUIDE
16 | Kaleido Remote Control Protocol (Gateway)
oThe data legends will be mapped to valid XML attribute names, all of which are listed
here:
inputFormat
WSS
scansys
AFD
AFD3Bits
AFDANC
SID
programConfig
dialogLevel
networkName
stationID
channelNumber
TSID
programName
programType
vChipRating
programDescription
programLength
elapsedTime
programID
timeOfDay
timeZone
oThe value field is escaped as defined in the XML protocol for an attribute value.
oFor instance, ABC"DEF\GHI<JKL>MNO/PQR&STU;VWX'YZ
becomes ABC&quot;DEF\GHI&lt;JKL&gt;MNO/PQR&amp;STU;VWX&apos;YZ
oThe attributes order is not guaranteed and may change for two consecutives calls to the
same command.
<nack/>: there is a syntax error in the XML command.
Note: If the MultiData component is not assigned to a text component, no values will be included
in the information returned to the user from the gateway. Make sure to assign the MultiData
component to a text label component.
setKTimer KX K2 AQ
This command is used to configure the specified countdown timer component.
<setKTimer>set id="TimerID" preset="HH:MM:SS" direction="Direction"
loop="Loop" </setKTimer>
Where:
oTimerID is the ID of the countdown timer component to modify.
oHH:MM:SS is the preset value for the countdown timer component.
oDirection is the direction to count, either UP or DOWN.