Linux 4.11-rc6
[linux/fpc-iii.git] / Documentation / media / uapi / dvb / video-set-system.rst
blobe39cbe080ef7b56713ae0ff0bb399f017523c63a
1 .. -*- coding: utf-8; mode: rst -*-
3 .. _VIDEO_SET_SYSTEM:
5 ================
6 VIDEO_SET_SYSTEM
7 ================
9 Name
10 ----
12 VIDEO_SET_SYSTEM
14 .. attention:: This ioctl is deprecated.
16 Synopsis
17 --------
19 .. c:function:: int ioctl(fd, VIDEO_SET_SYSTEM , video_system_t system)
20     :name: VIDEO_SET_SYSTEM
23 Arguments
24 ---------
26 .. flat-table::
27     :header-rows:  0
28     :stub-columns: 0
31     -  .. row 1
33        -  int fd
35        -  File descriptor returned by a previous call to open().
37     -  .. row 2
39        -  int request
41        -  Equals VIDEO_SET_FORMAT for this command.
43     -  .. row 3
45        -  video_system_t system
47        -  video system of TV output.
50 Description
51 -----------
53 This ioctl sets the television output format. The format (see section
54 ??) may vary from the color format of the displayed MPEG stream. If the
55 hardware is not able to display the requested format the call will
56 return an error.
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.
68 .. flat-table::
69     :header-rows:  0
70     :stub-columns: 0
73     -  .. row 1
75        -  ``EINVAL``
77        -  system is not a valid or supported video system.