doc-rst: linux_tv: split DVB function call documentation
[deliverable/linux.git] / Documentation / linux_tv / media / dvb / video-try-command.rst
1 .. -*- coding: utf-8; mode: rst -*-
2
3 .. _VIDEO_TRY_COMMAND:
4
5 VIDEO_TRY_COMMAND
6 =================
7
8 Description
9 -----------
10
11 This ioctl is obsolete. Do not use in new drivers. For V4L2 decoders
12 this ioctl has been replaced by the
13 :ref:`VIDIOC_TRY_DECODER_CMD <VIDIOC_DECODER_CMD>` ioctl.
14
15 This ioctl tries a decoder command. The ``video_command`` struct is a
16 subset of the ``v4l2_decoder_cmd`` struct, so refer to the
17 :ref:`VIDIOC_TRY_DECODER_CMD <VIDIOC_DECODER_CMD>` documentation
18 for more information.
19
20 Synopsis
21 --------
22
23 .. c:function:: int ioctl(int fd, int request = VIDEO_TRY_COMMAND, struct video_command *cmd)
24
25 Arguments
26 ----------
27
28
29
30 .. flat-table::
31 :header-rows: 0
32 :stub-columns: 0
33
34
35 - .. row 1
36
37 - int fd
38
39 - File descriptor returned by a previous call to open().
40
41 - .. row 2
42
43 - int request
44
45 - Equals VIDEO_TRY_COMMAND for this command.
46
47 - .. row 3
48
49 - struct video_command \*cmd
50
51 - Try a decoder command.
52
53
54 Return Value
55 ------------
56
57 On success 0 is returned, on error -1 and the ``errno`` variable is set
58 appropriately. The generic error codes are described at the
59 :ref:`Generic Error Codes <gen-errors>` chapter.
60
61
This page took 0.038493 seconds and 5 git commands to generate.