Package org.harctoolbox.harchardware.ir

Interface ICapture

All Superinterfaces:

AutoCloseable, Closeable, IHarcHardware, IIrReader

All Known Implementing Classes:

CommandFusion, DevLirc, GirsClient, GlobalCache, IrToy, IrWidget, LircMode2

public interface ICapture
extends IIrReader

This hardware captures IR signals, for analyzing rather than for deployment use. It delivers a modulation frequency, and normally uses a non-demodulating sensor.

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.ModulatedIrSequence	capture()	Listens to the device and returns a sequence.
boolean	stopCapture()	Signals the capturing device that it should stop capturing.

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

capture

org.harctoolbox.ircore.ModulatedIrSequence capture()
                                            throws HarcHardwareException,
IOException,
org.harctoolbox.ircore.InvalidArgumentException

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

org.harctoolbox.ircore.InvalidArgumentException

stopCapture

boolean stopCapture()

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

Returns:

status