How to fix Vivox failing to initialize at runtime in Xbox or PlayStation app

Symptoms:

• I am receiving the VivoxCore Error: hResult=-1994129150 in my log when launching my Xbox GDK app.
• I am building for the Xbox or PlayStation platform and the Vivox library is failing to initialize at runtime.

Cause:

• hResult codes -1994129150 and 0x89240102 correspond to GDK error E_GAMERUNTIME_VERSION_MISMATCH. You need to use a different Vivox library DLL, one built with the matching GDK version your project is built with.
• DLL mismatches can also occur on the PlayStation 4 and PlayStation 5 platforms. If a Vivox error occurs before or during initialization on one of these platforms, you might need to download a different Vivox library.

Resolution:

• Vivox Unity:
  • Alternate console platform SDKs for Vivox Unity are not readily available for download. Contact Support or reach out to your Vivox account manager with your platform and version requirements.
• Vivox Core (Custom Engines):
  • From the Unity Cloud Dashboard where you originally downloaded the Vivox Core SDK, find the desired platform and click See all versions to select and download an alternate SDK package. For console platforms like Xbox and PlayStation, each Vivox release version will typically have more than one package available to download, each built with a different console SDK.
    • Using Xbox as an example, 5.25.4.240600 is Vivox version 5.24.4 built for the June 2024 GDK (Update 0), and 5.25.4.231004 is Vivox version 5.24.4 built for the October 2023 GDK (Update 4).
• Vivox Unreal:
  • Start by following the steps for Vivox Core above to download the Vivox Core kit matching the Vivox Unreal plugin version you're using, and the console SDK version you need.
  • Using the Core SDK zip for 5.25.4 as an example, you'll find all the files you need in the folder vivox-sdk-5.25.4.33805.68548b92\SDK, which contains sub-folders include, Libraries\Debug and Libraries\Release. In the Unreal plugin source, these each replace the include, Debug, and Release folders found in VivoxCore\Source\ThirdParty\VivoxCoreLibrary\<YOUR-PLATFORM>.
  • Simply replace the contents of these three folders with the ones from the Core zip to swap in the libraries and headers which match your console SDK.