From f4c3701342f584950b00f11f8e69c5b5a6775357 Mon Sep 17 00:00:00 2001 From: JC Date: Tue, 8 Oct 2024 18:58:16 +0100 Subject: [PATCH 1/2] Add (optional) export name to the create-export API endpoint docs --- docs/docs/integrations/api.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/docs/docs/integrations/api.md b/docs/docs/integrations/api.md index 0c48c0c82c..413217b306 100644 --- a/docs/docs/integrations/api.md +++ b/docs/docs/integrations/api.md @@ -415,13 +415,14 @@ HTTP Live Streaming Video on Demand URL for the camera with the specified time r 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 time-lapse. +It is also possible to export this recording as a time-lapse using the "playback" key in the json body, or specify a custom export filename, using the "name" key. **Optional Body:** ```json { - "playback": "realtime" // playback factor: realtime or timelapse_25x + "playback": "realtime", // playback factor: realtime or timelapse_25x + "name": "custom export name" // override the default export filename with a custom name } ``` From 83d64a9eb19ecdb4e706962d6a50b5192b71ff46 Mon Sep 17 00:00:00 2001 From: JC Date: Tue, 8 Oct 2024 18:58:28 +0100 Subject: [PATCH 2/2] Add the exports list endpoint to the docs --- docs/docs/integrations/api.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/docs/docs/integrations/api.md b/docs/docs/integrations/api.md index 413217b306..f0a8448880 100644 --- a/docs/docs/integrations/api.md +++ b/docs/docs/integrations/api.md @@ -411,6 +411,25 @@ 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. +### `GET /api/exports` + +Fetch a list of all export recordings + +Sample response: +```json +[ + { + "camera": "doorbell", + "date": 12800057, + "id": "doorbell_pjis54", + "in_progress": false, + "name": "2024-10-04 fox visit", + "thumb_path": "/media/frigate/clips/export/doorbell_pjis54.webp", + "video_path": "/media/frigate/exports/doorbell_pjis54.mp4" + } +] +``` + ### `POST /api/export//start//end/` 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.