Documentation/media/uapi/dvb/video-stillpicture.rst

   1 .. -*- coding: utf-8; mode: rst -*-
   2
   3 .. _VIDEO_STILLPICTURE:
   4
   5 ==================
   6 VIDEO_STILLPICTURE
   7 ==================
   8
   9 Name
  10 ----
  11
  12 VIDEO_STILLPICTURE
  13
  14 .. attention:: This ioctl is deprecated.
  15
  16 Synopsis
  17 --------
  18
  19 .. c:function:: int ioctl(fd, VIDEO_STILLPICTURE, struct video_still_picture *sp)
  20     :name: VIDEO_STILLPICTURE
  21
  22
  23 Arguments
  24 ---------
  25
  26 .. flat-table::
  27     :header-rows:  0
  28     :stub-columns: 0
  29
  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
  50 Description
  51 -----------
  52
  53 This ioctl call asks the Video Device to display a still picture
  54 (I-frame). The input data shall contain an I-frame. If the pointer is
  55 NULL, then the current displayed still picture is blanked.
  56
  57
  58 Return Value
  59 ------------
  60
  61 On success 0 is returned, on error -1 and the ``errno`` variable is set
  62 appropriately. The generic error codes are described at the
  63 :ref:`Generic Error Codes <gen-errors>` chapter.