Skip to content

Commit acef932

Browse files
committed
doc: better clarify supported image formats
1 parent e56edf1 commit acef932

File tree

1 file changed

+10
-3
lines changed

1 file changed

+10
-3
lines changed

src/arduino/app_peripherals/camera/websocket_camera.py

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -29,10 +29,17 @@ class WebSocketCamera(BaseCamera):
2929
This camera acts as a WebSocket server that receives frames from connected clients.
3030
Only one client can be connected at a time.
3131
32-
Clients can send frames in various 8-bit (e.g. JPEG, PNG 8-bit) formats:
32+
Clients must encode video frames in one of these formats:
33+
- JPEG
34+
- PNG
35+
- WebP
36+
- BMP
37+
- TIFF
38+
39+
The frames can be serialized in one of the following formats:
40+
- Binary image data
3341
- Base64 encoded images
3442
- JSON messages with image data
35-
- Binary image data
3643
"""
3744

3845
def __init__(
@@ -52,7 +59,7 @@ def __init__(
5259
host (str): Host address to bind the server to (default: "0.0.0.0")
5360
port (int): Port to bind the server to (default: 8080)
5461
timeout (int): Connection timeout in seconds (default: 10)
55-
frame_format (str): Expected frame format from clients ("base64", "json", "binary") (default: "binary")
62+
frame_format (str): Expected frame format from clients ("binary", "base64", "json") (default: "binary")
5663
resolution (tuple, optional): Resolution as (width, height). None uses default resolution.
5764
fps (int): Frames per second to capture from the camera.
5865
adjustments (callable, optional): Function or function pipeline to adjust frames that takes

0 commit comments

Comments
 (0)