1 .. -*- coding: utf-8; mode: rst -*-
5 ***********************
6 ioctl VIDIOC_ENUMOUTPUT
7 ***********************
12 VIDIOC_ENUMOUTPUT - Enumerate video outputs
18 .. cpp:function:: int ioctl( int fd, int request, struct v4l2_output *argp )
25 File descriptor returned by :ref:`open() <func-open>`.
36 To query the attributes of a video outputs applications initialize the
37 ``index`` field of struct :ref:`v4l2_output <v4l2-output>` and call
38 the :ref:`VIDIOC_ENUMOUTPUT` ioctl with a pointer to this structure.
39 Drivers fill the rest of the structure or return an ``EINVAL`` error code
40 when the index is out of bounds. To enumerate all outputs applications
41 shall begin at index zero, incrementing by one until the driver returns
45 .. tabularcolumns:: |p{4.4cm}|p{4.4cm}|p{8.7cm}|
49 .. flat-table:: struct v4l2_output
61 - Identifies the output, set by the application.
69 - Name of the video output, a NUL-terminated ASCII string, for
70 example: "Vout". This information is intended for the user,
71 preferably the connector label on the device itself.
79 - Type of the output, see :ref:`output-type`.
87 - Drivers can enumerate up to 32 video and audio outputs. This field
88 shows which audio outputs were selectable as the current output if
89 this was the currently selected video output. It is a bit mask.
90 The LSB corresponds to audio output 0, the MSB to output 31. Any
91 number of bits can be set, or none.
93 When the driver does not enumerate audio outputs no bits must be
94 set. Applications shall not interpret this as lack of audio
95 support. Drivers may automatically select audio outputs without
98 For details on audio outputs and how to select the current output
107 - Output devices can have zero or more RF modulators. When the
108 ``type`` is ``V4L2_OUTPUT_TYPE_MODULATOR`` this is an RF connector
109 and this field identifies the modulator. It corresponds to struct
110 :ref:`v4l2_modulator <v4l2-modulator>` field ``index``. For
111 details on modulators see :ref:`tuner`.
115 - :ref:`v4l2_std_id <v4l2-std-id>`
119 - Every video output supports one or more different video standards.
120 This field is a set of all supported standards. For details on
121 video standards and how to switch see :ref:`standard`.
129 - This field provides capabilities for the output. See
130 :ref:`output-capabilities` for flags.
138 - Reserved for future extensions. Drivers must set the array to
143 .. tabularcolumns:: |p{7.0cm}|p{1.8cm}|p{8.7cm}|
147 .. flat-table:: Output Type
155 - ``V4L2_OUTPUT_TYPE_MODULATOR``
159 - This output is an analog TV modulator.
163 - ``V4L2_OUTPUT_TYPE_ANALOG``
167 - Analog baseband output, for example Composite / CVBS, S-Video,
172 - ``V4L2_OUTPUT_TYPE_ANALOGVGAOVERLAY``
180 .. tabularcolumns:: |p{6.6cm}|p{2.2cm}|p{8.7cm}|
182 .. _output-capabilities:
184 .. flat-table:: Output capabilities
192 - ``V4L2_OUT_CAP_DV_TIMINGS``
196 - This output supports setting video timings by using
201 - ``V4L2_OUT_CAP_STD``
205 - This output supports setting the TV standard by using
210 - ``V4L2_OUT_CAP_NATIVE_SIZE``
214 - This output supports setting the native size using the
215 ``V4L2_SEL_TGT_NATIVE_SIZE`` selection target, see
216 :ref:`v4l2-selections-common`.
222 On success 0 is returned, on error -1 and the ``errno`` variable is set
223 appropriately. The generic error codes are described at the
224 :ref:`Generic Error Codes <gen-errors>` chapter.
227 The struct :ref:`v4l2_output <v4l2-output>` ``index`` is out of