Skip to content

Commit a3fa0c4

Browse files
Update start_streaming docstring
Co-authored-by: Julian Stirling <[email protected]>
1 parent 0b04db8 commit a3fa0c4

File tree

1 file changed

+12
-8
lines changed

1 file changed

+12
-8
lines changed

src/labthings_picamera2/thing.py

Lines changed: 12 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -452,14 +452,18 @@ def start_streaming(self, main_resolution: tuple[int, int] = (820, 616)) -> None
452452
"""
453453
Start the MJPEG stream
454454
455-
Sets the camera resolutions based on input parameters, and sets the low-res resolution to (320, 240)
456-
((320, 240) is a standard from the Pi Camera manual)
457-
458-
Create two streams, `lores_mjpeg_stream` for autofocus at low-res resolution, and `mjpeg_stream` for preview.
459-
This is the `main_resolution` if this is less than (1280, 960), or the low-res resolution if above.
460-
This allows for high resolution capture without streaming high resolution video.
461-
462-
main_resolution: the resolution for the main configuration. Defaults to (820, 616), 1/4 sensor size
455+
Sets the camera resolutions based on input parameters, and sets the low-res
456+
resolution to (320, 240). Note: (320, 240) is a standard from the Pi Camera
457+
manual.
458+
459+
Create two streams:
460+
- `lores_mjpeg_stream` for autofocus at low-res resolution
461+
- `mjpeg_stream` for preview. This is the `main_resolution` if this is less
462+
than (1280, 960), or the low-res resolution if above. This allows for
463+
high resolution capture without streaming high resolution video.
464+
465+
main_resolution: the resolution for the main configuration. Defaults to
466+
(820, 616), 1/4 sensor size.
463467
"""
464468
with self.picamera() as picam:
465469
# TODO: Filip: can we use the lores output to keep preview stream going

0 commit comments

Comments
 (0)