Package org.harctoolbox.harchardware.ir

Interface ITransmitter

All Known Implementing Classes:

DevLirc, GirsClient, GlobalCache, IrTrans, IrTransIRDB, LircCcfClient, LircClient

public interface ITransmitter

Some general functions for generating transmitters in a general framework. Semantics may vary depending on the implementation.

Method Summary

Modifier and Type	Method	Description
Transmitter	getTransmitter()	Returns a default transmitter for the present device.
Transmitter	getTransmitter(String connector)	Parses the String argument, and returns a transmitter accordingly.
String[]	getTransmitterNames()	Return possible name of transmitters, that are guaranteed to work with the getTransmitter(String).

Method Details

getTransmitter

Transmitter getTransmitter()

Returns a default transmitter for the present device.

Returns:

Transmitter

getTransmitter

Transmitter getTransmitter(String connector)
                    throws NoSuchTransmitterException

Parses the String argument, and returns a transmitter accordingly. Syntax and semantics may vary.

Parameters:

connector - String describing desired port. Syntax is dependent on the implementing class.

Returns:

Transmitter

Throws:

NoSuchTransmitterException

getTransmitterNames

String[] getTransmitterNames()

Return possible name of transmitters, that are guaranteed to work with the getTransmitter(String). This may be generated by inquiring the device, producing correct result, or it may be some static function, describing transmitters not necessarily present on the actually deployed device.

Returns:

Array of strings that are guaranteed to work with the getTransmitter(String)