Commit | Line | Data |
---|---|---|
191fbb90 MCC |
1 | .. -*- coding: utf-8; mode: rst -*- |
2 | ||
3 | .. _lirc_set_transmitter_mask: | |
4 | ||
5 | ******************************* | |
6 | ioctl LIRC_SET_TRANSMITTER_MASK | |
7 | ******************************* | |
8 | ||
9 | Name | |
10 | ==== | |
11 | ||
12 | LIRC_SET_TRANSMITTER_MASK - Enables send codes on a given set of transmitters | |
13 | ||
14 | Synopsis | |
15 | ======== | |
16 | ||
17 | .. cpp:function:: int ioctl( int fd, int request, __u32 *mask ) | |
18 | ||
19 | Arguments | |
20 | ========= | |
21 | ||
22 | ``fd`` | |
23 | File descriptor returned by open(). | |
24 | ||
25 | ``request`` | |
26 | LIRC_SET_TRANSMITTER_MASK | |
27 | ||
28 | ``mask`` | |
29 | Mask with channels to enable tx. Channel 0 is the least significant bit. | |
30 | ||
31 | ||
32 | Description | |
33 | =========== | |
34 | ||
35 | Some IR TX devices have multiple output channels, in such case, | |
36 | :ref:`LIRC_CAN_SET_TRANSMITTER_MASK <LIRC-CAN-SET-TRANSMITTER-MASK>` is | |
37 | returned via :ref:`LIRC_GET_FEATURES` and this ioctl sets what channels will | |
38 | send IR codes. | |
39 | ||
40 | This ioctl enables the given set of transmitters. The first transmitter is | |
41 | encoded by the least significant bit and so on. | |
42 | ||
43 | When an invalid bit mask is given, i.e. a bit is set, even though the device | |
44 | does not have so many transitters, then this ioctl returns the number of | |
45 | available transitters and does nothing otherwise. | |
46 | ||
47 | ||
48 | Return Value | |
49 | ============ | |
50 | ||
51 | On success 0 is returned, on error -1 and the ``errno`` variable is set | |
52 | appropriately. The generic error codes are described at the | |
53 | :ref:`Generic Error Codes <gen-errors>` chapter. |