Linux 4.8.3
[linux/fpc-iii.git] / Documentation / media / uapi / dvb / video-set-display-format.rst
blob2061ab06497717f6f808b4077cc342d95aa49f29
1 .. -*- coding: utf-8; mode: rst -*-
3 .. _VIDEO_SET_DISPLAY_FORMAT:
5 ========================
6 VIDEO_SET_DISPLAY_FORMAT
7 ========================
9 Name
10 ----
12 VIDEO_SET_DISPLAY_FORMAT
15 Synopsis
16 --------
18 .. cpp:function:: int ioctl(fd, int request = VIDEO_SET_DISPLAY_FORMAT, video_display_format_t format)
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_DISPLAY_FORMAT for this command.
41     -  .. row 3
43        -  video_display_format_t format
45        -  Selects the video format to be used.
48 Description
49 -----------
51 This ioctl call asks the Video Device to select the video format to be
52 applied by the MPEG chip on the video.
55 Return Value
56 ------------
58 On success 0 is returned, on error -1 and the ``errno`` variable is set
59 appropriately. The generic error codes are described at the
60 :ref:`Generic Error Codes <gen-errors>` chapter.