getOptions

Returns the camera possibilities for the positioning options: pan, tilt, zoom, focus and iris. And returns a list with the preset names.

  • Relative true means the camera supports the parameter with the command setRelativePosition
  • Absolute true means the camera supports the parameter with the command setAbsolutePosition.
  • Position true means the camera supports the parameter with the command getPosition.
  • Stop true means the camera supports the parameter with the command holdPosition.
  • Auto true means the camera supports the parameter with the command setAbsolutePosition.

This command always return the available options, even when the device is not a dome. In that case, instead of returning a ‘No Dome’ message, this command will return the results with all positioning values false.

Request

command=getOptions&serverid=[UID]&cameraid=[UID]
parameter type remarks
serverid [UID] unique server id.
cameraid [UID] unique camera id

Response

<result errorcode="0">
  <options>
    <positioning>
      <pan>...</pan>
      <tilt>...</tilt>
      <zoom>...</zoom>
      <focus>...</focus>
      <iris>...</iris>
    </positioning>
    <presets count>
      <presets number>...</presets number>
    </presets count>
 ...
 </options>
 </result>
node value remarks
/result
@errorcode [number] See error codes below
/result/positioning
pan [false|true]  options for relative, absolute, position and stop
tilt [false|true]  options for relative, absolute, position and stop
zoom [false|true]  options for relative, absolute, position, stop and auto
focus [false|true]  options for relative, absolute, position, stop and auto
iris [false|true]  options for relative, absolute, position, stop and auto
/result/presets
@count [number]  The number of presets
/result/presets/preset*
@number [number]  The index number of the preset
[string] The value of the preset
error code description remarks
0 Ok Ok, no error
-2 No device  No device found for the supplied cameraid/deviceid
-18 General error An undefined error occured

Changelog

  • 2.1.1 – Added serverid parameter
  • 1.3.3 – Added