Release notes

Release notes for 5.26

Release overview

Important note: The VivoxCore.uplugin VersionName field inside of the 5.26.0.unr.0 package incorrectly specifies a version of 5.25.4.unr.0. This is purely a cosmetic error and the correct package is being distrbuted.

Version 5.26.0.unr.0 introduces comprehensive audio processing improvements with enhanced noise suppression, expanded platform support for audio processing features, and significant performance optimizations.

This release focuses on improving voice quality while optimizing resource usage across all supported platforms.

For further technical details on all the changes included in this release, refer to the CHANGELOG.md file within the SDK.

Key Features and Bugs Addressed

  • Updated license and third-party notices
  • Fixed a crash with iOS Shipping Builds in Unreal 5.3+ caused when disconnecting from a channel.
  • Fixed a crash caused by the LoginSession object being deleted while HandleEvent is running.
  • Vivox log levels were off-by-one. There may be more Vivox log statements now if VivoxConfig.SetLogLevel was used for your application.

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
  • iOS: Updated default voice processing behavior to improve audio quality by only using the VoiceProcessingIO unit when speakerphone is active, leveraging newer echo cancellation algorithms for other audio configurations.
  • Android/iOS: Improved platform AEC control independent of DVPS

Implementation Considerations:

  • Consider adjusting application volume presets due to new AGC behavior

Public API Changes

Known Issues

  • Xbox: Voice chat may be interrupted when disconnecting and reconnecting controllers or audio devices. These issues were not observed on the Xbox Series X|S.

Release notes for 5.25

Release overview

  • This release updates the officially supported Unreal Engine version for the Vivox SDK to 5.3, along with the addition of the new Moderation for Vivox module, and consent API endpoints that can be used in conjunction with the Vivox Safe Voice service.

Key Features and Bugs Addressed

  • iOS, Android: - Enabled Unreal Engine custom allocators for all Unreal versions except for UE4.26 and UE4.27 on mobile platforms. Mobile platforms with those versions of UE are still excluded to avoid a crash.
  • Added a copy step to iOS and macOS builds to copy the PrivacyInfo.xcprivacy file to the Xcode project.
  • Added a new Module allowing for user sanctions for behaviours, powered by the Unity Moderation Service, available on the Unity Dashboard
  • Added two new API end points to LoginSession (BeginSetSafeVoiceConsentStatus and BeginGetSafeVoiceConsentStatus), allowing for Consent to be given for Vivox Safe Voice recordings if the feature is turned on on the Unity Dashboard.
  • Fixed issue related to LoginState not returned to LoggedOut after a failed connector_create. Leads to InvalidState error on subsequent login retries.
  • Fixed Error LNK1104 : cannot open file 'SceSha1.lib' which could occur when building non-PlayStation platforms in environments where PLATFORM_PS4 is defined.
  • Removed ensure() statements which could trigger when calling IAudioDevices accessor methods in some cases.

Public API Changes

  • Added an optional EnvironmentVariable parameter to both AccountId's and ChannelId's to update them for use with the Unity Moderation Service.

Known Issues

None.

Release notes for 5.24

Release overview

This release adds a step to iOS and macOS builds to automatically copy the PrivacyInfo.xcprivacy file to Xcode projects and a fix to LoginState returning InvalidState errors on subsequent login tries.

Key Features and Bugs Addressed

macOS, iOS

  • Added a step to iOS and macOS builds to copy the PrivacyInfo.xcprivacy file to the Xcode project.
  • Fixed issue related to LoginState not returning to LoggedOut after a failed connector_create. Leads to InvalidState error on subsequent login retries.

Public API Changes

None.

Known Issues

None.