Windows Client SDK Release Notes

The Vonage Video API Windows SDK allows you use Vonage Video API-powered video sessions in Windows apps.

New features and changes

Version 2.28.2 -- September 2024

This version fixes an issue where, in some cases, the audio level stayed the same when the publisher was muted.
This version fixes an issue where custom audio devices could potentially cause a crash.
This version fixes an issue where, in some cases, audio from web client SDK users was garbled.

Version 2.28.1 -- August 2024

This version fixes an issue where video was briefly stuttering after connecting to another user.
This version fixes an issue where the video resolution was not updating when devices were rotated.

Version 2.28.0 -- June 2024

This version adds support for Single Peer Connection. When enabled, it reduces OS resource consumption, improves rate control, and in the case of mobile native devices, supports large sessions. See the documentation for Session.SinglePeerConnection.
This version adds support for VideoFrame.IsMirrored, which returns true when the video frame is mirrored. This was previously a beta feature.
This version adds support for advanced noise suppression. This uses the Vonage Media Library to provide enhanced noise cancellation. See the documentation for the Publisher.AudioTransformers property. This was previously a beta feature.
This version adds support for advanced audio controls. See the documentation for Publisher.AudioBitrate, Publisher.AutoGainControl, Publisher.NoiseSuppression, Publisher.EchoCancellation, and Publisher.DisableAudioProcessing. This was previously a beta feature.
This version fixes an issue where, in some cases, the publisher was destroyed when video was muted.

Version 2.27.2 -- June 2024

This version adds support for VideoFrame.IsMirrored, which returns true when the video frame is mirrored. This is a beta feature.
This version adds support for advanced noise suppression. This uses the Vonage Media Library to provide enhanced noise cancellation. See the documentation for the Publisher.AudioTransformers property. This is a beta feature.
This version adds support for advanced audio controls. See the documentation for Publisher.AudioBitrate, Publisher.AutoGainControl, Publisher.NoiseSuppression, Publisher.EchoCancellation, and Publisher.DisableAudioProcessing. This is a beta feature.
This version reduces the size of the SDK by removing the Vonage Media Library code. In order to use methods that use the Vonage Media Library, you must load the Vonage Media Library separately from the Vonage Video Windows SDK. These include the VideoTransformer(string name, string properties) and AudioTransformer(string name, string properties) constructors. For more information, see Vonage Media Library integration.
This version fixes a issue where, in some cases, the local publisher was not mirrored.
This version fixes a crash.

Version 2.27.1 -- January 2024

This version fixes a bug where CanSubscribe returned incorrect information in Session.Capabilities.

This version fixes an issue where an exception error was occurring when IVideoCapturer.SetVideoContentHint() was called before IVideoCapturer.Init() was invoked.

This version fixes an issue where the state of captions was not properly updated for subscribers under certain circumstances.
This version fixes a crash.

Version 2.27.0 -- December 2023

This version adds support for the Vonage Media Processor library and custom media transformers. See the documentation for the Publisher.AudioTransformers and Publisher.VideoTransformers properties. This was previously a beta feature.
This version adds support for publisher audio fallback. This was previously a beta feature. See the Publisher audio fallback documentation.
This version adds support for the VP9 codec in relayed sessions. For more information, see the Video Codecs documentation.
This version adds support for end-to-end encryption. You can enable end-to end-encryption using the Session.SetEncryptionSecret() method. For more information, see the End-to-End Encryption documentation.
This version adds support for adaptive media routing. For more information, see the Adaptive Media Routing documentation.
This version adds some memory management improvements.
This version fixes an issue where certain events were being dropped.

Version 2.26.2 -- November 2023

This version adds support for publisher audio fallback. This is a beta feature. See the Publisher audio fallback documentation.
This version improves software-only performance for Vonage Media Processor filters.

Version 2.26.1 -- October 2023

This version fixes a rare issue where a crash occurred when closing an application.
This version fixes an issue where, in some cases, users were unable to connect to sessions with both custom TURN servers and IP Proxies enabled.
This version fixes an issue where, in some cases, using custom audio devices was causing publishing failures.
This version fixes some memory leaks.
This version fixes an issue where it sometimes took longer than expected to disconnect from a session.
This version fixes an issue where, in some cases, setting the microphone to mute was causing a crash.

Version 2.26.0 -- August 2023

Important: Windows SDK 2.26.0 was published as version 2.26.0-release. We are looking into the issue.

This version adds support for Live Captions. See the docs for Publisher.PublishCaptions and Subscriber.SubscribeToCaptions. This was previously a beta feature.
This version adds support for more Vonage Media Processor filters. The background blur filter now accepts a custom radius option. And there is a new background replacement filter. See the documentation for the Publisher.VideoTransformers property. These are beta features.

Version 2.25.2 -- June 2023

This version adds support for the Vonage Media Processor library and custom media transformers. See the documentation for the Publisher.AudioTransformers and Publisher.VideoTransformers properties. NVIDIA GPUs are recommended for optimal performance. This is a beta feature.
This version fixes an issue where captions were enabled by default.

Version 2.25.1 -- May 2023

This version fixes some memory leaks.
This version fixes an issue where occasionally the app would crash if it was publishing for a very long time.
This version adds support for Live Captions). See the docs for Publisher.PublishCaptions and Subscriber.SubscribeToCaptions. This is a beta feature.

Version 2.25.0 -- April 2023

This version of the SDK uses an updated version of WebRTC 99, which includes improvements in performance and stability.
Added a OpenTok.IAudioDeviceExtension interface. You can use this to set up a custom audio device with methods for enumerating devices, selecting a specific device, or subscribing to notifications, which can be wired internally to the custom audio device implementation instead of the default static one. Additionally, the new The MMAudioDevice class, included in the SDK, implements this interface using the
Windows mmdeviceapi.h interface.
This version fixes an intermittent crash that may occur when publishing and unpublishing rapidly.

Version 2.24.2 -- February 2023

This version fixes an issue where starting a session with muted video would disable scalable video.
This version fixes an issue where audio would remain muted for users under certain circumstances.
This version fixes an issue where proxies were not working.
This version fixes an issue where audio device changes could cause the application to crash.

Version 2.24.1 -- December 2022

This version fixes an issue where, in some cases, using a proxy server would cause the application to crash.
This version fixes an issue where publishing failures were occurring using certain USB cameras.

Version 2.24.0 -- October 2022

This version of the SDK uses WebRTC 99, which includes improvements in performance and stability.
This version adds support for accessing audio data for individual subscribed streams. This was previously a beta feature. See the docs for the Subscriber.AudioData event.
This version adds support for an audio output device selection. This was previously a beta feature. See the docs for the AudioDevice.SetOutputAudioDevice() method.
This version adds support for integration with Windows OS audio settings. See the documentation for the OpenTok.AudioDevice.Notifications class. This was previously a beta feature.
This version fixes an issue in which applications could not connect to a session when IP Proxy was enabled.
This version fixes an issue when the publisher image was frozen when turning video off.
This version fixes an issue when AES-256 was enabled and applications could not connect to clients using on Safari 15.3 and below.

Version 2.23.2 -- August 2022

This version adds support for integration with Windows OS audio settings. See the documentation for the OpenTok.AudioDevice.Notifications class. This is a beta feature.
This version fixes an issue that caused excessive bandwidth usage by streams in relayed sessions.
This version fixes an issue where an app may crash when connected to a headset.

Version 2.23.1 -- July 2022

This version adds support for accessing audio data for individual subscribed streams. This is a beta feature.
See the docs for the Subscriber.AudioData event.
This version adds support for an audio output device selection. This is a beta feature. See the docs for the AudioDevice.SetOutputAudioDevice() method.

Version 2.23.0 -- June 2022

This version adds support for the Custom Dispatcher API. See the reference documentation for the Context class.
In this version, scalable video in H.264 routed sessions is no longer hardcoded.
Adding support for Full High Definition (1920x1080-pixel) resolution. You can specify High1080p as the resolution value you pass into the OpenTok.VideoCapturer.VideoDevice.CreateVideoCapturer() method. This was previously a beta feature.
This version adds support for Universal Windows Platform in desktop applications. This was previously a beta feature.
This version adds the ability to enable per-subscriber audio levels. This was previously a beta feature. See the docs for the Subscriber.AudioVolume property.
This version implements scalable video support for screen sharing. This was previously a beta feature. See the Publisher.Builder.ScalableScreenshare property.
This version fixes an issue where publishers of 1080p or 720p streams to routed sessions published two scalable video layers instead of three.
This version fixes an issue where the camera LED was not turned off when the video was muted.
This version fixes an issue where UTF8 strings in signals were garbled.
This version fixes an issue where VideoCapturer.EnumerateDevices() does not list all the physical USB cameras.

Known issues

Disconnecting from a session may take longer than expected. We are working on a fix for this issue.
In some instances, signals can be sent out of order. We are looking into the issue now.
In some cases, the SDK may not detect proxy settings. We are looking into the issue.
Devices without NVIDIA GPUs may experience poor performance when using Vonage Media Processors. We are looking into the issue.