Merge remote-tracking branch 'mmc-uh/next'
[deliverable/linux.git] / Documentation / media / uapi / dvb / video-command.rst
CommitLineData
47d23e36
MCC
1.. -*- coding: utf-8; mode: rst -*-
2
3.. _VIDEO_COMMAND:
4
586027ce 5=============
47d23e36
MCC
6VIDEO_COMMAND
7=============
8
15e7d615 9Name
586027ce 10----
47d23e36 11
586027ce 12VIDEO_COMMAND
47d23e36 13
cf8076c3 14.. attention:: This ioctl is deprecated.
15e7d615
MCC
15
16Synopsis
47d23e36
MCC
17--------
18
cf8076c3
MCC
19.. c:function:: int ioctl(int fd, VIDEO_COMMAND, struct video_command *cmd)
20 :name: VIDEO_COMMAND
47d23e36 21
47d23e36 22
15e7d615 23Arguments
586027ce 24---------
47d23e36
MCC
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_COMMAND for this command.
42
43 - .. row 3
44
45 - struct video_command \*cmd
46
47 - Commands the decoder.
48
49
15e7d615 50Description
586027ce
MCC
51-----------
52
53This ioctl is obsolete. Do not use in new drivers. For V4L2 decoders
54this ioctl has been replaced by the
55:ref:`VIDIOC_DECODER_CMD` ioctl.
56
57This ioctl commands the decoder. The ``video_command`` struct is a
58subset of the ``v4l2_decoder_cmd`` struct, so refer to the
59:ref:`VIDIOC_DECODER_CMD` documentation for
60more information.
61
848d1031
MCC
62.. c:type:: struct video_command
63
64.. code-block:: c
65
66 /* The structure must be zeroed before use by the application
67 This ensures it can be extended safely in the future. */
68 struct video_command {
69 __u32 cmd;
70 __u32 flags;
71 union {
72 struct {
73 __u64 pts;
74 } stop;
75
76 struct {
77 /* 0 or 1000 specifies normal speed,
78 1 specifies forward single stepping,
79 -1 specifies backward single stepping,
80 >1: playback at speed/1000 of the normal speed,
81 <-1: reverse playback at (-speed/1000) of the normal speed. */
82 __s32 speed;
83 __u32 format;
84 } play;
85
86 struct {
87 __u32 data[16];
88 } raw;
89 };
90 };
91
586027ce 92
15e7d615 93Return Value
47d23e36
MCC
94------------
95
96On success 0 is returned, on error -1 and the ``errno`` variable is set
97appropriately. The generic error codes are described at the
98:ref:`Generic Error Codes <gen-errors>` chapter.
This page took 0.056827 seconds and 5 git commands to generate.