Share via

NuiSkeletonGetNextFrame

  • Article

Kinect for Windows 1.5, 1.6, 1.7, 1.8

Gets the next frame of data from the skeleton stream.

Syntax

HRESULT NuiSkeletonGetNextFrame(
         DWORD dwMillisecondsToWait,
         NUI_SKELETON_FRAME *pSkeletonFrame
)

Parameters

  • dwMillisecondsToWait
    Type: DWORD
    [in] The time in milliseconds that NuiSkeletonGetNextFrame must wait before returning without a frame.
  • pSkeletonFrame
    Type: NUI_SKELETON_FRAME
    [in, out] 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
E_POINTER The pSkeletonFrame parameter is an invalid handle.
E_NUI_FRAME_NO_DATA The wait timeout expired before a new frame was available.
S_FALSE The wait timeout expired before a new frame was available and NuiSkeletonTrackingEnable was passed the NUI_SKELETON_TRACKING_FLAG_TITLE_SETS_TRACKED_SKELETONS flag.

Requirements

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