getPtzControls

TrueConf7/5/26About 2 min

getPtzControls

Description

Check if it is possible to control a PTZ camera of TrueConf VideoSDK

void getPtzControls()

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
}

Response Parameters

Name	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	The unique name 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
result	A flag indicating whether the request was successful

See also