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

   1 .. -*- coding: utf-8; mode: rst -*-
   2
   3 .. _VIDEO_STOP:
   4
   5 ==========
   6 VIDEO_STOP
   7 ==========
   8
   9 Name
  10 ----
  11
  12 VIDEO_STOP
  13
  14 .. attention:: This ioctl is deprecated.
  15
  16 Synopsis
  17 --------
  18
  19 .. c:function:: int ioctl(fd, VIDEO_STOP, boolean mode)
  20     :name: VIDEO_STOP
  21
  22
  23 Arguments
  24 ---------
  25
  26 .. flat-table::
  27     :header-rows:  0
  28     :stub-columns: 0
  29
  30
  31     -  .. row 1
  32
  33        -  int fd
  34
  35        -  File descriptor returned by a previous call to open().
  36
  37     -  .. row 2
  38
  39        -  int request
  40
  41        -  Equals VIDEO_STOP for this command.
  42
  43     -  .. row 3
  44
  45        -  Boolean mode
  46
  47        -  Indicates how the screen shall be handled.
  48
  49     -  .. row 4
  50
  51        -
  52        -  TRUE: Blank screen when stop.
  53
  54     -  .. row 5
  55
  56        -
  57        -  FALSE: Show last decoded frame.
  58
  59
  60 Description
  61 -----------
  62
  63 This ioctl is for Digital TV devices only. To control a V4L2 decoder use the
  64 V4L2 :ref:`VIDIOC_DECODER_CMD` instead.
  65
  66 This ioctl call asks the Video Device to stop playing the current
  67 stream. Depending on the input parameter, the screen can be blanked out
  68 or displaying the last decoded frame.
  69
  70
  71 Return Value
  72 ------------
  73
  74 On success 0 is returned, on error -1 and the ``errno`` variable is set
  75 appropriately. The generic error codes are described at the
  76 :ref:`Generic Error Codes <gen-errors>` chapter.