blob: 3858c69496a5ec31be8f338eec11a81ef06a7f1e [file] [log] [blame]
Mauro Carvalho Chehab47d23e32016-07-05 10:37:31 -03001.. -*- coding: utf-8; mode: rst -*-
2
3.. _VIDEO_SET_BLANK:
4
Mauro Carvalho Chehab586027c2016-07-05 07:58:48 -03005===============
Mauro Carvalho Chehab47d23e32016-07-05 10:37:31 -03006VIDEO_SET_BLANK
7===============
8
Mauro Carvalho Chehab15e7d612016-07-05 15:14:35 -03009Name
Mauro Carvalho Chehab586027c2016-07-05 07:58:48 -030010----
Mauro Carvalho Chehab47d23e32016-07-05 10:37:31 -030011
Mauro Carvalho Chehab586027c2016-07-05 07:58:48 -030012VIDEO_SET_BLANK
Mauro Carvalho Chehab47d23e32016-07-05 10:37:31 -030013
Mauro Carvalho Chehabcf8076c2016-08-19 16:56:15 -030014.. attention:: This ioctl is deprecated.
Mauro Carvalho Chehab15e7d612016-07-05 15:14:35 -030015
16Synopsis
Mauro Carvalho Chehab47d23e32016-07-05 10:37:31 -030017--------
18
Mauro Carvalho Chehabcf8076c2016-08-19 16:56:15 -030019.. c:function:: int ioctl(fd, VIDEO_SET_BLANK, boolean mode)
20 :name: VIDEO_SET_BLANK
Mauro Carvalho Chehab47d23e32016-07-05 10:37:31 -030021
Mauro Carvalho Chehab47d23e32016-07-05 10:37:31 -030022
Mauro Carvalho Chehab15e7d612016-07-05 15:14:35 -030023Arguments
Mauro Carvalho Chehab586027c2016-07-05 07:58:48 -030024---------
Mauro Carvalho Chehab47d23e32016-07-05 10:37:31 -030025
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
Mauro Carvalho Chehab15e7d612016-07-05 15:14:35 -030055Description
Mauro Carvalho Chehab586027c2016-07-05 07:58:48 -030056-----------
57
58This ioctl call asks the Video Device to blank out the picture.
59
60
Mauro Carvalho Chehab15e7d612016-07-05 15:14:35 -030061Return Value
Mauro Carvalho Chehab47d23e32016-07-05 10:37:31 -030062------------
63
64On success 0 is returned, on error -1 and the ``errno`` variable is set
65appropriately. The generic error codes are described at the
66:ref:`Generic Error Codes <gen-errors>` chapter.