Share via

INuiSensor::NuiImageStreamReleaseFrame Method

  • Article

Kinect for Windows 1.5, 1.6, 1.7, 1.8

Releases a frame of data.

Syntax

public:
HRESULT NuiImageStreamReleaseFrame(
         HANDLE hStream,
         NUI_IMAGE_FRAME *pImageFrame
)

Parameters

  • hStream
    Type: HANDLE
    [in] A handle to the stream that contains the frame to release.

    Note

    Open the stream by calling the NuiImageStreamOpen method, before calling NuiImageStreamReleaseFrame.

  • pImageFrame
    Type: NUI_IMAGE_FRAME
    [in] A pointer to the frame to release.

Return Value

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

Error Description
E_INVALIDARG The value of the hStream or the pImageFrame parameter is NULL.
E_NOINTERFACE The pFrameTexture member of the pImageFrame parameter is NULL.
E_NUI_DEVICE_NOT_READY The sensorhas not been initialized. Refer to NuiInitialize.

Remarks

Important

Reset the notification event for the stream, before calling NuiImageStreamReleaseFrame.

Requirements

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