getPtzControls

TrueConfAbout 2 min

getPtzControls

Description: obtain information about the capability to control the PTZ camera TrueConf Room API.

Request example:

{
    "method" : "getPtzControls",
    "requestId" : "1"
}

Response example:

{
    "method": "getPtzControls",
    "requestId" : "1",
    "pan": {
        "isContinuousType": false,
        "support": true,
        "minValue": -10,
        "maxValue": 10,
        "currentValue": 0,
        "defValue": 0,
        "step": 1,
        "inverted" : false
    },
    "tilt": {
        "support": false
    },
    "zoom": {
        "isContinuousType": false,
        "support": true,
        "minValue": 1,
        "maxValue": 5,
        "currentValue": 1,
        "defValue": 1,
        "step": 4,
        "inverted" : false
    },
    "videoCapturerName": "USB Video Device",
    "videoCapturerDescription": "\\\\?\\usb#vid_046d&pid_0823&mi_02#6&1fd43445&0&0002#{65e8773d-8f56-11d0-a3b9-00a0c9223196}\\global",
    "result": true
}

Parameter description:

  • pan — detailed information about the “pan” property of the PTZ camera

  • tilt — detailed information about the “tilt” property of the PTZ camera

  • zoom — detailed information about the “zoom” property of the PTZ camera.

  • support — the flag indicating if the property is available

  • minValue— the minimum value of a property. The field is included if support is equal to true

  • maxValue — the maximum value of a property. The field is included if support is equal to true

  • currentValue— the current value of a property. The field is included if support is equal to true

  • defValue — the default value. The field is included if support is equal to true

  • videoCapturerName - unique name of the current video capture device

  • videoCapturerDescription — the unique identifier of the current video capture device

  • step — the rate of property change. The field is included if support is equal to true

  • isContinuousType — the flag indicating if the value of a property can change continuously

  • inverted - a flag indicating the inversion of a property

  • requestId - a unique request identifier. You can find more details about it here.

See also: