Documentation/media/uapi/dvb/video-command.rst

   1 .. -*- coding: utf-8; mode: rst -*-
   2
   3 .. _VIDEO_COMMAND:
   4
   5 =============
   6 VIDEO_COMMAND
   7 =============
   8
   9 Name
  10 ----
  11
  12 VIDEO_COMMAND
  13
  14
  15 Synopsis
  16 --------
  17
  18 .. cpp:function:: int ioctl(int fd, int request = VIDEO_COMMAND, struct video_command *cmd)
  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_COMMAND for this command.
  40
  41     -  .. row 3
  42
  43        -  struct video_command \*cmd
  44
  45        -  Commands the decoder.
  46
  47
  48 Description
  49 -----------
  50
  51 This ioctl is obsolete. Do not use in new drivers. For V4L2 decoders
  52 this ioctl has been replaced by the
  53 :ref:`VIDIOC_DECODER_CMD` ioctl.
  54
  55 This ioctl commands the decoder. The ``video_command`` struct is a
  56 subset of the ``v4l2_decoder_cmd`` struct, so refer to the
  57 :ref:`VIDIOC_DECODER_CMD` documentation for
  58 more information.
  59
  60
  61 Return Value
  62 ------------
  63
  64 On success 0 is returned, on error -1 and the ``errno`` variable is set
  65 appropriately. The generic error codes are described at the
  66 :ref:`Generic Error Codes <gen-errors>` chapter.