Documentation/media/uapi/dvb/video-set-blank.rst

   1 .. -*- coding: utf-8; mode: rst -*-
   2
   3 .. _VIDEO_SET_BLANK:
   4
   5 ===============
   6 VIDEO_SET_BLANK
   7 ===============
   8
   9 Name
  10 ----
  11
  12 VIDEO_SET_BLANK
  13
  14 .. attention:: This ioctl is deprecated.
  15
  16 Synopsis
  17 --------
  18
  19 .. c:function:: int ioctl(fd, VIDEO_SET_BLANK, boolean mode)
  20     :name: VIDEO_SET_BLANK
  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_SET_BLANK for this command.
  42
  43     -  .. row 3
  44
  45        -  boolean mode
  46
  47        -  TRUE: Blank screen when stop.
  48
  49     -  .. row 4
  50
  51        -
  52        -  FALSE: Show last decoded frame.
  53
  54
  55 Description
  56 -----------
  57
  58 This ioctl call asks the Video Device to blank out the picture.
  59
  60
  61 Return Value
  62 ------------
  63
  64 On success 0 is returned, on error -1 and the ``errno`` variable is set
  65 appropriately. The generic error codes are described at the
  66 :ref:`Generic Error Codes <gen-errors>` chapter.