com.livescribe.configuration
Class SystemConfig

java.lang.Object
  com.livescribe.configuration.Config
      com.livescribe.configuration.SystemConfig

public class SystemConfig
extends Config

This class provides the ability to access and modify system configuration values.

Certain properties can be set by any application and others can only be set by the system. If a property is disallowed from being set then that set method (currently) will do nothing.

Field Summary

static int	DEFAULT_COORDINATE_FREQUENCY_DIVIDER The default frequency divider when streaming coordinates.
static Object	DEFAULT_VALUE_AUDIO_MUTED Object to maintain the system default value (on/off) for audio mute.
static Object	DEFAULT_VALUE_AUDIO_QUALITY Object to maintain the system default value for audio quality.
static Object	DEFAULT_VALUE_AUDIO_VOLUME Object to maintain the system default value for audio volume.
static Object	DEFAULT_VALUE_DATE_FORMAT Object to maintain the system default value for date format.
static Object	DEFAULT_VALUE_DISPLAY_BRIGHTNESS Object to maintain the system default value for display brightness.
static Object	DEFAULT_VALUE_DISPLAY_ORIENTATION Object to maintain the system default value for display orientation.
static Object	DEFAULT_VALUE_LAUNCHLINE Object to maintain the system default value (on/off) for LaunchLine.
static Object	DEFAULT_VALUE_MIC_SENSITIVITY Object to maintain the system default value for microphone sensitivity.
static Object	DEFAULT_VALUE_PLAYBACK_LATENCY Object to maintain the system default value (on/off) for playback latency.
static Object	DEFAULT_VALUE_SCROLL_SPEED Object to maintain the system default value for scroll speed.
static Object	DEFAULT_VALUE_TIME_FORMAT Object to maintain the system default value for date format.
static Object	DEFAULT_VALUE_VOICE_MENUS Object to maintain the system default value (on/off) for voice menus.
protected static Hashtable	DEFAULT_VALUES Hashtable to maintain the system default values.
protected Locale	locale Contains the current locale.
static String	PROPERTY_BOOL_AUDIO_MUTED String to query the current value for audio mute on/off
static String	PROPERTY_BOOL_DISPLAY_ORIENTATION String to query the current value for display orientation.
static String	PROPERTY_BOOL_LAUNCHLINE String to query the current value (on/off) for LaunchLine.
static String	PROPERTY_BOOL_PLAYBACK_LATENCY String to query the current value (on/off) for playback latency.
static String	PROPERTY_BOOL_VOICE_MENUS String to query the current value for voice menus on/off.
static String	PROPERTY_BYTE_AUDIO_QUALITY String to query the current value for audio quality.
static String	PROPERTY_BYTE_AUDIO_VOLUME String to query the current value for audio volume.
static String	PROPERTY_BYTE_DATE_FORMAT String to query the current value for date format
static String	PROPERTY_BYTE_DISPLAY_BRIGHTNESS String to query the current value for display brightness.
static String	PROPERTY_BYTE_MIC_SENSITIVITY String to query the current value for microphone sensitivity.
static String	PROPERTY_BYTE_TIME_FORMAT String to query the current value for time format
static String	PROPERTY_LONG_SCROLL_SPEED String to query the current value for scroll speed.
static String	PROPERTY_STRING_FWVERSION String to query the current firmware version number.
static String	PROPERTY_STRING_LOCALE String to query the current value for the system locale.
static String	PROPERTY_STRING_PEN_NAME Pen property: Pen name.
static byte	VALUE_AUDIO_QUALITY_HIGH Constant representing high quality audio.
static byte	VALUE_AUDIO_QUALITY_LOW Constant representing low quality audio.
static byte	VALUE_AUDIO_QUALITY_MEDIUM Constant representing medium quality audio.
static byte	VALUE_DATE_FORMAT_DDMMYY Constant representing date format of DD.MM.YY (European-like)
static byte	VALUE_DATE_FORMAT_MMDDYY Constant representing date format of MM.DD.YY (US-like)
static byte	VALUE_MIC_SENSITIVITY_AUTO Constant representing auto microphone sensitivity.
static byte	VALUE_MIC_SENSITIVITY_HIGH Constant representing high microphone sensitivity.
static byte	VALUE_MIC_SENSITIVITY_LOW Constant representing low microphone sensitivity.

Fields inherited from class com.livescribe.configuration.Config

VALUE_BOOLEAN, VALUE_DOUBLE, VALUE_LONG, VALUE_STRING

Constructor Summary

protected

SystemConfig()

Method Summary

void	changeDisplayBrightness(short brightness) Sets the brightness of the smartpen display.
void	enableLaunchLine(boolean value) Sets LaunchLine on/off.
int	getAudioBitrate() Returns the audio bitrate, based on the audio quality and the binaural mode.
byte	getAudioQuality() Returns the system audio quality setting.
byte	getAudioVolume() Returns the system volume.
int	getAutoPowerOffTime() Gets the automatic power-off time, in seconds.
int	getBatteryLevel() Returns the current level of charge of the battery.
boolean	getBooleanValue(String property) Gets the value of the specified property as a boolean.
byte	getByteValue(String property)
int	getCoordinateFrequencyDivider() Gets the current value for the coordinate streaming frequency divider.
byte	getDateFormat() Returns the system date format setting.
byte	getDisplayBrightness() Returns the brightness of the smartpen display.
boolean	getDisplayOrientation() Returns whether the smartpen display currently has left-handed display orientation.
double	getDoubleValue(String property) Gets the value of the specified property as a double.
int	getFailedCoordinateCount() Gets the total number of failed coordinates since the pen was turned on.
int	getFileSystemAvailableSize() Returns the available space on the smartpen file system.
long	getFileSystemAvailableSize64()
int	getFileSystemTotalSize() Returns the total size of the smartpen file system, both used and unused.
long	getFileSystemTotalSize64()
String	getFirmwareVersion() Returns the system firmware version.
static SystemConfig	getInstance()
static long	getInternalTime() Returns the system time.
Locale	getLocale() Returns the current locale.
long	getLongValue(String property) Gets the value of the specified property as a long.
byte	getMicSensitivity() Returns the microphone sensitivity.
String	getPenName() Returns the pen name
int	getRawBatteryVoltage() Returns the raw battery voltage.
int	getRecordingAvailableSize() Gets the available space to store new audio recordings.
long	getRecordingAvailableSize64()
long	getScrollSpeed() Returns the system scroll speed.
String	getStringValue(String property) Gets the value of the specified property as a string.
int	getSuccessfulCoordinateCount() Gets the total number of successful coordinates since the pen was turned on.
static Locale[]	getSupportedLocales() Returns the list of locales support by the system.
byte	getTimeFormat() Returns the system time format setting.
long	getTimeOfDay() Deprecated. use {System.currentTimeMillis}
boolean	getVoiceMenus() Returns the state of voice menus (on/off).
boolean	isHeadPhonesPluggedIn() Indicates if the headphones are plugged in.
boolean	isLaunchLineEnabled() Determines if LaunchLine is enabled.
boolean	isMicsPluggedIn() Indicates if the binaural microphones are plugged in.
boolean	isMuted() Determines if system audio is muted.
boolean	isSystemTimeSet() Returns the state of the system time (set/unset)
void	setAudioQuality(byte quality) Sets the audio quality (low/high/medium).
void	setAutoPowerOffTime(int time) Sets the automatic power-off time.
void	setBooleanValue(String property, boolean value) This method does nothing because applications cannot change the system configuration.
protected void	setByteValue(String property, byte value) This method does nothing.
void	setCoordinateFrequencyDivider(int divider) Sets the coordinate streaming frequency divider.
void	setDateFormat(byte format) Sets the system date format.
void	setDisplayBrightness(byte percent) Sets brightness of the smartpen display.
void	setDisplayOrientation(boolean leftHanded) Sets the display orientation.
void	setDoubleValue(String property, double value) This method does nothing because applications cannot change the system configuration.
void	setHoverModeEnabled(boolean flag) Turns hover mode on or off.
void	setLocale(Locale locale) Sets the system's locale.
void	setLongValue(String property, long value) This method does nothing because applications cannot change the system configuration.
void	setMicSensitivity(byte sensitivity) Sets the microphone sensitivity (low/high/auto).
void	setMute(boolean on) Sets system mute on/off.
void	setScrollSpeed(long value) Sets the scroll speed.
void	setStringValue(String property, String value) This method does nothing because applications cannot change the system configuration.
void	setTimeFormat(byte format) Sets the system time format.
void	setTimeOfDay(long value) This method does nothing because applications cannot change the system time.
void	setVoiceMenus(boolean on) Sets voice menus on/off.
void	setVolume(byte percent) Sets the system volume

Methods inherited from class java.lang.Object

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

Field Detail

VALUE_AUDIO_QUALITY_LOW

public static final byte VALUE_AUDIO_QUALITY_LOW

Constant representing low quality audio.

See Also:

Constant Field Values

VALUE_AUDIO_QUALITY_MEDIUM

public static final byte VALUE_AUDIO_QUALITY_MEDIUM

Constant representing medium quality audio.

See Also:

Constant Field Values

VALUE_AUDIO_QUALITY_HIGH

public static final byte VALUE_AUDIO_QUALITY_HIGH

Constant representing high quality audio.

See Also:

Constant Field Values

VALUE_MIC_SENSITIVITY_LOW

public static final byte VALUE_MIC_SENSITIVITY_LOW

Constant representing low microphone sensitivity.

See Also:

Constant Field Values

VALUE_MIC_SENSITIVITY_HIGH

public static final byte VALUE_MIC_SENSITIVITY_HIGH

Constant representing high microphone sensitivity.

See Also:

Constant Field Values

VALUE_MIC_SENSITIVITY_AUTO

public static final byte VALUE_MIC_SENSITIVITY_AUTO

Constant representing auto microphone sensitivity.

See Also:

Constant Field Values

VALUE_DATE_FORMAT_MMDDYY

public static final byte VALUE_DATE_FORMAT_MMDDYY

Constant representing date format of MM.DD.YY (US-like)

See Also:

Constant Field Values

VALUE_DATE_FORMAT_DDMMYY

public static final byte VALUE_DATE_FORMAT_DDMMYY

Constant representing date format of DD.MM.YY (European-like)

See Also:

Constant Field Values

PROPERTY_BOOL_DISPLAY_ORIENTATION

public static final String PROPERTY_BOOL_DISPLAY_ORIENTATION

String to query the current value for display orientation.

See Also:

Constant Field Values

PROPERTY_LONG_SCROLL_SPEED

public static final String PROPERTY_LONG_SCROLL_SPEED

String to query the current value for scroll speed.

See Also:

Constant Field Values

PROPERTY_BOOL_VOICE_MENUS

public static final String PROPERTY_BOOL_VOICE_MENUS

String to query the current value for voice menus on/off.

See Also:

Constant Field Values

PROPERTY_STRING_FWVERSION

public static final String PROPERTY_STRING_FWVERSION

String to query the current firmware version number.

See Also:

Constant Field Values

PROPERTY_STRING_PEN_NAME

public static final String PROPERTY_STRING_PEN_NAME

Pen property: Pen name.

See Also:

Constant Field Values

PROPERTY_BYTE_DISPLAY_BRIGHTNESS

public static final String PROPERTY_BYTE_DISPLAY_BRIGHTNESS

String to query the current value for display brightness.

See Also:

Constant Field Values

PROPERTY_BYTE_AUDIO_QUALITY

public static final String PROPERTY_BYTE_AUDIO_QUALITY

String to query the current value for audio quality.

See Also:

Constant Field Values

PROPERTY_BYTE_MIC_SENSITIVITY

public static final String PROPERTY_BYTE_MIC_SENSITIVITY

String to query the current value for microphone sensitivity.

See Also:

Constant Field Values

PROPERTY_BYTE_AUDIO_VOLUME

public static final String PROPERTY_BYTE_AUDIO_VOLUME

String to query the current value for audio volume.

See Also:

Constant Field Values

PROPERTY_BYTE_DATE_FORMAT

public static final String PROPERTY_BYTE_DATE_FORMAT

String to query the current value for date format

See Also:

Constant Field Values

PROPERTY_BYTE_TIME_FORMAT

public static final String PROPERTY_BYTE_TIME_FORMAT

String to query the current value for time format

See Also:

Constant Field Values

PROPERTY_BOOL_AUDIO_MUTED

public static final String PROPERTY_BOOL_AUDIO_MUTED

String to query the current value for audio mute on/off

See Also:

Constant Field Values

PROPERTY_BOOL_PLAYBACK_LATENCY

public static final String PROPERTY_BOOL_PLAYBACK_LATENCY

String to query the current value (on/off) for playback latency.

See Also:

Constant Field Values

PROPERTY_STRING_LOCALE

public static final String PROPERTY_STRING_LOCALE

String to query the current value for the system locale.

See Also:

Constant Field Values

PROPERTY_BOOL_LAUNCHLINE

public static final String PROPERTY_BOOL_LAUNCHLINE

String to query the current value (on/off) for LaunchLine.

See Also:

Constant Field Values

DEFAULT_VALUE_DISPLAY_ORIENTATION

public static final Object DEFAULT_VALUE_DISPLAY_ORIENTATION

Object to maintain the system default value for display orientation.

DEFAULT_VALUE_SCROLL_SPEED

public static final Object DEFAULT_VALUE_SCROLL_SPEED

Object to maintain the system default value for scroll speed.

DEFAULT_VALUE_VOICE_MENUS

public static final Object DEFAULT_VALUE_VOICE_MENUS

Object to maintain the system default value (on/off) for voice menus.

DEFAULT_VALUE_DISPLAY_BRIGHTNESS

public static final Object DEFAULT_VALUE_DISPLAY_BRIGHTNESS

Object to maintain the system default value for display brightness.

DEFAULT_VALUE_AUDIO_QUALITY

public static final Object DEFAULT_VALUE_AUDIO_QUALITY

Object to maintain the system default value for audio quality.

DEFAULT_VALUE_MIC_SENSITIVITY

public static final Object DEFAULT_VALUE_MIC_SENSITIVITY

Object to maintain the system default value for microphone sensitivity.

DEFAULT_VALUE_AUDIO_VOLUME

public static final Object DEFAULT_VALUE_AUDIO_VOLUME

Object to maintain the system default value for audio volume.

DEFAULT_VALUE_DATE_FORMAT

public static final Object DEFAULT_VALUE_DATE_FORMAT

Object to maintain the system default value for date format.

DEFAULT_VALUE_TIME_FORMAT

public static final Object DEFAULT_VALUE_TIME_FORMAT

Object to maintain the system default value for date format.

DEFAULT_VALUE_AUDIO_MUTED

public static final Object DEFAULT_VALUE_AUDIO_MUTED

Object to maintain the system default value (on/off) for audio mute.

DEFAULT_VALUE_PLAYBACK_LATENCY

public static final Object DEFAULT_VALUE_PLAYBACK_LATENCY

Object to maintain the system default value (on/off) for playback latency.

DEFAULT_VALUE_LAUNCHLINE

public static final Object DEFAULT_VALUE_LAUNCHLINE

Object to maintain the system default value (on/off) for LaunchLine.

DEFAULT_VALUES

protected static Hashtable DEFAULT_VALUES

Hashtable to maintain the system default values.

DEFAULT_COORDINATE_FREQUENCY_DIVIDER

public static final int DEFAULT_COORDINATE_FREQUENCY_DIVIDER

The default frequency divider when streaming coordinates.

See Also:

Constant Field Values

locale

protected Locale locale

Contains the current locale.

Since:

0.4

Constructor Detail

SystemConfig

protected SystemConfig()

Method Detail

getInstance

public static SystemConfig getInstance()

Returns:

the instance of system config.

setDisplayOrientation

public void setDisplayOrientation(boolean leftHanded)

Sets the display orientation.

Parameters:

leftHanded - true if the display should orient for a left handed user; false for a right handed user.

setScrollSpeed

public void setScrollSpeed(long value)

Sets the scroll speed.

Parameters:

value - long value ranging from 0 to 10.

setVoiceMenus

public void setVoiceMenus(boolean on)

Sets voice menus on/off.

Parameters:

on - boolean value. true to enable voice menus ; false to disable voice menus.

setDisplayBrightness

public void setDisplayBrightness(byte percent)

Sets brightness of the smartpen display.

Parameters:

percent - byte value greater than 0. If greater than 100, this sets the value to 100, and then calls changeDisplayBrightness(short)

setAudioQuality

public void setAudioQuality(byte quality)

Sets the audio quality (low/high/medium).

Parameters:

quality - byte. Value is: VALUE_AUDIO_QUALITY_LOW, VALUE_AUDIO_QUALITY_MEDIUM, or VALUE_AUDIO_QUALITY_HIGH.

Throws:

java.lang.IllegalStateException - if recording is in progress

setDateFormat

public void setDateFormat(byte format)

Sets the system date format. The value is one of the DATE_* constants in Formatter.

Parameters:

format - the new format value

See Also:

Formatter

setTimeFormat

public void setTimeFormat(byte format)

Sets the system time format. The value is one of the TIME_* constants in Formatter.

Parameters:

format - the new format value

See Also:

Formatter

setMicSensitivity

public void setMicSensitivity(byte sensitivity)

Sets the microphone sensitivity (low/high/auto).

Parameters:

sensitivity - byte. Value is: VALUE_MIC_SENSITIVITY_LOW, VALUE_MIC_SENSITIVITY_HIGH, or VALUE_MIC_SENSITIVITY_AUTO.

Throws:

java.lang.IllegalStateException - if recording is in progress

setVolume

public void setVolume(byte percent)

Sets the system volume

Parameters:

percent - byte value ranging from 0 to 100.

setMute

public void setMute(boolean on)

Sets system mute on/off.

Parameters:

on - boolean value true if audio is to be muted and false if audio is to be not muted.

enableLaunchLine

public void enableLaunchLine(boolean value)

Sets LaunchLine on/off.

Parameters:

value - boolean value true if LaunchLine is to be enabled and false if LaunchLine is to be disabled.

getTimeOfDay

public long getTimeOfDay()

Deprecated. use {System.currentTimeMillis}

Returns the system time.

Returns:

long representing the system time.

getAutoPowerOffTime

public int getAutoPowerOffTime()

Gets the automatic power-off time, in seconds.

Returns:

the automatic power off time, in seconds.

See Also:

setAutoPowerOffTime(int)

setAutoPowerOffTime

public void setAutoPowerOffTime(int time)

Sets the automatic power-off time. This setting tells the pen how long to wait before powering off the pen after a period of inactivity.

Parameters:

time - the new automatic power-off time, in seconds

See Also:

getAutoPowerOffTime()

getInternalTime

public static long getInternalTime()

Returns the system time.

Returns:

long representing the internal clock of the pen. This time will correspond to paper event times.

isSystemTimeSet

public boolean isSystemTimeSet()

Returns the state of the system time (set/unset)

Returns:

boolean. true if system time set; false if system time is not set.

getDisplayOrientation

public boolean getDisplayOrientation()

Returns whether the smartpen display currently has left-handed display orientation.

Returns:

boolean. true if left handed orientation; false if right handed orientation.

getVoiceMenus

public boolean getVoiceMenus()

Returns the state of voice menus (on/off).

Returns:

boolean. true if voice menus are enabled; false if voice menus are not enabled.

getScrollSpeed

public long getScrollSpeed()

Returns the system scroll speed.

Returns:

long value ranging from 0 to 10.

getFirmwareVersion

public String getFirmwareVersion()

Returns the system firmware version.

Returns:

String representing the firmware version.

getPenName

public String getPenName()

Returns the pen name

Returns:

String representing the pen name.

getDisplayBrightness

public byte getDisplayBrightness()

Returns the brightness of the smartpen display.

Returns:

byte value ranging from 0 to 100.

getAudioBitrate

public final int getAudioBitrate()

Returns the audio bitrate, based on the audio quality and the binaural mode.

Returns:

integer. Value is: 16000, 24000, or 40000.

isMuted

public final boolean isMuted()

Determines if system audio is muted.

Returns:

boolean. true if system audio is muted; false if system audio is not muted.

isLaunchLineEnabled

public final boolean isLaunchLineEnabled()

Determines if LaunchLine is enabled.

Returns:

boolean. true if LaunchLine is enabled; false if LaunchLine is disabled.

getAudioVolume

public final byte getAudioVolume()

Returns the system volume.

Returns:

byte value ranging from 0 to 100.

getAudioQuality

public byte getAudioQuality()

Returns the system audio quality setting.

Returns:

byte. Value is: VALUE_AUDIO_QUALITY_LOW, VALUE_AUDIO_QUALITY_MEDIUM, or VALUE_AUDIO_QUALITY_HIGH

getDateFormat

public byte getDateFormat()

Returns the system date format setting. This is used by the Formatter.formatDateTime(Calendar, int) method.

Returns:

the format value used by Formatter.

See Also:

Formatter.formatDateTime(Calendar, int)

getTimeFormat

public byte getTimeFormat()

Returns the system time format setting. This is used by the Formatter.formatDateTime(Calendar, int) method.

Returns:

the format value used by Formatter.

See Also:

Formatter.formatDateTime(Calendar, int)

getMicSensitivity

public byte getMicSensitivity()

Returns the microphone sensitivity.

Returns:

byte. Value is: VALUE_MIC_SENSITIVITY_LOW, VALUE_MIC_SENSITIVITY_HIGH, or VALUE_MIC_SENSITIVITY_AUTO.

getLocale

public Locale getLocale()

Returns the current locale.

Returns:

Locale object representing current locale.

Since:

0.4

setLocale

public void setLocale(Locale locale)

Sets the system's locale.

Parameters:

locale - a Locale object. If the value of locale null, the method returns without doing anything.

Since:

0.4

getSupportedLocales

public static Locale[] getSupportedLocales()

Returns the list of locales support by the system.

Returns:

an array of Locale objects, one for each locale supported.

Since:

0.4

getByteValue

public byte getByteValue(String property)

getBooleanValue

public boolean getBooleanValue(String property)

Description copied from class: Config

Gets the value of the specified property as a boolean. It is up to the implementation to decide what to do if the specified property name is null, if the property does not exist, or if the value cannot be represented as a boolean.

Specified by:

getBooleanValue in class Config

Parameters:

property - the property name

Returns:

the property value as a boolean.

getStringValue

public String getStringValue(String property)

Description copied from class: Config

Gets the value of the specified property as a string. It is up to the implementation to decide what to do if the specified property name is null, if the property does not exist, or if the value cannot be represented as a string.

Specified by:

getStringValue in class Config

Parameters:

property - the property name

Returns:

the property value as a string.

getLongValue

public long getLongValue(String property)

Description copied from class: Config

Gets the value of the specified property as a long. It is up to the implementation to decide what to do if the specified property name is null, if the property does not exist, or if the value cannot be represented as a long.

Specified by:

getLongValue in class Config

Parameters:

property - the property name

Returns:

the property value as a long.

getDoubleValue

public double getDoubleValue(String property)

Description copied from class: Config

Gets the value of the specified property as a double. It is up to the implementation to decide what to do if the specified property name is null, if the property does not exist, or if the value cannot be represented as a double.

Specified by:

getDoubleValue in class Config

Parameters:

property - the property name

Returns:

the property value as a double.

getRecordingAvailableSize

public int getRecordingAvailableSize()

Gets the available space to store new audio recordings.

Returns:

number of bytes of recording space.

getRecordingAvailableSize64

public long getRecordingAvailableSize64()

getFileSystemAvailableSize

public int getFileSystemAvailableSize()

Returns the available space on the smartpen file system. This is the same amount returned by getRecordingAvailableSize

Returns:

number of bytes of available space.

getFileSystemAvailableSize64

public long getFileSystemAvailableSize64()

getFileSystemTotalSize

public int getFileSystemTotalSize()

Returns the total size of the smartpen file system, both used and unused.

Returns:

number of bytes of svailable space.

getFileSystemTotalSize64

public long getFileSystemTotalSize64()

getRawBatteryVoltage

public int getRawBatteryVoltage()

Returns the raw battery voltage.

Returns:

In volts.

getBatteryLevel

public int getBatteryLevel()

Returns the current level of charge of the battery.

Returns:

percent of full charge, from 0 to 100.

setTimeOfDay

public void setTimeOfDay(long value)

This method does nothing because applications cannot change the system time.

Parameters:

value - unused

setLongValue

public void setLongValue(String property,
                         long value)

This method does nothing because applications cannot change the system configuration.

Specified by:

setLongValue in class Config

Parameters:

value - unused

property - the property name

setDoubleValue

public void setDoubleValue(String property,
                           double value)

This method does nothing because applications cannot change the system configuration.

Specified by:

setDoubleValue in class Config

Parameters:

value - unused

property - the property name

setBooleanValue

public void setBooleanValue(String property,
                            boolean value)

This method does nothing because applications cannot change the system configuration.

Specified by:

setBooleanValue in class Config

Parameters:

value - unused

property - the property name

setStringValue

public void setStringValue(String property,
                           String value)

This method does nothing because applications cannot change the system configuration.

Specified by:

setStringValue in class Config

Parameters:

value - unused

property - the property name

setByteValue

protected void setByteValue(String property,
                            byte value)

This method does nothing.

Parameters:

property - unused

value - unused

changeDisplayBrightness

public void changeDisplayBrightness(short brightness)

Sets the brightness of the smartpen display. This is Called by setDisplayBrightness(byte).

Parameters:

brightness - short value ranging from 0 to 100

isMicsPluggedIn

public boolean isMicsPluggedIn()

Indicates if the binaural microphones are plugged in.

Returns:

true if the mics are plugged in and false otherwise.

isHeadPhonesPluggedIn

public boolean isHeadPhonesPluggedIn()

Indicates if the headphones are plugged in.

Returns:

true if the head phones are plugged in and false otherwise.

getFailedCoordinateCount

public int getFailedCoordinateCount()

Gets the total number of failed coordinates since the pen was turned on. To get a performance metric, use the following code:

int nSucc = config.getSuccessfulCoordinateCount();
int nFail = config.getFailedCoordinateCount();
float perf = 100.0f * (float)nSuc / (float)( nSucc + nFail );

Returns:

the number of failed coordinates since the pen was turned on.

See Also:

getSuccessfulCoordinateCount()

getSuccessfulCoordinateCount

public int getSuccessfulCoordinateCount()

Gets the total number of successful coordinates since the pen was turned on.

Returns:

the number of successful coordinates since the pen was turned on.

See Also:

getFailedCoordinateCount()

setHoverModeEnabled

public void setHoverModeEnabled(boolean flag)

Turns hover mode on or off.

Parameters:

flag - whether to enable or disable hover mode

See Also:

CoordinateListener

setCoordinateFrequencyDivider

public void setCoordinateFrequencyDivider(int divider)

Sets the coordinate streaming frequency divider. The default divider value is 4, or 18.75 coordinates per second. Note that a lower value (a higher frequency) is not necessarily better, depending on how much work the program does with the coordinate events. At too high a rate, the program might become sluggish and unresponsive. Start with a high divider value (a lower frequency) and lower it until the lowest value that still keeps the program responsive is found.

The values are as follows:

Divider Value	Frequency (coordinates/s)
1	75
2	37.5
3	25
4	18.75
5	15

Values ≤ zero are considered to be 1. Higher values will work as expected.

The default value is 4.

Parameters:

divider - the new divider value

See Also:

CoordinateListener, DEFAULT_COORDINATE_FREQUENCY_DIVIDER

getCoordinateFrequencyDivider

public int getCoordinateFrequencyDivider()

Gets the current value for the coordinate streaming frequency divider.

Returns:

the current frequency divider value.

See Also:

setCoordinateFrequencyDivider(int)