Share via

INuiSensor::NuiSkeletonGetNextFrame Method

  • Article

Kinect for Windows 1.5, 1.6, 1.7, 1.8

Gets the next frame of data from the skeleton stream.

Syntax

public:
HRESULT NuiSkeletonGetNextFrame(
         DWORD dwMillisecondsToWait,
         NUI_SKELETON_FRAME *pSkeletonFrame
)

Parameters

  • dwMillisecondsToWait
    Type: DWORD
    [in] The time in milliseconds to wait before returning without a frame.
  • pSkeletonFrame
    Type: NUI_SKELETON_FRAME
    A pointer to a NUI_SKELETON_FRAME structure that contains the next image frame in the skeleton stream. This parameter cannot be NULL.

Return Value

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

Error Description
S_FALSE The waiting timeout expired before a frame was available and the NUI_SKELETON_TRACKING_FLAG_TITLE_SETS_TRACKED_SKELETONS flag was passed to NuiSkeletonTrackingEnable.
E_NUI_FRAME_NO_DATA The waiting timeout expired before a frame was available.
E_POINTER The value of the pSkeletonFrame parameter is NULL.

Requirements

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