7.14. ioctl VIDIOC_ENUM_FMT¶
VIDIOC_ENUM_FMT - Enumerate image formats
ioctl(int fd, VIDIOC_ENUM_FMT, struct v4l2_fmtdesc *argp)¶
- File descriptor returned by open().
- Pointer to struct
To enumerate image formats applications initialize the
index field of struct
v4l2_fmtdesc and call
the ioctl VIDIOC_ENUM_FMT ioctl with a pointer to this structure. Drivers
fill the rest of the structure or return an
EINVAL error code. All
formats are enumerable by beginning at index zero and incrementing by
EINVAL is returned.
After switching input or output the list of enumerated image formats may be different.
||Number of the format in the enumeration, set by the application.
This is in no way related to the
||Type of the data stream, set by the application. Only these types
are valid here:
||See Image Format Description Flags|
||Description of the format, a NUL-terminated ASCII string. This information is intended for the user, for example: “YUV 4:2:2”.|
||The image format identifier. This is a four character code as computed by the v4l2_fourcc() macro:|
Several image formats are already defined by this specification in Image Formats.
These codes are not the same as those used in the Windows world.
||Reserved for future extensions. Drivers must set the array to zero.|
||0x0001||This is a compressed format.|
||0x0002||This format is not native to the device but emulated through software (usually libv4l2), where possible try to use a native format instead for better performance.|
7.14.5. Return Value¶
On success 0 is returned, on error -1 and the
errno variable is set
appropriately. The generic error codes are described at the
Generic Error Codes chapter.
- The struct
typeis not supported or the
indexis out of bounds.