54f38fcae5
Since 2017, there is an space reserved for userspace API,
created by changeset 1d596dee38 ("docs: Create a user-space API guide").
As the media subsystem was one of the first subsystems to use
Sphinx, until this patch, we were keeping things on a separate
place.
Let's just use the new location, as having all uAPI altogether
will likely make things easier for developers.
Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
76 lines
1.7 KiB
ReStructuredText
76 lines
1.7 KiB
ReStructuredText
.. Permission is granted to copy, distribute and/or modify this
|
|
.. document under the terms of the GNU Free Documentation License,
|
|
.. Version 1.1 or any later version published by the Free Software
|
|
.. Foundation, with no Invariant Sections, no Front-Cover Texts
|
|
.. and no Back-Cover Texts. A copy of the license is included at
|
|
.. Documentation/userspace-api/media/fdl-appendix.rst.
|
|
..
|
|
.. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections
|
|
|
|
.. _VIDEO_TRY_COMMAND:
|
|
|
|
=================
|
|
VIDEO_TRY_COMMAND
|
|
=================
|
|
|
|
Name
|
|
----
|
|
|
|
VIDEO_TRY_COMMAND
|
|
|
|
.. attention:: This ioctl is deprecated.
|
|
|
|
Synopsis
|
|
--------
|
|
|
|
.. c:function:: int ioctl(int fd, VIDEO_TRY_COMMAND, struct video_command *cmd)
|
|
:name: VIDEO_TRY_COMMAND
|
|
|
|
|
|
Arguments
|
|
---------
|
|
|
|
.. flat-table::
|
|
:header-rows: 0
|
|
:stub-columns: 0
|
|
|
|
|
|
- .. row 1
|
|
|
|
- int fd
|
|
|
|
- File descriptor returned by a previous call to open().
|
|
|
|
- .. row 2
|
|
|
|
- int request
|
|
|
|
- Equals VIDEO_TRY_COMMAND for this command.
|
|
|
|
- .. row 3
|
|
|
|
- struct video_command \*cmd
|
|
|
|
- Try a decoder command.
|
|
|
|
|
|
Description
|
|
-----------
|
|
|
|
This ioctl is obsolete. Do not use in new drivers. For V4L2 decoders
|
|
this ioctl has been replaced by the
|
|
:ref:`VIDIOC_TRY_DECODER_CMD <VIDIOC_DECODER_CMD>` ioctl.
|
|
|
|
This ioctl tries a decoder command. The ``video_command`` struct is a
|
|
subset of the ``v4l2_decoder_cmd`` struct, so refer to the
|
|
:ref:`VIDIOC_TRY_DECODER_CMD <VIDIOC_DECODER_CMD>` documentation
|
|
for more information.
|
|
|
|
|
|
Return Value
|
|
------------
|
|
|
|
On success 0 is returned, on error -1 and the ``errno`` variable is set
|
|
appropriately. The generic error codes are described at the
|
|
:ref:`Generic Error Codes <gen-errors>` chapter.
|