doc-rst: linux_tv: split DVB function call documentation
[deliverable/linux.git] / Documentation / linux_tv / media / dvb / video-get-frame-count.rst
1 .. -*- coding: utf-8; mode: rst -*-
2
3 .. _VIDEO_GET_FRAME_COUNT:
4
5 VIDEO_GET_FRAME_COUNT
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 ``V4L2_CID_MPEG_VIDEO_DEC_FRAME``
13 control.
14
15 This ioctl call asks the Video Device to return the number of displayed
16 frames since the decoder was started.
17
18 Synopsis
19 --------
20
21 .. c:function:: int ioctl(int fd, int request = VIDEO_GET_FRAME_COUNT, __u64 *pts)
22
23 Arguments
24 ----------
25
26
27
28 .. flat-table::
29 :header-rows: 0
30 :stub-columns: 0
31
32
33 - .. row 1
34
35 - int fd
36
37 - File descriptor returned by a previous call to open().
38
39 - .. row 2
40
41 - int request
42
43 - Equals VIDEO_GET_FRAME_COUNT for this command.
44
45 - .. row 3
46
47 - __u64 \*pts
48
49 - Returns the number of frames displayed since the decoder was
50 started.
51
52
53 Return Value
54 ------------
55
56 On success 0 is returned, on error -1 and the ``errno`` variable is set
57 appropriately. The generic error codes are described at the
58 :ref:`Generic Error Codes <gen-errors>` chapter.
59
60
This page took 0.192987 seconds and 5 git commands to generate.