aboutsummaryrefslogtreecommitdiff
path: root/Documentation/DocBook/media/v4l/vidioc-encoder-cmd.xml
diff options
context:
space:
mode:
authorHans Verkuil <hans.verkuil@cisco.com>2011-11-24 09:55:53 -0300
committerMauro Carvalho Chehab <mchehab@redhat.com>2012-02-14 13:42:34 -0200
commit6b4f12523db46536c750473abdd380763cb0409b (patch)
tree5ef2e19da577e29256c77a55141f50df2f6511ba /Documentation/DocBook/media/v4l/vidioc-encoder-cmd.xml
parenta45c0ad51d344dad18c6fb67304b4f87cf0ffd59 (diff)
[media] v4l spec: document VIDIOC_(TRY_)DECODER_CMD
Signed-off-by: Hans Verkuil <hans.verkuil@cisco.com> Signed-off-by: Mauro Carvalho Chehab <mchehab@redhat.com>
Diffstat (limited to 'Documentation/DocBook/media/v4l/vidioc-encoder-cmd.xml')
-rw-r--r--Documentation/DocBook/media/v4l/vidioc-encoder-cmd.xml9
1 files changed, 5 insertions, 4 deletions
diff --git a/Documentation/DocBook/media/v4l/vidioc-encoder-cmd.xml b/Documentation/DocBook/media/v4l/vidioc-encoder-cmd.xml
index af7f3f2a36d..f431b3ba79b 100644
--- a/Documentation/DocBook/media/v4l/vidioc-encoder-cmd.xml
+++ b/Documentation/DocBook/media/v4l/vidioc-encoder-cmd.xml
@@ -74,15 +74,16 @@ only used by the STOP command and contains one bit: If the
encoding will continue until the end of the current <wordasword>Group
Of Pictures</wordasword>, otherwise it will stop immediately.</para>
- <para>A <function>read</function>() call sends a START command to
-the encoder if it has not been started yet. After a STOP command,
+ <para>A <function>read</function>() or &VIDIOC-STREAMON; call sends an implicit
+START command to the encoder if it has not been started yet. After a STOP command,
<function>read</function>() calls will read the remaining data
buffered by the driver. When the buffer is empty,
<function>read</function>() will return zero and the next
<function>read</function>() call will restart the encoder.</para>
- <para>A <function>close</function>() call sends an immediate STOP
-to the encoder, and all buffered data is discarded.</para>
+ <para>A <function>close</function>() or &VIDIOC-STREAMOFF; call of a streaming
+file descriptor sends an implicit immediate STOP to the encoder, and all buffered
+data is discarded.</para>
<para>These ioctls are optional, not all drivers may support
them. They were introduced in Linux 2.6.21.</para>