Share via

INuiSensor::NuiSkeletonTrackingEnable Method

  • Article

Kinect for Windows 1.5, 1.6, 1.7, 1.8

Enables skeleton tracking.

Syntax

public:
HRESULT NuiSkeletonTrackingEnable(
         HANDLE hNextFrameEvent,
         DWORD dwFlags
)

Parameters

  • hNextFrameEvent
    Type: HANDLE
    [in] A handle to an application-allocated, manual reset event that will be set whenever a new frame of skeleton data is available, and will be reset whenever the latest frame data is returned. This can be NULL.
  • dwFlags
    Type: DWORD
    [in] Skeleton tracking flags. Use a bitwise-OR combination of the following values:
    Flag Description
    NUI_SKELETON_TRACKING_FLAG_SUPPRESS_NO_FRAME_DATA Prevents the INuiSensor::NuiSkeletonGetNextFrame method from returning E_NUI_FRAME_NO_DATA errors. Instead, calls to NuiSkeletonGetNextFrame block execution until data is available or the timeout period passes.
    NUI_SKELETON_TRACKING_FLAG_TITLE_SETS_TRACKED_SKELETONS Disables the default player selection mode and enables the title to choose which detected skeletons are tracked.
    NUI_SKELETON_TRACKING_FLAG_ENABLE_SEATED_SUPPORT Uses seated skeleton tracking mode. The 10 lower-body joints of each skeleton will not be tracked.

Return Value

Type: HRESULT
Returns S_OK if successful; otherwise, returns one of the following failure codes.

ERROR_INVALID_OPERATION

Kinect is not initialized or is not initialized with the NUI_INITIALIZE_FLAG_USES_SKELETON flag.

E_INVALIDARG

The value of the dwFlags parameter is NULL.

E_OUTOFMEMORY

The allocation failed.

Requirements

Header: Declared in NuiSensor.h; however, include NuiApi.h in your project.