# addVideoCapturerPreset
Version: 4.2.0+
Description: add a video capture device preset with the specified parameters.
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
- identifier of the created presetisMuted
— the flag indicating if the video capture device is turned on or offcomPort
- the selected COM port for controlling the PTZ camera. If set to an empty string, the COM port will not be used.pan
- the pan property of the video capture devicetilt
- video capture device tilt propertyzoom
- zoom property of the video capture devicepreview
- preview of the preset. If theisPresent
field is present, thevalue
field should contain the source of the JPEG image in BASE64 format.videoCapturerName
- unique name of the video capture deviceisPresent
- a flag indicating the presence of a property in the presetvalue
- property values. The field must be present ifisPresent
is equal totrue
requestId
- a unique request identifier. You can learn more about it here.
See also:
- getPtzControls
- ptzZoomInc
- ptzZoomDec
- ptzUp
- ptzDown
- ptzStop
- ptzRight
- ptzLeft
- setPanPos
- setTiltPos
- setZoomPos
- setPtzDefaults
- addPresetFromCurrentVideoCapturer
- getAllVideoCapturerPresets
- updateVideoCapturerPreset
- applyVideoCapturerPreset
- removeVideoCapturerPreset
- updatePresetFromCurrentVideoCapturer
- videoCapturerPresetRemoved
- videoCapturerPresetAdded
- videoCapturerPresetUpdated
- videoCapturerPresetApplied
- ptzControlsChanged