summaryrefslogtreecommitdiffstats
path: root/Documentation/media/uapi/dvb/video-set-blank.rst
blob: 3858c69496a5ec31be8f338eec11a81ef06a7f1e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
.. -*- coding: utf-8; mode: rst -*-

.. _VIDEO_SET_BLANK:

===============
VIDEO_SET_BLANK
===============

Name
----

VIDEO_SET_BLANK

.. attention:: This ioctl is deprecated.

Synopsis
--------

.. c:function:: int ioctl(fd, VIDEO_SET_BLANK, boolean mode)
    :name: VIDEO_SET_BLANK


Arguments
---------

.. flat-table::
    :header-rows:  0
    :stub-columns: 0


    -  .. row 1

       -  int fd

       -  File descriptor returned by a previous call to open().

    -  .. row 2

       -  int request

       -  Equals VIDEO_SET_BLANK for this command.

    -  .. row 3

       -  boolean mode

       -  TRUE: Blank screen when stop.

    -  .. row 4

       -
       -  FALSE: Show last decoded frame.


Description
-----------

This ioctl call asks the Video Device to blank out the picture.


Return Value
------------

On success 0 is returned, on error -1 and the ``errno`` variable is set
appropriately. The generic error codes are described at the
:ref:`Generic Error Codes <gen-errors>` chapter.