administrator/frigate
1
0
Fork 0
mirror of https://github.com/blakeblackshear/frigate.git synced 2026-02-02 01:05:20 +03:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

Add API documentation for PTZ commands

Browse Source
This commit is contained in:
Shea Smith 2021-11-27 03:28:36 +00:00
parent e2a776556d
commit d243ccf879
1 changed files with 20 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
docs/docs/integrations/api.md
View File

@ -229,3 +229,23 @@ HTTP Live Streaming Video on Demand URL for the specified event. Can be viewed i
### `GET /vod/<camera>/start/<start-timestamp>/end/<end-timestamp>/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/<camera>/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/<camera>/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/<camera>/stop`
Stops any PTZ movements that are currently happening.
### `GET /api/<camera>/sethome`
Sets the 'home' location of this camera to the current location.
### `GET /api/<camera>/gotohome`
Moves the camera to the preset 'home' location.