media/v4l/vidioc-subdev-enum-frame-interval.rst

1 .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
13 VIDIOC_SUBDEV_ENUM_FRAME_INTERVAL - Enumerate frame intervals
34 This ioctl lets applications enumerate available frame intervals on a
35 given sub-device pad. Frame intervals only makes sense for sub-devices
36 that can control the frame period on their own. This includes, for
39 For the common use case of image sensors, the frame intervals available
40 on the sub-device output pad depend on the frame format and size on the
42 when enumerating frame intervals.
44 To enumerate frame intervals applications initialize the ``index``,
49 EINVAL error code if one of the input fields is invalid. All frame
53 Available frame intervals may depend on the current 'try' formats at
54 other pads of the sub-device, as well as on the current active links.
58 Sub-devices that support the frame interval enumeration ioctl should
60 multiple pads of the same sub-device is not defined.
66 .. flat-table:: struct v4l2_subdev_frame_interval_enum
67     :header-rows:  0
68     :stub-columns: 0
71     * - __u32
72       - ``index``
73       - Number of the format in the enumeration, set by the application.
74     * - __u32
75       - ``pad``
76       - Pad number as reported by the media controller API.
77     * - __u32
78       - ``code``
79       - The media bus format code, as defined in
80 	:ref:`v4l2-mbus-format`.
81     * - __u32
82       - ``width``
83       - Frame width, in pixels.
84     * - __u32
85       - ``height``
86       - Frame height, in pixels.
87     * - struct :c:type:`v4l2_fract`
88       - ``interval``
89       - Period, in seconds, between consecutive video frames.
90     * - __u32
91       - ``which``
92       - Frame intervals to be enumerated, from enum
93 	:ref:`v4l2_subdev_format_whence <v4l2-subdev-format-whence>`.
94     * - __u32
95       - ``stream``
96       - Stream identifier.
97     * - __u32
98       - ``reserved``\ [7]
99       - Reserved for future extensions. Applications and drivers must set
105 On success 0 is returned, on error -1 and the ``errno`` variable is set
107 :ref:`Generic Error Codes <gen-errors>` chapter.
111     non-existing pad, the ``which`` field has an unsupported value, one of the