# Index

A C D E F G H I J O P R S T V W Y
All Classes and Interfaces|All Packages|Constant Field Values

## A

addDeviceConnectedListener(OpenNI.DeviceConnectedListener) - Static method in class org.openni.OpenNI
  Add new device connected observer to OpenNI observers list
addDeviceDisconnectedListener(OpenNI.DeviceDisconnectedListener) - Static method in class org.openni.OpenNI
  Add new device connected observer to OpenNI observers list
addDeviceStateChangedListener(OpenNI.DeviceStateChangedListener) - Static method in class org.openni.OpenNI
  Add new device connected observer to OpenNI observers list
addNewFrameListener(VideoStream.NewFrameListener) - Method in class org.openni.VideoStream
  Adds a new Listener to receive this VideoStream onNewFrame event.
addStream(VideoStream, boolean) - Method in class org.openni.Recorder
  Attaches a stream to the recorder.

## C

close() - Method in class org.openni.Device
  Closes the device.
COLOR - Enum constant in enum class org.openni.SensorType
convertDepthToColor(VideoStream, VideoStream, int, int, short) - Static method in class org.openni.CoordinateConverter
  For a given depth point, provides the coordinates of the corresponding color value.
convertDepthToWorld(VideoStream, float, float, float) - Static method in class org.openni.CoordinateConverter
  Converts a single point from a floating point representation of the Depth coordinate system to the World coordinate system.
convertDepthToWorld(VideoStream, int, int, short) - Static method in class org.openni.CoordinateConverter
  Converts a single point from the Depth coordinate system to the World coordinate system.
convertWorldToDepthFloat(VideoStream, float, float, float) - Static method in class org.openni.CoordinateConverter
  Converts a single point from the World coordinate system to a floating point representation of the Depth coordinate system
convertWorldToDepthInt(VideoStream, float, float, float) - Static method in class org.openni.CoordinateConverter
  Converts a single point from the World coordinate system to the Depth coordinate system.
CoordinateConverter - Class in org.openni
  The CoordinateConverter class converts points between the different coordinate systems.
CoordinateConverter() - Constructor for class org.openni.CoordinateConverter
create(String) - Static method in class org.openni.Recorder
  Initializes a recorder.
create(Device, SensorType) - Static method in class org.openni.VideoStream
  Creates a stream of frames from a specific sensor type of a specific device.
CropArea - Class in org.openni
  The CropArea object encapsulate cropping information data
CropArea(int, int, int, int) - Constructor for class org.openni.CropArea
  The CropArea constructor

## D

DEPTH - Enum constant in enum class org.openni.SensorType
DEPTH_1_MM - Enum constant in enum class org.openni.PixelFormat
DEPTH_100_UM - Enum constant in enum class org.openni.PixelFormat
DEPTH_TO_COLOR - Enum constant in enum class org.openni.ImageRegistrationMode
destroy() - Method in class org.openni.Recorder
  Destroys a recorder.
destroy() - Method in class org.openni.VideoStream
  Destroy this stream.
Device - Class in org.openni
  The Device object abstracts a specific device; either a single hardware device, or a file device holding a recording from a hardware device.
Device() - Constructor for class org.openni.Device
DeviceInfo - Class in org.openni
  The DeviceInfo class encapsulates info related to a specific device.
DeviceInfo(String, String, String, int, int) - Constructor for class org.openni.DeviceInfo

## E

enumerateDevices() - Static method in class org.openni.OpenNI
  Fills up an array of `DeviceInfo` DeviceInfo objects with devices that are available.

## F

finalize() - Method in class org.openni.VideoFrameRef
fromNative(int) - Static method in enum class org.openni.ImageRegistrationMode
fromNative(int) - Static method in enum class org.openni.PixelFormat
fromNative(int) - Static method in enum class org.openni.SensorType

## G

getAutoExposureEnabled() - Method in class org.openni.VideoStream.CameraSettings
  Set Auto Exposure Enabled for corresponding sensor
getAutoWhiteBalanceEnabled() - Method in class org.openni.VideoStream.CameraSettings
  Set Auto White Balance Enabled for corresponding sensor
getBuild() - Method in class org.openni.Version
  This function return build number.
getCameraSettings() - Method in class org.openni.VideoStream
  Gets an object through which several camera settings can be configured.
getCropOriginX() - Method in class org.openni.VideoFrameRef
  Indicates the X coordinate of the upper left corner of the crop window.
getCropOriginY() - Method in class org.openni.VideoFrameRef
  Indicates the Y coordinate of the upper left corner of the crop window.
getCropping() - Method in class org.openni.VideoStream
  Obtains the current cropping settings for this stream.
getCroppingEnabled() - Method in class org.openni.VideoFrameRef
  Indicates whether cropping was enabled when the frame was produced.
getData() - Method in class org.openni.VideoFrameRef
  Getter function for the array of data pointed to by this object.
getDeviceInfo() - Method in class org.openni.Device
  Provides information about this device in the form of a DeviceInfo object.
getExtendedError() - Static method in class org.openni.OpenNI
  Retrieves the calling thread's last extended error information.
getFps() - Method in class org.openni.VideoMode
  Getter function for the frame rate of this VideoMode.
getFrameIndex() - Method in class org.openni.VideoFrameRef
  Frames are provided sequential frame ID numbers by the sensor that produced them.
getHandle() - Method in class org.openni.Device
  This function return device handle.
getHandle() - Method in class org.openni.Recorder
  This function return recorded handle.
getHandle() - Method in class org.openni.VideoStream
  This function return stream handle.
getHeight() - Method in class org.openni.CropArea
  Return height cropping value
getHeight() - Method in class org.openni.VideoFrameRef
  Gives the current height of this frame, measured in pixels.
getHorizontalFieldOfView() - Method in class org.openni.VideoStream
  Gets the horizontal field of view of frames received from this stream.
getImageRegistrationMode() - Method in class org.openni.Device
  Gets the current image registration mode of this device.
getMaintenance() - Method in class org.openni.Version
  This function return minor value.
getMajor() - Method in class org.openni.Version
  This function return major value.
getMaxPixelValue() - Method in class org.openni.VideoStream
  Provides the maximum possible value for pixels obtained by this stream.
getMinor() - Method in class org.openni.Version
  This function return minor value.
getMinPixelValue() - Method in class org.openni.VideoStream
  Provides the smallest possible value for pixels obtains by this VideoStream.
getMirroringEnabled() - Method in class org.openni.VideoStream
  Check whether mirroring is currently turned on for this stream.
getName() - Method in class org.openni.DeviceInfo
  Getter function for the device name.
getNumberOfFrames(VideoStream) - Method in class org.openni.PlaybackControl
  Provides the a count of frames that this recording contains for a given stream.
getOriginX() - Method in class org.openni.CropArea
  Return X cropping coordinate
getOriginY() - Method in class org.openni.CropArea
  Return Y cropping coordinate
getPixelFormat() - Method in class org.openni.VideoMode
  Getter function for the pixel format of this VideoMode.
getPlaybackControl() - Method in class org.openni.Device
  Gets an object through which playback of a file device can be controlled.
getRepeatEnabled() - Method in class org.openni.PlaybackControl
  Gets the current repeat setting of the file device.
getResolutionX() - Method in class org.openni.VideoMode
  Getter function for the X resolution of this VideoMode.
getResolutionY() - Method in class org.openni.VideoMode
  Getter function for the Y resolution of this VideoMode.
getSensorInfo() - Method in class org.openni.VideoStream
  Provides the `SensorInfo` object associated with the sensor that is producing this `VideoStream`.
getSensorInfo(SensorType) - Method in class org.openni.Device
  Get the `SensorInfo` for a specific sensor type on this device.
getSensorType() - Method in class org.openni.SensorInfo
  Provides the sensor type of the sensor this object is associated with.
getSensorType() - Method in class org.openni.VideoFrameRef
  Getter function for the sensor type used to produce this frame.
getSensorType() - Method in class org.openni.VideoStream
  Gets the sensor type for this stream.
getSpeed() - Method in class org.openni.PlaybackControl
  Getter function for the current playback speed of this device.
getStrideInBytes() - Method in class org.openni.VideoFrameRef
  Gives the length of one row of pixels, measured in bytes.
getSupportedVideoModes() - Method in class org.openni.SensorInfo
  Provides a list of video modes that this sensor can support.
getTimestamp() - Method in class org.openni.VideoFrameRef
  Provides a timestamp for the frame.
getUri() - Method in class org.openni.DeviceInfo
  Getter function for the device URI.
getUsbProductId() - Method in class org.openni.DeviceInfo
  Getter function for the USB PID device code.
getUsbVendorId() - Method in class org.openni.DeviceInfo
  Getter function for the USB VID device code.
getVendor() - Method in class org.openni.DeviceInfo
  Getter function for the device vendor name.
getVersion() - Static method in class org.openni.OpenNI
  This function return current OpenNI version
getVerticalFieldOfView() - Method in class org.openni.VideoStream
  Gets the vertical field of view of frames received from this stream.
getVideoMode() - Method in class org.openni.VideoFrameRef
  Returns a reference to the `VideoMode` object assigned to this frame.
getVideoMode() - Method in class org.openni.VideoStream
  Get the current video mode information for this video stream.
getWidth() - Method in class org.openni.CropArea
  Return width cropping value
getWidth() - Method in class org.openni.VideoFrameRef
  Gives the current width of this frame, measured in pixels.
getX() - Method in class org.openni.Point2D
  Return X coordinate
getX() - Method in class org.openni.Point3D
  Return X coordinate
getY() - Method in class org.openni.Point2D
  Return X coordinate
getY() - Method in class org.openni.Point3D
  Return Y coordinate
getZ() - Method in class org.openni.Point3D
  Return Z coordinate
GRAY16 - Enum constant in enum class org.openni.PixelFormat
GRAY8 - Enum constant in enum class org.openni.PixelFormat

## H

hasSensor(SensorType) - Method in class org.openni.Device
  This function checks to see if one of the specific sensor types defined in `SensorType` is available on this device.

## I

ImageRegistrationMode - Enum Class in org.openni
  Provides string names values for all image registration type codes.
initialize() - Static method in class org.openni.OpenNI
  Initialize the library.
IR - Enum constant in enum class org.openni.SensorType
isCroppingSupported() - Method in class org.openni.VideoStream
  Checks whether this stream supports cropping.
isFile() - Method in class org.openni.Device
  Checks whether this device is a file device (i.e.
isImageRegistrationModeSupported(ImageRegistrationMode) - Method in class org.openni.Device
  Checks to see if this device can support registration of color video and depth video.

## J

JPEG - Enum constant in enum class org.openni.PixelFormat

## O

OFF - Enum constant in enum class org.openni.ImageRegistrationMode
onDeviceConnected(DeviceInfo) - Method in interface org.openni.OpenNI.DeviceConnectedListener
  Callback function for the onDeviceConnected event.
onDeviceDisconnected(DeviceInfo) - Method in interface org.openni.OpenNI.DeviceDisconnectedListener
  Callback function for the onDeviceDisconnected event.
onDeviceStateChanged(DeviceInfo, int) - Method in interface org.openni.OpenNI.DeviceStateChangedListener
  Callback function for the onDeviceStateChanged event.
onFrameReady(VideoStream) - Method in interface org.openni.VideoStream.NewFrameListener
  Derived classes should implement this function to handle new frames.
open() - Static method in class org.openni.Device
  Opens a any device.
open(String) - Static method in class org.openni.Device
  Opens a device.
OpenNI - Class in org.openni
  The OpenNI class is a static entry point to the library.
OpenNI() - Constructor for class org.openni.OpenNI
OpenNI.DeviceConnectedListener - Interface in org.openni
  The OpenNI.DeviceConnectedListener interface provides a means of registering for, and responding to when a device is connected.
OpenNI.DeviceDisconnectedListener - Interface in org.openni
  The OpenNI.DeviceDisconnectedListener interface provides a means of registering for, and responding to when a device is disconnected.
OpenNI.DeviceStateChangedListener - Interface in org.openni
  The OpenNI::DeviceStateChangedListener interface provides a means of registering for, and responding to when a device's state is changed.
org.openni - package org.openni

## P

PixelFormat - Enum Class in org.openni
  Provides string names values for all pixel format type codes.
PlaybackControl - Class in org.openni
  The PlaybackControl class provides access to a series of specific to playing back a recording from a file device.
PlaybackControl(Device) - Constructor for class org.openni.PlaybackControl
Point2D<T> - Class in org.openni
  The Point2D object encapsulate 2 Dimension point
Point2D(T, T) - Constructor for class org.openni.Point2D
  The Point2D constructor
Point3D<T> - Class in org.openni
  The Point3D object encapsulate 3 Dimension point
Point3D(T, T, T) - Constructor for class org.openni.Point3D
  The Point3D constructor

## R

readFrame() - Method in class org.openni.VideoStream
  Read the next frame from this video stream, delivered as a `VideoFrameRef`.
Recorder - Class in org.openni
  The Recorder class is used to record streams to an ONI file.
Recorder() - Constructor for class org.openni.Recorder
release() - Method in class org.openni.VideoFrameRef
  Release the reference to the frame.
removeDeviceConnectedListener(OpenNI.DeviceConnectedListener) - Static method in class org.openni.OpenNI
  Remove device connected observer to OpenNI observers list
removeDeviceDisconnectedListener(OpenNI.DeviceDisconnectedListener) - Static method in class org.openni.OpenNI
  Remove device connected observer to OpenNI observers list
removeDeviceStateChangedListener(OpenNI.DeviceStateChangedListener) - Static method in class org.openni.OpenNI
  Remove device state changed observer from OpenNI observers list
removeNewFrameListener(VideoStream.NewFrameListener) - Method in class org.openni.VideoStream
  Removes a Listener from this video stream list.
resetCropping() - Method in class org.openni.VideoStream
  Disables cropping.
RGB888 - Enum constant in enum class org.openni.PixelFormat

## S

seek(VideoStream, int) - Method in class org.openni.PlaybackControl
  Seeks within a VideoStream to a given FrameID.
SensorInfo - Class in org.openni
  The SensorInfo class encapsulates all info related to a specific sensor in a specific device.
  A `Device` object holds a SensorInfo object for each sensor it contains.
  A `VideoStream` object holds one SensorInfo object, describing the sensor used to produce that stream.
SensorType - Enum Class in org.openni
  Provides string names values for all sensors type codes.
setAutoExposureEnabled(boolean) - Method in class org.openni.VideoStream.CameraSettings
  Set Auto Exposure Enabled for corresponding sensor
setAutoWhiteBalanceEnabled(boolean) - Method in class org.openni.VideoStream.CameraSettings
  Set Auto White Balance for corresponding sensor
setCropping(CropArea) - Method in class org.openni.VideoStream
  Changes the cropping settings for this stream.
setDepthColorSyncEnabled(boolean) - Method in class org.openni.Device
  Used to turn the depth/color frame synchronization feature on and off.
setFps(int) - Method in class org.openni.VideoMode
  Setter function for the frame rate.
setImageRegistrationMode(ImageRegistrationMode) - Method in class org.openni.Device
  Sets the image registration on this device.
setMirroringEnabled(boolean) - Method in class org.openni.VideoStream
  Enable or disable mirroring for this stream.
setPixelFormat(PixelFormat) - Method in class org.openni.VideoMode
  Setter function for the pixel format of this VideoMode.
setRepeatEnabled(boolean) - Method in class org.openni.PlaybackControl
  Changes the current repeat mode of the device.
setResolution(int, int) - Method in class org.openni.VideoMode
  Setter function for the resolution of this VideoMode.
setSpeed(float) - Method in class org.openni.PlaybackControl
  Setter function for the playback speed of the device.
setVideoMode(VideoMode) - Method in class org.openni.VideoStream
  Changes the current video mode of this stream.
SHIFT_9_2 - Enum constant in enum class org.openni.PixelFormat
SHIFT_9_3 - Enum constant in enum class org.openni.PixelFormat
shutdown() - Static method in class org.openni.OpenNI
  Stop using the library.
start() - Method in class org.openni.Recorder
  Starts recording.
start() - Method in class org.openni.VideoStream
  Starts data generation from this video stream.
stop() - Method in class org.openni.Recorder
  Stops recording.
stop() - Method in class org.openni.VideoStream
  Stops data generation from this video stream.

## T

TIMEOUT_FOREVER - Static variable in class org.openni.OpenNI
toNative() - Method in enum class org.openni.ImageRegistrationMode
toNative() - Method in enum class org.openni.PixelFormat
toNative() - Method in enum class org.openni.SensorType

## V

valueOf(String) - Static method in enum class org.openni.ImageRegistrationMode
  Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class org.openni.PixelFormat
  Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class org.openni.SensorType
  Returns the enum constant of this class with the specified name.
values() - Static method in enum class org.openni.ImageRegistrationMode
  Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class org.openni.PixelFormat
  Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class org.openni.SensorType
  Returns an array containing the constants of this enum class, in the order they are declared.
Version - Class in org.openni
  Holds an OpenNI version number, which consists of four separate numbers in the format: major.minor.maintenance.build.
VideoFrameRef - Class in org.openni
  The `VideoFrameRef` class encapsulates a single video frame - the output of a `VideoStream` at a specific time.
VideoMode - Class in org.openni
  Encapsulates a group of settings for a `VideoStream`.
VideoMode() - Constructor for class org.openni.VideoMode
  Default constructor, creates an empty VideoMode object.
VideoMode(int, int, int, int) - Constructor for class org.openni.VideoMode
VideoStream - Class in org.openni
  The `VideoStream` object encapsulates a single video stream from a device.
VideoStream.CameraSettings - Class in org.openni
  The `VideoStream.CameraSettings` object encapsulates camera setting for a single device.
VideoStream.NewFrameListener - Interface in org.openni
  The VideoStream::NewFrameListener interface is provided to allow the implementation of event driven frame reading.

## W

waitForAnyStream(List<VideoStream>, int) - Static method in class org.openni.OpenNI
  Wait for a new frame from any of the streams provided.

## Y

YUV422 - Enum constant in enum class org.openni.PixelFormat
YUYV - Enum constant in enum class org.openni.PixelFormat

A C D E F G H I J O P R S T V W Y
All Classes and Interfaces|All Packages|Constant Field Values