Documentation/userspace-api/media/dvb/video-try-command.rst

   1 .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
   2 .. c:namespace:: DTV.video
   3
   4 .. _VIDEO_TRY_COMMAND:
   5
   6 =================
   7 VIDEO_TRY_COMMAND
   8 =================
   9
  10 Name
  11 ----
  12
  13 VIDEO_TRY_COMMAND
  14
  15 .. attention:: This ioctl is deprecated.
  16
  17 Synopsis
  18 --------
  19
  20 .. c:macro:: VIDEO_TRY_COMMAND
  21
  22 ``int ioctl(int fd, VIDEO_TRY_COMMAND, struct video_command *cmd)``
  23
  24 Arguments
  25 ---------
  26
  27 .. flat-table::
  28     :header-rows:  0
  29     :stub-columns: 0
  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 Description
  50 -----------
  51
  52 This ioctl is obsolete. Do not use in new drivers. For V4L2 decoders
  53 this ioctl has been replaced by the
  54 :ref:`VIDIOC_TRY_DECODER_CMD <VIDIOC_DECODER_CMD>` ioctl.
  55
  56 This ioctl tries a decoder command. The ``video_command`` struct is a
  57 subset of the ``v4l2_decoder_cmd`` struct, so refer to the
  58 :ref:`VIDIOC_TRY_DECODER_CMD <VIDIOC_DECODER_CMD>` documentation
  59 for more information.
  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.