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 .. cpp:function:: int ioctl( int fd, int request = DMX_SET_BUFFER_SIZE, unsigned long size)
  19
  20
  21 Arguments
  22 ---------
  23
  24 .. flat-table::
  25     :header-rows:  0
  26     :stub-columns: 0
  27
  28
  29     -  .. row 1
  30
  31        -  int fd
  32
  33        -  File descriptor returned by a previous call to open().
  34
  35     -  .. row 2
  36
  37        -  int request
  38
  39        -  Equals DMX_SET_BUFFER_SIZE for this command.
  40
  41     -  .. row 3
  42
  43        -  unsigned long size
  44
  45        -  Size of circular buffer.
  46
  47
  48 Description
  49 -----------
  50
  51 This ioctl call is used to set the size of the circular buffer used for
  52 filtered data. The default size is two maximum sized sections, i.e. if
  53 this function is not called a buffer size of 2 \* 4096 bytes will be
  54 used.
  55
  56
  57 Return Value
  58 ------------
  59
  60 On success 0 is returned, on error -1 and the ``errno`` variable is set
  61 appropriately. The generic error codes are described at the
  62 :ref:`Generic Error Codes <gen-errors>` chapter.