[deliverable/linux.git] / Documentation / media / uapi / rc / lirc-set-send-carrier.rst

.. -*- coding: utf-8; mode: rst -*-

.. _lirc_set_send_carrier:

***************************
ioctl LIRC_SET_SEND_CARRIER
***************************

Name
====

LIRC_SET_SEND_CARRIER - Set send carrier used to modulate IR TX.


Synopsis
========

.. c:function:: int ioctl( int fd, LIRC_SET_SEND_CARRIER, __u32 *frequency )
    :name: LIRC_SET_SEND_CARRIER

Arguments
=========

``fd``
    File descriptor returned by open().

``frequency``
    Frequency of the carrier to be modulated, in Hz.

Description
===========

Set send carrier used to modulate IR PWM pulses and spaces.


Return Value
============

On success 0 is returned, on error -1 and the ``errno`` variable is set
appropriately. The generic error codes are described at the
:ref:`Generic Error Codes <gen-errors>` chapter.
Commit	Line	Data
910f4461 MCC	1	.. -- coding: utf-8; mode: rst --
	2
	3	.. _lirc_set_send_carrier:
	4
	5	***************************
	6	ioctl LIRC_SET_SEND_CARRIER
	7	***************************
	8
	9	Name
	10	====
	11
	12	LIRC_SET_SEND_CARRIER - Set send carrier used to modulate IR TX.
	13
	14
	15	Synopsis
	16	========
	17
15c19014 MCC	18	.. c:function:: int ioctl( int fd, LIRC_SET_SEND_CARRIER, __u32 *frequency )
15c19014 MCC	19	:name: LIRC_SET_SEND_CARRIER
910f4461 MCC	20
	21	Arguments
	22	=========
	23
	24	``fd``
	25	File descriptor returned by open().
	26
910f4461 MCC	27	``frequency``
	28	Frequency of the carrier to be modulated, in Hz.
	29
	30	Description
	31	===========
	32
	33	Set send carrier used to modulate IR PWM pulses and spaces.
	34
	35
	36	Return Value
	37	============
	38
	39	On success 0 is returned, on error -1 and the ``errno`` variable is set
	40	appropriately. The generic error codes are described at the
	41	:ref:`Generic Error Codes <gen-errors>` chapter.