media/v4l/vidioc-enumoutput.rst

1 .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
13 VIDIOC_ENUMOUTPUT - Enumerate video outputs
34 To query the attributes of a video outputs applications initialize the
38 when the index is out of bounds. To enumerate all outputs applications
46 .. flat-table:: struct v4l2_output
47     :header-rows:  0
48     :stub-columns: 0
51     * - __u32
52       - ``index``
53       - Identifies the output, set by the application.
54     * - __u8
55       - ``name``\ [32]
56       - Name of the video output, a NUL-terminated ASCII string, for
59     * - __u32
60       - ``type``
61       - Type of the output, see :ref:`output-type`.
62     * - __u32
63       - ``audioset``
64       - Drivers can enumerate up to 32 video and audio outputs. This field
65 	shows which audio outputs were selectable as the current output if
70 	When the driver does not enumerate audio outputs no bits must be
72 	support. Drivers may automatically select audio outputs without
75 	For details on audio outputs and how to select the current output
77     * - __u32
78       - ``modulator``
79       - Output devices can have zero or more RF modulators. When the
84     * - :ref:`v4l2_std_id <v4l2-std-id>`
85       - ``std``
86       - Every video output supports one or more different video standards.
87 	This field is a set of all supported standards. For details on
89     * - __u32
90       - ``capabilities``
91       - This field provides capabilities for the output. See
92 	:ref:`output-capabilities` for flags.
93     * - __u32
94       - ``reserved``\ [3]
95       - Reserved for future extensions. Drivers must set the array to
101 .. _output-type:
103 .. flat-table:: Output Type
104     :header-rows:  0
105     :stub-columns: 0
108     * - ``V4L2_OUTPUT_TYPE_MODULATOR``
109       - 1
110       - This output is an analog TV modulator.
111     * - ``V4L2_OUTPUT_TYPE_ANALOG``
112       - 2
113       - Any non-modulator video output, for example Composite Video,
114 	S-Video, HDMI. The naming as ``_TYPE_ANALOG`` is historical,
116     * - ``V4L2_OUTPUT_TYPE_ANALOGVGAOVERLAY``
117       - 3
118       - The video output will be copied to a :ref:`video overlay <overlay>`.
123 .. _output-capabilities:
125 .. flat-table:: Output capabilities
126     :header-rows:  0
127     :stub-columns: 0
130     * - ``V4L2_OUT_CAP_DV_TIMINGS``
131       - 0x00000002
132       - This output supports setting video timings by using
134     * - ``V4L2_OUT_CAP_STD``
135       - 0x00000004
136       - This output supports setting the TV standard by using
138     * - ``V4L2_OUT_CAP_NATIVE_SIZE``
139       - 0x00000008
140       - This output supports setting the native size using the
142 	:ref:`v4l2-selections-common`.
147 On success 0 is returned, on error -1 and the ``errno`` variable is set
149 :ref:`Generic Error Codes <gen-errors>` chapter.