Documentation/media/uapi/v4l/vidioc-overlay.rst

   1 .. -*- coding: utf-8; mode: rst -*-
   2
   3 .. _VIDIOC_OVERLAY:
   4
   5 ********************
   6 ioctl VIDIOC_OVERLAY
   7 ********************
   8
   9 Name
  10 ====
  11
  12 VIDIOC_OVERLAY - Start or stop video overlay
  13
  14
  15 Synopsis
  16 ========
  17
  18 .. cpp:function:: int ioctl( int fd, int request, const int *argp )
  19
  20
  21 Arguments
  22 =========
  23
  24 ``fd``
  25     File descriptor returned by :ref:`open() <func-open>`.
  26
  27 ``request``
  28     VIDIOC_OVERLAY
  29
  30 ``argp``
  31
  32
  33 Description
  34 ===========
  35
  36 This ioctl is part of the :ref:`video overlay <overlay>` I/O method.
  37 Applications call :ref:`VIDIOC_OVERLAY` to start or stop the overlay. It
  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
  41 Drivers do not support :ref:`VIDIOC_STREAMON` or
  42 :ref:`VIDIOC_STREAMOFF <VIDIOC_STREAMON>` with
  43 ``V4L2_BUF_TYPE_VIDEO_OVERLAY``.
  44
  45
  46 Return Value
  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.