dmx-set-buffer-size.rst 1.27 KB
Newer Older
1 2 3 4 5
.. Permission is granted to copy, distribute and/or modify this
.. document under the terms of the GNU Free Documentation License,
.. Version 1.1 or any later version published by the Free Software
.. Foundation, with no Invariant Sections, no Front-Cover Texts
.. and no Back-Cover Texts. A copy of the license is included at
6
.. Documentation/userspace-api/media/fdl-appendix.rst.
7 8 9
..
.. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections

10 11
.. _DMX_SET_BUFFER_SIZE:

12
===================
13 14 15
DMX_SET_BUFFER_SIZE
===================

16
Name
17
----
18

19
DMX_SET_BUFFER_SIZE
20

21 22

Synopsis
23 24
--------

25 26
.. c:function:: int ioctl( int fd, DMX_SET_BUFFER_SIZE, unsigned long size)
    :name: DMX_SET_BUFFER_SIZE
27 28


29
Arguments
30
---------
31

32 33
``fd``
    File descriptor returned by :c:func:`open() <dvb-dmx-open>`.
34

35 36
``size``
    Unsigned long size
37

38
Description
39 40 41 42
-----------

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
43
this function is not called a buffer size of ``2 * 4096`` bytes will be
44 45 46
used.


47
Return Value
48 49
------------

50 51 52 53 54 55 56

On success 0 is returned.

On error -1 is returned, and the ``errno`` variable is set
appropriately.

The generic error codes are described at the
57
:ref:`Generic Error Codes <gen-errors>` chapter.