TrueConf VideoSDK Guide

# addVideoCapturerPreset

Version: 4.2.0+

Description: add a preset for video capture device with specified parameters.

Request example:

{
    "method": "addVideoCapturerPreset",
    "requestId" : "1",
    "videoCapturerName": "USB Video Device",
    "videoCapturerDescription": "\\\\?\\usb#vid_046d&pid_0823&mi_02#6&1fd43445&0&0002#{65e8773d-8f56-11d0-a3b9-00a0c9223196}\\global",
    "isMuted": false,
    "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 - identifier of the created preset
  • isMuted — the flag indicating if the video capture device is turned on or off
  • pan - property for rotating the video capture device
  • tilt - property of the tilt angle of the video capture device
  • zoom - the zoom property of the video capture device.
  • preview - preset preview. If the isPresent field is present, the value field should contain the source jpeg image in BASE64 format.
  • videoCapturerName — the name of the current video capture device
  • videoCapturerDescription — the unique identifier of the current video capture device
  • isPresent - a flag indicating the presence of a property in the preset
  • value - property value. This field must be present if isPresent is equal to true
  • requestId - unique request identifier. More details can be found here

See also: