Driver Operations Video driver operations More...

#include <zephyr/drivers/video.h>

Data Fields
video_api_format_t	set_format
	REQ Set video format.
video_api_format_t	get_format
	REQ Get video format.
video_api_set_stream_t	set_stream
	REQ Start the video device function.
video_api_get_caps_t	get_caps
	REQ Get the capabilities of a video endpoint.
video_api_enqueue_t	enqueue
	OPT Enqueue a video buffer.
video_api_dequeue_t	dequeue
	OPT Dequeue a video buffer.
video_api_flush_t	flush
	OPT Flush endpoint buffers.
video_api_ctrl_t	set_ctrl
	OPT Set the value of a control.
video_api_ctrl_t	get_volatile_ctrl
	OPT Get the current value of a control.
video_api_set_signal_t	set_signal
	OPT Register/Unregister k_poll signal for a video endpoint.
video_api_frmival_t	set_frmival
	OPT Set video frame interval.
video_api_frmival_t	get_frmival
	OPT Get video frame interval.
video_api_enum_frmival_t	enum_frmival
	OPT List video frame intervals.
video_api_selection_t	set_selection
	OPT Set video selection (crop/compose).
video_api_selection_t	get_selection
	OPT Get video selection (crop/compose).
video_api_transform_cap_t	transform_cap
	OPT Transform a video format capability from one end to the other end of a m2m video device.

Detailed Description

Driver Operations Video driver operations

This is the driver API structure any Video driver needs to define. It contains function pointers to the operations the driver implements, as well as any other driver-specific constant data.

Members marked with REQ MUST be set by the driver, whereas those marked with OPT are optional.

See also: DEVICE_DT_INST_DEFINE(); DEVICE_DT_DEFINE(); DEVICE_API()

Field Documentation

◆ dequeue

video_api_dequeue_t video_driver_api::dequeue

OPT Dequeue a video buffer.

◆ enqueue

video_api_enqueue_t video_driver_api::enqueue

OPT Enqueue a video buffer.

◆ enum_frmival

video_api_enum_frmival_t video_driver_api::enum_frmival

OPT List video frame intervals.

◆ flush

video_api_flush_t video_driver_api::flush

OPT Flush endpoint buffers.

◆ get_caps

video_api_get_caps_t video_driver_api::get_caps

REQ Get the capabilities of a video endpoint.

◆ get_format

video_api_format_t video_driver_api::get_format

REQ Get video format.

◆ get_frmival

video_api_frmival_t video_driver_api::get_frmival

OPT Get video frame interval.

◆ get_selection

video_api_selection_t video_driver_api::get_selection

OPT Get video selection (crop/compose).

◆ get_volatile_ctrl

video_api_ctrl_t video_driver_api::get_volatile_ctrl

OPT Get the current value of a control.

◆ set_ctrl

video_api_ctrl_t video_driver_api::set_ctrl

OPT Set the value of a control.

◆ set_format

video_api_format_t video_driver_api::set_format

REQ Set video format.

◆ set_frmival

video_api_frmival_t video_driver_api::set_frmival

OPT Set video frame interval.

◆ set_selection

video_api_selection_t video_driver_api::set_selection

OPT Set video selection (crop/compose).

◆ set_signal

video_api_set_signal_t video_driver_api::set_signal

OPT Register/Unregister k_poll signal for a video endpoint.

◆ set_stream

video_api_set_stream_t video_driver_api::set_stream

REQ Start the video device function.

◆ transform_cap

video_api_transform_cap_t video_driver_api::transform_cap

OPT Transform a video format capability from one end to the other end of a m2m video device.

The documentation for this struct was generated from the following file:

zephyr/drivers/video.h

Data Fields