WIP FPC-III support
[linux/fpc-iii.git] / Documentation / userspace-api / media / dvb / dmx-set-buffer-size.rst
blob13ce4092c2d2831f65da2ec274e99bf30b996b44
1 .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
2 .. c:namespace:: DTV.dmx
4 .. _DMX_SET_BUFFER_SIZE:
6 ===================
7 DMX_SET_BUFFER_SIZE
8 ===================
10 Name
11 ----
13 DMX_SET_BUFFER_SIZE
15 Synopsis
16 --------
18 .. c:macro:: DMX_SET_BUFFER_SIZE
20 ``int ioctl(int fd, DMX_SET_BUFFER_SIZE, unsigned long size)``
22 Arguments
23 ---------
25 ``fd``
26     File descriptor returned by :c:func:`open()`.
28 ``size``
29     Unsigned long size
31 Description
32 -----------
34 This ioctl call is used to set the size of the circular buffer used for
35 filtered data. The default size is two maximum sized sections, i.e. if
36 this function is not called a buffer size of ``2 * 4096`` bytes will be
37 used.
39 Return Value
40 ------------
42 On success 0 is returned.
44 On error -1 is returned, and the ``errno`` variable is set
45 appropriately.
47 The generic error codes are described at the
48 :ref:`Generic Error Codes <gen-errors>` chapter.