1 .. -*- coding: utf-8; mode: rst -*-
5 ***********************
6 ioctl VIDIOC_ENUMOUTPUT
7 ***********************
9 *man VIDIOC_ENUMOUTPUT(2)*
11 Enumerate video outputs
17 .. c:function:: int ioctl( int fd, int request, struct v4l2_output *argp )
23 File descriptor returned by :ref:`open() <func-open>`.
34 To query the attributes of a video outputs applications initialize the
35 ``index`` field of struct :ref:`v4l2_output <v4l2-output>` and call
36 the ``VIDIOC_ENUMOUTPUT`` ioctl with a pointer to this structure.
37 Drivers fill the rest of the structure or return an EINVAL error code
38 when the index is out of bounds. To enumerate all outputs applications
39 shall begin at index zero, incrementing by one until the driver returns
45 .. flat-table:: struct v4l2_output
57 - Identifies the output, set by the application.
65 - Name of the video output, a NUL-terminated ASCII string, for
66 example: "Vout". This information is intended for the user,
67 preferably the connector label on the device itself.
75 - Type of the output, see :ref:`output-type`.
83 - Drivers can enumerate up to 32 video and audio outputs. This field
84 shows which audio outputs were selectable as the current output if
85 this was the currently selected video output. It is a bit mask.
86 The LSB corresponds to audio output 0, the MSB to output 31. Any
87 number of bits can be set, or none.
89 When the driver does not enumerate audio outputs no bits must be
90 set. Applications shall not interpret this as lack of audio
91 support. Drivers may automatically select audio outputs without
94 For details on audio outputs and how to select the current output
103 - Output devices can have zero or more RF modulators. When the
104 ``type`` is ``V4L2_OUTPUT_TYPE_MODULATOR`` this is an RF connector
105 and this field identifies the modulator. It corresponds to struct
106 :ref:`v4l2_modulator <v4l2-modulator>` field ``index``. For
107 details on modulators see :ref:`tuner`.
111 - :ref:`v4l2_std_id <v4l2-std-id>`
115 - Every video output supports one or more different video standards.
116 This field is a set of all supported standards. For details on
117 video standards and how to switch see :ref:`standard`.
125 - This field provides capabilities for the output. See
126 :ref:`output-capabilities` for flags.
134 - Reserved for future extensions. Drivers must set the array to
141 .. flat-table:: Output Type
149 - ``V4L2_OUTPUT_TYPE_MODULATOR``
153 - This output is an analog TV modulator.
157 - ``V4L2_OUTPUT_TYPE_ANALOG``
161 - Analog baseband output, for example Composite / CVBS, S-Video,
166 - ``V4L2_OUTPUT_TYPE_ANALOGVGAOVERLAY``
174 .. _output-capabilities:
176 .. flat-table:: Output capabilities
184 - ``V4L2_OUT_CAP_DV_TIMINGS``
188 - This output supports setting video timings by using
193 - ``V4L2_OUT_CAP_STD``
197 - This output supports setting the TV standard by using
202 - ``V4L2_OUT_CAP_NATIVE_SIZE``
206 - This output supports setting the native size using the
207 ``V4L2_SEL_TGT_NATIVE_SIZE`` selection target, see
208 :ref:`v4l2-selections-common`.
215 On success 0 is returned, on error -1 and the ``errno`` variable is set
216 appropriately. The generic error codes are described at the
217 :ref:`Generic Error Codes <gen-errors>` chapter.
220 The struct :ref:`v4l2_output <v4l2-output>` ``index`` is out of
224 .. ------------------------------------------------------------------------------
225 .. This file was automatically converted from DocBook-XML with the dbxml
226 .. library (https://github.com/return42/sphkerneldoc). The origin XML comes
227 .. from the linux kernel, refer to:
229 .. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
230 .. ------------------------------------------------------------------------------