Skip to content

Commit e7d5e69

Browse files
Docstring for capture_array()
Co-authored-by: Julian Stirling <julian@julianstirling.co.uk>
1 parent fba444e commit e7d5e69

File tree

1 file changed

+2
-1
lines changed

1 file changed

+2
-1
lines changed

src/labthings_picamera2/thing.py

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -537,7 +537,8 @@ def capture_array(
537537
It's likely to be highly inefficient - raw and/or uncompressed captures using
538538
binary image formats will be added in due course.
539539
540-
wait: float to pass to picamera as a timeout, raising an error if it is exceeded (seconds)
540+
stream_name: (Optional) The PiCamera2 stream to use, should be one of ["main", "lores", "raw"]. Default = "main"
541+
wait: (Optional, float) Set a timeout in seconds. A TimeoutError is raised if this time is exceeded during capture. Default = None
541542
"""
542543
with self.picamera() as cam:
543544
return cam.capture_array(stream_name, wait = wait)

0 commit comments

Comments
 (0)