openni Namespace Reference

Classes
class	_NullString
class	Array
class	CameraSettings
class	CoordinateConverter
class	Device
class	DeviceInfo
class	OpenNI
class	PlaybackControl
class	Recorder
struct	RGB888Pixel
class	SensorInfo
struct	Version
class	VideoFrameRef
class	VideoMode
class	VideoStream
struct	YUV422DoublePixel
struct	YUYVDoublePixel

Typedefs
typedef uint16_t	DepthPixel
typedef uint16_t	Grayscale16Pixel

Enumerations
enum	{   DEVICE_PROPERTY_FIRMWARE_VERSION = 0, DEVICE_PROPERTY_DRIVER_VERSION = 1, DEVICE_PROPERTY_HARDWARE_VERSION = 2, DEVICE_PROPERTY_SERIAL_NUMBER = 3,   DEVICE_PROPERTY_ERROR_STATE = 4, DEVICE_PROPERTY_IMAGE_REGISTRATION = 5, OBEXTENSION_ID_IR_GAIN = 11, OBEXTENSION_ID_IR_EXP,   OBEXTENSION_ID_LDP_EN, OBEXTENSION_ID_CAM_PARAMS, OBEXTENSION_ID_LASER_EN, OBEXTENSION_ID_SERIALNUMBER,   OBEXTENSION_ID_DEVICETYPE, OBEXTENSION_ID_UPDATE_FIRMWARE, DEVICE_PROPERTY_PLAYBACK_SPEED = 100, DEVICE_PROPERTY_PLAYBACK_REPEAT_ENABLED = 101 }
enum	{   STREAM_PROPERTY_CROPPING = 0, STREAM_PROPERTY_HORIZONTAL_FOV = 1, STREAM_PROPERTY_VERTICAL_FOV = 2, STREAM_PROPERTY_VIDEO_MODE = 3,   STREAM_PROPERTY_MAX_VALUE = 4, STREAM_PROPERTY_MIN_VALUE = 5, STREAM_PROPERTY_STRIDE = 6, STREAM_PROPERTY_MIRRORING = 7,   STREAM_PROPERTY_NUMBER_OF_FRAMES = 8, STREAM_PROPERTY_AUTO_WHITE_BALANCE = 100, STREAM_PROPERTY_AUTO_EXPOSURE = 101, STREAM_PROPERTY_EXPOSURE = 102,   STREAM_PROPERTY_GAIN = 103, STREAM_PROPERTY_SOFTWARE_REGISTRATION = 0x2080FF42 }
enum	{ DEVICE_COMMAND_SEEK = 1 }
enum	DeviceState { DEVICE_STATE_OK = 0, DEVICE_STATE_ERROR = 1, DEVICE_STATE_NOT_READY = 2, DEVICE_STATE_EOF = 3 }
enum	ImageRegistrationMode { IMAGE_REGISTRATION_OFF = 0, IMAGE_REGISTRATION_DEPTH_TO_COLOR = 1 }
enum	ParamsRegistrationMode { PARAMS_REGISTRATION_OFF = 0, PARAMS_REGISTRATION_DEPTH_TO_COLOR = 1, PARAMS_REGISTRATION_USE_DISTORTION = 2 }
enum	PixelFormat {   PIXEL_FORMAT_DEPTH_1_MM = 100, PIXEL_FORMAT_DEPTH_100_UM = 101, PIXEL_FORMAT_SHIFT_9_2 = 102, PIXEL_FORMAT_SHIFT_9_3 = 103,   PIXEL_FORMAT_RGB888 = 200, PIXEL_FORMAT_YUV422 = 201, PIXEL_FORMAT_GRAY8 = 202, PIXEL_FORMAT_GRAY16 = 203,   PIXEL_FORMAT_JPEG = 204, PIXEL_FORMAT_YUYV = 205 }
enum	SensorType { SENSOR_IR = 1, SENSOR_COLOR = 2, SENSOR_DEPTH = 3 }
enum	Status {   STATUS_OK = 0, STATUS_ERROR = 1, STATUS_NOT_IMPLEMENTED = 2, STATUS_NOT_SUPPORTED = 3,   STATUS_BAD_PARAMETER = 4, STATUS_OUT_OF_FLOW = 5, STATUS_NO_DEVICE = 6, STATUS_TIME_OUT = 102 }

Variables
static const _NullString	ANY_DEVICE
static const int	TIMEOUT_FOREVER = -1
static const int	TIMEOUT_NONE = 0

Detailed Description

openni is the namespace of the entire C++ API of OpenNI

Typedef Documentation

typedef uint16_t openni::DepthPixel

Pixel type used to store depth images.

Definition at line 39 of file OpenNI.h.

typedef uint16_t openni::Grayscale16Pixel

Pixel type used to store IR images.

Definition at line 42 of file OpenNI.h.

Enumeration Type Documentation

anonymous enum

Enumerator
DEVICE_PROPERTY_FIRMWARE_VERSION
DEVICE_PROPERTY_DRIVER_VERSION
DEVICE_PROPERTY_HARDWARE_VERSION
DEVICE_PROPERTY_SERIAL_NUMBER
DEVICE_PROPERTY_ERROR_STATE
DEVICE_PROPERTY_IMAGE_REGISTRATION
OBEXTENSION_ID_IR_GAIN
OBEXTENSION_ID_IR_EXP
OBEXTENSION_ID_LDP_EN
OBEXTENSION_ID_CAM_PARAMS
OBEXTENSION_ID_LASER_EN
OBEXTENSION_ID_SERIALNUMBER
OBEXTENSION_ID_DEVICETYPE
OBEXTENSION_ID_UPDATE_FIRMWARE
DEVICE_PROPERTY_PLAYBACK_SPEED
DEVICE_PROPERTY_PLAYBACK_REPEAT_ENABLED

Definition at line 28 of file OniProperties.h.

anonymous enum

Enumerator
STREAM_PROPERTY_CROPPING
STREAM_PROPERTY_HORIZONTAL_FOV
STREAM_PROPERTY_VERTICAL_FOV
STREAM_PROPERTY_VIDEO_MODE
STREAM_PROPERTY_MAX_VALUE
STREAM_PROPERTY_MIN_VALUE
STREAM_PROPERTY_STRIDE
STREAM_PROPERTY_MIRRORING
STREAM_PROPERTY_NUMBER_OF_FRAMES
STREAM_PROPERTY_AUTO_WHITE_BALANCE
STREAM_PROPERTY_AUTO_EXPOSURE
STREAM_PROPERTY_EXPOSURE
STREAM_PROPERTY_GAIN
STREAM_PROPERTY_SOFTWARE_REGISTRATION

Definition at line 52 of file OniProperties.h.

anonymous enum

Enumerator
DEVICE_COMMAND_SEEK

Definition at line 77 of file OniProperties.h.

enum openni::DeviceState

Enumerator
DEVICE_STATE_OK
DEVICE_STATE_ERROR
DEVICE_STATE_NOT_READY
DEVICE_STATE_EOF

Definition at line 67 of file OniEnums.h.

enum openni::ImageRegistrationMode

Enumerator
IMAGE_REGISTRATION_OFF
IMAGE_REGISTRATION_DEPTH_TO_COLOR

Definition at line 75 of file OniEnums.h.

enum openni::ParamsRegistrationMode

Enumerator
PARAMS_REGISTRATION_OFF
PARAMS_REGISTRATION_DEPTH_TO_COLOR
PARAMS_REGISTRATION_USE_DISTORTION

Definition at line 81 of file OniEnums.h.

enum openni::PixelFormat

All available formats of the output of a stream

Enumerator
PIXEL_FORMAT_DEPTH_1_MM
PIXEL_FORMAT_DEPTH_100_UM
PIXEL_FORMAT_SHIFT_9_2
PIXEL_FORMAT_SHIFT_9_3
PIXEL_FORMAT_RGB888
PIXEL_FORMAT_YUV422
PIXEL_FORMAT_GRAY8
PIXEL_FORMAT_GRAY16
PIXEL_FORMAT_JPEG
PIXEL_FORMAT_YUYV

Definition at line 50 of file OniEnums.h.

enum openni::SensorType

The source of the stream

Enumerator
SENSOR_IR
SENSOR_COLOR
SENSOR_DEPTH

Definition at line 41 of file OniEnums.h.

enum openni::Status

Possible failure values

Enumerator
STATUS_OK
STATUS_ERROR
STATUS_NOT_IMPLEMENTED
STATUS_NOT_SUPPORTED
STATUS_BAD_PARAMETER
STATUS_OUT_OF_FLOW
STATUS_NO_DEVICE
STATUS_TIME_OUT

Definition at line 28 of file OniEnums.h.

Variable Documentation

const _NullString openni::ANY_DEVICE

static

Definition at line 111 of file OpenNI.h.

const int openni::TIMEOUT_FOREVER = -1

static

Definition at line 89 of file OniEnums.h.

const int openni::TIMEOUT_NONE = 0

static

Definition at line 88 of file OniEnums.h.