Documentation/media/uapi/rc/lirc-set-wideband-receiver.rst

   1 .. -*- coding: utf-8; mode: rst -*-
   2
   3 .. _lirc_set_wideband_receiver:
   4
   5 ********************************
   6 ioctl LIRC_SET_WIDEBAND_RECEIVER
   7 ********************************
   8
   9 Name
  10 ====
  11
  12 LIRC_SET_WIDEBAND_RECEIVER - enable wide band receiver.
  13
  14 Synopsis
  15 ========
  16
  17 .. c:function:: int ioctl( int fd, LIRC_SET_WIDEBAND_RECEIVER, __u32 *enable )
  18     :name: LIRC_SET_WIDEBAND_RECEIVER
  19
  20 Arguments
  21 =========
  22
  23 ``fd``
  24     File descriptor returned by open().
  25
  26 ``enable``
  27     enable = 1 means enable wideband receiver, enable = 0 means disable
  28     wideband receiver.
  29
  30
  31 Description
  32 ===========
  33
  34 Some receivers are equipped with special wide band receiver which is
  35 intended to be used to learn output of existing remote. This ioctl
  36 allows enabling or disabling it.
  37
  38 This might be useful of receivers that have otherwise narrow band receiver
  39 that prevents them to be used with some remotes. Wide band receiver might
  40 also be more precise. On the other hand its disadvantage it usually
  41 reduced range of reception.
  42
  43 .. note::
  44
  45     Wide band receiver might be implictly enabled if you enable
  46     carrier reports. In that case it will be disabled as soon as you disable
  47     carrier reports. Trying to disable wide band receiver while carrier
  48     reports are active will do nothing.
  49
  50
  51 Return Value
  52 ============
  53
  54 On success 0 is returned, on error -1 and the ``errno`` variable is set
  55 appropriately. The generic error codes are described at the
  56 :ref:`Generic Error Codes <gen-errors>` chapter.