Gitiles
Code Review Sign In
gerrit-public.fairphone.software / kernel / msm-4.9 / 586027cefac593d1a17f86e2236694357ebc6670 / . / Documentation / linux_tv / media / dvb / video-set-format.rst
blob: af126d2de8c3e5e5f594b79bb19157618d94fe87 [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 Chehab586027c2016-07-05 07:58:48 -0300[diff] [blame^]9NAME
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 Chehab586027c2016-07-05 07:58:48 -0300[diff] [blame^]14SYNOPSIS
Mauro Carvalho Chehab47d23e32016-07-05 10:37:31 -0300[diff] [blame]15--------
16
17.. c:function:: int ioctl(fd, int request = VIDEO_SET_FORMAT, video_format_t format)
18
Mauro Carvalho Chehab47d23e32016-07-05 10:37:31 -0300[diff] [blame]19
Mauro Carvalho Chehab586027c2016-07-05 07:58:48 -0300[diff] [blame^]20ARGUMENTS
21---------
Mauro Carvalho Chehab47d23e32016-07-05 10:37:31 -0300[diff] [blame]22
23.. flat-table::
24 :header-rows: 0
25 :stub-columns: 0
26
27
28 - .. row 1
29
30 - int fd
31
32 - File descriptor returned by a previous call to open().
33
34 - .. row 2
35
36 - int request
37
38 - Equals VIDEO_SET_FORMAT for this command.
39
40 - .. row 3
41
42 - video_format_t format
43
44 - video format of TV as defined in section ??.
45
46
Mauro Carvalho Chehab586027c2016-07-05 07:58:48 -0300[diff] [blame^]47DESCRIPTION
48-----------
49
50This ioctl sets the screen format (aspect ratio) of the connected output
51device (TV) so that the output of the decoder can be adjusted
52accordingly.
53
54
55RETURN VALUE
Mauro Carvalho Chehab47d23e32016-07-05 10:37:31 -0300[diff] [blame]56------------
57
58On success 0 is returned, on error -1 and the ``errno`` variable is set
59appropriately. The generic error codes are described at the
60:ref:`Generic Error Codes <gen-errors>` chapter.
61
62
63
64.. flat-table::
65 :header-rows: 0
66 :stub-columns: 0
67
68
69 - .. row 1
70
71 - ``EINVAL``
72
73 - format is not a valid video format.