Grass Valley Kaleido Remote Control Protocol Gateway May.2011 User Manual
Page 13

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.