Merge branch 'next-integrity' of git://git.kernel.org/pub/scm/linux/kernel/git/jmorri...
[sfrench/cifs-2.6.git] / Documentation / media / uapi / dvb / video-slowmotion.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_SLOWMOTION:
11
12 ================
13 VIDEO_SLOWMOTION
14 ================
15
16 Name
17 ----
18
19 VIDEO_SLOWMOTION
20
21 .. attention:: This ioctl is deprecated.
22
23 Synopsis
24 --------
25
26 .. c:function:: int ioctl(fd, VIDEO_SLOWMOTION, int nFrames)
27     :name: VIDEO_SLOWMOTION
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_SLOWMOTION for this command.
49
50     -  .. row 3
51
52        -  int nFrames
53
54        -  The number of times to repeat each frame.
55
56
57 Description
58 -----------
59
60 This ioctl call asks the video device to repeat decoding frames N number
61 of times. This call can only be used if VIDEO_SOURCE_MEMORY is
62 selected.
63
64
65 Return Value
66 ------------
67
68 On success 0 is returned, on error -1 and the ``errno`` variable is set
69 appropriately. The generic error codes are described at the
70 :ref:`Generic Error Codes <gen-errors>` chapter.
71
72
73
74 .. flat-table::
75     :header-rows:  0
76     :stub-columns: 0
77
78
79     -  .. row 1
80
81        -  ``EPERM``
82
83        -  Mode VIDEO_SOURCE_MEMORY not selected.