lirc-get-timeout.rst (1435B)
1.. SPDX-License-Identifier: GPL-2.0 OR GFDL-1.1-no-invariants-or-later 2.. c:namespace:: RC 3 4.. _lirc_get_min_timeout: 5.. _lirc_get_max_timeout: 6 7**************************************************** 8ioctls LIRC_GET_MIN_TIMEOUT and LIRC_GET_MAX_TIMEOUT 9**************************************************** 10 11Name 12==== 13 14LIRC_GET_MIN_TIMEOUT / LIRC_GET_MAX_TIMEOUT - Obtain the possible timeout 15range for IR receive. 16 17Synopsis 18======== 19 20.. c:macro:: LIRC_GET_MIN_TIMEOUT 21 22``int ioctl(int fd, LIRC_GET_MIN_TIMEOUT, __u32 *timeout)`` 23 24.. c:macro:: LIRC_GET_MAX_TIMEOUT 25 26``int ioctl(int fd, LIRC_GET_MAX_TIMEOUT, __u32 *timeout)`` 27 28Arguments 29========= 30 31``fd`` 32 File descriptor returned by open(). 33 34``timeout`` 35 Timeout, in microseconds. 36 37Description 38=========== 39 40Some devices have internal timers that can be used to detect when 41there's no IR activity for a long time. This can help lircd in 42detecting that a IR signal is finished and can speed up the decoding 43process. Returns an integer value with the minimum/maximum timeout 44that can be set. 45 46.. note:: 47 48 Some devices have a fixed timeout, in that case 49 both ioctls will return the same value even though the timeout 50 cannot be changed via :ref:`LIRC_SET_REC_TIMEOUT`. 51 52Return Value 53============ 54 55On success 0 is returned, on error -1 and the ``errno`` variable is set 56appropriately. The generic error codes are described at the 57:ref:`Generic Error Codes <gen-errors>` chapter.