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

   1 .. -*- coding: utf-8; mode: rst -*-
   2
   3 .. _VIDEO_FREEZE:
   4
   5 ============
   6 VIDEO_FREEZE
   7 ============
   8
   9 Name
  10 ----
  11
  12 VIDEO_FREEZE
  13
  14
  15 Synopsis
  16 --------
  17
  18 .. cpp:function:: int ioctl(fd, int request = VIDEO_FREEZE)
  19
  20
  21 Arguments
  22 ---------
  23
  24 .. flat-table::
  25     :header-rows:  0
  26     :stub-columns: 0
  27
  28
  29     -  .. row 1
  30
  31        -  int fd
  32
  33        -  File descriptor returned by a previous call to open().
  34
  35     -  .. row 2
  36
  37        -  int request
  38
  39        -  Equals VIDEO_FREEZE for this command.
  40
  41
  42 Description
  43 -----------
  44
  45 This ioctl is for DVB devices only. To control a V4L2 decoder use the
  46 V4L2 :ref:`VIDIOC_DECODER_CMD` instead.
  47
  48 This ioctl call suspends the live video stream being played. Decoding
  49 and playing are frozen. It is then possible to restart the decoding and
  50 playing process of the video stream using the VIDEO_CONTINUE command.
  51 If VIDEO_SOURCE_MEMORY is selected in the ioctl call
  52 VIDEO_SELECT_SOURCE, the DVB subsystem will not decode any more data
  53 until the ioctl call VIDEO_CONTINUE or VIDEO_PLAY is performed.
  54
  55
  56 Return Value
  57 ------------
  58
  59 On success 0 is returned, on error -1 and the ``errno`` variable is set
  60 appropriately. The generic error codes are described at the
  61 :ref:`Generic Error Codes <gen-errors>` chapter.