Share via

INuiSensor::NuiSetForceInfraredEmitterOff Method

  • Article

Kinect for Windows 1.5, 1.6, 1.7, 1.8

Sets a value indicating whether the infrared emitter is disabled. The default value is false, which means that the infrared sensor is enabled (that is, not disabled).

This property does not work with XBox 360 Kinect sensors. It only works with Kinect for Windows sensors.

Syntax

public:
HRESULT NuiSetForceInfraredEmitterOff(
         BOOL fForceInfraredEmitterOff
)

Parameters

  • fForceInfraredEmitterOff
    Type: BOOL
    Set to TRUE to disable the infrared emitter; set to FALSE to enable the emitter.

Return Value

Type: HRESULT
Returns S_OK if successful; otherwise, returns a failure code.

Requirements

Header: Declared in nuisensor.h.