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