linux/Documentation/media/uapi/dvb/video-clear-buffer.rst
Mauro Carvalho Chehab 60c2820d0f doc_rst: rename the media Sphinx suff to Documentation/media
The name of the subsystem is "media", and not "linux_tv". Also,
as we plan to add other stuff there in the future, let's
rename also the media uAPI book to media_uapi, to make it
clearer.

No functional changes.

Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-08 11:59:40 -03:00

55 lines
836 B
ReStructuredText

.. -*- coding: utf-8; mode: rst -*-
.. _VIDEO_CLEAR_BUFFER:
==================
VIDEO_CLEAR_BUFFER
==================
Name
----
VIDEO_CLEAR_BUFFER
Synopsis
--------
.. cpp:function:: int ioctl(fd, int request = 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.