From 4cc8546008cb273610cd3b542d232e547aa9e1ff Mon Sep 17 00:00:00 2001 From: JxxIT <110342008+JxxIT@users.noreply.github.com> Date: Fri, 5 Jul 2024 12:13:58 +0200 Subject: [PATCH] Document stream endpoint --- docs/REST-API.md | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/docs/REST-API.md b/docs/REST-API.md index 420a25c..1f7760e 100644 --- a/docs/REST-API.md +++ b/docs/REST-API.md @@ -113,6 +113,16 @@ Note: For more detailed information to the REST handler, have a look to the code ### capture_with_flashlight Capture a new image with flashlight +### stream + Stream a live video of the camera. + + It has a slow refresh rate of only 2 FPS to avoid stressing the system. Flow processing continues to work in the background, albeit possibly a bit slower. + + When the `flashlight` parameter is set, it turns on the flaslight. Both `http:///stream?flashlight=true` and `http:///stream?flashlight` turn on the flashlight. + + **LIMITATION:** To avoid using extra memory, no additional dedicated stream webserver is implemented for this feature (instead, the web interface server is reused in a kind of "blocking way"). This means that either the web interface is fully functional or the stream is active, but not both at the same time. However, this is sufficient for the intended use case. + + ### save Save a new image to SD card - The `save` entrypoint also support parameters: @@ -135,4 +145,4 @@ Note: For more detailed information to the REST handler, have a look to the code ## Prometheus/OpenMetrics ### metrics - Provides a set of metrics that can be scraped by prometheus. See [Prometheus/OpenMetrics](../prometheus-openmetrics) for details. \ No newline at end of file + Provides a set of metrics that can be scraped by prometheus. See [Prometheus/OpenMetrics](../prometheus-openmetrics) for details.