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

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