Skip to content

Commit

Permalink
Add api docs for export
Browse files Browse the repository at this point in the history
  • Loading branch information
NickM-27 committed May 28, 2023
1 parent 9734eae commit af94b23
Showing 1 changed file with 14 additions and 0 deletions.
14 changes: 14 additions & 0 deletions docs/docs/integrations/api.md
Original file line number Diff line number Diff line change
Expand Up @@ -271,6 +271,20 @@ HTTP Live Streaming Video on Demand URL for the specified event. Can be viewed i

HTTP Live Streaming Video on Demand URL for the camera with the specified time range. Can be viewed in an application like VLC.

### `POST /api/export/<camera>/start/<start-timestamp>/end/<end-timestamp>`

Export recordings from `start-timestamp` to `end-timestamp` for `camera` as a single mp4 file. These recordings will be exported to the `/media/frigate/exports` folder.

It is also possible to export this recording as a timelapse.

**Optional Body:**

```json
{
"playback": "realtime", // playback factor: realtime or timelapse_25x
}
```

### `GET /api/<camera_name>/recordings/summary`

Hourly summary of recordings data for a camera.
Expand Down

0 comments on commit af94b23

Please sign in to comment.