Package org.harctoolbox.harchardware.ir

Interface IReceive

All Superinterfaces:

AutoCloseable, Closeable, IHarcHardware, IIrReader

All Known Implementing Classes:

DevLirc, GirsClient, IRrecvDumpV2, IrToy, LircMode2

public interface IReceive
extends IIrReader

This hardware can receive an IR signal for deployment. It does not return a modulation frequency, and normally uses demodulating hardware.

Field Summary

Fields inherited from interface org.harctoolbox.harchardware.ir.IIrReader

DEFAULT_BEGIN_TIMEOUT, DEFAULT_CAPTURE_MAXSIZE, DEFAULT_ENDING_TIMEOUT

Method Summary

Modifier and Type	Method	Description
org.harctoolbox.ircore.IrSequence	receive()	Listens to the device and returns a sequence.
boolean	stopReceive()	Signals the receiving device that it should stop receiving.

Methods inherited from interface java.io.Closeable

close

Methods inherited from interface org.harctoolbox.harchardware.IHarcHardware

getVersion, isValid, open, setDebug, setTimeout, setVerbose

Methods inherited from interface org.harctoolbox.harchardware.ir.IIrReader

setBeginTimeout, setCaptureMaxSize, setEndingTimeout

Method Details

receive

org.harctoolbox.ircore.IrSequence receive()
                                   throws HarcHardwareException,
IOException,
org.harctoolbox.ircore.OddSequenceLengthException

Listens to the device and returns a sequence. Requires the device to be previously opened. Should itself neither open or close the device.

Returns:

Captured sequence, or null by timeout.

Throws:

HarcHardwareException - if the device is not in valid/open state.

IOException

org.harctoolbox.ircore.OddSequenceLengthException

stopReceive

boolean stopReceive()

Signals the receiving device that it should stop receiving. May not be implemented in all hardware.

Returns:

status