Documentation/media/uapi/dvb/video-freeze.rst

   1 .. Permission is granted to copy, distribute and/or modify this
   2 .. document under the terms of the GNU Free Documentation License,
   3 .. Version 1.1 or any later version published by the Free Software
   4 .. Foundation, with no Invariant Sections, no Front-Cover Texts
   5 .. and no Back-Cover Texts. A copy of the license is included at
   6 .. Documentation/media/uapi/fdl-appendix.rst.
   7 ..
   8 .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections
   9
  10 .. _VIDEO_FREEZE:
  11
  12 ============
  13 VIDEO_FREEZE
  14 ============
  15
  16 Name
  17 ----
  18
  19 VIDEO_FREEZE
  20
  21 .. attention:: This ioctl is deprecated.
  22
  23 Synopsis
  24 --------
  25
  26 .. c:function:: int ioctl(fd, VIDEO_FREEZE)
  27     :name: VIDEO_FREEZE
  28
  29
  30 Arguments
  31 ---------
  32
  33 .. flat-table::
  34     :header-rows:  0
  35     :stub-columns: 0
  36
  37
  38     -  .. row 1
  39
  40        -  int fd
  41
  42        -  File descriptor returned by a previous call to open().
  43
  44     -  .. row 2
  45
  46        -  int request
  47
  48        -  Equals VIDEO_FREEZE for this command.
  49
  50
  51 Description
  52 -----------
  53
  54 This ioctl is for Digital TV devices only. To control a V4L2 decoder use the
  55 V4L2 :ref:`VIDIOC_DECODER_CMD` instead.
  56
  57 This ioctl call suspends the live video stream being played. Decoding
  58 and playing are frozen. It is then possible to restart the decoding and
  59 playing process of the video stream using the VIDEO_CONTINUE command.
  60 If VIDEO_SOURCE_MEMORY is selected in the ioctl call
  61 VIDEO_SELECT_SOURCE, the Digital TV subsystem will not decode any more data
  62 until the ioctl call VIDEO_CONTINUE or VIDEO_PLAY is performed.
  63
  64
  65 Return Value
  66 ------------
  67
  68 On success 0 is returned, on error -1 and the ``errno`` variable is set
  69 appropriately. The generic error codes are described at the
  70 :ref:`Generic Error Codes <gen-errors>` chapter.