Documentation/userspace-api/media/dvb/video-set-blank.rst

   1 .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
   2 .. c:namespace:: DTV.video
   3
   4 .. _VIDEO_SET_BLANK:
   5
   6 ===============
   7 VIDEO_SET_BLANK
   8 ===============
   9
  10 Name
  11 ----
  12
  13 VIDEO_SET_BLANK
  14
  15 .. attention:: This ioctl is deprecated.
  16
  17 Synopsis
  18 --------
  19
  20 .. c:macro:: VIDEO_SET_BLANK
  21
  22 ``int ioctl(fd, VIDEO_SET_BLANK, boolean mode)``
  23
  24 Arguments
  25 ---------
  26
  27 .. flat-table::
  28     :header-rows:  0
  29     :stub-columns: 0
  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 Description
  55 -----------
  56
  57 This ioctl call asks the Video Device to blank out the picture.
  58
  59 Return Value
  60 ------------
  61
  62 On success 0 is returned, on error -1 and the ``errno`` variable is set
  63 appropriately. The generic error codes are described at the
  64 :ref:`Generic Error Codes <gen-errors>` chapter.