[media] docs-rst: Convert V4L2 uAPI to use C function references
[deliverable/linux.git] / Documentation / media / uapi / dvb / video-try-command.rst
CommitLineData
47d23e36
MCC
1.. -*- coding: utf-8; mode: rst -*-
2
3.. _VIDEO_TRY_COMMAND:
4
586027ce 5=================
47d23e36
MCC
6VIDEO_TRY_COMMAND
7=================
8
15e7d615 9Name
586027ce 10----
47d23e36 11
586027ce 12VIDEO_TRY_COMMAND
47d23e36 13
15e7d615
MCC
14
15Synopsis
47d23e36
MCC
16--------
17
1b81f010 18.. c:function:: int ioctl(int fd, int request = VIDEO_TRY_COMMAND, struct video_command *cmd)
47d23e36 19
47d23e36 20
15e7d615 21Arguments
586027ce 22---------
47d23e36
MCC
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_TRY_COMMAND for this command.
40
41 - .. row 3
42
43 - struct video_command \*cmd
44
45 - Try a decoder command.
46
47
15e7d615 48Description
586027ce
MCC
49-----------
50
51This ioctl is obsolete. Do not use in new drivers. For V4L2 decoders
52this ioctl has been replaced by the
53:ref:`VIDIOC_TRY_DECODER_CMD <VIDIOC_DECODER_CMD>` ioctl.
54
55This ioctl tries a decoder command. The ``video_command`` struct is a
56subset of the ``v4l2_decoder_cmd`` struct, so refer to the
57:ref:`VIDIOC_TRY_DECODER_CMD <VIDIOC_DECODER_CMD>` documentation
58for more information.
59
60
15e7d615 61Return Value
47d23e36
MCC
62------------
63
64On success 0 is returned, on error -1 and the ``errno`` variable is set
65appropriately. The generic error codes are described at the
66:ref:`Generic Error Codes <gen-errors>` chapter.
This page took 0.070102 seconds and 5 git commands to generate.