com.unity.services.vivox 16.6.0

com.unity.services.vivox

Source docs
Notes: processedReleased April 3, 2025

Browse versions

PreviousNext

Unity Compatibility

Minimum Unity: 2020.3

📈 Improvements

  • The licenses and third party notices have been updated.
  • Vivox Acoustic Echo Cancellation and Automatic Gain Control have had their underlying algorithms replaced.
  • - Acoustic Echo Cancellation on mobile platforms no longer mutes the microphone signal when echo is detected. Instead, echo is removed and speech continues to transmit.
  • - Automatic Gain Control is on by default. The new Automatic Gain Control increases microphone capture loudness on all platforms. Consider adjusting application volume presets if they were changed from the default volumes; perhaps going so far as to reset user volume settings entirely or to adjust them by some formula.
  • - For platforms that already had Acoustic Echo Cancellation and Automatic Gain Control, the new implementation including the addition of Noise Suppression has:
  • - The same or less CPU cost than the previous implementation when using the Release configuration.
  • - A reduction in memory usage of about 11 MB while a voice session is active.
  • - For platforms that are getting Acoustic Echo Cancellation and Automatic Gain Control for the first time:
  • - CPU cost of the Vivox audio thread increases by about 44% when using the Release configuration.
  • - An extra 6 MB of memory will be used while a voice session is active.
  • - Vivox library sizes have increased for all platforms due to the change in audio processing implementations:
  • - Release configuration libraries add between 53 KB and 8 MB more to an application than the previous Vivox release.
  • - Debug configuration libraries can add upwards of 12 MB more to an application than the previous Vivox release.
  • Network optimization: A new default voice codec bitrate was chosen to reduce packet loss and jitter. The new setting was found to be indistinguishable from the previous setting in structured listening tests.
  • `iOS`:
  • - The `VivoxConfigurationOptions.IosVoiceProcessingMode` value now defaults to 1 rather than 2, meaning that the VoiceProcessingIO (VPIO) unit will only be used when the speakerphone is used for render and capture. This change favors the use of the new Acoustic Echo Cancellation underlying algorithms rather than the use of the VPIO unit to avoid the decrease in quality for most audio device configurations that come from using the VPIO unit.

Features

  • Noise suppression: Now applied to capture audio by default. To change the settings, see the new `IVivoxGlobalAudioSettings` APIs.
  • Vivox Acoustic Echo Cancellation and Automatic Gain Control are now available on all platforms. Acoustic Echo Cancellation and Automatic Gain Control were previously unavailable on Nintendo Switch™, PlayStation®, Xbox, visionOS, and UWP platforms.
  • New `IVivoxGlobalAudioSettings` interface providing centralized control over Vivox audio processing features accessible through `VivoxService.Instance.VivoxGlobalAudioSettings`:
  • - Noise suppression controls:
  • - `NoiseSuppressionEnabled` to toggle background noise reduction
  • - Echo cancellation settings:
  • - `PlatformAcousticEchoCancellationEnabled` for mobile platform-native Acoustic Echo Cancellation
  • - `VivoxAcousticEchoCancellationEnabled` for SDK-level Acoustic Echo Cancellation
  • - Audio processing features:
  • - `AutomaticGainControlEnabled` for input volume normalization
  • - `DynamicVoiceProcessingSwitchingEnabled` for adaptive processing
  • - `VolumeBasedDuplicationSuppressionEnabled` for multi-channel audio management
  • - `PositionalChannelVolumeProtectionEnabled` for 3D audio distortion prevention
  • - Clipping protection controls:
  • - `AudioClippingProtectorEnabled` to toggle clipping prevention
  • - `AudioClippingProtectorParameters` to fine-tune protection behavior

🔧 Bug Fixes

  • 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.
  • Vivox log levels were off-by-one. There may be more Vivox log statements now if the