summaryrefslogtreecommitdiffstats
path: root/Documentation/userspace-api/media/dvb/dmx-set-buffer-size.rst
diff options
context:
space:
mode:
Diffstat (limited to 'Documentation/userspace-api/media/dvb/dmx-set-buffer-size.rst')
-rw-r--r--Documentation/userspace-api/media/dvb/dmx-set-buffer-size.rst48
1 files changed, 48 insertions, 0 deletions
diff --git a/Documentation/userspace-api/media/dvb/dmx-set-buffer-size.rst b/Documentation/userspace-api/media/dvb/dmx-set-buffer-size.rst
new file mode 100644
index 0000000000..13ce4092c2
--- /dev/null
+++ b/Documentation/userspace-api/media/dvb/dmx-set-buffer-size.rst
@@ -0,0 +1,48 @@
+.. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
+.. c:namespace:: DTV.dmx
+
+.. _DMX_SET_BUFFER_SIZE:
+
+===================
+DMX_SET_BUFFER_SIZE
+===================
+
+Name
+----
+
+DMX_SET_BUFFER_SIZE
+
+Synopsis
+--------
+
+.. c:macro:: DMX_SET_BUFFER_SIZE
+
+``int ioctl(int fd, DMX_SET_BUFFER_SIZE, unsigned long size)``
+
+Arguments
+---------
+
+``fd``
+ File descriptor returned by :c:func:`open()`.
+
+``size``
+ Unsigned long 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.
+
+Return Value
+------------
+
+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
+:ref:`Generic Error Codes <gen-errors>` chapter.