Documentation/media/uapi/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 .. attention:: This ioctl is deprecated.
  15
  16 Synopsis
  17 --------
  18
  19 .. c:function:: int ioctl(fd, VIDEO_GET_NAVI , struct video_navi_pack *navipack)
  20     :name: VIDEO_GET_NAVI
  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_GET_NAVI for this command.
  42
  43     -  .. row 3
  44
  45        -  video_navi_pack_t \*navipack
  46
  47        -  PCI or DSI pack (private stream 2) according to section ??.
  48
  49
  50 Description
  51 -----------
  52
  53 This ioctl returns navigational information from the DVD stream. This is
  54 especially needed if an encoded stream has to be decoded by the
  55 hardware.
  56
  57 .. c:type:: video_navi_pack
  58
  59 .. code-block::c
  60
  61         typedef struct video_navi_pack {
  62                 int length;          /* 0 ... 1024 */
  63                 __u8 data[1024];
  64         } video_navi_pack_t;
  65
  66 Return Value
  67 ------------
  68
  69 On success 0 is returned, on error -1 and the ``errno`` variable is set
  70 appropriately. The generic error codes are described at the
  71 :ref:`Generic Error Codes <gen-errors>` chapter.
  72
  73
  74
  75 .. flat-table::
  76     :header-rows:  0
  77     :stub-columns: 0
  78
  79
  80     -  .. row 1
  81
  82        -  ``EFAULT``
  83
  84        -  driver is not able to return navigational information