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
  15 Synopsis
  16 --------
  17
  18 .. cpp:function:: int ioctl(fd, int request = VIDEO_STOP, boolean mode)
  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_STOP for this command.
  40
  41     -  .. row 3
  42
  43        -  Boolean mode
  44
  45        -  Indicates how the screen shall be handled.
  46
  47     -  .. row 4
  48
  49        -
  50        -  TRUE: Blank screen when stop.
  51
  52     -  .. row 5
  53
  54        -
  55        -  FALSE: Show last decoded frame.
  56
  57
  58 Description
  59 -----------
  60
  61 This ioctl is for DVB devices only. To control a V4L2 decoder use the
  62 V4L2 :ref:`VIDIOC_DECODER_CMD` instead.
  63
  64 This ioctl call asks the Video Device to stop playing the current
  65 stream. Depending on the input parameter, the screen can be blanked out
  66 or displaying the last decoded frame.
  67
  68
  69 Return Value
  70 ------------
  71
  72 On success 0 is returned, on error -1 and the ``errno`` variable is set
  73 appropriately. The generic error codes are described at the
  74 :ref:`Generic Error Codes <gen-errors>` chapter.