• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1.. -*- coding: utf-8; mode: rst -*-
2
3.. _VIDEO_SET_FORMAT:
4
5================
6VIDEO_SET_FORMAT
7================
8
9Name
10----
11
12VIDEO_SET_FORMAT
13
14.. attention:: This ioctl is deprecated.
15
16Synopsis
17--------
18
19.. c:function:: int ioctl(fd, VIDEO_SET_FORMAT, video_format_t format)
20    :name: VIDEO_SET_FORMAT
21
22
23Arguments
24---------
25
26.. flat-table::
27    :header-rows:  0
28    :stub-columns: 0
29
30
31    -  .. row 1
32
33       -  int fd
34
35       -  File descriptor returned by a previous call to open().
36
37    -  .. row 2
38
39       -  int request
40
41       -  Equals VIDEO_SET_FORMAT for this command.
42
43    -  .. row 3
44
45       -  video_format_t format
46
47       -  video format of TV as defined in section ??.
48
49
50Description
51-----------
52
53This ioctl sets the screen format (aspect ratio) of the connected output
54device (TV) so that the output of the decoder can be adjusted
55accordingly.
56
57.. c:type:: video_format_t
58
59.. code-block:: c
60
61	typedef enum {
62		VIDEO_FORMAT_4_3,     /* Select 4:3 format */
63		VIDEO_FORMAT_16_9,    /* Select 16:9 format. */
64		VIDEO_FORMAT_221_1    /* 2.21:1 */
65	} video_format_t;
66
67Return Value
68------------
69
70On success 0 is returned, on error -1 and the ``errno`` variable is set
71appropriately. The generic error codes are described at the
72:ref:`Generic Error Codes <gen-errors>` chapter.
73
74
75
76.. flat-table::
77    :header-rows:  0
78    :stub-columns: 0
79
80
81    -  .. row 1
82
83       -  ``EINVAL``
84
85       -  format is not a valid video format.
86