org.harctoolbox.harchardware.ir

Interface IReceive

All Superinterfaces:

AutoCloseable, Closeable, IHarcHardware, IIrReader

All Known Implementing Classes:

Arduino, DevLirc, GirsClient, 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

defaultBeginTimeout, defaultCaptureMaxSize, defaultEndTimeout

Method Summary

Modifier and Type	Method and Description
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 org.harctoolbox.harchardware.ir.IIrReader

setBeginTimeout, setCaptureMaxSize, setEndTimeout

Methods inherited from interface org.harctoolbox.harchardware.IHarcHardware

getVersion, isValid, open, setDebug, setTimeout, setVerbosity

Methods inherited from interface java.io.Closeable

close

Method Detail

receive

IrSequence receive()
            throws HarcHardwareException,
                   IOException,
                   IrpMasterException

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

IrpMasterException

stopReceive

boolean stopReceive()

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

Returns:

status