Share via


INuiSensor::NuiGetForceInfraredEmitterOff Method

Kinect for Windows 1.5, 1.6, 1.7, 1.8

Gets a boolean value that indicates whether the infrared emitter is disabled. The default is FALSE, that is, the emitter is NOT disabled.

Syntax

public:
BOOL NuiGetForceInfraredEmitterOff(
         void
)

Parameters

  • **
    Type: void
    Set to TRUE to disable the emitter, FALSE otherwise.

Return Value

Type: BOOL
Returns TRUE if successful; otherwise FALSE.

Remarks

This method does not work on XBox 360 sensors. It works only on Kinect for Windows sensors.

Requirements

Header: Declared in nuisensor.h.