linux/Documentation/userspace-api/media/dvb/video-clear-buffer.rst
Mauro Carvalho Chehab f9b2e8aa32 media: docs: make DVB documents more compatible with Sphinx 3.1+
Sphinx 3.x broke support for the cdomain.py extension, as the
c domain code was rewritten. Due to that, the c tags need to
be re-written, in order to use the new c domain notation.

Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
2020-10-15 07:49:39 +02:00

55 lines
929 B
ReStructuredText

.. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
.. c:namespace:: DTV.video
.. _VIDEO_CLEAR_BUFFER:
==================
VIDEO_CLEAR_BUFFER
==================
Name
----
VIDEO_CLEAR_BUFFER
.. attention:: This ioctl is deprecated.
Synopsis
--------
.. c:macro:: VIDEO_CLEAR_BUFFER
``int ioctl(fd, VIDEO_CLEAR_BUFFER)``
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_CLEAR_BUFFER for this command.
Description
-----------
This ioctl call clears all video buffers in the driver and in the
decoder hardware.
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.