Vivox Unity release notes

Version 16.10.0

Key features and bugs addressed

• Updated minimum supported Editor version to 2022.3.

API changes

• Added

  VivoxParticipant.IsInAudio

  and

  VivoxParticipant.IsInText

  properties to check whether a participant is connected to channel audio or text.
• Added

  VivoxParticipant.ParticipantAudioStateChanged

  and

  VivoxParticipant.ParticipantTextStateChanged

  events that fire when a participant's audio or text connection state changes.

• VivoxApiException

  is now a public class, allowing developers to catch and inspect Vivox-specific exceptions including the

  StatusCode

  and

  RequestId

  properties.
• Added

  VivoxObserver

  , a convenience class for subscribing to

  IVivoxService

  events without managing service initialization state.

  VivoxObserver

  can be constructed before

  UnityServices.InitializeAsync()

  completes and will automatically connect to the service once it's ready.
• Added

  VivoxObserverType

  flags enum to scope a

  VivoxObserver

  to only the event categories your system needs (

  Login

  ,

  Channel

  ,

  ChannelMessages

  ,

  DirectMessages

  ,

  AudioDevices

  , or

  All

  ).

Version 16.9.0

Key features and bugs addressed

• Fixed an issue where the Vivox Unity Android SDK was unintentionally adding the

  android.permission.READ_PHONE_STATE

  permission to an XR application's manifest.

API changes

• Added

  IVivoxService.Initialized

  event to listen for when the SDK has been successfully initialized.
• Added

  IVivoxService.InitializationFailed

  event to listen for when the SDK failed to initialize.
• Added

  IVivoxService.InitializationState

  property and VivoxInitializationState enum to check the SDKs initialization state.

Version 16.8.0

Release overview

CHANGELOG.md

Key features and bugs addressed

• Fixed a memory leak caused by unbound event handlers preventing

  VivoxParticipant

  objects from being cleaned up when the local user left channels with remaining participants.

• VivoxMessage.Metadata

  property for accessing channel or directed message metadata.

• MessageOptions.Metadata

  property for attaching metadata to outgoing messages.
• Added automatic SDK initialization and user sign-in when SDK actions are attempted without prior setup.
• Added support for multiple concurrent Vivox SDK instances via

  IUnityServices.GetVivoxService()

  .
• Removed Mint service integration and deprecated related public APIs.
• Updated minimum supported Editor version to 2021.3.
• Updated Services Core SDK dependency version.

Known issues

• Some Bluetooth audio devices on Windows will have reduced audio quality because the operating system forces them into Handsfree Telephony mode. This will be fixed in the next hotfix release.

Version 16.7.0

Release overview

Key features and bugs addressed

• Memory Management: Fixed a memory leak where

  VivoxParticipant

  objects were not being properly cleaned up when users left channels, improving overall SDK performance and stability.
• Message Metadata: Added new metadata support allowing developers to attach and access custom data with both channel and directed messages through

  VivoxMessage.Metadata

  and

  MessageOptions.Metadata

  properties.
• SDK Initialization: Implemented automatic SDK initialization and user sign-in, streamlining the setup process when SDK actions are attempted without prior configuration.
• Multi-Instance Support: Added support for running multiple concurrent Vivox SDK instances through the new

  IUnityServices.GetVivoxService()

  method.
• Platform Updates:
  • Updated minimum supported Unity Editor version to 2021.3
  • Updated Services Core SDK dependency.

API changes

Added

• VivoxMessage.Metadata

  property

• MessageOptions.Metadata

  property

• IUnityServices.GetVivoxService()

  method

Removed/Deprecated

• Mint service integration and related public APIs have been removed

Known issues

Version 16.6.3

Release overview

Key features and bugs addressed

• Added support for Nintendo Switch™ 2.

API changes

Known issues

Version 16.6.2

Release overview

Key features and bugs addressed

• Android: Recompiled the native Android library

  libVivoxNative.so

  to support 16 KB page sizes on devices running Android 15 or later.
• Android: Unity SDK AAR library size has been decreased from 102 MB to 31 MB. This will in turn decrease game APK sizes.

API changes

Known issues

Version 16.6.0

Release overview

CHANGELOG.md

Key features and bugs addressed

• Updated license and third-party notices
• Fixed a bug where adjusting timeScale could prevent events from firing.
• Fixed an issue where creating an Android build with Player Settings > Android settings > Publishing Settings > Minify enabled would result in runtime errors.

Audio Processing Improvements

• Noise suppression now applied to capture audio by default
• Extended Acoustic Echo Cancellation (AEC) and Automatic Gain Control (AGC) support to Nintendo Switch™, PlayStation®, Xbox, visionOS, and UWP
• New AEC implementation prevents microphone dropouts in the presence of echo on mobile platforms
• AGC enabled by default with improved microphone capture loudness
• Optimized voice codec for reduced packet loss and jitter

Performance Optimizations

• Existing AEC/AGC platforms:
  • 11 MB reduction in memory usage during active sessions
  • Improved CPU efficiency in Release configuration
• New AEC/AGC platforms:
  • 44% increase in audio thread CPU usage
  • 6 MB additional memory usage during sessions
• Memory allocator improvements reducing heap memory requests

Platform-Specific Changes

• Android: Added 16KB page size support for native libraries
• Android: Proguard rules now included in AAR libraries
• iOS: Removed support for ARMV7 architecture
• iOS: Removed bitcode
• Android/iOS: Improved platform AEC control independent of DVPS

Implementation Considerations

• Consider adjusting application volume presets due to new AGC behavior

API changes

New interface

• IVivoxGlobalAudioSettings

  provides centralized control of the new audio processing APIs, accessible through

  VivoxService.Instance.VivoxGlobalAudioSettings

  .

Noise suppression controls

• bool NoiseSuppressionEnabled { get; set; }

Echo cancellation settings

• bool PlatformAcousticEchoCancellationEnabled { get; set; }

• bool VivoxAcousticEchoCancellationEnabled { get; set; }

Audio processing features

• bool AutomaticGainControlEnabled { get; set; }

• bool DynamicVoiceProcessingSwitchingEnabled { get; set; }

• bool VolumeBasedDuplicationSuppressionEnabled { get; set; }

• bool PositionalChannelVolumeProtectionEnabled { get; set; }

Clipping protection

• bool AudioClippingProtectorEnabled { get; set; }

• AudioClippingProtectorParameters ClippingProtectorParameters { get; set; }

Known issues

Version 16.5.4

Release overview

Key features and bugs addressed

• GameCore: Improved handling of hotswapping capture and render devices.
• GameCore: Fixed issues preventing Remote Control functioning with Vivox through Xbox Manager. Refer to the Vivox Xbox documentation for full details.
• GameCore: Fixed a bug where USB audio devices weren't being detected when plugged in.
• Fixed a bug where trying to join multiple channels quickly would lead to an exception.

API changes

Known issues

Version 16.5.0

Release overview

Key features and bugs addressed

• WebGL now has limited support for voice and text chat in a single channel.
• Moved the

  IVivoxTokenProvider

  validation step from Vivox SDK initialization to the Login operation.
• Made the error reported by the

  VivoxParticipantTap

  a bit clearer when the 'Channel Name' or the 'Participant Name' parameter are unknown or not set.
• Resolved an issue where attempting to rejoin a channel was not possible after a JoinChannelAsync operation experienced a TimeoutException.
• Resolved an issue where

  CancellationTokenSource

  instances used internally were not being disposed of when no longer needed, occasionally resulting in unexpected behavior.
• Fixed a bug where allocated memory that was supposed to be aligned was not actually aligned.
• Fixed a bug where the "Channel Name" field for Audio Taps would reset to empty when an unexpected value was entered.
• Improved the overall experience of interacting with the Audio Tap inspector by registering the tap only after all fields are fully edited, instead of on every character entry.
• Fixed a bug that would prevent the

  VivoxParticipant.ParticipantMuteStateChanged

  event from firing.

API changes

• Vivox Safe Voice consent endpoints have been added to the VivoxService, allowing for collection of consent from users for Vivox Safe Voice recordings.

Known issues

• Some issues are still lingering with automated credential pulling on Unity version 2020 and 2021.

Version 16.4.0

Release overview

Key features and bugs addressed

• A new sample,

  Text Chat Sample

  , has been added to the package. This text-focused sample showcases a robust chat experience that demonstrates sending, editing, and deleting DM or channel messages, as well as retrieving past conversations and their message history.
• Fixed a bug that would cause the SDK to throw an exception when trying to perform cleanup operations, such as leaving channels, during OnApplicationQuit in the Unity editor.

API changes

• VivoxConfigurationOptions.IosVoiceProcessingIOMode

  for configuring how the VoiceProcessing IO unit is used in different scenarios. The

  IVivoxService.IosVoiceProcessingIOMode

  can be used to get the current value and

  IVivoxService.SetIosVoiceProcessingIOMode

  to set the value at runtime. This configuration is only relevant on iOS.

Known issues