projects / deliverable / linux.git / blame
| Commit | Line | Data |
|---|---|---|
| 5377d91f MH |
1 | .. -*- coding: utf-8; mode: rst -*- |
| 2 | ||
| af4a4d0d | 3 | .. _VIDIOC_OVERLAY: |
| 5377d91f MH |
4 | |
| 5 | ******************** | |
| 6 | ioctl VIDIOC_OVERLAY | |
| 7 | ******************** | |
| 8 | ||
| 15e7d615 | 9 | Name |
| 586027ce | 10 | ==== |
| 5377d91f | 11 | |
| 586027ce | 12 | VIDIOC_OVERLAY - Start or stop video overlay |
| 5377d91f | 13 | |
| 15e7d615 MCC |
14 | |
| 15 | Synopsis | |
| 5377d91f MH |
16 | ======== |
| 17 | ||
| b7e67f6c | 18 | .. cpp:function:: int ioctl( int fd, int request, const int *argp ) |
| 5377d91f | 19 | |
| 586027ce | 20 | |
| 15e7d615 | 21 | Arguments |
| 5377d91f MH |
22 | ========= |
| 23 | ||
| 24 | ``fd`` | |
| 25 | File descriptor returned by :ref:`open() <func-open>`. | |
| 26 | ||
| 27 | ``request`` | |
| 28 | VIDIOC_OVERLAY | |
| 29 | ||
| 30 | ``argp`` | |
| 31 | ||
| 32 | ||
| 15e7d615 | 33 | Description |
| 5377d91f MH |
34 | =========== |
| 35 | ||
| 36 | This ioctl is part of the :ref:`video overlay <overlay>` I/O method. | |
| 2212ff25 | 37 | Applications call :ref:`VIDIOC_OVERLAY` to start or stop the overlay. It |
| 5377d91f MH |
38 | takes a pointer to an integer which must be set to zero by the |
| 39 | application to stop overlay, to one to start. | |
| 40 | ||
| 7347081e | 41 | Drivers do not support :ref:`VIDIOC_STREAMON` or |
| af4a4d0d | 42 | :ref:`VIDIOC_STREAMOFF <VIDIOC_STREAMON>` with |
| 5377d91f MH |
43 | ``V4L2_BUF_TYPE_VIDEO_OVERLAY``. |
| 44 | ||
| 45 | ||
| 15e7d615 | 46 | Return Value |
| 5377d91f MH |
47 | ============ |
| 48 | ||
| 49 | On success 0 is returned, on error -1 and the ``errno`` variable is set | |
| 50 | appropriately. The generic error codes are described at the | |
| 51 | :ref:`Generic Error Codes <gen-errors>` chapter. | |
| 52 | ||
| 53 | EINVAL | |
| 54 | The overlay parameters have not been set up. See :ref:`overlay` | |
| 55 | for the necessary steps. |