Documentation/userspace-api/media/dvb/video-fast-forward.rst

   1 .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
   2 .. c:namespace:: DTV.video
   3
   4 .. _VIDEO_FAST_FORWARD:
   5
   6 ==================
   7 VIDEO_FAST_FORWARD
   8 ==================
   9
  10 Name
  11 ----
  12
  13 VIDEO_FAST_FORWARD
  14
  15 .. attention:: This ioctl is deprecated.
  16
  17 Synopsis
  18 --------
  19
  20 .. c:macro:: VIDEO_FAST_FORWARD
  21
  22 ``int ioctl(fd, VIDEO_FAST_FORWARD, int nFrames)``
  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_FAST_FORWARD for this command.
  42
  43     -  .. row 3
  44
  45        -  int nFrames
  46
  47        -  The number of frames to skip.
  48
  49 Description
  50 -----------
  51
  52 This ioctl call asks the Video Device to skip decoding of N number of
  53 I-frames. This call can only be used if VIDEO_SOURCE_MEMORY is
  54 selected.
  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.
  62
  63
  64 .. flat-table::
  65     :header-rows:  0
  66     :stub-columns: 0
  67
  68     -  .. row 1
  69
  70        -  ``EPERM``
  71
  72        -  Mode VIDEO_SOURCE_MEMORY not selected.