Share via

INuiAudioBeam::SetBeam Method

  • Article

Kinect for Windows 1.5, 1.6, 1.7, 1.8

Sets the beam angle, which is the direction that the sensor is actively listening.

Syntax

public:
HRESULT SetBeam(
         double angle
)

Parameters

  • angle
    Type: double
    [in] The beam angle (in radians).

Return Value

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

Remarks

Important

To use SetBeam, you must set the KinectAudio DMO's MFPKEY_WMAAECMA_FEATR_MICARR_MODE property key to MIC_ARRAY_MODE.MICARRAY_EXTERN_BEAM. For more information, see Capturing Audio Data in C#.

Note

The Kinect Audio DirectX Media Object supports 11 beams. They have fixed directions ranging from -0.875 radians to +0.875 radians in .0175 radian increments, which corresponds to approximately -50 degrees to +50 degrees, in ten degree increments. If the beam angle is set to a value which does not equal one of the fixed angles, the beam angle is set to the closest fixed angle. No error message is produced in this case.

For a general conceptual discussion about sound beams, see Beamforming.

For more information about the beam direction generated by the DirectX Media Object, see KinectAudio DMO.

Requirements

Header: Declared in NuiSensor.h.