Get info of degrees of freedom

GET http://IPaddress:port/prefix/control/telemetry/info/{TELEMETRYCONTROLID} − gets info about supported controllable degrees of freedom and the ways of controlling them (continuous, relative, discrete) and their max values.

TELEMETRYCONTROLID − template from Get list of telemetry devices for specified video source.

Sample request:

GET http://127.0.0.1:80/control/telemetry/info/Server1/DeviceIpint.2/TelemetryControl.0

Sample response:

{
   "degrees" : {
      "focus" : {
         "continuous" : {
            "max" : "7",
            "min" : "0"
         }
      },
      "pan" : {
         "absolute" : {
            "max" : "3600",
            "min" : "0"
         },
         "continuous" : {
            "max" : "100",
            "min" : "0"
         }
      },
      "tilt" : {
         "absolute" : {
            "max" : "2700",
            "min" : "-900"
         },
         "continuous" : {
            "max" : "100",
            "min" : "0"
         }
      },
      "zoom" : {
         "absolute" : {
            "max" : "1000",
            "min" : "0"
         },
         "continuous" : {
            "max" : "100",
            "min" : "0"
         }
      }
   },
   "feature" : []
}


ParameterDescription
degrees

Information about degrees of freedom (tilt, pan, zoom, focus, iris). Every degree of freedom contains the list of supported ways of control (absolute, relative, continuous).

featureList of supported functions (autoFocus, autoIris, areaZoom, pointMove).

Edit tilt and pan

GET http://IPaddress:port/prefix/control/telemetry/move/{TELEMETRYCONTROLID} – changes tilt, pan.

TELEMETRYCONTROLID − template from Get list of telemetry devices for specified video source.


ParameterRequiredDescription
modeYes

Way of control (absolute, relative, continuous).

pan

tilt

Yes

Values for corresponding degrees of freedom. The value should be in the [-1;1] range.

For the absolute telemetry, the values are normalized and are in the range of 0,0 to 1.0. Moreover, for the absolute telemetry, it is possible to change the tilt without pan, and vice versa, the pan without tilt.


session_idYesSession id (see Acquire telemetry control session).

Sample request: 

GET http://127.0.0.1:80/control/telemetry/move/Server1/DeviceIpint.25/TelemetryControl.0?mode=absolute&pan=0.0277&session_id=8

Edit degree of freedom

GET http://IPaddress:port/prefix/control/telemetry/{zoom|focus|iris}/{TELEMETRYCONTROLID} – changes one of degrees (zoom, focus, iris).  

TELEMETRYCONTROLID − template from Get list of telemetry devices for specified video source.


ParameterRequiredDescription
modeYes

Way of control (absolute, relative, continuous).

value

Yes

Value.


session_idYesSession id (see Acquire telemetry control session).

Sample requests:

GET http://127.0.0.1:80/control/telemetry/zoom/HOSTNAME/DeviceIpint.25/TelemetryControl.0?mode=absolute&value=6&session_id=1 - zoom change;  

GET http://127.0.0.1:80/control/telemetry/focus/HOSTNAME/DeviceIpint.25/TelemetryControl.0?mode=relative&value=3&session_id=1 - focus change;  

GET http://127.0.0.1:80/control/telemetry/iris/HOSTNAME/DeviceIpint.25/TelemetryControl.0?mode=continuous&value=1&session_id=1 - iris change.

Capture screen point

GET http://IPaddress:port/prefix/control/telemetry/move/point/{TELEMETRYCONTROLID} – captures the screen point.

TELEMETRYCONTROLID − template from Get list of telemetry devices for specified video source.


ParameterRequiredDescription

x

y

Yes

Values of vertical and horizontal coordinates, specified in relation to image size.

session_idYesSession id (see Acquire telemetry control session).

Sample request:  

GET http://127.0.0.1:80/control/telemetry/move/point/Server1/DeviceIpint.23/TelemetryControl.0?x=0.14&y=0.32&session_id=1

Zoom image area

GET http://IPaddress:port/prefix/control/telemetry/zoom/area/{TELEMETRYCONTROLID} – zooms selected image area.

TELEMETRYCONTROLID − template from Get list of telemetry devices for specified video source.


ParameterRequiredDescription

x

y

Yes

Left upper corner of selected area.

Coordinates and dimensions are specified in relation to image size.


w

h

YesWidth and height of area.
session_idYesSession id (see Acquire telemetry control session).

Sample request:

GET http://127.0.0.1:80/control/telemetry/zoom/area/Server1/DeviceIpint.24/TelemetryControl.0?x=0.23&y=0.089&w=0.25&h=0.25&session_id=1

Auto focus and iris

GET http://IPaddress:port/prefix/control/telemetry/auto/{TELEMETRYCONTROLID} – auto focus/iris.

TELEMETRYCONTROLID – template from Get list of telemetry devices for specified video source.


ParameterRequiredDescription

degree

Yes

Focus or iris.

session_idYesSession id (see Acquire telemetry control session).


Sample request:

GET http://127.0.0.1:80/control/telemetry/auto/Server1/DeviceIpint.24/TelemetryControl.0?degree=iris&session_id=1