Documentation/media/uapi/dvb/dmx-set-buffer-size.rst

   1 .. Permission is granted to copy, distribute and/or modify this
   2 .. document under the terms of the GNU Free Documentation License,
   3 .. Version 1.1 or any later version published by the Free Software
   4 .. Foundation, with no Invariant Sections, no Front-Cover Texts
   5 .. and no Back-Cover Texts. A copy of the license is included at
   6 .. Documentation/media/uapi/fdl-appendix.rst.
   7 ..
   8 .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections
   9
  10 .. _DMX_SET_BUFFER_SIZE:
  11
  12 ===================
  13 DMX_SET_BUFFER_SIZE
  14 ===================
  15
  16 Name
  17 ----
  18
  19 DMX_SET_BUFFER_SIZE
  20
  21
  22 Synopsis
  23 --------
  24
  25 .. c:function:: int ioctl( int fd, DMX_SET_BUFFER_SIZE, unsigned long size)
  26     :name: DMX_SET_BUFFER_SIZE
  27
  28
  29 Arguments
  30 ---------
  31
  32 ``fd``
  33     File descriptor returned by :c:func:`open() <dvb-dmx-open>`.
  34
  35 ``size``
  36     Unsigned long size
  37
  38 Description
  39 -----------
  40
  41 This ioctl call is used to set the size of the circular buffer used for
  42 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 used.
  45
  46
  47 Return Value
  48 ------------
  49
  50
  51 On success 0 is returned.
  52
  53 On error -1 is returned, and the ``errno`` variable is set
  54 appropriately.
  55
  56 The generic error codes are described at the
  57 :ref:`Generic Error Codes <gen-errors>` chapter.