addVideoCapturerPreset

TrueConfAbout 2 min

addVideoCapturerPreset

Description: Add a video capture device preset with the specified parameters. v4.2.0+

Request example:

{
    "method": "addVideoCapturerPreset",
    "requestId" : "1",
    "videoCapturerName": "USB Video Device",
    "isMuted": false,
    "comPort": "",
    "pan": {
        "isPresent": false
    },
    "tilt": {
        "isPresent": true,
        "value": 666
    },
    "zoom": {
        "isPresent": true,
        "value": 666
    },
    "preview": {
        "isPresent": true,
        "value": "base64ImageSource"
    }
}

Response example:

{
    "method": "addVideoCapturerPreset",
    "requestId" : "1",
    "presetId": "1667483891701",
    "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 controlling the PTZ camera. If left empty, the COM port will not be used.
  • 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. If the isPresent field is included, the value field must contain the jpeg image source in BASE64 format.
  • videoCapturerName - the unique name of the video capture device
  • isPresent - a flag indicating the presence of a property in the preset
  • value - property values. The field must be present if isPresent is true.
  • requestId - a unique request identifier. You can find more details about it here.

See also: