Grass Valley iControl Services Gateway - Manual (Page 16)

Page 16 of 26
1.1.14 Q UERYING AN A CCESS KEY P ARAMETER
’ F ORMAT ( GET P ARAMETER I NFO )
Purpose:
To obtain all the available information on parameters of an access key accessible to an application.
Pre-Requisites:

Short Identifier of the Node Service is known.

IP address of the Service Node is known.

TCP/IP socket port 13000 has been successfully opened at <address> of Service Node.

A session with the Miranda Service Node we want to query has been successfully opened with
the command <openID>[Service Node Short Identifier]</openID>
XML Syntax:
<getParameterInfo?key=”[Access Key]”/> where [Access Key]
is the parameter‟s specific key.
All iControl‟s access keys must start with lower-case letter.
Replies:
 {…} <[param>[value]?[unit]</[param]>
<parameterInfo><key>[Access Key]<type>[param]<type>[param]…<type><param><parameterInfo/>
where each [param] is a Service Node Access Key parameter Name to be used within commands get
[param] and set [param].
 {…}<nack/>
Returned when the command syntax is wrong.
 {…}<unknownInfo/>
Returned when the command string key= is misspelled (missing or wrong characters instead the
expected ones)
It would better be described as a <missingInfo/> error.
The first XML tag returned as response is the current vLuma value, after which the parameter Info tag is
returned.
Example:
Getting the information about the parameters of the Access Key vLuma, where the values of vLuma are
float number and there is no associated measurement unit.
<getParameterInfo?key="vLuma"/>
<vLuma>0 </vLuma>
<parameterInfo name="Luminance" isActive="true" min="-800.0" max="800.0" step="1.0"
step="5" nominal="0.0" unit=""/>
Returned information for the vTest signal parameter, where the values of vTest are a choice list
<getParameterInfo key="vTestMode"/>
<vTestMode>OFF</vTestMode>
<parameterInfo name="Test Signal" type="choice" isActive="true"><choice label="OFF"
rcpval="OFF" active="true"/><choice label="100% Bars" rcpval="100%" active="true"/><choice
label="75% Bars" rcpval="75%" active="true"/><choice label="Black" rcpval="BLCK"
active="true"/></parameterInfo>
where: