vidioc-subscribe-event.rst 3.4 KB
Newer Older
1 2
.. -*- coding: utf-8; mode: rst -*-

3
.. _VIDIOC_SUBSCRIBE_EVENT:
4
.. _VIDIOC_UNSUBSCRIBE_EVENT:
5 6 7 8 9

******************************************************
ioctl VIDIOC_SUBSCRIBE_EVENT, VIDIOC_UNSUBSCRIBE_EVENT
******************************************************

10
Name
11
====
12

13
VIDIOC_SUBSCRIBE_EVENT - VIDIOC_UNSUBSCRIBE_EVENT - Subscribe or unsubscribe event
14

15 16

Synopsis
17 18
========

19 20 21 22 23
.. c:function:: int ioctl( int fd, VIDIOC_SUBSCRIBE_EVENT, struct v4l2_event_subscription *argp )
    :name: VIDIOC_SUBSCRIBE_EVENT

.. c:function:: int ioctl( int fd, VIDIOC_UNSUBSCRIBE_EVENT, struct v4l2_event_subscription *argp )
    :name: VIDIOC_UNSUBSCRIBE_EVENT
24

25

26
Arguments
27 28 29 30 31 32 33 34
=========

``fd``
    File descriptor returned by :ref:`open() <func-open>`.

``argp``


35
Description
36 37 38
===========

Subscribe or unsubscribe V4L2 event. Subscribed events are dequeued by
39
using the :ref:`VIDIOC_DQEVENT` ioctl.
40 41


42 43
.. tabularcolumns:: |p{4.4cm}|p{4.4cm}|p{8.7cm}|

44
.. c:type:: v4l2_event_subscription
45

46 47 48 49 50 51 52 53 54 55 56 57
.. flat-table:: struct v4l2_event_subscription
    :header-rows:  0
    :stub-columns: 0
    :widths:       1 1 2


    -  .. row 1

       -  __u32

       -  ``type``

58 59
       -  Type of the event, see :ref:`event-type`.

60 61 62
	  .. note::

	     ``V4L2_EVENT_ALL`` can be used with
63 64
	     :ref:`VIDIOC_UNSUBSCRIBE_EVENT <VIDIOC_SUBSCRIBE_EVENT>` for
	     unsubscribing all events at once.
65 66 67 68 69 70 71 72

    -  .. row 2

       -  __u32

       -  ``id``

       -  ID of the event source. If there is no ID associated with the
73 74
	  event source, then set this to 0. Whether or not an event needs an
	  ID depends on the event type.
75 76 77 78 79 80 81 82 83 84 85 86 87

    -  .. row 3

       -  __u32

       -  ``flags``

       -  Event flags, see :ref:`event-flags`.

    -  .. row 4

       -  __u32

88
       -  ``reserved``\ [5]
89 90

       -  Reserved for future extensions. Drivers and applications must set
91
	  the array to zero.
92 93 94



95 96
.. tabularcolumns:: |p{6.6cm}|p{2.2cm}|p{8.7cm}|

97 98
.. _event-flags:

99 100 101 102 103 104 105 106 107 108 109 110 111
.. flat-table:: Event Flags
    :header-rows:  0
    :stub-columns: 0
    :widths:       3 1 4


    -  .. row 1

       -  ``V4L2_EVENT_SUB_FL_SEND_INITIAL``

       -  0x0001

       -  When this event is subscribed an initial event will be sent
112 113 114
	  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.
115 116 117 118 119 120 121 122

    -  .. row 2

       -  ``V4L2_EVENT_SUB_FL_ALLOW_FEEDBACK``

       -  0x0002

       -  If set, then events directly caused by an ioctl will also be sent
123 124 125 126 127 128 129 130 131 132 133 134 135 136 137
	  to the filehandle that called that ioctl. For example, changing a
	  control using :ref:`VIDIOC_S_CTRL <VIDIOC_G_CTRL>` will cause
	  a V4L2_EVENT_CTRL to be sent back to that same filehandle.
	  Normally such events are suppressed to prevent feedback loops
	  where an application changes a control to a one value and then
	  another, and then receives an event telling it that that control
	  has changed to the first value.

	  Since it can't tell whether that event was caused by another
	  application or by the :ref:`VIDIOC_S_CTRL <VIDIOC_G_CTRL>`
	  call it is hard to decide whether to set the control to the value
	  in the event, or ignore it.

	  Think carefully when you set this flag so you won't get into
	  situations like that.
138 139


140
Return Value
141 142 143 144 145
============

On success 0 is returned, on error -1 and the ``errno`` variable is set
appropriately. The generic error codes are described at the
:ref:`Generic Error Codes <gen-errors>` chapter.
新手
引导
客服 返回
顶部