1.. -*- coding: utf-8; mode: rst -*-
2
3.. _lirc_get_rec_resolution:
4
5*****************************
6ioctl LIRC_GET_REC_RESOLUTION
7*****************************
8
9Name
10====
11
12LIRC_GET_REC_RESOLUTION - Obtain the value of receive resolution, in microseconds.
13
14Synopsis
15========
16
17.. c:function:: int ioctl( int fd, LIRC_GET_REC_RESOLUTION, __u32 *microseconds)
18    :name: LIRC_GET_REC_RESOLUTION
19
20Arguments
21=========
22
23``fd``
24    File descriptor returned by open().
25
26``microseconds``
27    Resolution, in microseconds.
28
29
30Description
31===========
32
33Some receivers have maximum resolution which is defined by internal
34sample rate or data format limitations. E.g. it's common that
35signals can only be reported in 50 microsecond steps.
36
37This ioctl returns the integer value with such resolution, with can be
38used by userspace applications like lircd to automatically adjust the
39tolerance value.
40
41
42Return Value
43============
44
45On success 0 is returned, on error -1 and the ``errno`` variable is set
46appropriately. The generic error codes are described at the
47:ref:`Generic Error Codes <gen-errors>` chapter.
48