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

   1 .. -*- coding: utf-8; mode: rst -*-
   2
   3 .. _DMX_SET_BUFFER_SIZE:
   4
   5 ===================
   6 DMX_SET_BUFFER_SIZE
   7 ===================
   8
   9 Name
  10 ----
  11
  12 DMX_SET_BUFFER_SIZE
  13
  14
  15 Synopsis
  16 --------
  17
  18 .. c:function:: int ioctl( int fd, DMX_SET_BUFFER_SIZE, unsigned long size)
  19     :name: DMX_SET_BUFFER_SIZE
  20
  21
  22 Arguments
  23 ---------
  24
  25 ``fd``
  26     File descriptor returned by :c:func:`open() <dvb-dmx-open>`.
  27
  28 ``size``
  29     Unsigned long size
  30
  31 Description
  32 -----------
  33
  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.
  38
  39
  40 Return Value
  41 ------------
  42
  43
  44 On success 0 is returned.
  45
  46 On error -1 is returned, and the ``errno`` variable is set
  47 appropriately.
  48
  49 The generic error codes are described at the
  50 :ref:`Generic Error Codes <gen-errors>` chapter.