INuiSensor::NuiImageStreamSetImageFrameFlags Method

Kinect for Windows 1.5, 1.6, 1.7, 1.8

Sets the image frame options.

public:
HRESULT NuiImageStreamSetImageFrameFlags(
         HANDLE hStream,
         DWORD dwImageFrameFlags
)

Parameters

hStream
Type: HANDLE
[in] A handle to the stream.
dwImageFrameFlags
Type: DWORD
[in] Specifies the image frame options, as a bitwise-OR combination of the NUI_IMAGE_STREAM_FLAG constants.

Return Value

Type: HRESULT
Returns S_OK if successful; otherwise, returns one of the failure codes in the following table.
ErrorDescription
E_INVALIDARGThe value of hStream is NULL or invalid.
E_NUI_DEVICE_NOT_READYThe device has not been initialized. Refer to NuiInitialize.

The maximum number of output frames you can set is defined by NUI_IMAGE_STREAM_FRAME_LIMIT_MAXIMUM.

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

Community Additions

ADD
Show: