Skip to content

Commit cf3a28f

Browse files
committed
Update timeout parameter to include suffix descriptions
1 parent 9088335 commit cf3a28f

File tree

1 file changed

+12
-2
lines changed

1 file changed

+12
-2
lines changed

documentation/asciidoc/computers/camera/rpicam_options_common.adoc

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -89,9 +89,19 @@ Alias: `-t`
8989
9090
Default value: 5000 milliseconds (5 seconds)
9191
92-
Specify how long the application runs before closing. This applies to both video recording and preview windows. When capturing a still image, the application shows a preview window for `timeout` milliseconds before capturing the output image.
92+
Specify how long the application runs before closing. This value is interpreted as a number of milliseconds unless an optional suffix is used to change the unit. The suffix may be one of:
9393
94-
To run the application indefinitely, specify a value of `0`.
94+
* `min` - minutes
95+
* `s` or `sec` - seconds
96+
* `ms` - milliseconds (the default if no suffix used)
97+
* `us` - microseconds
98+
* `ns` - nanoseconds.
99+
100+
This time applies to both video recording and preview windows. When capturing a still image, the application shows a preview window for the length of time specified by the `timeout` parameter before capturing the output image.
101+
102+
To run the application indefinitely, specify a value of `0`. Floating point values are also permitted.
103+
104+
Example: `rpicam-hello -t 0.5min` would run for 30 seconds.
95105
96106
==== `preview`
97107

0 commit comments

Comments
 (0)