Merge branch 'pm-cpufreq'
[cascardo/linux.git] / Documentation / media / uapi / dvb / video-get-frame-count.rst
1 .. -*- coding: utf-8; mode: rst -*-
2
3 .. _VIDEO_GET_FRAME_COUNT:
4
5 =====================
6 VIDEO_GET_FRAME_COUNT
7 =====================
8
9 Name
10 ----
11
12 VIDEO_GET_FRAME_COUNT
13
14 .. attention:: This ioctl is deprecated.
15
16 Synopsis
17 --------
18
19 .. c:function:: int ioctl(int fd, VIDEO_GET_FRAME_COUNT, __u64 *pts)
20     :name: VIDEO_GET_FRAME_COUNT
21
22
23 Arguments
24 ---------
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_GET_FRAME_COUNT for this command.
42
43     -  .. row 3
44
45        -  __u64 \*pts
46
47        -  Returns the number of frames displayed since the decoder was
48           started.
49
50
51 Description
52 -----------
53
54 This ioctl is obsolete. Do not use in new drivers. For V4L2 decoders
55 this ioctl has been replaced by the ``V4L2_CID_MPEG_VIDEO_DEC_FRAME``
56 control.
57
58 This ioctl call asks the Video Device to return the number of displayed
59 frames since the decoder was started.
60
61
62 Return Value
63 ------------
64
65 On success 0 is returned, on error -1 and the ``errno`` variable is set
66 appropriately. The generic error codes are described at the
67 :ref:`Generic Error Codes <gen-errors>` chapter.