com.squareup.seismic

Class ShakeDetector

java.lang.Object

com.squareup.seismic.ShakeDetector

All Implemented Interfaces:

android.hardware.SensorEventListener

public class ShakeDetector
extends java.lang.Object
implements android.hardware.SensorEventListener

Detects phone shaking. If more than 75% of the samples taken in the past 0.5s are accelerating, the device is a) shaking, or b) free falling 1.84m (h = 1/2*g*t^2*3/4).

Author:

Bob Lee (bob@squareup.com), Eric Burke (eric@squareup.com)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ShakeDetector.Listener Listens for shakes.

Field Summary

Fields

Modifier and Type	Field and Description
static int	SENSITIVITY_HARD
static int	SENSITIVITY_LIGHT
static int	SENSITIVITY_MEDIUM

Constructor Summary

Constructors

Constructor and Description
ShakeDetector(ShakeDetector.Listener listener)

Method Summary

Modifier and Type	Method and Description
void	onAccuracyChanged(android.hardware.Sensor sensor, int accuracy)
void	onSensorChanged(android.hardware.SensorEvent event)
void	setSensitivity(int accelerationThreshold) Sets the acceleration threshold sensitivity.
boolean	start(android.hardware.SensorManager sensorManager) Starts listening for shakes on devices with appropriate hardware.
boolean	start(android.hardware.SensorManager sensorManager, int sensorDelay) Starts listening for shakes on devices with appropriate hardware.
void	stop() Stops listening.

Methods inherited from class java.lang.Object

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

Field Detail

SENSITIVITY_LIGHT

public static final int SENSITIVITY_LIGHT

See Also:

Constant Field Values

SENSITIVITY_MEDIUM

public static final int SENSITIVITY_MEDIUM

See Also:

Constant Field Values

SENSITIVITY_HARD

public static final int SENSITIVITY_HARD

See Also:

Constant Field Values

Constructor Detail

ShakeDetector

public ShakeDetector(ShakeDetector.Listener listener)

Method Detail

start

public boolean start(android.hardware.SensorManager sensorManager)

Starts listening for shakes on devices with appropriate hardware.

Returns:

true if the device supports shake detection.

start

public boolean start(android.hardware.SensorManager sensorManager,
                     int sensorDelay)

Starts listening for shakes on devices with appropriate hardware. Allowing to set the sensor delay, available values are: SENSOR_DELAY_FASTEST, SENSOR_DELAY_GAME, SENSOR_DELAY_UI, SENSOR_DELAY_NORMAL.

Returns:

true if the device supports shake detection.

See Also:

SensorManager

stop

public void stop()

Stops listening. Safe to call when already stopped. Ignored on devices without appropriate hardware.

onSensorChanged

public void onSensorChanged(android.hardware.SensorEvent event)

Specified by:

onSensorChanged in interface android.hardware.SensorEventListener

setSensitivity

public void setSensitivity(int accelerationThreshold)

Sets the acceleration threshold sensitivity.

onAccuracyChanged

public void onAccuracyChanged(android.hardware.Sensor sensor,
                              int accuracy)

Specified by:

onAccuracyChanged in interface android.hardware.SensorEventListener