diff options
author | Hans Verkuil <hans.verkuil@cisco.com> | 2012-09-03 08:21:59 -0400 |
---|---|---|
committer | Mauro Carvalho Chehab <mchehab@redhat.com> | 2012-09-26 08:26:57 -0400 |
commit | 6bd4dd27f926519527b9c39709df13ad120d63f9 (patch) | |
tree | 9b9f6c0fdf68097c6b63dbcfb023d29c72ae349d | |
parent | 8e19b3475072682312de71f4dddf6d4f4081e143 (diff) |
[media] DocBook: improve STREAMON/OFF documentation
Specify that STREAMON/OFF should return 0 if the stream is already
started/stopped.
The spec never specified what the correct behavior is. This ambiguity
was resolved during the 2012 Media Workshop.
Signed-off-by: Hans Verkuil <hans.verkuil@cisco.com>
Reviewed-by: Sylwester Nawrocki <s.nawrocki@samsung.com>
Acked-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
Acked-by: Sakari Ailus <sakari.ailus@iki.fi>
Signed-off-by: Mauro Carvalho Chehab <mchehab@redhat.com>
-rw-r--r-- | Documentation/DocBook/media/v4l/vidioc-streamon.xml | 7 |
1 files changed, 6 insertions, 1 deletions
diff --git a/Documentation/DocBook/media/v4l/vidioc-streamon.xml b/Documentation/DocBook/media/v4l/vidioc-streamon.xml index 81cca4569050..716ea15e54a1 100644 --- a/Documentation/DocBook/media/v4l/vidioc-streamon.xml +++ b/Documentation/DocBook/media/v4l/vidioc-streamon.xml | |||
@@ -74,7 +74,12 @@ not transmitted yet. I/O returns to the same state as after calling | |||
74 | stream type. This is the same as &v4l2-requestbuffers; | 74 | stream type. This is the same as &v4l2-requestbuffers; |
75 | <structfield>type</structfield>.</para> | 75 | <structfield>type</structfield>.</para> |
76 | 76 | ||
77 | <para>Note applications can be preempted for unknown periods right | 77 | <para>If <constant>VIDIOC_STREAMON</constant> is called when streaming |
78 | is already in progress, or if <constant>VIDIOC_STREAMOFF</constant> is called | ||
79 | when streaming is already stopped, then the ioctl does nothing and 0 is | ||
80 | returned.</para> | ||
81 | |||
82 | <para>Note that applications can be preempted for unknown periods right | ||
78 | before or after the <constant>VIDIOC_STREAMON</constant> or | 83 | before or after the <constant>VIDIOC_STREAMON</constant> or |
79 | <constant>VIDIOC_STREAMOFF</constant> calls, there is no notion of | 84 | <constant>VIDIOC_STREAMOFF</constant> calls, there is no notion of |
80 | starting or stopping "now". Buffer timestamps can be used to | 85 | starting or stopping "now". Buffer timestamps can be used to |