beautypg.com

Gateway command descriptions, Openid – Grass Valley Kaleido Remote Control Protocol Gateway Jan.09 2014 User Manual

Page 11

background image

7

Kaleido Remote Control Protocol (Gateway)

User’s Guide

Gateway Command Descriptions

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 multiviewer.

• On a Kaleido-K2 or Kaleido-Alto/Quad/Quad-Dual multiviewer:

IP_ADDRESS_0_4_0_0

• On a Kaleido-X series multiviewer:

• To open a session without room context:

• To open a session with a room context:

ROOM_NAME

• To open a session with user privilege validation with MD5 password hash:

mirandagateway://
USERNAME:PASSWORD_MD5_HASH@SYSTEM_NAME/ROOM_NAME

• To open a session with user privilege validation without MD5 password hash:

mirandagateway://USERNAME:CLEAR_PASSWORD @SYSTEM_NAME/
ROOM_NAME

Where:

IP_ADDRESS

is the IP address of your destination Kaleido frame.

ROOM_NAME

is the room context for the session (see

getKCurrentLayout

,

setKCurrentLayout

and

getKLayoutList

).

USERNAME

is the user name of the RCP user (authorized for the room) that will be

used to validate permissions.

PASSWORD_MD5_HASH

is the md5 hash of the user password, encoded in base 64.

1

CLEAR_PASSWORD

is the user password.

SYSTEM_NAME

is the system name as specified in XAdmin.

Gateway response:

: The command was recognized by the Gateway.

:

• The Gateway was not able to recognize the command.

• The room name was invalid.

• The user name did not match the password provided.

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.

1.For information on md5 see http://www.ietf.org/rfc/rfc1321.txt; for information on
base 64 see RFC 3548.

This manual is related to the following products: