Add mjpeg warning (#24954)
CI / AMD64 Build (push) Canceled after 0s
CI / ARM Build (push) Canceled after 0s
CI / Jetson Jetpack 6 (push) Canceled after 0s
CI / AMD64 Extra Build (push) Canceled after 0s
CI / ARM Extra Build (push) Canceled after 0s
CI / Synaptics Build (push) Canceled after 0s
CI / Assemble and push default build (push) Canceled after 0s

This commit is contained in:
Nicolas Mowen
2026-11-12 11:41:09 -07:00
committed by GitHub
parent 2d25f9a8b5
commit cc94cbc2da
2 changed files with 17 additions and 2 deletions
+4 -1
View File
@@ -5374,6 +5374,10 @@ paths:
tags: tags:
- Media - Media
summary: Mjpeg Feed summary: Mjpeg Feed
description: |-
**Access:** Authenticated user with access to the referenced camera.
An MJPEG stream of the camera's latest processed frame, intended for debugging only. Every frame of every open stream is color converted, annotated, resized, and JPEG encoded in Frigate's main process, which adds load to the system and can slow down Frigate's processing. It is strictly not recommended to view this stream continuously, such as on a dashboard. For live viewing, use a go2rtc restream instead. The frame rate and resolution can be raised with the fps and height parameters, for example ?fps=10&height=1080, at the cost of additional load.
operationId: mjpeg_feed__camera_name__get operationId: mjpeg_feed__camera_name__get
parameters: parameters:
- name: camera_name - name: camera_name
@@ -5461,7 +5465,6 @@ paths:
security: security:
- frigateUserAuth: [] - frigateUserAuth: []
x-required-role: camera x-required-role: camera
description: '**Access:** Authenticated user with access to the referenced camera.'
/{camera_name}/ptz/info: /{camera_name}/ptz/info:
get: get:
tags: tags:
+13 -1
View File
@@ -74,7 +74,19 @@ def _resolve_cache_age(max_cache_age: int) -> int:
return max_cache_age.default return max_cache_age.default
@router.get("/{camera_name}", dependencies=[Depends(require_camera_access)]) @router.get(
"/{camera_name}",
dependencies=[Depends(require_camera_access)],
description=(
"An MJPEG stream of the camera's latest processed frame, intended for debugging only. "
"Every frame of every open stream is color converted, annotated, resized, and JPEG "
"encoded in Frigate's main process, which adds load to the system and can slow down "
"Frigate's processing. It is strictly not recommended to view this stream "
"continuously, such as on a dashboard. For live viewing, use a go2rtc restream "
"instead. The frame rate and resolution can be raised with the fps and height "
"parameters, for example ?fps=10&height=1080, at the cost of additional load."
),
)
async def mjpeg_feed( async def mjpeg_feed(
request: Request, request: Request,
camera_name: str, camera_name: str,