Merge tag 'lkdtm-v4.8-rc1' of git://git.kernel.org/pub/scm/linux/kernel/git/kees...
[cascardo/linux.git] / 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
15 Synopsis
16 --------
17
18 .. cpp:function:: int ioctl(fd, int request = VIDEO_SET_BLANK, 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_SET_BLANK for this command.
40
41     -  .. row 3
42
43        -  boolean mode
44
45        -  TRUE: Blank screen when stop.
46
47     -  .. row 4
48
49        -
50        -  FALSE: Show last decoded frame.
51
52
53 Description
54 -----------
55
56 This ioctl call asks the Video Device to blank out the picture.
57
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.