addPresetFromCurrentVideoCapturer

TrueConfAbout 2 min

addPresetFromCurrentVideoCapturer

Description: Save the current video capture device and its property settings as a separate preset. v4.2.0+

Request example:

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

Response example:

{
    "method": "addPresetFromCurrentVideoCapturer",
    "requestId" : "1",
    "videoCapturerName": "USB Video Device",
    "presetId": "1667476138528",
    "isMuted": false,
    "comPort": "",
    "pan": {
        "isPresent": true,
        "value": 9
    },
    "tilt": {
        "isPresent": true,
        "value": -9
    },
    "zoom": {
        "isPresent": true,
        "value": 5
    },
    "preview": {
        "isPresent": true
    },
    "result": true
}

Parameter description:

  • presetId - the identifier of the created preset
  • isMuted — the flag indicating if the video capture device is turned on or off
  • 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.
  • requestId - a unique request identifier. You can find more details about it here.

See also: