summaryrefslogtreecommitdiff
path: root/Documentation/linux_tv/media/dvb/video-freeze.rst
diff options
context:
space:
mode:
Diffstat (limited to 'Documentation/linux_tv/media/dvb/video-freeze.rst')
-rw-r--r--Documentation/linux_tv/media/dvb/video-freeze.rst40
1 files changed, 22 insertions, 18 deletions
diff --git a/Documentation/linux_tv/media/dvb/video-freeze.rst b/Documentation/linux_tv/media/dvb/video-freeze.rst
index d384e329b661..8fbc7835382c 100644
--- a/Documentation/linux_tv/media/dvb/video-freeze.rst
+++ b/Documentation/linux_tv/media/dvb/video-freeze.rst
@@ -2,31 +2,23 @@
.. _VIDEO_FREEZE:
+============
VIDEO_FREEZE
============
-Description
------------
+NAME
+----
-This ioctl is for DVB devices only. To control a V4L2 decoder use the
-V4L2 :ref:`VIDIOC_DECODER_CMD` instead.
-
-This ioctl call suspends the live video stream being played. Decoding
-and playing are frozen. It is then possible to restart the decoding and
-playing process of the video stream using the VIDEO_CONTINUE command.
-If VIDEO_SOURCE_MEMORY is selected in the ioctl call
-VIDEO_SELECT_SOURCE, the DVB subsystem will not decode any more data
-until the ioctl call VIDEO_CONTINUE or VIDEO_PLAY is performed.
+VIDEO_FREEZE
-Synopsis
+SYNOPSIS
--------
.. c:function:: int ioctl(fd, int request = VIDEO_FREEZE)
-Arguments
-----------
-
+ARGUMENTS
+---------
.. flat-table::
:header-rows: 0
@@ -46,11 +38,23 @@ Arguments
- Equals VIDEO_FREEZE for this command.
-Return Value
+DESCRIPTION
+-----------
+
+This ioctl is for DVB devices only. To control a V4L2 decoder use the
+V4L2 :ref:`VIDIOC_DECODER_CMD` instead.
+
+This ioctl call suspends the live video stream being played. Decoding
+and playing are frozen. It is then possible to restart the decoding and
+playing process of the video stream using the VIDEO_CONTINUE command.
+If VIDEO_SOURCE_MEMORY is selected in the ioctl call
+VIDEO_SELECT_SOURCE, the DVB subsystem will not decode any more data
+until the ioctl call VIDEO_CONTINUE or VIDEO_PLAY is performed.
+
+
+RETURN VALUE
------------
On success 0 is returned, on error -1 and the ``errno`` variable is set
appropriately. The generic error codes are described at the
:ref:`Generic Error Codes <gen-errors>` chapter.
-
-