Document conventions – Grass Valley Kaleido Remote Control Protocol Gateway Jan.09 2014 User Manual
Page 10

6
Gateway Commands
Document Conventions
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
setKChannel
KX K2 AQ Associates a source (channel) to the specified
monitor
setKDynamicText
KX K2 AQ Sends text to the specified layout element
getKDynamicText
KX
Retrieves text from the specified layout element
getKMetaData
K2
Gets metadata from a MultiData component
setKTimer
KX K2 AQ Configures the specified countdown timer
setKTimer2
KX K2
Configures the specified timer
setKTimerTrigger
KX K2 AQ Starts, stops or resets a countdown timer
setKFireAction
KX K2 AQ Fires the specified action
getKActionList
KX
Gets the list of available actions
setKEnableAlarmGroup
KX K2
Enables an alarm group
setKDisableAlarmGroup KX K2
Disables an alarm group
setKSaveLayout
K2 AQ Saves the current layout
getKAudioOut
KX K2 AQ Identifies the current audio output
setKAudioOut
KX K2 AQ Selects the audio to be monitored
getKAudioOutVolume
KX K2 AQ Gets the current audio monitoring output
volume
setKAudioOutVolume
KX K2 AQ Sets the volume of the audio monitoring output
getKAudioOutMode
KX K2 AQ Gets the current audio monitoring output mode
setKAudioOutMode
KX K2 AQ Sets the audio monitoring output mode
setKVerticalOffset
AQ Offsets the graphic from display
setKIcontrolMode
AQ Enables/Disables mouse color keying over video
setKMouseColorA
AQ Sets the mouse color to be keyed over the video
setKMouseColorB
AQ Sets the mouse color to be keyed over the video
setKMouseColorC
AQ Sets the mouse color to be keyed over the video
Command
Applies to
Description
Page