Gitiles
Code Review Sign In
gerrit-public.fairphone.software / kernel / msm-4.9 / 60c2820d0f6d3497975b6488e2599f8f611d8b95 / . / Documentation / media / uapi / dvb / video-set-format.rst
blob: 53d66ec462ca51ecdad08281797092207473859a [file] [log] [blame]
Mauro Carvalho Chehab47d23e32016-07-05 10:37:31 -0300[diff] [blame]1.. -*- coding: utf-8; mode: rst -*-
2
3.. _VIDEO_SET_FORMAT:
4
Mauro Carvalho Chehab586027c2016-07-05 07:58:48 -0300[diff] [blame]5================
Mauro Carvalho Chehab47d23e32016-07-05 10:37:31 -0300[diff] [blame]6VIDEO_SET_FORMAT
7================
8
Mauro Carvalho Chehab15e7d612016-07-05 15:14:35 -0300[diff] [blame]9Name
Mauro Carvalho Chehab586027c2016-07-05 07:58:48 -0300[diff] [blame]10----
Mauro Carvalho Chehab47d23e32016-07-05 10:37:31 -0300[diff] [blame]11
Mauro Carvalho Chehab586027c2016-07-05 07:58:48 -0300[diff] [blame]12VIDEO_SET_FORMAT
Mauro Carvalho Chehab47d23e32016-07-05 10:37:31 -0300[diff] [blame]13
Mauro Carvalho Chehab15e7d612016-07-05 15:14:35 -0300[diff] [blame]14
15Synopsis
Mauro Carvalho Chehab47d23e32016-07-05 10:37:31 -0300[diff] [blame]16--------
17
Mauro Carvalho Chehab5929cb12016-07-05 15:22:59 -0300[diff] [blame]18.. cpp:function:: int ioctl(fd, int request = VIDEO_SET_FORMAT, video_format_t format)
Mauro Carvalho Chehab47d23e32016-07-05 10:37:31 -0300[diff] [blame]19
Mauro Carvalho Chehab47d23e32016-07-05 10:37:31 -0300[diff] [blame]20
Mauro Carvalho Chehab15e7d612016-07-05 15:14:35 -0300[diff] [blame]21Arguments
Mauro Carvalho Chehab586027c2016-07-05 07:58:48 -0300[diff] [blame]22---------
Mauro Carvalho Chehab47d23e32016-07-05 10:37:31 -0300[diff] [blame]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
Mauro Carvalho Chehab15e7d612016-07-05 15:14:35 -0300[diff] [blame]48Description
Mauro Carvalho Chehab586027c2016-07-05 07:58:48 -0300[diff] [blame]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
Mauro Carvalho Chehab15e7d612016-07-05 15:14:35 -0300[diff] [blame]56Return Value
Mauro Carvalho Chehab47d23e32016-07-05 10:37:31 -0300[diff] [blame]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.