Kinect/NuiSensor.h File Reference

NuiSensor.h File Reference
#include "rpc.h"
#include "rpcndr.h"
#include "oaidl.h"
#include "ocidl.h"

Classes

struct  _Vector4
 
struct  _Matrix4
 
struct  _NUI_IMAGE_VIEW_AREA
 
struct  _NUI_TRANSFORM_SMOOTH_PARAMETERS
 
struct  _NUI_SURFACE_DESC
 
struct  _NUI_SKELETON_DATA
 
struct  _NUI_SKELETON_FRAME
 
struct  _NUI_SKELETON_BONE_ROTATION
 
struct  _NUI_SKELETON_BONE_ORIENTATION
 
struct  _NUI_LOCKED_RECT
 
struct  _NUI_DEPTH_IMAGE_POINT
 
struct  _NUI_COLOR_IMAGE_POINT
 
struct  _NUI_IMAGE_FRAME
 
struct  _NUI_DEPTH_IMAGE_PIXEL
 
struct  INuiAudioBeamVtbl
 
struct  INuiFrameTextureVtbl
 
struct  INuiCoordinateMapperParametersChangedEventVtbl
 
struct  INuiCoordinateMapperVtbl
 
struct  INuiColorCameraSettingsVtbl
 
struct  INuiDepthFilterVtbl
 
struct  INuiSensorVtbl
 
struct  NUI_MICROPHONE_ARRAY_DEVICE
 
struct  NUI_SPEAKER_DEVICE
 

Macros

#define __REQUIRED_RPCNDR_H_VERSION__   475
 
#define __INuiAudioBeam_FWD_DEFINED__
 
#define __INuiFrameTexture_FWD_DEFINED__
 
#define __INuiCoordinateMapperParametersChangedEvent_FWD_DEFINED__
 
#define __INuiCoordinateMapper_FWD_DEFINED__
 
#define __INuiColorCameraSettings_FWD_DEFINED__
 
#define __INuiDepthFilter_FWD_DEFINED__
 
#define __INuiSensor_FWD_DEFINED__
 
#define DEFINE_UUID(name, l, w1, w2, b1, b2, b3, b4, b5, b6, b7, b8)   extern "C" const GUID __declspec(selectany) name = { l, w1, w2, { b1, b2, b3, b4, b5, b6, b7, b8 } }
 
#define NUI_SKELETON_COUNT   ( 6 )
 
#define _Vector4_
 
#define _Matrix4_
 
#define _NUI_SKELETON_POSITION_INDEX_
 
#define _NUI_IMAGE_TYPE_
 
#define _NUI_IMAGE_RESOLUTION_
 
#define _NUI_BACKLIGHT_COMPENSATION_MODE_
 
#define _NUI_POWER_LINE_FREQUENCY_
 
#define _NUI_IMAGE_VIEW_AREA_
 
#define _NUI_TRANSFORM_SMOOTH_PARAMETERS_
 
#define _NUI_SURFACE_DESC_
 
#define _NUI_SKELETON_POSITION_TRACKING_STATE_
 
#define _NUI_SKELETON_TRACKING_STATE_
 
#define _NUI_SKELETON_DATA_
 
#define _NUI_SKELETON_FRAME_
 
#define _NUI_SKELETON_BONE_ROTATION_
 
#define _NUI_SKELETON_BONE_ORIENTATION_
 
#define _NUI_LOCKED_RECT_
 
#define _NUI_DEPTH_IMAGE_POINT_
 
#define _NUI_COLOR_IMAGE_POINT_
 
#define MICARRAY_ADAPTIVE_BEAM   0x1100
 
#define _NUI_IMAGE_FRAME_
 
#define _NUI_DEPTH_IMAGE_PIXEL_
 
#define __INuiAudioBeam_INTERFACE_DEFINED__
 
#define __INuiFrameTexture_INTERFACE_DEFINED__
 
#define __INuiCoordinateMapperParametersChangedEvent_INTERFACE_DEFINED__
 
#define __INuiCoordinateMapper_INTERFACE_DEFINED__
 
#define __INuiColorCameraSettings_INTERFACE_DEFINED__
 
#define __INuiDepthFilter_INTERFACE_DEFINED__
 
#define __INuiSensor_INTERFACE_DEFINED__
 
#define MAX_DEV_STR_LEN   512
 

Typedefs

typedef interface INuiAudioBeam INuiAudioBeam
 
typedef interface INuiFrameTexture INuiFrameTexture
 
typedef interface INuiCoordinateMapperParametersChangedEvent INuiCoordinateMapperParametersChangedEvent
 
typedef interface INuiCoordinateMapper INuiCoordinateMapper
 
typedef interface INuiColorCameraSettings INuiColorCameraSettings
 
typedef interface INuiDepthFilter INuiDepthFilter
 
typedef interface INuiSensor INuiSensor
 
typedef struct _Vector4 Vector4
 
typedef struct _Matrix4 Matrix4
 
typedef enum _NUI_SKELETON_POSITION_INDEX NUI_SKELETON_POSITION_INDEX
 
typedef enum _NUI_IMAGE_TYPE NUI_IMAGE_TYPE
 
typedef enum _NUI_IMAGE_RESOLUTION NUI_IMAGE_RESOLUTION
 
typedef enum _NUI_BACKLIGHT_COMPENSATION_MODE NUI_BACKLIGHT_COMPENSATION_MODE
 
typedef enum _NUI_POWER_LINE_FREQUENCY NUI_POWER_LINE_FREQUENCY
 
typedef struct _NUI_IMAGE_VIEW_AREA NUI_IMAGE_VIEW_AREA
 
typedef struct _NUI_TRANSFORM_SMOOTH_PARAMETERS NUI_TRANSFORM_SMOOTH_PARAMETERS
 
typedef struct _NUI_SURFACE_DESC NUI_SURFACE_DESC
 
typedef enum _NUI_SKELETON_POSITION_TRACKING_STATE NUI_SKELETON_POSITION_TRACKING_STATE
 
typedef enum _NUI_SKELETON_TRACKING_STATE NUI_SKELETON_TRACKING_STATE
 
typedef struct _NUI_SKELETON_DATA NUI_SKELETON_DATA
 
typedef struct _NUI_SKELETON_FRAME NUI_SKELETON_FRAME
 
typedef struct _NUI_SKELETON_BONE_ROTATION NUI_SKELETON_BONE_ROTATION
 
typedef struct _NUI_SKELETON_BONE_ORIENTATION NUI_SKELETON_BONE_ORIENTATION
 
typedef struct _NUI_LOCKED_RECT NUI_LOCKED_RECT
 
typedef struct _NUI_DEPTH_IMAGE_POINT NUI_DEPTH_IMAGE_POINT
 
typedef struct _NUI_COLOR_IMAGE_POINT NUI_COLOR_IMAGE_POINT
 
typedef struct _NUI_IMAGE_FRAME NUI_IMAGE_FRAME
 
typedef struct _NUI_DEPTH_IMAGE_PIXEL NUI_DEPTH_IMAGE_PIXEL
 
typedef struct INuiAudioBeamVtbl INuiAudioBeamVtbl
 
typedef struct INuiFrameTextureVtbl INuiFrameTextureVtbl
 
typedef struct INuiCoordinateMapperParametersChangedEventVtbl INuiCoordinateMapperParametersChangedEventVtbl
 
typedef struct INuiCoordinateMapperVtbl INuiCoordinateMapperVtbl
 
typedef struct INuiColorCameraSettingsVtbl INuiColorCameraSettingsVtbl
 
typedef struct INuiDepthFilterVtbl INuiDepthFilterVtbl
 
typedef struct INuiSensorVtbl INuiSensorVtbl
 
typedef void(CALLBACKNuiStatusProc) (HRESULT hrStatus, const OLECHAR *instanceName, const OLECHAR *uniqueDeviceName, void *pUserData)
 
typedef struct NUI_MICROPHONE_ARRAY_DEVICEPNUI_MICROPHONE_ARRAY_DEVICE
 
typedef struct NUI_SPEAKER_DEVICEPNUI_SPEAKER_DEVICE
 

Enumerations

enum  _NUI_SKELETON_POSITION_INDEX {
  NUI_SKELETON_POSITION_HIP_CENTER = 0, NUI_SKELETON_POSITION_SPINE = ( NUI_SKELETON_POSITION_HIP_CENTER + 1 ), NUI_SKELETON_POSITION_SHOULDER_CENTER = ( NUI_SKELETON_POSITION_SPINE + 1 ), NUI_SKELETON_POSITION_HEAD = ( NUI_SKELETON_POSITION_SHOULDER_CENTER + 1 ),
  NUI_SKELETON_POSITION_SHOULDER_LEFT = ( NUI_SKELETON_POSITION_HEAD + 1 ), NUI_SKELETON_POSITION_ELBOW_LEFT = ( NUI_SKELETON_POSITION_SHOULDER_LEFT + 1 ), NUI_SKELETON_POSITION_WRIST_LEFT = ( NUI_SKELETON_POSITION_ELBOW_LEFT + 1 ), NUI_SKELETON_POSITION_HAND_LEFT = ( NUI_SKELETON_POSITION_WRIST_LEFT + 1 ),
  NUI_SKELETON_POSITION_SHOULDER_RIGHT = ( NUI_SKELETON_POSITION_HAND_LEFT + 1 ), NUI_SKELETON_POSITION_ELBOW_RIGHT = ( NUI_SKELETON_POSITION_SHOULDER_RIGHT + 1 ), NUI_SKELETON_POSITION_WRIST_RIGHT = ( NUI_SKELETON_POSITION_ELBOW_RIGHT + 1 ), NUI_SKELETON_POSITION_HAND_RIGHT = ( NUI_SKELETON_POSITION_WRIST_RIGHT + 1 ),
  NUI_SKELETON_POSITION_HIP_LEFT = ( NUI_SKELETON_POSITION_HAND_RIGHT + 1 ), NUI_SKELETON_POSITION_KNEE_LEFT = ( NUI_SKELETON_POSITION_HIP_LEFT + 1 ), NUI_SKELETON_POSITION_ANKLE_LEFT = ( NUI_SKELETON_POSITION_KNEE_LEFT + 1 ), NUI_SKELETON_POSITION_FOOT_LEFT = ( NUI_SKELETON_POSITION_ANKLE_LEFT + 1 ),
  NUI_SKELETON_POSITION_HIP_RIGHT = ( NUI_SKELETON_POSITION_FOOT_LEFT + 1 ), NUI_SKELETON_POSITION_KNEE_RIGHT = ( NUI_SKELETON_POSITION_HIP_RIGHT + 1 ), NUI_SKELETON_POSITION_ANKLE_RIGHT = ( NUI_SKELETON_POSITION_KNEE_RIGHT + 1 ), NUI_SKELETON_POSITION_FOOT_RIGHT = ( NUI_SKELETON_POSITION_ANKLE_RIGHT + 1 ),
  NUI_SKELETON_POSITION_COUNT = ( NUI_SKELETON_POSITION_FOOT_RIGHT + 1 ), NUI_SKELETON_POSITION_HIP_CENTER = 0, NUI_SKELETON_POSITION_SPINE, NUI_SKELETON_POSITION_SHOULDER_CENTER,
  NUI_SKELETON_POSITION_HEAD, NUI_SKELETON_POSITION_SHOULDER_LEFT, NUI_SKELETON_POSITION_ELBOW_LEFT, NUI_SKELETON_POSITION_WRIST_LEFT,
  NUI_SKELETON_POSITION_HAND_LEFT, NUI_SKELETON_POSITION_SHOULDER_RIGHT, NUI_SKELETON_POSITION_ELBOW_RIGHT, NUI_SKELETON_POSITION_WRIST_RIGHT,
  NUI_SKELETON_POSITION_HAND_RIGHT, NUI_SKELETON_POSITION_HIP_LEFT, NUI_SKELETON_POSITION_KNEE_LEFT, NUI_SKELETON_POSITION_ANKLE_LEFT,
  NUI_SKELETON_POSITION_FOOT_LEFT, NUI_SKELETON_POSITION_HIP_RIGHT, NUI_SKELETON_POSITION_KNEE_RIGHT, NUI_SKELETON_POSITION_ANKLE_RIGHT,
  NUI_SKELETON_POSITION_FOOT_RIGHT, NUI_SKELETON_POSITION_COUNT
}
 
enum  _NUI_IMAGE_TYPE {
  NUI_IMAGE_TYPE_DEPTH_AND_PLAYER_INDEX = 0, NUI_IMAGE_TYPE_COLOR, NUI_IMAGE_TYPE_COLOR_YUV, NUI_IMAGE_TYPE_COLOR_RAW_YUV,
  NUI_IMAGE_TYPE_DEPTH, NUI_IMAGE_TYPE_COLOR_INFRARED, NUI_IMAGE_TYPE_COLOR_RAW_BAYER, NUI_IMAGE_TYPE_DEPTH_AND_PLAYER_INDEX = 0,
  NUI_IMAGE_TYPE_COLOR = ( NUI_IMAGE_TYPE_DEPTH_AND_PLAYER_INDEX + 1 ), NUI_IMAGE_TYPE_COLOR_YUV = ( NUI_IMAGE_TYPE_COLOR + 1 ), NUI_IMAGE_TYPE_COLOR_RAW_YUV = ( NUI_IMAGE_TYPE_COLOR_YUV + 1 ), NUI_IMAGE_TYPE_DEPTH = ( NUI_IMAGE_TYPE_COLOR_RAW_YUV + 1 ),
  NUI_IMAGE_TYPE_COLOR_INFRARED = ( NUI_IMAGE_TYPE_DEPTH + 1 ), NUI_IMAGE_TYPE_COLOR_RAW_BAYER = ( NUI_IMAGE_TYPE_COLOR_INFRARED + 1 )
}
 
enum  _NUI_IMAGE_RESOLUTION {
  NUI_IMAGE_RESOLUTION_INVALID = -1, NUI_IMAGE_RESOLUTION_80x60 = 0, NUI_IMAGE_RESOLUTION_320x240, NUI_IMAGE_RESOLUTION_640x480,
  NUI_IMAGE_RESOLUTION_1280x960, NUI_IMAGE_RESOLUTION_INVALID = -1, NUI_IMAGE_RESOLUTION_80x60 = 0, NUI_IMAGE_RESOLUTION_320x240 = ( NUI_IMAGE_RESOLUTION_80x60 + 1 ),
  NUI_IMAGE_RESOLUTION_640x480 = ( NUI_IMAGE_RESOLUTION_320x240 + 1 ), NUI_IMAGE_RESOLUTION_1280x960 = ( NUI_IMAGE_RESOLUTION_640x480 + 1 )
}
 
enum  _NUI_BACKLIGHT_COMPENSATION_MODE {
  NUI_BACKLIGHT_COMPENSATION_MODE_AVERAGE_BRIGHTNESS = 0, NUI_BACKLIGHT_COMPENSATION_MODE_CENTER_PRIORITY = 1, NUI_BACKLIGHT_COMPENSATION_MODE_LOWLIGHTS_PRIORITY = 2, NUI_BACKLIGHT_COMPENSATION_MODE_CENTER_ONLY = 4,
  NUI_BACKLIGHT_COMPENSATION_MODE_AVERAGE_BRIGHTNESS = 0, NUI_BACKLIGHT_COMPENSATION_MODE_CENTER_PRIORITY = 1, NUI_BACKLIGHT_COMPENSATION_MODE_LOWLIGHTS_PRIORITY = 2, NUI_BACKLIGHT_COMPENSATION_MODE_CENTER_ONLY = 4
}
 
enum  _NUI_POWER_LINE_FREQUENCY {
  NUI_POWER_LINE_FREQUENCY_DISABLED = 0, NUI_POWER_LINE_FREQUENCY_50HZ = 1, NUI_POWER_LINE_FREQUENCY_60HZ = 2, NUI_POWER_LINE_FREQUENCY_DISABLED = 0,
  NUI_POWER_LINE_FREQUENCY_50HZ = 1, NUI_POWER_LINE_FREQUENCY_60HZ = 2
}
 
enum  _NUI_SKELETON_POSITION_TRACKING_STATE {
  NUI_SKELETON_POSITION_NOT_TRACKED = 0, NUI_SKELETON_POSITION_INFERRED = ( NUI_SKELETON_POSITION_NOT_TRACKED + 1 ), NUI_SKELETON_POSITION_TRACKED = ( NUI_SKELETON_POSITION_INFERRED + 1 ), NUI_SKELETON_POSITION_NOT_TRACKED = 0,
  NUI_SKELETON_POSITION_INFERRED, NUI_SKELETON_POSITION_TRACKED
}
 
enum  _NUI_SKELETON_TRACKING_STATE {
  NUI_SKELETON_NOT_TRACKED = 0, NUI_SKELETON_POSITION_ONLY = ( NUI_SKELETON_NOT_TRACKED + 1 ), NUI_SKELETON_TRACKED = ( NUI_SKELETON_POSITION_ONLY + 1 ), NUI_SKELETON_NOT_TRACKED = 0,
  NUI_SKELETON_POSITION_ONLY, NUI_SKELETON_TRACKED
}
 

Functions

const GUID __declspec (selectany) IID_INuiSensor = { 0x13ea17f5 , 0xff2e , 0x4670 , { 0x9e , 0xe5 , 0x12 , 0x97 , 0xa6 , 0xe8 , 0x80 , 0xd1 } }
 
_Check_return_ HRESULT NUIAPI NuiGetSensorCount (_In_ int *pCount)
 Returns the number of Kinect sensors that are connected to the computer. More...
 
_Check_return_ HRESULT NUIAPI NuiCreateSensorByIndex (_In_ int index, _Out_ INuiSensor **ppNuiSensor)
 Creates an instance of the sensor with the specified index so that an application can open and use it. More...
 
_Check_return_ HRESULT NUIAPI NuiCreateSensorById (_In_ const OLECHAR *strInstanceId, _Out_ INuiSensor **ppNuiSensor)
 Creates an instance of the sensor with the specified ID so that an application can open and use it. More...
 
_Check_return_ HRESULT NUIAPI NuiGetAudioSource (_Out_ INuiAudioBeam **ppDmo)
 
void NUIAPI NuiSetDeviceStatusCallback (NuiStatusProc callback, void *pUserData)
 Sets a callback function that gets notified when the sensor connection status changes. More...
 
_Check_return_ bool HasSkeletalEngine (_In_ INuiSensor *pNuiSensor)
 Determines whether the sensor instance has a skeletal engine. More...
 
_Check_return_ HRESULT NuiGetMicrophoneArrayDevices (_Out_opt_cap_post_count_(size,*piDeviceCount) PNUI_MICROPHONE_ARRAY_DEVICE pDeviceInfo, _In_ int size, _Out_ int *piDeviceCount)
 Gets device information for the connected Kinect sensors. More...
 
_Check_return_ HRESULT NuiGetSpeakerDevices (_Out_opt_cap_post_count_(size,*piDeviceCount) PNUI_SPEAKER_DEVICE pDeviceInfo, _In_ int size, _Out_ int *piDeviceCount)
 Gets the active speaker devices found on the system. More...
 
_Check_return_ HRESULT NUIAPI NuiCreateCoordinateMapperFromParameters (_In_ ULONG dataByteCount, _In_ void *pData, _Out_ INuiCoordinateMapper **ppCoordinateMapper)
 
_Check_return_ HRESULT NUIAPI NuiCreateDepthFilter (_In_ LPCWSTR filename, _In_ LPCSTR factoryEntryPoint, _Out_ INuiDepthFilter **ppDepthFilter)
 Creates a filter that can be applied to depth frames. More...
 

Variables

RPC_IF_HANDLE __MIDL_itf_Kinect_0000_0000_v0_0_c_ifspec
 
RPC_IF_HANDLE __MIDL_itf_Kinect_0000_0000_v0_0_s_ifspec
 
EXTERN_C const IID IID_INuiAudioBeam
 
interface INuiAudioBeam CONST_VTBL struct INuiAudioBeamVtbllpVtbl
 
EXTERN_C const IID IID_INuiFrameTexture
 
EXTERN_C const IID IID_INuiCoordinateMapperParametersChangedEvent
 
EXTERN_C const IID IID_INuiCoordinateMapper
 
EXTERN_C const IID IID_INuiColorCameraSettings
 
EXTERN_C const IID IID_INuiDepthFilter
 
EXTERN_C const IID IID_INuiSensor
 
RPC_IF_HANDLE __MIDL_itf_Kinect_0001_0070_v0_0_c_ifspec
 
RPC_IF_HANDLE __MIDL_itf_Kinect_0001_0070_v0_0_s_ifspec
 

Macro Definition Documentation

#define __INuiAudioBeam_FWD_DEFINED__

Definition at line 45 of file NuiSensor.h.

#define __INuiAudioBeam_INTERFACE_DEFINED__

Definition at line 440 of file NuiSensor.h.

#define __INuiColorCameraSettings_FWD_DEFINED__

Definition at line 69 of file NuiSensor.h.

#define __INuiColorCameraSettings_INTERFACE_DEFINED__

Definition at line 978 of file NuiSensor.h.

#define __INuiCoordinateMapper_FWD_DEFINED__

Definition at line 63 of file NuiSensor.h.

#define __INuiCoordinateMapper_INTERFACE_DEFINED__

Definition at line 741 of file NuiSensor.h.

#define __INuiCoordinateMapperParametersChangedEvent_FWD_DEFINED__

Definition at line 57 of file NuiSensor.h.

#define __INuiCoordinateMapperParametersChangedEvent_INTERFACE_DEFINED__

Definition at line 664 of file NuiSensor.h.

#define __INuiDepthFilter_FWD_DEFINED__

Definition at line 75 of file NuiSensor.h.

#define __INuiDepthFilter_INTERFACE_DEFINED__

Definition at line 1535 of file NuiSensor.h.

#define __INuiFrameTexture_FWD_DEFINED__

Definition at line 51 of file NuiSensor.h.

#define __INuiFrameTexture_INTERFACE_DEFINED__

Definition at line 541 of file NuiSensor.h.

#define __INuiSensor_FWD_DEFINED__

Definition at line 81 of file NuiSensor.h.

#define __INuiSensor_INTERFACE_DEFINED__

Definition at line 1622 of file NuiSensor.h.

#define __REQUIRED_RPCNDR_H_VERSION__   475

Definition at line 24 of file NuiSensor.h.

#define _Matrix4_

Definition at line 139 of file NuiSensor.h.

#define _NUI_BACKLIGHT_COMPENSATION_MODE_

Definition at line 237 of file NuiSensor.h.

#define _NUI_COLOR_IMAGE_POINT_

Definition at line 391 of file NuiSensor.h.

#define _NUI_DEPTH_IMAGE_PIXEL_

Definition at line 427 of file NuiSensor.h.

#define _NUI_DEPTH_IMAGE_POINT_

Definition at line 380 of file NuiSensor.h.

#define _NUI_IMAGE_FRAME_

Definition at line 413 of file NuiSensor.h.

#define _NUI_IMAGE_RESOLUTION_

Definition at line 225 of file NuiSensor.h.

#define _NUI_IMAGE_TYPE_

Definition at line 211 of file NuiSensor.h.

#define _NUI_IMAGE_VIEW_AREA_

Definition at line 258 of file NuiSensor.h.

#define _NUI_LOCKED_RECT_

Definition at line 361 of file NuiSensor.h.

#define _NUI_POWER_LINE_FREQUENCY_

Definition at line 248 of file NuiSensor.h.

#define _NUI_SKELETON_BONE_ORIENTATION_

Definition at line 350 of file NuiSensor.h.

#define _NUI_SKELETON_BONE_ROTATION_

Definition at line 341 of file NuiSensor.h.

#define _NUI_SKELETON_DATA_

Definition at line 309 of file NuiSensor.h.

#define _NUI_SKELETON_FRAME_

Definition at line 324 of file NuiSensor.h.

#define _NUI_SKELETON_POSITION_INDEX_

Definition at line 183 of file NuiSensor.h.

#define _NUI_SKELETON_POSITION_TRACKING_STATE_

Definition at line 289 of file NuiSensor.h.

#define _NUI_SKELETON_TRACKING_STATE_

Definition at line 299 of file NuiSensor.h.

#define _NUI_SURFACE_DESC_

Definition at line 280 of file NuiSensor.h.

#define _NUI_TRANSFORM_SMOOTH_PARAMETERS_

Definition at line 268 of file NuiSensor.h.

#define _Vector4_

Definition at line 128 of file NuiSensor.h.

#define DEFINE_UUID (   name,
  l,
  w1,
  w2,
  b1,
  b2,
  b3,
  b4,
  b5,
  b6,
  b7,
  b8 
)    extern "C" const GUID __declspec(selectany) name = { l, w1, w2, { b1, b2, b3, b4, b5, b6, b7, b8 } }

Definition at line 107 of file NuiSensor.h.

#define MAX_DEV_STR_LEN   512

Definition at line 2207 of file NuiSensor.h.

#define MICARRAY_ADAPTIVE_BEAM   0x1100

Definition at line 399 of file NuiSensor.h.

#define NUI_SKELETON_COUNT   ( 6 )
+ Examples:

Definition at line 125 of file NuiSensor.h.

Typedef Documentation

typedef interface INuiAudioBeam INuiAudioBeam

Definition at line 46 of file NuiSensor.h.

Definition at line 70 of file NuiSensor.h.

Definition at line 64 of file NuiSensor.h.

typedef interface INuiDepthFilter INuiDepthFilter

Definition at line 76 of file NuiSensor.h.

Definition at line 52 of file NuiSensor.h.

typedef interface INuiSensor INuiSensor

Definition at line 82 of file NuiSensor.h.

typedef struct _Matrix4 Matrix4
typedef void(CALLBACK* NuiStatusProc) (HRESULT hrStatus, const OLECHAR *instanceName, const OLECHAR *uniqueDeviceName, void *pUserData)

Definition at line 2182 of file NuiSensor.h.

typedef struct _Vector4 Vector4

Enumeration Type Documentation

Enumerator
NUI_BACKLIGHT_COMPENSATION_MODE_AVERAGE_BRIGHTNESS 
NUI_BACKLIGHT_COMPENSATION_MODE_CENTER_PRIORITY 
NUI_BACKLIGHT_COMPENSATION_MODE_LOWLIGHTS_PRIORITY 
NUI_BACKLIGHT_COMPENSATION_MODE_CENTER_ONLY 
NUI_BACKLIGHT_COMPENSATION_MODE_AVERAGE_BRIGHTNESS 
NUI_BACKLIGHT_COMPENSATION_MODE_CENTER_PRIORITY 
NUI_BACKLIGHT_COMPENSATION_MODE_LOWLIGHTS_PRIORITY 
NUI_BACKLIGHT_COMPENSATION_MODE_CENTER_ONLY 

Definition at line 238 of file NuiSensor.h.

Enumerator
NUI_IMAGE_RESOLUTION_INVALID 
NUI_IMAGE_RESOLUTION_80x60 
NUI_IMAGE_RESOLUTION_320x240 
NUI_IMAGE_RESOLUTION_640x480 
NUI_IMAGE_RESOLUTION_1280x960 
NUI_IMAGE_RESOLUTION_INVALID 
NUI_IMAGE_RESOLUTION_80x60 
NUI_IMAGE_RESOLUTION_320x240 
NUI_IMAGE_RESOLUTION_640x480 
NUI_IMAGE_RESOLUTION_1280x960 

Definition at line 226 of file NuiSensor.h.

Enumerator
NUI_IMAGE_TYPE_DEPTH_AND_PLAYER_INDEX 
NUI_IMAGE_TYPE_COLOR 
NUI_IMAGE_TYPE_COLOR_YUV 
NUI_IMAGE_TYPE_COLOR_RAW_YUV 
NUI_IMAGE_TYPE_DEPTH 
NUI_IMAGE_TYPE_COLOR_INFRARED 
NUI_IMAGE_TYPE_COLOR_RAW_BAYER 
NUI_IMAGE_TYPE_DEPTH_AND_PLAYER_INDEX 
NUI_IMAGE_TYPE_COLOR 
NUI_IMAGE_TYPE_COLOR_YUV 
NUI_IMAGE_TYPE_COLOR_RAW_YUV 
NUI_IMAGE_TYPE_DEPTH 
NUI_IMAGE_TYPE_COLOR_INFRARED 
NUI_IMAGE_TYPE_COLOR_RAW_BAYER 

Definition at line 212 of file NuiSensor.h.

Enumerator
NUI_POWER_LINE_FREQUENCY_DISABLED 
NUI_POWER_LINE_FREQUENCY_50HZ 
NUI_POWER_LINE_FREQUENCY_60HZ 
NUI_POWER_LINE_FREQUENCY_DISABLED 
NUI_POWER_LINE_FREQUENCY_50HZ 
NUI_POWER_LINE_FREQUENCY_60HZ 

Definition at line 249 of file NuiSensor.h.

Enumerator
NUI_SKELETON_POSITION_HIP_CENTER 
NUI_SKELETON_POSITION_SPINE 
NUI_SKELETON_POSITION_SHOULDER_CENTER 
NUI_SKELETON_POSITION_HEAD 
NUI_SKELETON_POSITION_SHOULDER_LEFT 
NUI_SKELETON_POSITION_ELBOW_LEFT 
NUI_SKELETON_POSITION_WRIST_LEFT 
NUI_SKELETON_POSITION_HAND_LEFT 
NUI_SKELETON_POSITION_SHOULDER_RIGHT 
NUI_SKELETON_POSITION_ELBOW_RIGHT 
NUI_SKELETON_POSITION_WRIST_RIGHT 
NUI_SKELETON_POSITION_HAND_RIGHT 
NUI_SKELETON_POSITION_HIP_LEFT 
NUI_SKELETON_POSITION_KNEE_LEFT 
NUI_SKELETON_POSITION_ANKLE_LEFT 
NUI_SKELETON_POSITION_FOOT_LEFT 
NUI_SKELETON_POSITION_HIP_RIGHT 
NUI_SKELETON_POSITION_KNEE_RIGHT 
NUI_SKELETON_POSITION_ANKLE_RIGHT 
NUI_SKELETON_POSITION_FOOT_RIGHT 
NUI_SKELETON_POSITION_COUNT 
NUI_SKELETON_POSITION_HIP_CENTER 
NUI_SKELETON_POSITION_SPINE 
NUI_SKELETON_POSITION_SHOULDER_CENTER 
NUI_SKELETON_POSITION_HEAD 
NUI_SKELETON_POSITION_SHOULDER_LEFT 
NUI_SKELETON_POSITION_ELBOW_LEFT 
NUI_SKELETON_POSITION_WRIST_LEFT 
NUI_SKELETON_POSITION_HAND_LEFT 
NUI_SKELETON_POSITION_SHOULDER_RIGHT 
NUI_SKELETON_POSITION_ELBOW_RIGHT 
NUI_SKELETON_POSITION_WRIST_RIGHT 
NUI_SKELETON_POSITION_HAND_RIGHT 
NUI_SKELETON_POSITION_HIP_LEFT 
NUI_SKELETON_POSITION_KNEE_LEFT 
NUI_SKELETON_POSITION_ANKLE_LEFT 
NUI_SKELETON_POSITION_FOOT_LEFT 
NUI_SKELETON_POSITION_HIP_RIGHT 
NUI_SKELETON_POSITION_KNEE_RIGHT 
NUI_SKELETON_POSITION_ANKLE_RIGHT 
NUI_SKELETON_POSITION_FOOT_RIGHT 
NUI_SKELETON_POSITION_COUNT 

Definition at line 184 of file NuiSensor.h.

enum _NUI_SKELETON_POSITION_INDEX NUI_SKELETON_POSITION_INDEX
Enumerator
NUI_SKELETON_POSITION_NOT_TRACKED 
NUI_SKELETON_POSITION_INFERRED 
NUI_SKELETON_POSITION_TRACKED 
NUI_SKELETON_POSITION_NOT_TRACKED 
NUI_SKELETON_POSITION_INFERRED 
NUI_SKELETON_POSITION_TRACKED 

Definition at line 290 of file NuiSensor.h.

Enumerator
NUI_SKELETON_NOT_TRACKED 
NUI_SKELETON_POSITION_ONLY 
NUI_SKELETON_TRACKED 
NUI_SKELETON_NOT_TRACKED 
NUI_SKELETON_POSITION_ONLY 
NUI_SKELETON_TRACKED 

Definition at line 300 of file NuiSensor.h.

Function Documentation

const GUID __declspec ( selectany  ) = { 0x13ea17f5 , 0xff2e , 0x4670 , { 0x9e , 0xe5 , 0x12 , 0x97 , 0xa6 , 0xe8 , 0x80 , 0xd1 } }
_Check_return_ bool HasSkeletalEngine ( _In_ INuiSensor pNuiSensor)
inline

Determines whether the sensor instance has a skeletal engine.

Parameters
pNuiSensorPointer to an instance of the sensor.
Returns
Returns true if the sensor instance has a skeletal engine; otherwise, returns false.

Definition at line 2201 of file NuiSensor.h.

2202 {
2203  if (!pNuiSensor) return false;
2204  return (pNuiSensor->NuiInitializationFlags() & NUI_INITIALIZE_FLAG_USES_SKELETON) || (pNuiSensor->NuiInitializationFlags() & NUI_INITIALIZE_FLAG_USES_DEPTH_AND_PLAYER_INDEX);
2205 };
#define NUI_INITIALIZE_FLAG_USES_DEPTH_AND_PLAYER_INDEX
Definition: NuiApi.h:27
#define NUI_INITIALIZE_FLAG_USES_SKELETON
Definition: NuiApi.h:29
_Check_return_ HRESULT NUIAPI NuiCreateCoordinateMapperFromParameters ( _In_ ULONG  dataByteCount,
_In_ void *  pData,
_Out_ INuiCoordinateMapper **  ppCoordinateMapper 
)
_Check_return_ HRESULT NUIAPI NuiCreateDepthFilter ( _In_ LPCWSTR  filename,
_In_ LPCSTR  factoryEntryPoint,
_Out_ INuiDepthFilter **  ppDepthFilter 
)

Creates a filter that can be applied to depth frames.

Parameters
filenameThe name of the DLL that implements the depth filter. Must be an absolute path or a simple filename. Other forms of relative paths are not permitted. If a simple filename, the file must be found in the same directory as the process executable.
factoryEntryPointThe name of the DLL entry point to instantiate the depth filter.
ppDepthFilterReceives a reference-counted pointer to the newly created filter.
Returns
Returns S_OK if successful; otherwise returns a failure code.
_Check_return_ HRESULT NUIAPI NuiCreateSensorById ( _In_ const OLECHAR *  strInstanceId,
_Out_ INuiSensor **  ppNuiSensor 
)

Creates an instance of the sensor with the specified ID so that an application can open and use it.

Parameters
strInstanceIdA pointer to the ID of the Kinect sensor to open. This must not be NULL.
ppNuiSensorA pointer that receives a reference to the created INuiSensor interface. This must not be NULL.
Returns
Returns S_OK if successful; otherwise, returns one of the following error codes:
Error code Description
E_INVALIDARG The strInstanceId parameter is NULL.
E_NUI_BADINDEX The strInstanceId parameter does not match any attached device.
E_POINTER The ppNuiSensor parameter is NULL.

Applications that support more than one Kinect sensor call this function to access the second and subsequent devices. This function returns a pointer to an INuiSensor interface, which provides functions that are identical to those in NuiApi.h

Repeated calls to this method with the same ID may return the same interface pointer.

_Check_return_ HRESULT NUIAPI NuiCreateSensorByIndex ( _In_ int  index,
_Out_ INuiSensor **  ppNuiSensor 
)

Creates an instance of the sensor with the specified index so that an application can open and use it.

Parameters
indexThe zero-based index of the sensor to open. Valid values range from zero to one less than the value returned by the NuiGetSensorCount function.
ppNuiSensorA pointer that receives a reference to the created INuiSensor interface. This must not be NULL.
Returns
Returns S_OK if successful; otherwise, returns one of the following error codes:
Error code Description
E_INVALIDARG The index parameter is negative.
E_NUI_BADINDEX The index parameter is out of range.
E_POINTER The ppNuiSensor parameter is NULL.

Applications that support more than one Kinect sensor call this function to access the second and subsequent devices. This function returns a pointer to an INuiSensor interface, which provides functions that are identical to those in NuiApi.h

Repeated calls to this method with the same ID may return the same interface pointer.

+ Examples:
_Check_return_ HRESULT NUIAPI NuiGetAudioSource ( _Out_ INuiAudioBeam **  ppDmo)
_Check_return_ HRESULT NuiGetMicrophoneArrayDevices ( _Out_opt_cap_post_count_(size,*piDeviceCount) PNUI_MICROPHONE_ARRAY_DEVICE  pDeviceInfo,
_In_ int  size,
_Out_ int piDeviceCount 
)

Gets device information for the connected Kinect sensors.

Parameters
pDeviceInfoPointer to an array of NUI_MICROPHONE_ARRAY_DEVICE structures, allocated by the caller, each of which receives the device information for a single connected Kinect sensor. If you set this parameter to NULL, the piDeviceCount parameter will still receive the number of connected Kinect sensors.
sizeSize of the array pointed to by the pDeviceInfo parameter.
piDeviceCountReceives the number of connected Kinect sensors. When this function returns, this parameter is set to the number of structures in the array pointed to by the pDeviceInfo parameter that contain valid information.
Returns
Returns S_OK if successful; otherwise returns a failure code.
_Check_return_ HRESULT NUIAPI NuiGetSensorCount ( _In_ int pCount)

Returns the number of Kinect sensors that are connected to the computer.

Parameters
pCountPointer to an integer which receives the number of Kinect sensors.
Returns
Returns S_OK if successful; otherwise, returns one of the following failure codes:
Error code Description
E_POINTER The pCount parameter is NULL.
+ Examples:
_Check_return_ HRESULT NuiGetSpeakerDevices ( _Out_opt_cap_post_count_(size,*piDeviceCount) PNUI_SPEAKER_DEVICE  pDeviceInfo,
_In_ int  size,
_Out_ int piDeviceCount 
)

Gets the active speaker devices found on the system.

Parameters
pDeviceInfoPointer to an array of NUI_SPEAKER_DEVICE structures, allocated by the caller, each of which receives the device information for a single connected speaker device. If you set this parameter to NULL, the piDeviceCount parameter will still receive the number of connected speaker devices.
sizeSize of the array pointed to by the pDeviceInfo parameter.
piDeviceCountReceives the number of connected speaker devices. When this function returns, this parameter is set to the number of structures in the array pointed to by the pDeviceInfo parameter that contain valid information.
Returns
Returns S_OK if successful; otherwise returns a failure code.
void NUIAPI NuiSetDeviceStatusCallback ( NuiStatusProc  callback,
void *  pUserData 
)

Sets a callback function that gets notified when the sensor connection status changes.

Parameters
callbackFunction pointer to the callback.
pUserDataPointer to optional context data that will be passed to the callback.

Use this method to handle the case of a user connecting or disconnecting a sensor.

Variable Documentation

RPC_IF_HANDLE __MIDL_itf_Kinect_0000_0000_v0_0_c_ifspec
RPC_IF_HANDLE __MIDL_itf_Kinect_0000_0000_v0_0_s_ifspec
RPC_IF_HANDLE __MIDL_itf_Kinect_0001_0070_v0_0_c_ifspec
RPC_IF_HANDLE __MIDL_itf_Kinect_0001_0070_v0_0_s_ifspec
EXTERN_C const IID IID_INuiAudioBeam

Definition at line 446 of file NuiSensor.h.

EXTERN_C const IID IID_INuiColorCameraSettings

Definition at line 984 of file NuiSensor.h.

EXTERN_C const IID IID_INuiCoordinateMapper

Definition at line 747 of file NuiSensor.h.

EXTERN_C const IID IID_INuiCoordinateMapperParametersChangedEvent

Definition at line 670 of file NuiSensor.h.

EXTERN_C const IID IID_INuiDepthFilter

Definition at line 1541 of file NuiSensor.h.

EXTERN_C const IID IID_INuiFrameTexture

Definition at line 547 of file NuiSensor.h.

EXTERN_C const IID IID_INuiSensor

Definition at line 1628 of file NuiSensor.h.

interface INuiAudioBeam CONST_VTBL struct INuiAudioBeamVtbl* lpVtbl

Definition at line 502 of file NuiSensor.h.

Go to the source code of this file.