linux/Documentation/media/uapi/dvb/video-fast-forward.rst
Mauro Carvalho Chehab cf8076c314 [media] docs-rst: Convert DVB uAPI to use C function references
Name all ioctl references and make them match the ioctls that
are documented. That will improve the cross-reference index,
as it will have all ioctls and syscalls there.

While here, improve the documentation, marking the deprecated
ioctls, and making the non-deprecated ones more like the rest
of the media book.

Also, add a notice for ioctls that still require documentation.

Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-08-22 21:23:34 -03:00

77 lines
1.2 KiB
ReStructuredText

.. -*- coding: utf-8; mode: rst -*-
.. _VIDEO_FAST_FORWARD:
==================
VIDEO_FAST_FORWARD
==================
Name
----
VIDEO_FAST_FORWARD
.. attention:: This ioctl is deprecated.
Synopsis
--------
.. c:function:: int ioctl(fd, VIDEO_FAST_FORWARD, int nFrames)
:name: VIDEO_FAST_FORWARD
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_FAST_FORWARD for this command.
- .. row 3
- int nFrames
- The number of frames to skip.
Description
-----------
This ioctl call asks the Video Device to skip decoding of N number of
I-frames. This call can only be used if VIDEO_SOURCE_MEMORY is
selected.
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.
.. flat-table::
:header-rows: 0
:stub-columns: 0
- .. row 1
- ``EPERM``
- Mode VIDEO_SOURCE_MEMORY not selected.