getAllVideoCapturerPresets

TrueConfAbout 2 min

getAllVideoCapturerPresets

Description: Retrieve a list of all video capture device presets. v4.2.0+

Request example:

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

Response example:

{
    "method": "getAllVideoCapturerPresets",
    "requestId" : "1",
    "presets": [
        {
            "videoCapturerName": "USB Video Device",
            "presetId": "1667476590422",
            "comPort": "",
            "pan": {
                "isPresent": true,
                "value": 9
            },
            "tilt": {
                "isPresent": true,
                "value": -9
            },
            "zoom": {
                "isPresent": true,
                "value": 1
            },
            "preview": {
                "isPresent": true
            },
        }
    ],
    "result": true
}

Parameter description:

  • presetId - the identifier of the created preset
  • comPort - the selected COM port for PTZ camera control. If the COM port is not used, the field will contain an empty string.
  • pan - the property for adjusting the rotation of the video capture device
  • tilt - the tilt property of the video capture device
  • zoom - video capture device zoom property
  • preview - preset preview
  • videoCapturerName - the unique name of the video capture device
  • isPresent - a flag indicating the presence of a property in the preset
  • value - the property values. This field is absent if isPresent is false.
  • presets - list of presets
  • requestId - a unique request identifier. You can find more details about it here.

See also: