Kinect for Windows – Details of API Changes from Beta2 to v1.0 (C#/VB)

[This article covers the details of changes of C#/VB accessible
APIs. Please ensure you read the code
migration post as well.]

Namespace and Assembly Name Changes

Since our Beta 1 (June 2011) release of the Kinect for
Windows SDK , our C#/VB  accessible APIs have been provided via
Microsoft.Research.Kinect.dll. The public Types all were organized into 2 namespaces:
Microsoft.Research.Kinect.Nui and Microsoft.Research.Kinect.Audio.
Our team made the decision back in early 2011 that we would mark our beta
releases of APIs as “Research” to indicate the fact that this was an early
version of our APIs, created in concert with Microsoft Research.

On February 1, 2012, we released our final v1.0 SDK. In that
release, our DLL is now called Microsoft.Kinect.dll. All of our public APIs are
in the Microsoft.Kinect namespace.

Release	Assembly Names	Namespaces
Beta 2 (November 2011)	Microsoft.Research.Kinect.dll	Microsoft.Research.Kinect.Nui Microsoft.Research.Kinect.Audio
V1.0 (Feb 2012)	Microsoft.Kinect.dll	Microsoft.Kinect

Runtime type (Rename to KinectSensor, refactoring)

Significant changes:

• Rename of top level class – Runtime à KinectSensor
• Removal of Camera class.
• Several renames/refactorings.
• New guidance for KinectSensor discovery.
• Change in initialization of KinectSensor. (Initialize/Uninitialize)
• Addition of several Mapping APIs. See details in Mapping API changes details.
• Addition of several new KinectStatus values.

KINECTSENSOR API – SUMMARY OF API CHANGES/REMOVALS/ADDITIONS

<NamespaceOldName=“Microsoft.Research.Kinect.Nui“Name=“Microsoft.Kinect“>     <TypeOldName=“Runtime“Name=“KinectSensor“>         <MemberOldName=“Kinects“Name=“KinectSensors“ />         <MemberOldName=“Initialize“Name=“Start“ />         <MemberOldName=“Uninitialize“Name=“Stop“ />         <MemberName=“Dispose“Added=“True“ />           <MemberOldName=“VideoStream“Name=“ColorStream“ />         <MemberOldName=“VideoFrameReady“Name=“ColorFrameReady“ />           <MemberOldName=“SkeletonEngine“ Name=“SkeletonStream“ />           <MemberName=“AllFramesReady“ Added=“True“ />           <MemberName=“InstanceIndex“ Removed=“True“ />         <MemberOldName=“InstanceName“Name=“DeviceConnectionId“ />         <MemberName=“UniqueKinectId“ Added=“True“ />           <MemberName=“NuiCamera“Removed=“True“/>         <MemberOldName=“ElevationMaximum“Name=“MaxElevationAngle“MovedFrom=“Camera“ />         <MemberOldName=“ElevationMinimum“Name=“MinElevationAngle“MovedFrom=“Camera“ />         <MemberName=“ElevationAngle“ MovedFrom=“Camera“ />           <MemberName=“MapDepthFrameToColorFrame“Added=“True“ />         <MemberName=“MapDepthToColorImagePoint“Added=“True“ />         <MemberName=“MapDepthToSkeletonPoint“Added=“True“ />         <MemberName=“MapSkeletonPointToDepth“Added=“True“ />         <MemberName=“MapSkeletonPointToColor“Added=“True“ />     </Type>     <TypeName=“RuntimeOptions“Removed=“True“Message=“Enable the streams from the KinectSensor class.“ />     <TypeOldName=“KinectDeviceCollection“Name=“KinectSensorCollection“>         <MemberName=“Dispose“Added=“True“ />     </Type>     <TypeName=“StatusChangedEventArgs“>         <MemberOldName=“KinectRuntime“ Name=“Sensor“ />     </Type>     <TypeName=“Camera“Removed=“True“>         <MemberOldName=“GetColorPixelCoordinatesFromDepthPixel“Name=“MapToColorPixel“MovedTo=“DepthImageFrame“ />         <MemberOldName=“ElevationMaximum“Name=“MaxElevationAngle“MovedTo=“KinectSensor“ />         <MemberOldName=“ElevationMinimum“Name=“MinElevationAngle“MovedTo=“KinectSensor“ />         <MemberName=“ElevationAngle“ MovedTo=“KinectSensor“ />     </Type>     <TypeName=“KinectStatus“>         <MemberName=“Undefined“Added=“True“ />         <MemberName=“Initializing“Added=“True“ />         <MemberName=“DeviceNotGenuine“Added=“True“ />         <MemberName=“DeviceNotSupported“Added=“True“ />         <MemberName=“InsufficientBandwidth“Added=“True“ />     </Type> </Namespace>

KinectSensor discovery

In beta2 (November 2011), we introduced a KinectSensors property on the Runtime object. We also
introduced a StatusChanged event.

In v1 (Feb 2012), those continue to be the key concepts to
understand when your program needs to work with 1 or more sensors.

It is critical that Kinect-enabled applications can deal
appropriately with the situations that users will hit with their application
(no Kinect sensor connected to computer, Kinect sensor is not powered by A/C
power, insufficient USB bandwidth, etc…)

Please read the documentation under “Programming
Guide/Kinect Sensor/Kinect-Enabled Application”:

Relevant samples (installed with SDK):

• ShapeGame (C#/WPF) – KinectSensorChooser component
• KinectAudioDemo (C#/WPF) – KinectSensorChooser component
• KinectExplorer (C#/WPF)
• SkeletonViewer (C++/Direct2D+GDI)

KinectSensor
initialization

Our beta APIs had a set of hard to understand and discover
API calls to configure the services you needed to get from the sensor. We
worked to make this part of our API more approachable. Our design goals were:

• Enable a developer to ask once, not several
  times for a feature.
• Valid settings are determinable via intellisense/compiling, not just runtime errors
• Good default behavior.
• Dynamic changing of any setting over time.

OLD CODE	EQUIVALENT NEW CODE
runtime.Initialize(RuntimeOptions.UseDepthAndPlayerIndex | RuntimeOptions.UseSkeletalTracking | RuntimeOptions.UseColor); runtime.VideoStream.Open(ImageStreamType.Video, 2, ImageResolution.Resolution640x480, ImageType.Color); runtime.DepthStream.Open(ImageStreamType.Depth, 2, ImageResolution.Resolution320x240, ImageType.DepthAndPlayerIndex);	kinectSensor.ColorStream.Enable(); kinectSensor.DepthStream.Enable(); kinectSensor.SkeletonStream.Enable(); kinectSensor.Start();
The old way doesn’t meet many of our design goals for Initialization: You needed to ask twice – once in Init() and once in Open(). Runtime errors were often are raised. We had poor defaults; you had to ask for every setting. We didn’t expose r/w properties for most of those settings, so you needed to re-init() and/or re-open() to set them to different values.	The ColorImageStream, DepthImageStream, and SkeletonStream types also have ways to tweak their behavior. Enable has some optional parameters, and those stream types have several r/w properties as well.

Types/APIs to explore: KinectSensor, ColorImageStream, DepthImageStream,
SkeletonStream.

KinectSensor uninitialize

OLD CODE	NEW CODE
runtime.Uninitialize();	kinectSensor.Stop();

ColorImage API changes

Significant changes:

• Reorganization of colorImage
  data. There is no longer a PlanarImage class.
• Developer is now responsible for own allocations
  of pixelData variables and copying pixelData to that storage. (Color pixelData
  is still a byte array with same layout as beta2.)
• This enables the Kinect Runtime to better reuse
  resources if an application’s data processing falls behind.
• Availability of colorImage
  data during ColorFrameReady or AllFramesReady
  events. (AllFramesReady gives matching color, depth
  and/or skeleton frames.)

Relevant samples (installed with SDK):

• KinectExplorer (C#/WPF) – KinectColorViewer component
• SkeletonViewer (C++/Direct2D+GDI)
• ShapeGame (C#/WPF) – KinectColorViewer component

COLORIMAGE API – SUMMARY OF API CHANGES/REMOVALS/ADDITIONS

<TypeName=“ColorImageStream“Added=“True“>     <MemberOldName=“GetNextFrame“Name=“OpenNextFrame“ />     <MemberName=“Disable“Added=“True“ />     <MemberOldName=“Open“Name=“Enable“ />     <MemberName=“StreamType“Removed=“True“ />     <MemberName=“Resolution“Removed=“True“ />     <MemberName=“Type“Removed=“True“ />     <MemberOldName=“Height“Name=“FrameHeight“ />     <MemberOldName=“Width“Name=“FrameWidth“ />     <MemberName=“CreateCompatibleImageFrame“Removed=“True“ /> </Type> <TypeName=“ImageFrameReadyEventArgs“Removed=“True“Message=“Use ColorImageFrameReadyEventArgs or DepthImageFrameReadyEventArgs instead of the now removed ImageFrameReadyEventArgs“> </Type> <TypeName=“ColorImageFrameReadyEventArgs“Added=“True“>     <MemberOldName=“ImageFrame“Name=“OpenColorImageFrame“ /> </Type> <TypeName=“ColorImageFrame“Added=“True“>     <MemberName=“Type“Removed=“True“ />     <MemberName=“Resolution“Removed=“True“ />     <MemberName=“Image“Removed=“True“ />     <MemberName=“ViewArea“Removed=“True“ />     <MemberName=“ImageFrame“Removed=“True“ />     <MemberName=“BytesPerPixel“MovedFrom=“PlanarImage“ />     <MemberName=“Height“MovedFrom=“PlanarImage“ />     <MemberName=“Width“MovedFrom=“PlanarImage“ />     <MemberOldName=“Bits“Name=“PixelData“MovedFrom=“PlanarImage“ />     <MemberName=“CopyPixelDataTo“ />     <MemberName=“SourceStream“Removed=“True“ />     <MemberName=“PixelData“Removed=“True“Message=“use CopyPixelDataTo(…)“/>     <MemberName=“Dispose“Added=“True“ /> </Type> <TypeName=“PlanarImage“Removed=“True“Message=“Data moved to ColorImageFrame/DepthImageFrame“ />

OLD CODE

runtime.VideoStream.Open(ImageStreamType.Video, 2, ImageResolution.Resolution640x480, ImageType.Color);   runtime.VideoFrameReady += new EventHandler<ImageFrameReadyEventArgs>(ColorImageReady);   void ColorImageReady(object sender, ImageFrameReadyEventArgs e) {     PlanarImage planarImage = e.ImageFrame.Image;       // DISPLAY OR PROCESS IMAGE DATA IN planarImage HERE }

NEW CODE

kinectSensor.ColorStream.Enable(ColorImageFormat.RgbResolution640x480Fps30);   kinectSensor.ColorFrameReady += new EventHandler<ColorImageFrameReadyEventArgs>(ColorImageReady); byte[] pixelData;   void ColorImageReady(object sender, ColorImageFrameReadyEventArgs e) {     bool receivedData = false;     using (ColorImageFrame colorImageFrame = e.OpenColorImageFrame())     {         if (colorImageFrame != null)         {             if (pixelData == null) //allocate the first time             {                 pixelData = new byte[colorImageFrame.PixelDataLength];             }             colorImageFrame.CopyPixelDataTo(pixelData);             receivedData = true;         }         else         {             // apps processing of image data is taking too long, it got more than 2 frames behind.             // the data is no longer avabilable.         }     }     if (receivedData)     {         // DISPLAY OR PROCESS IMAGE DATA IN pixelData HERE     } }

DepthImage API changes

Significant changes:

• Reorganization of depthImage data. There is no longer a PlanarImage class.
• DepthPixel data is now a short[], instead of a byte[]. (Still 2 bytes of data representing each pixel.)
• DepthPixel bit layout is now consistent, regardless if you have opted for Depth+Player or just Depth.
• There is no longer a need to ask for Depth+Player or Depth. If the SkeletonStream is enabled, you get Depth+Player.
• Developer is now responsible for own allocations of pixelData variables and copying pixelData to that storage.

This enables the Kinect Runtime to better reuse resources if an application’s data processing falls behind.

• Availability of depthImage data during DepthFrameReady or AllFramesReady
  events. (AllFramesReady gives matching color, depth and/or skeleton frames.)

Relevant samples (installed with SDK):

• KinectExplorer (C#/WPF) – KinectDepthViewer component
• SkeletonViewer (C++/Direct2D+GDI)

DEPTHIMAGE API – SUMMARY OF API CHANGES/REMOVALS/ADDITIONS

<TypeName=“ImageFrameReadyEventArgs“Removed=“True“Message=“Use ColorImageFrameReadyEventArgs or DepthImageFrameReadyEventArgs instead of the now removed ImageFrameReadyEventArgs“> </Type> <TypeName=“DepthImageStream“Added=“True“>     <MemberOldName=“GetNextFrame“Name=“OpenNextFrame“ />     <MemberName=“IsTooFarRangeEnabled“  Added=“True“/>     <MemberName=“Disable“Added=“True“ />     <MemberOldName=“Open“Name=“Enable“ />     <MemberName=“StreamType“Removed=“True“ />     <MemberName=“Resolution“Removed=“True“ />     <MemberName=“Type“Removed=“True“ />     <MemberOldName=“Height“Name=“FrameHeight“ />     <MemberOldName=“Width“Name=“FrameWidth“ />     <MemberName=“CreateCompatibleImageFrame“Removed=“True“ /> </Type> <TypeName=“DepthImageFrameReadyEventArgs“Added=“True“>     <MemberOldName=“ImageFrame“Name=“OpenDepthImageFrame“ /> </Type> <TypeName=“DepthImageFrame“Added=“True“>     <MemberOldName=“GetColorPixelCoordinatesFromDepthPixel“Name=“MapToColorImagePoint“MovedFrom=“DepthImageFrame“ />     <MemberOldName=“SkeletonToDepthImage“Name=“MapFromSkeletonPoint“MovedFrom=“SkeletonStream“ />     <MemberOldName=“DepthImageToSkeleton“Name=“MapToSkeletonPoint“MovedFrom=“SkeletonStream“ />     <MemberName=“PlayerIndexBitmask“Added=“True“ />     <MemberName=“PlayerIndexBitmaskWidth“Added=“True“ /> </Type> <TypeName=“PlanarImage“Removed=“True“Message=“Data moved to ColorImageFrame/DepthImageFrame“ /> <TypeName=“ImageDigitalZoom“Removed=“True“ /> <TypeName=“ImageStreamType“Removed=“True“ /> <TypeName=“ImageType“Removed=“True“ /> <TypeName=“ImageResolution“Removed=“True“ /> <TypeName=“PlanarImage“Removed=“True“Message=“Data moved to ColorImageFrame/DepthImageFrame“ /> <TypeName=“ImageViewArea“ Removed=“True“ /> <TypeName=“DepthImageFormat“  Added=“True“/> <TypeName=“DepthRange“  Added=“True“/> <TypeName=“DepthImagePoint“Added=“True“ /> <TypeName=“DepthImagePointFloat“Added=“True“ />

OLD CODE

runtime.DepthStream.Open(ImageStreamType.Depth, 2, ImageResolution.Resolution320x240,                      ImageType.DepthAndPlayerIndex);   runtime.DepthFrameReady += new EventHandler<ImageFrameReadyEventArgs>(DepthImageReady);   private void DepthImageReady(object sender, ImageFrameReadyEventArgs e) {     PlanarImage planarImage = e.ImageFrame.Image;       // DISPLAY OR PROCESS IMAGE DATA IN pixelData HERE }

NEW CODE

kinectSensor.DepthStream.Enable(DepthImageFormat.Resolution320x240Fps30);   kinectSensor.DepthFrameReady += new EventHandler<DepthImageFrameReadyEventArgs>(DepthImageReady); short[] pixelData;   private void DepthImageReady(object sender, DepthImageFrameReadyEventArgs e) {     bool receivedData = false;     using (DepthImageFrame depthImageFrame = e.OpenDepthImageFrame())     {         if (depthImageFrame != null)         {             if (pixelData == null) //allocate the first time             {                 pixelData = new short[depthImageFrame.PixelDataLength];             }             depthImageFrame.CopyPixelDataTo(pixelData);             receivedData = true;         }         else         {             // apps processing of image data took too long; it got more than 2 frames behind.             // the data is no longer avabilable.         }     }     if (receivedData)     {         // DISPLAY OR PROCESS IMAGE DATA IN pixelData HERE     } }

Skeleton API improvements

Significant changes:

• Renamed SkeletonEngine -> SkeletonStream
• Renamed SkeletonData -> Skeleton
• Renamed JointID -> Joint
• Renamed JointsCollection -> JointCollection
• Renamed Vector -> SkeletonPoint
• Renamed SkeletonQuality -> FrameEdges
• Developer is now responsible for own allocations of skeleton array variables and copying skeletons to that storage.

This enables the Kinect Runtime to better reuse
resources if an application’s data processing falls behind.

• Availability of skeleton data during SkeletonFrameReady or AllFramesReady
  events. (AllFramesReady gives matching color, depth
  and/or skeleton frames.)
• New SkeletonStream.AppChoosesSkeletons  property + ChooseSkeletons() methods.

Relevant samples (installed with SDK):

• KinectExplorer (C#/WPF) – KinectSkeletalViewer component
• SkeletonViewer (C++/Direct2D+GDI)
• ShapeGame (C#/WPF)

SKELETON API – SUMMARY OF API CHANGES/REMOVALS/ADDITIONS

<TypeOldName=“SkeletonEngine“ Name=“SkeletonStream“>     <MemberName=“Disable“Added=“True“ />     <MemberName=“Enable“Added=“True“ />     <MemberName=“ChooseSkeletons“Added=“True“ />     <MemberOldName=“GetNextFrame“Name=“OpenNextFrame“ />     <MemberName=“DepthImageToSkeleton“MovedTo=“DepthImageFrame“ />     <MemberName=“SkeletonToDepthImage“MovedTo=“DepthImageFrame“ /> </Type> <TypeName=“SkeletonFrameReadyEventArgs“>     <MemberOldName=“SkeletonFrame“ Name=“OpenSkeletonFrame“ /> </Type> <TypeName=“SkeletonFrame“>     <MemberOldName=“TimeStamp“Name=“Timestamp“ />     <MemberOldName=“Skeletons“Name=“CopySkeletonDataTo“ />     <MemberName=“Dispose“Added=“True“ />     <MemberName=“Quality“Removed=“True“ /> </Type> <TypeOldName=“SkeletonData“Name=“Skeleton“ >     <MemberOldName=“TrackingID“Name=“TrackingId“ /> <MemberName=“Count“Removed=“True“ /> </Type> <TypeName=“JointType“Added=“True“/> <TypeOldName=“JointID“Name=“Joint“>     <MemberOldName=“ID“Name=“JointType“ />     <MemberOldName=“Vector“Name=“Position“ />     <MemberName=“Parent“Removed=“True“ /> </Type> <TypeOldName=“JointsCollection“Name=“JointCollection“ /> <TypeOldName=“Vector“Name=“SkeletonPoint“>     <MemberName=“W“Removed=“True“ /> </Type> <TypeOldName=“SkeletonQuality“Name=“FrameEdges“>     <MemberOldName=“ClippedLeft“Name=“Left“ />     <MemberOldName=“ClippedTop“Name=“Top“ />     <MemberOldName=“ClippedRight“Name=“Right“ />     <MemberOldName=“ClippedBottom“ Name=“Bottom“ />     <MemberName=“None“Added=“True“ /> </Type> <TypeName=“SkeletonFrameQuality“Removed=“True“ />

OLD CODE

runtime.SkeletonFrameReady += new EventHandler<SkeletonFrameReadyEventArgs>(nui_SkeletonFrameReady);   private void nui_SkeletonFrameReady(object sender, SkeletonFrameReadyEventArgs e) {     SkeletonFrame skeletonFrame = e.SkeletonFrame;   }

NEW CODE

kinectSensor.SkeletonFrameReady += new EventHandler<SkeletonFrameReadyEventArgs>(nui_SkeletonFrameReady);   Skeleton[] skeletons;   private void nui_SkeletonFrameReady(object sender, SkeletonFrameReadyEventArgs e) {     bool receivedData = false;     using (SkeletonFrame skeletonFrame = e.OpenSkeletonFrame())     {         if (skeletonFrame != null)         {             if (skeletons == null) //allocate the first time             {                 skeletons = new Skeleton[skeletonFrame.SkeletonArrayLength];             }             receivedData = true;         }         else         {             // apps processing of skeleton data took too long; it got more than 2 frames behind.             // the data is no longer avabilable.         }     }     if (receivedData)     {         // DISPLAY OR PROCESS IMAGE DATA IN skeletons HERE     } }

Mapping API improvements (Skeleton
-> Depth, Depth -> Color)

Significant changes:

• Moved these members to DepthImageFrame and KinectSensor
• Added a new “entire frame” instead of per pixel function. (KinectSensor.MapDepthFrameToColorFrame)
• Added a new Skeleton to Color method, which is similar to calling SkeletonToDepth and then DepthToColor.
• The DepthImageFrame versions of these methods take fewer parameter, since
  it has the appropriate depthImage.
• New return types: SkeletonPoint (replacing Vector) and DepthImagePoint (replacing 2 “out” parameters).

Relevant samples (installed with SDK):

• KinectExplorer (C#/WPF) –KinectSkeletalViewer component
• SkeletonViewer (C++/Direct2D+GDI)

OLD APIs

public class Camera {     public void GetColorPixelCoordinatesFromDepthPixel(ImageResolution colorResolution, ImageViewArea viewArea, int depthX, int depthY, short depthValue, out int colorX, out int colorY); }   publicclass SkeletonEngine {     public Vector DepthImageToSkeleton(float depthX, float depthY, short depthValue);     public void SkeletonToDepthImage(Vector point, out float depthX, out float depthY);     public void SkeletonToDepthImage(Vector point, out float depthX, out float depthY, out short depthValue); }

NEW APIs

publicsealedclass DepthImageFrame : ImageFrame {     public DepthImagePoint MapFromSkeletonPoint(SkeletonPoint skeletonPoint);     public ColorImagePoint MapToColorImagePoint(int depthX, int depthY, ColorImageFormat colorImageFormat);     public SkeletonPoint MapToSkeletonPoint(int depthX, int depthY); } publicsealedclass KinectSensor : IDisposable {     public void MapDepthFrameToColorFrame(DepthImageFormat depthImageFormat, short[] depthPixelData, ColorImageFormat colorImageFormat, ColorImagePoint[] colorCoordinates);     public ColorImagePoint MapDepthToColorImagePoint(DepthImageFormat depthImageFormat, int depthX, int depthY, short depthPixelValue, ColorImageFormat colorImageFormat);     public SkeletonPoint MapDepthToSkeletonPoint(DepthImageFormat depthImageFormat, int depthX, int depthY, short depthPixelValue);     public ColorImagePoint MapSkeletonPointToColor(SkeletonPoint skeletonPoint, ColorImageFormat colorImageFormat);     public DepthImagePoint MapSkeletonPointToDepth(SkeletonPoint skeletonPoint, DepthImageFormat depthImageFormat); }

Audio API improvements

Significant changes:

• KinectAudioSource no longer has a constructor, you must access the AudioSource property from KinectSensor. In multiple KinectSensor scenarios, it will now ensure that you get the audio source that is from that sensor.
• API renames
• API refactoring with simplification in mind.
• Removal of many less useful members.
• Properties that return angles now return angles in degrees instead of radians. This is  consistent with the motor’s ElevationAngle.

Relevant samples (installed with SDK):

• KinectAudioDemo (C#/WPF)
• ShapeGame (C#/WPF)
• Speech (C#/console)
• AudioCaptureRaw (C++/console)
• MFAudioFilter (C++/console)
• MicArrayEchoCancellation (C++/console)
• KinectExplorer (C#/WPF) – KinectAudioViewer component

AUDIO API – SUMMARY OF API CHANGES/REMOVALS/ADDITIONS

<Namespace OldName=“Microsoft.Research.Kinect.Audio“ Name=“Microsoft.Kinect“>     <Type Name=“AudioDeviceInfo“ Removed=“True“ />     <Type Name=“KinectAudioSource“>         <Member Name=“FindCaptureDevices“ Removed=“True“ />         <Member Name=“RetrieveTsStats“ Removed=“True“ />         <Member Name=“QualityMetrics“ Removed=“True“ />         <Member Name=“DevicePairGuid“ Removed=“True“ />         <Member Name=“KinectAudioSource“ Removed=“True“ />         <Member OldName=“AutomaticGainControl“ Name=“AutomaticGainControlEnabled“ />         <Member OldName=“SoundSourcePosition“ Name=“SoundSourceAngle“ Message=“Now using degrees, instead of Radians.“/>         <Member OldName=“SoundSourcePositionConfidence“ Name=“SoundSourceAngleConfidence“ />         <Member OldName=“MicArrayMode“ Name=“BeamAngleMode“ />         <Member OldName=“MicArrayBeamAngle“ Name=“ManualBeamAngle“ />         <Member OldName=“BeamChanged“ Name=“BeamAngleChanged“ />         <Member OldName=“SpeakerIndex“ Name=“EchoCancellationSpeakerIndex“ Message=“Automatically set to default Speaker on PC now.“ />         <Member Name=“AcousticEchoSuppression“ Removed=“True“ Message=“Replaced by setting kinectAudioSource.EchoCancellationMode = EchoCancellationMode.CancellationAndSuppression“ />         <Member Name=“CenterClip“ Removed=“True“/>         <Member Name=“EchoLength“ Removed=“True“/>         <Member Name=“FeatureMode“ Removed=“True“ Message=“Just remove the line of code that set FeatureMode. It was useless.“/>         <Member Name=“FrameSize“ Removed=“True“/>         <Member Name=“GainBounder“ Removed=“True“/>         <Member Name=“MicArrayPreprocess“ Removed=“True“/>         <Member Name=“MicrophoneIndex“ Removed=“True“/>         <Member Name=“NoiseFill“ Removed=“True“/>         <Member Name=“SourceMode“ Removed=“True“/>         <Member Name=“VoiceActivityDetector“ Removed=“True“/>         <Member OldName=“SystemMode“ Name=“EchoCancellationMode“ Message=“For ArrayOnly, use EchoCancellationMode.None. For ArrayAndEchoCancellation, use EchoCancellationMode.CancellationOnly.“ />         <Member Name=“Dispose“ Removed=“True“ />     </Type>     <Type Name=“MicArrayMode“ Removed=“True“ />     <Type Name=“SystemMode“ Removed=“True“ Message=“Use EchoCancellationMode property instead.“ />     <Type OldName=“BeamChangedEventArgs“ Name=“BeamAngleChangedEventArgs“/>     <Type Name=“SoundSourceAngleChangedEventArgs“ Added=“True“ />     <Type Name=“EchoCancellationMode“ Added=“True“ />     <Type Name=“BeamAngleMode“ Added=“True“ /> </Namespace>

 

OLD CODE

KinectAudioSource audioSource = newKinectAudioSource(); audioSource.SystemMode = SystemMode.OptibeamArrayOnly; audioSource.FeatureMode = true; audioSource.AutomaticGainControl = false; audioSource.MicArrayMode = MicArrayMode.MicArrayAdaptiveBeam; var kinectStream = audioSource.Start();

NEW CODE

KinectAudioSource audioSource = kinectSensor.AudioSource; audioSource.EchoCancellationMode = EchoCancellationMode.CancellationOnly; audioSource.AutomaticGainControlEnabled = false; audioSource.BeamAngleMode = BeamAngleMode.Adaptive; var audioStream = audioSource.Start();

Speech API improvements

Significant changes:

• Beta 2 of Kinect for Windows used Speech SDK v10.2. We now use Speech SDK v11
• Our new runtime setup installs Speech runtimes (x86 and/or x64) and the Kinect language pack (en-us).

Relevant samples (installed with SDK):

• KinectAudioDemo (C#/WPF)
• ShapeGame (C#/WPF)
• Speech (C#/console)