Documentation/media/uapi/dvb/video-get-capabilities.rst

   1 .. Permission is granted to copy, distribute and/or modify this
   2 .. document under the terms of the GNU Free Documentation License,
   3 .. Version 1.1 or any later version published by the Free Software
   4 .. Foundation, with no Invariant Sections, no Front-Cover Texts
   5 .. and no Back-Cover Texts. A copy of the license is included at
   6 .. Documentation/media/uapi/fdl-appendix.rst.
   7 ..
   8 .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections
   9
  10 .. _VIDEO_GET_CAPABILITIES:
  11
  12 ======================
  13 VIDEO_GET_CAPABILITIES
  14 ======================
  15
  16 Name
  17 ----
  18
  19 VIDEO_GET_CAPABILITIES
  20
  21 .. attention:: This ioctl is deprecated.
  22
  23 Synopsis
  24 --------
  25
  26 .. c:function:: int ioctl(fd, VIDEO_GET_CAPABILITIES, unsigned int *cap)
  27     :name: VIDEO_GET_CAPABILITIES
  28
  29
  30 Arguments
  31 ---------
  32
  33 .. flat-table::
  34     :header-rows:  0
  35     :stub-columns: 0
  36
  37
  38     -  .. row 1
  39
  40        -  int fd
  41
  42        -  File descriptor returned by a previous call to open().
  43
  44     -  .. row 2
  45
  46        -  int request
  47
  48        -  Equals VIDEO_GET_CAPABILITIES for this command.
  49
  50     -  .. row 3
  51
  52        -  unsigned int \*cap
  53
  54        -  Pointer to a location where to store the capability information.
  55
  56
  57 Description
  58 -----------
  59
  60 This ioctl call asks the video device about its decoding capabilities.
  61 On success it returns and integer which has bits set according to the
  62 defines in section ??.
  63
  64
  65 Return Value
  66 ------------
  67
  68 On success 0 is returned, on error -1 and the ``errno`` variable is set
  69 appropriately. The generic error codes are described at the
  70 :ref:`Generic Error Codes <gen-errors>` chapter.