Merge branch 'for-linus' of git://git.kernel.org/pub/scm/linux/kernel/git/dtor/input
[sfrench/cifs-2.6.git] / Documentation / media / uapi / dvb / video-play.rst
1 .. Permission is granted to copy, distribute and/or modify this
2 .. document under the terms of the GNU Free Documentation License,
3 .. Version 1.1 or any later version published by the Free Software
4 .. Foundation, with no Invariant Sections, no Front-Cover Texts
5 .. and no Back-Cover Texts. A copy of the license is included at
6 .. Documentation/media/uapi/fdl-appendix.rst.
7 ..
8 .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections
9
10 .. _VIDEO_PLAY:
11
12 ==========
13 VIDEO_PLAY
14 ==========
15
16 Name
17 ----
18
19 VIDEO_PLAY
20
21 .. attention:: This ioctl is deprecated.
22
23 Synopsis
24 --------
25
26 .. c:function:: int ioctl(fd, VIDEO_PLAY)
27     :name: VIDEO_PLAY
28
29
30 Arguments
31 ---------
32
33 .. flat-table::
34     :header-rows:  0
35     :stub-columns: 0
36
37
38     -  .. row 1
39
40        -  int fd
41
42        -  File descriptor returned by a previous call to open().
43
44     -  .. row 2
45
46        -  int request
47
48        -  Equals VIDEO_PLAY for this command.
49
50
51 Description
52 -----------
53
54 This ioctl is for Digital TV devices only. To control a V4L2 decoder use the
55 V4L2 :ref:`VIDIOC_DECODER_CMD` instead.
56
57 This ioctl call asks the Video Device to start playing a video stream
58 from the selected source.
59
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.