WIP FPC-III support
[linux/fpc-iii.git] / Documentation / userspace-api / media / dvb / video-set-display-format.rst
blob1de4f40ae7324a57ee2704a0c22e33a9c0335e8f
1 .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
2 .. c:namespace:: DTV.video
4 .. _VIDEO_SET_DISPLAY_FORMAT:
6 ========================
7 VIDEO_SET_DISPLAY_FORMAT
8 ========================
10 Name
11 ----
13 VIDEO_SET_DISPLAY_FORMAT
15 .. attention:: This ioctl is deprecated.
17 Synopsis
18 --------
20 .. c:macro:: VIDEO_SET_DISPLAY_FORMAT
22 ``int ioctl(fd, VIDEO_SET_DISPLAY_FORMAT)``
24 Arguments
25 ---------
27 .. flat-table::
28     :header-rows:  0
29     :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_DISPLAY_FORMAT for this command.
43     -  .. row 3
45        -  video_display_format_t format
47        -  Selects the video format to be used.
49 Description
50 -----------
52 This ioctl call asks the Video Device to select the video format to be
53 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.