Documentation/linux_tv/media/dvb/video-get-navi.rst

   1 .. -*- coding: utf-8; mode: rst -*-
   2
   3 .. _VIDEO_GET_NAVI:
   4
   5 ==============
   6 VIDEO_GET_NAVI
   7 ==============
   8
   9 NAME
  10 ----
  11
  12 VIDEO_GET_NAVI
  13
  14 SYNOPSIS
  15 --------
  16
  17 .. c:function:: int ioctl(fd, int request = VIDEO_GET_NAVI , video_navi_pack_t *navipack)
  18
  19
  20 ARGUMENTS
  21 ---------
  22
  23 .. flat-table::
  24     :header-rows:  0
  25     :stub-columns: 0
  26
  27
  28     -  .. row 1
  29
  30        -  int fd
  31
  32        -  File descriptor returned by a previous call to open().
  33
  34     -  .. row 2
  35
  36        -  int request
  37
  38        -  Equals VIDEO_GET_NAVI for this command.
  39
  40     -  .. row 3
  41
  42        -  video_navi_pack_t \*navipack
  43
  44        -  PCI or DSI pack (private stream 2) according to section ??.
  45
  46
  47 DESCRIPTION
  48 -----------
  49
  50 This ioctl returns navigational information from the DVD stream. This is
  51 especially needed if an encoded stream has to be decoded by the
  52 hardware.
  53
  54
  55 RETURN VALUE
  56 ------------
  57
  58 On success 0 is returned, on error -1 and the ``errno`` variable is set
  59 appropriately. The generic error codes are described at the
  60 :ref:`Generic Error Codes <gen-errors>` chapter.
  61
  62
  63
  64 .. flat-table::
  65     :header-rows:  0
  66     :stub-columns: 0
  67
  68
  69     -  .. row 1
  70
  71        -  ``EFAULT``
  72
  73        -  driver is not able to return navigational information