Linux 4.8.3
[linux/fpc-iii.git] / Documentation / media / uapi / dvb / video-set-blank.rst
blob142ea8817380ceee99bdec426f52b08d59e9d8c6
1 .. -*- coding: utf-8; mode: rst -*-
3 .. _VIDEO_SET_BLANK:
5 ===============
6 VIDEO_SET_BLANK
7 ===============
9 Name
10 ----
12 VIDEO_SET_BLANK
15 Synopsis
16 --------
18 .. cpp:function:: int ioctl(fd, int request = VIDEO_SET_BLANK, boolean mode)
21 Arguments
22 ---------
24 .. flat-table::
25     :header-rows:  0
26     :stub-columns: 0
29     -  .. row 1
31        -  int fd
33        -  File descriptor returned by a previous call to open().
35     -  .. row 2
37        -  int request
39        -  Equals VIDEO_SET_BLANK for this command.
41     -  .. row 3
43        -  boolean mode
45        -  TRUE: Blank screen when stop.
47     -  .. row 4
49        -
50        -  FALSE: Show last decoded frame.
53 Description
54 -----------
56 This ioctl call asks the Video Device to blank out the picture.
59 Return Value
60 ------------
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.