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
  15 Synopsis
  16 --------
  17
  18 .. cpp:function:: int ioctl(fd, int request = VIDEO_STILLPICTURE, struct video_still_picture *sp)
  19
  20
  21 Arguments
  22 ---------
  23
  24 .. flat-table::
  25     :header-rows:  0
  26     :stub-columns: 0
  27
  28
  29     -  .. row 1
  30
  31        -  int fd
  32
  33        -  File descriptor returned by a previous call to open().
  34
  35     -  .. row 2
  36
  37        -  int request
  38
  39        -  Equals VIDEO_STILLPICTURE for this command.
  40
  41     -  .. row 3
  42
  43        -  struct video_still_picture \*sp
  44
  45        -  Pointer to a location where an I-frame and size is stored.
  46
  47
  48 Description
  49 -----------
  50
  51 This ioctl call asks the Video Device to display a still picture
  52 (I-frame). The input data shall contain an I-frame. If the pointer is
  53 NULL, then the current displayed still picture is blanked.
  54
  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.