linux/Documentation/linux_tv/media/dvb/video-get-frame-rate.rst
Mauro Carvalho Chehab 47d23e363f doc-rst: linux_tv: split DVB function call documentation
Just like V4L, split the DVB function calls into one file per
system call. This is a requirement for the man pages creator
on Sphinx to work, and makes the document easier to maintain.

Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-05 10:44:33 -03:00

55 lines
926 B
ReStructuredText

.. -*- coding: utf-8; mode: rst -*-
.. _VIDEO_GET_FRAME_RATE:
VIDEO_GET_FRAME_RATE
====================
Description
-----------
This ioctl call asks the Video Device to return the current framerate.
Synopsis
--------
.. c:function:: int ioctl(int fd, int request = VIDEO_GET_FRAME_RATE, unsigned int *rate)
Arguments
----------
.. flat-table::
:header-rows: 0
:stub-columns: 0
- .. row 1
- int fd
- File descriptor returned by a previous call to open().
- .. row 2
- int request
- Equals VIDEO_GET_FRAME_RATE for this command.
- .. row 3
- unsigned int \*rate
- Returns the framerate in number of frames per 1000 seconds.
Return Value
------------
On success 0 is returned, on error -1 and the ``errno`` variable is set
appropriately. The generic error codes are described at the
:ref:`Generic Error Codes <gen-errors>` chapter.