VIDIOC_SUBSCRIBE_EVENT, VIDIOC_UNSUBSCRIBE_EVENT — Subscribe or unsubscribe event
int fsfuncioctl( | int fd, |
int request, | |
struct v4l2_event_subscription
*argp) ; |
fd
File descriptor returned by open()
.
request
VIDIOC_SUBSCRIBE_EVENT, VIDIOC_UNSUBSCRIBE_EVENT
argp
Subscribe or unsubscribe V4L2 event. Subscribed events are
dequeued by using the VIDIOC_DQEVENT
ioctl.
Table A.90. struct v4l2_event_subscription
__u32 | type | Type of the event. |
__u32 | id | ID of the event source. If there is no ID associated with the event source, then set this to 0. Whether or not an event needs an ID depends on the event type. |
__u32 | flags | Event flags, see Table A.92, “Event Flags”. |
__u32 | reserved [5] | Reserved for future extensions. Drivers and applications must set the array to zero. |
Table A.91. Event Types
V4L2_EVENT_ALL | 0 | All events. V4L2_EVENT_ALL is valid only for VIDIOC_UNSUBSCRIBE_EVENT for unsubscribing all events at once. |
V4L2_EVENT_VSYNC | 1 | This event is triggered on the vertical sync. This event has a struct v4l2_event_vsync associated with it. |
V4L2_EVENT_EOS | 2 | This event is triggered when the end of a stream is reached. This is typically used with MPEG decoders to report to the application when the last of the MPEG stream has been decoded. |
V4L2_EVENT_CTRL | 3 | This event requires that the If the event is generated due to a call to This event type will ensure that no information is lost when
more events are raised than there is room internally. In that
case the struct v4l2_event_ctrl of the second-oldest event is kept,
but the |
V4L2_EVENT_PRIVATE_START | 0x08000000 | Base event number for driver-private events. |
Table A.92. Event Flags
V4L2_EVENT_SUB_FL_SEND_INITIAL | 0x0001 | When this event is subscribed an initial event will be sent
containing the current status. This only makes sense for events
that are triggered by a status change such as V4L2_EVENT_CTRL .
Other events will ignore this flag. |
V4L2_EVENT_SUB_FL_ALLOW_FEEDBACK | 0x0002 | If set, then events directly caused by an ioctl will also be sent to
the filehandle that called that ioctl. For example, changing a control using
Since it can't tell whether that event was caused by another application
or by the Think carefully when you set this flag so you won't get into situations like that. |
Table A.94. struct v4l2_event_ctrl
__u32 | changes | A bitmask that tells what has changed. See Table A.95, “Changes”. | |
__u32 | type | The type of the control. See enum v4l2_ctrl_type. | |
union (anonymous) | |||
__s32 | value | The 32-bit value of the control for 32-bit control types.
This is 0 for string controls since the value of a string
cannot be passed using VIDIOC_DQEVENT . | |
__s64 | value64 | The 64-bit value of the control for 64-bit control types. | |
__u32 | flags | The control flags. See Table A.80, “Control Flags”. | |
__s32 | minimum | The minimum value of the control. See struct v4l2_queryctrl. | |
__s32 | maximum | The maximum value of the control. See struct v4l2_queryctrl. | |
__s32 | step | The step value of the control. See struct v4l2_queryctrl. | |
__s32 | default_value | The default value value of the control. See struct v4l2_queryctrl. |
Table A.95. Changes
V4L2_EVENT_CTRL_CH_VALUE | 0x0001 | This control event was triggered because the value of the control changed. Special case: if a button control is pressed, then this event is sent as well, even though there is not explicit value associated with a button control. |
V4L2_EVENT_CTRL_CH_FLAGS | 0x0002 | This control event was triggered because the control flags changed. |
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.