Documentation/userspace-api/media/dvb/video-stillpicture.rst

   1 .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
   2 .. c:namespace:: DTV.video
   3
   4 .. _VIDEO_STILLPICTURE:
   5
   6 ==================
   7 VIDEO_STILLPICTURE
   8 ==================
   9
  10 Name
  11 ----
  12
  13 VIDEO_STILLPICTURE
  14
  15 .. attention:: This ioctl is deprecated.
  16
  17 Synopsis
  18 --------
  19
  20 .. c:macro:: VIDEO_STILLPICTURE
  21
  22 ``int ioctl(fd, VIDEO_STILLPICTURE, struct video_still_picture *sp)``
  23
  24 Arguments
  25 ---------
  26
  27 .. flat-table::
  28     :header-rows:  0
  29     :stub-columns: 0
  30
  31     -  .. row 1
  32
  33        -  int fd
  34
  35        -  File descriptor returned by a previous call to open().
  36
  37     -  .. row 2
  38
  39        -  int request
  40
  41        -  Equals VIDEO_STILLPICTURE for this command.
  42
  43     -  .. row 3
  44
  45        -  struct video_still_picture \*sp
  46
  47        -  Pointer to a location where an I-frame and size is stored.
  48
  49 Description
  50 -----------
  51
  52 This ioctl call asks the Video Device to display a still picture
  53 (I-frame). The input data shall contain an I-frame. If the pointer is
  54 NULL, then the current displayed still picture is blanked.
  55
  56 Return Value
  57 ------------
  58
  59 On success 0 is returned, on error -1 and the ``errno`` variable is set
  60 appropriately. The generic error codes are described at the
  61 :ref:`Generic Error Codes <gen-errors>` chapter.