doc-rst: linux_tv: split DVB function call documentation
[deliverable/linux.git] / Documentation / linux_tv / media / dvb / video-set-format.rst
CommitLineData
47d23e36
MCC
1.. -*- coding: utf-8; mode: rst -*-
2
3.. _VIDEO_SET_FORMAT:
4
5VIDEO_SET_FORMAT
6================
7
8Description
9-----------
10
11This ioctl sets the screen format (aspect ratio) of the connected output
12device (TV) so that the output of the decoder can be adjusted
13accordingly.
14
15Synopsis
16--------
17
18.. c:function:: int ioctl(fd, int request = VIDEO_SET_FORMAT, video_format_t format)
19
20Arguments
21----------
22
23
24
25.. flat-table::
26 :header-rows: 0
27 :stub-columns: 0
28
29
30 - .. row 1
31
32 - int fd
33
34 - File descriptor returned by a previous call to open().
35
36 - .. row 2
37
38 - int request
39
40 - Equals VIDEO_SET_FORMAT for this command.
41
42 - .. row 3
43
44 - video_format_t format
45
46 - video format of TV as defined in section ??.
47
48
49Return Value
50------------
51
52On success 0 is returned, on error -1 and the ``errno`` variable is set
53appropriately. The generic error codes are described at the
54:ref:`Generic Error Codes <gen-errors>` chapter.
55
56
57
58.. flat-table::
59 :header-rows: 0
60 :stub-columns: 0
61
62
63 - .. row 1
64
65 - ``EINVAL``
66
67 - format is not a valid video format.
68
69
70
This page took 0.026035 seconds and 5 git commands to generate.