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