org.hid4java

Class HidServicesSpecification

java.lang.Object

org.hid4java.HidServicesSpecification

public class HidServicesSpecification
extends Object

Specification to provide the following to API consumers:

• Flexible configuration of HID services parameters

Since:

0.5.0

Constructor Summary

Constructors

Constructor and Description
HidServicesSpecification()

Method Summary

Modifier and Type	Method and Description
int	getPauseInterval()
int	getScanInterval()
ScanMode	getScanMode()
boolean	isAutoShutdown()
void	setAutoShutdown(boolean autoShutdown)
void	setPauseInterval(int pauseInterval)
void	setScanInterval(int scanInterval)
void	setScanMode(ScanMode scanMode)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

HidServicesSpecification

public HidServicesSpecification()

Method Detail

getScanMode

public ScanMode getScanMode()

setScanMode

public void setScanMode(ScanMode scanMode)

Parameters:

scanMode - The scan mode to use to facilitate attach/detach events

getScanInterval

public int getScanInterval()

setScanInterval

public void setScanInterval(int scanInterval)

Parameters:

scanInterval - The interval in milliseconds between device enumeration scans

getPauseInterval

public int getPauseInterval()

setPauseInterval

public void setPauseInterval(int pauseInterval)

Parameters:

pauseInterval - The interval in milliseconds where device enumeration is paused (if scan mode supports pausing)

isAutoShutdown

public boolean isAutoShutdown()

setAutoShutdown

public void setAutoShutdown(boolean autoShutdown)

Parameters:

autoShutdown - True if a shutdown hook should be set to close the API automatically (recommended)