ch.aplu.kinect

Class Kinect

java.lang.Object

ch.aplu.kinect.Kinect

public class Kinect
extends java.lang.Object

Java class wrapper for the Microsoft Kinect C++ Library using the Java API Wrapper (JAW) framework.

Constructor Summary

Constructors

Constructor and Description
Kinect(java.lang.String dllPath, java.lang.String title, int ulx, int uly, int width, int height, long windowStyle) Same as Kinect(dllPath, title, ulx, uly, width, height, windowStyle, " audioBufferSize) with audioBufferSize = 0 (sound level detection disabled).
Kinect(java.lang.String dllPath, java.lang.String title, int ulx, int uly, int width, int height, long windowStyle, int audioBufferSize) Creates an abstraction of Microsoft's Kinect device using the Java Native Interface (JNI) and the Java API Wrapper (JAW).

Method Summary

Methods

Modifier and Type	Method and Description
void	addCloseListener(KinectCloseListener listener) Registers a callback that is called when the close button of the native window is hit.
void	addSkeletonListener(SkeletonListener listener) Registers a callback that is called when new skeleton data are available.
void	addSoundLevelListener(SoundLevelListener listener) Registers a SoundLevelListener for sound level detection.
static void	delay(int timeout) Delays current thread execution for given amount of time.
void	doBMPSnapShot(java.lang.String filename) Performs a native snap shot of the current image and copies it in the given file in BMP format by native code.
boolean	doGIFSnapShot(java.lang.String filename) Performs snap shot of the current image and copies it in the given file in GIF format by Java code.
boolean	doJPGSnapShot(java.lang.String filename) Performs snap shot of the current image and copies it in the given file in JPG format by Java code.
boolean	doPNGSnapShot(java.lang.String filename) Performs snap shot of the current image and copies it in the given file in PNG format by Java code.
void	enableClose(boolean enable) Enables/disables notification of clicking the title bar's close button.
int	getCameraElevationAngle() Returns the current camera elevation angle.
int	getCameraMaximumElevationAngle() Returns the maximum camera elevation angle.
int	getCameraMinimumElevationAngle() Returns the minimum camera elevation angle.
java.awt.image.BufferedImage	getImage() Returns a snap shot image of the current video image for further treatment by the Java code.
int	getJoints(Point3D[] joints) Returns the latest detected 20 skeleton points including depth information (z coordinate).
java.lang.String	getLoadedDllName() Returns the name of the loaded native library.
NativeHandler	getNativeHandler() Returns the NativeHandler instance reference used for communication with the native dll.
int	getSoundLevel() Returns the maximum level of the last captured sound sample.
int	getSystemMetrics(int metricsIndex) Returns the system metrics of the native windowing system.
static java.lang.String	getVersion() Returns current version information.
static boolean	is64bit() Returns true, if the Windows operating system is 64 bit.
boolean	isInitialized() Returns true, if the initialization of the Kinect device was successful after creating the Kinect class instance.
void	release() Closes the native window and releases all resources.
boolean	setCameraElevationAngle(int angle) You should tilt the Kinect sensor as few times as possible, to minimize wear on the camera and to minimize tilting time.
void	setSeletonTimeout(int timeout) Sets the maximum wait time for a new valid skeleton.
void	setTitle(java.lang.String text) Sets the title of the native window.
void	setVisible(boolean visible) Sets the visibility of the native video window.
void	setWindowScaleFactor(int windowScaleFactor) Sets a new window scale factor.

Methods inherited from class java.lang.Object

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

Constructor Detail

Kinect

public Kinect(java.lang.String dllPath,
      java.lang.String title,
      int ulx,
      int uly,
      int width,
      int height,
      long windowStyle)

Same as Kinect(dllPath, title, ulx, uly, width, height, windowStyle, " audioBufferSize) with audioBufferSize = 0 (sound level detection disabled).

Kinect

public Kinect(java.lang.String dllPath,
      java.lang.String title,
      int ulx,
      int uly,
      int width,
      int height,
      long windowStyle,
      int audioBufferSize)

Creates an abstraction of Microsoft's Kinect device using the Java Native Interface (JNI) and the Java API Wrapper (JAW). A native window may be shown that contains a camera image in real time using DirectX enhancement.

Parameters:

dllPath - the path to the native library DLL. Provide either the full path (Drive:/Directory/Filename) or the DLL name without extension. In the latter case, the DLL is searched in the Windows system path.

title - the title displayed in the native video window

ulx - the upper left x of the native video window (in screen pixels)

uly - the upper left y of the native video window (in screen pixels)

width - the width of the native video window

height - the height of the native video window

windowStyle - the Window style (see the fields in ch.aplu.jaw.NativeHandler). The native video window may be hidden

audioBufferSize - the size in bytes used for sound level detection. The following audio format is used: 22050 Hz sampling rate, 8 bit, mono, signed, little endian. For audioBufferSize < 0, sound leve detection is disabled.

See Also:

NativeHandler

Method Detail

addSoundLevelListener

public void addSoundLevelListener(SoundLevelListener listener)

Registers a SoundLevelListener for sound level detection.

Parameters:

listener - the SoundLevelListener to register.

getSoundLevel

public int getSoundLevel()

Returns the maximum level of the last captured sound sample.

Returns:

the level of the sound sample (0..100)

getJoints

public int getJoints(Point3D[] joints)

Returns the latest detected 20 skeleton points including depth information (z coordinate). Blocks until the native skeleton detection machine reports the skeleton data or a frame timeout occurs. The coordinate system is scaled to x = 0..windowWidth, y = 0..windowHeight with zero at upper left corner, unless a scale factor is set by calling setCoordinateScale(). z is the distance from the camera in mm. The default frame timeout value is 20 (= 200ms) and can be set by setSeletonTimeout().

Parameters:

joints - the 20 Point3D passed back

Returns:

the skeleton identifier (two persons may be tracked) or -1, if the timeout is reached

enableClose

public void enableClose(boolean enable)

Enables/disables notification of clicking the title bar's close button.

Parameters:

enable - if true, the notification is enabled, otherwise the application terminates when the close button is hit.

addCloseListener

public void addCloseListener(KinectCloseListener listener)

Registers a callback that is called when the close button of the native window is hit.

Parameters:

listener - the listener that gets the close notification

delay

public static void delay(int timeout)

Delays current thread execution for given amount of time.

Parameters:

timeout - the time to sleep (in ms)

setWindowScaleFactor

public void setWindowScaleFactor(int windowScaleFactor)

Sets a new window scale factor. This factor is used as multiplier to the joints x- and y-coordinates. Default 1: x in the range 0..windowWidth, y in the range 0..windowHeight.

Parameters:

windowScaleFactor - the new scaling factor apply to x- and y-coordinates

getImage

public java.awt.image.BufferedImage getImage()

Returns a snap shot image of the current video image for further treatment by the Java code.

Returns:

a buffered image of the current video image

doBMPSnapShot

public void doBMPSnapShot(java.lang.String filename)

Performs a native snap shot of the current image and copies it in the given file in BMP format by native code.

Parameters:

filename - the snap shot file

doPNGSnapShot

public boolean doPNGSnapShot(java.lang.String filename)

Performs snap shot of the current image and copies it in the given file in PNG format by Java code.

Parameters:

filename - the snap shot file

doGIFSnapShot

public boolean doGIFSnapShot(java.lang.String filename)

Performs snap shot of the current image and copies it in the given file in GIF format by Java code.

Parameters:

filename - the snap shot file

doJPGSnapShot

public boolean doJPGSnapShot(java.lang.String filename)

Performs snap shot of the current image and copies it in the given file in JPG format by Java code.

Parameters:

filename - the snap shot file

setCameraElevationAngle

public boolean setCameraElevationAngle(int angle)

You should tilt the Kinect sensor as few times as possible, to minimize wear on the camera and to minimize tilting time. The camera motor is not designed for constant or repetitive movement, and attempts to use it that way may cause degradation of motor function. This method limits the rate at which applications can tilt the sensor, in order to protect the Kinect hardware. Calls to setCameraElevationAngle are limited to one per second and a maximum of 15 calls in any 20-second period. If the application exceeds these limits, the method imposes a short lockout period during which any further calls will return an error code.

Parameters:

angle - to elevation angle in degrees. Zero indicates that the sensor array should point exactly horizontally. Positive values indicate that the sensor array should point above the horizon, and negative values indicate that the sensor array should point below the horizon. The values are limited to the interval between getCameraMinimumElevationAngle() and getCameraMaximumElevationAngle().

Returns:

true if successfull, false if device is not operational or the application tried to move the camera more then 15 times per 20 secondes or the angle is outside min-max interval

getCameraElevationAngle

public int getCameraElevationAngle()

Returns the current camera elevation angle.

Returns:

the elevation angle in degrees.

getCameraMinimumElevationAngle

public int getCameraMinimumElevationAngle()

Returns the minimum camera elevation angle.

Returns:

the minimum elevation angle in degrees

getCameraMaximumElevationAngle

public int getCameraMaximumElevationAngle()

Returns the maximum camera elevation angle.

Returns:

the maximum elevation angle in degrees

isInitialized

public boolean isInitialized()

Returns true, if the initialization of the Kinect device was successful after creating the Kinect class instance.

Returns:

true, if the Kinect device is ready for use; otherwise false

is64bit

public static boolean is64bit()

Returns true, if the Windows operating system is 64 bit.

Returns:

ture, if running on a 64-bit Windows machine; otherwise false

setVisible

public void setVisible(boolean visible)

Sets the visibility of the native video window.

Parameters:

visible - if true, the window is showed; otherwise it is hidden +

getNativeHandler

public NativeHandler getNativeHandler()

Returns the NativeHandler instance reference used for communication with the native dll.

Returns:

reference to the NativeHandler

getLoadedDllName

public java.lang.String getLoadedDllName()

Returns the name of the loaded native library.

Returns:

the name of the Windows DLL

setTitle

public void setTitle(java.lang.String text)

Sets the title of the native window.

Parameters:

text - the new text in the window title bar

getSystemMetrics

public int getSystemMetrics(int metricsIndex)

Returns the system metrics of the native windowing system.

Parameters:

metricsIndex - (search Internet 'msdn GetSystemMetrics'

Returns:

the value provided by the native API call GetSystemMetrics()

addSkeletonListener

public void addSkeletonListener(SkeletonListener listener)

Registers a callback that is called when new skeleton data are available.

Parameters:

listener - the listener that gets the notification

release

public void release()

Closes the native window and releases all resources.

setSeletonTimeout

public void setSeletonTimeout(int timeout)

Sets the maximum wait time for a new valid skeleton. This determines the maximum time getJoints() blocks. If a SkeletonListener is registered, a skeletonTimeout() callback is triggered. Default: 20 (= 200 ms).

Parameters:

timeout - the maximum waiting time to get new skeleton data (in units of 10 ms, minimum 1 = 10 ms)

getVersion

public static java.lang.String getVersion()

Returns current version information.

Returns:

a string with the current version of the JKinectLib package