From d243ccf87966d7b2e7e700e091cd8e704b9c8fcc Mon Sep 17 00:00:00 2001 From: Shea Smith <51303984+SheaSmith@users.noreply.github.com> Date: Sat, 27 Nov 2021 03:28:36 +0000 Subject: [PATCH] Add API documentation for PTZ commands --- docs/docs/integrations/api.md | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) diff --git a/docs/docs/integrations/api.md b/docs/docs/integrations/api.md index 69b6e7632..7cf3bc522 100644 --- a/docs/docs/integrations/api.md +++ b/docs/docs/integrations/api.md @@ -229,3 +229,23 @@ HTTP Live Streaming Video on Demand URL for the specified event. Can be viewed i ### `GET /vod//start//end//index.m3u8` HTTP Live Streaming Video on Demand URL for the camera with the specified time range. Can be viewed in an application like VLC. + +### `GET /api//ptz/move` + +If PTZ support is enabled for this particular camera, then you can use add `?direction=` and one of `left`, `right`, `up`, or `down` to move the camera. A 404 error will be returned for a camera which doesn't have ONVIF setup. + +### `GET /api//zoom` + +If PTZ support is enabled for this camera, then you can set `?zoomIn=` to either `0` or `1` to zoom in or out the camera respectively. + +### `GET /api//stop` + +Stops any PTZ movements that are currently happening. + +### `GET /api//sethome` + +Sets the 'home' location of this camera to the current location. + +### `GET /api//gotohome` + +Moves the camera to the preset 'home' location.