Documentation/media/uapi/rc/lirc-set-rec-timeout.rst

   1 .. -*- coding: utf-8; mode: rst -*-
   2
   3 .. _lirc_set_rec_timeout:
   4
   5 **************************
   6 ioctl LIRC_SET_REC_TIMEOUT
   7 **************************
   8
   9 Name
  10 ====
  11
  12 LIRC_SET_REC_TIMEOUT - sets the integer value for IR inactivity timeout.
  13
  14 Synopsis
  15 ========
  16
  17 .. cpp:function:: int ioctl( int fd, int request, __u32 *timeout )
  18
  19 Arguments
  20 =========
  21
  22 ``fd``
  23     File descriptor returned by open().
  24
  25 ``request``
  26     LIRC_SET_REC_TIMEOUT
  27
  28 ``timeout``
  29     Timeout, in microseconds.
  30
  31
  32 Description
  33 ===========
  34
  35 Sets the integer value for IR inactivity timeout.
  36
  37 If supported by the hardware, setting it to 0  disables all hardware timeouts
  38 and data should be reported as soon as possible. If the exact value
  39 cannot be set, then the next possible value _greater_ than the
  40 given value should be set.
  41
  42 .. note::
  43
  44    The range of supported timeout is given by :ref:`LIRC_GET_MIN_TIMEOUT`.
  45
  46
  47 Return Value
  48 ============
  49
  50 On success 0 is returned, on error -1 and the ``errno`` variable is set
  51 appropriately. The generic error codes are described at the
  52 :ref:`Generic Error Codes <gen-errors>` chapter.