linux/Documentation/linux_tv/media/dvb/dmx-set-buffer-size.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

58 lines
1.0 KiB
ReStructuredText

.. -*- coding: utf-8; mode: rst -*-
.. _DMX_SET_BUFFER_SIZE:
DMX_SET_BUFFER_SIZE
===================
Description
-----------
This ioctl call is used to set the size of the circular buffer used for
filtered data. The default size is two maximum sized sections, i.e. if
this function is not called a buffer size of 2 \* 4096 bytes will be
used.
Synopsis
--------
.. c:function:: int ioctl( int fd, int request = DMX_SET_BUFFER_SIZE, unsigned long size)
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 DMX_SET_BUFFER_SIZE for this command.
- .. row 3
- unsigned long size
- Size of circular buffer.
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.