Documentation

Vivox Core SDK

Vivox Core SDK

Release notes

Review the latest Vivox Core release notes and updates.
Read time 12 minutesLast updated 8 days ago

Version 5.29.0

Release overview

The 5.29.0 release adds native text-to-speech on Android, iOS, Windows, and Xbox, delivers a user's own directed messages back to them, introduces text translation, and adds support for the PS5 14.00 SDK and Xbox GDK 260400. It also contains various bug fixes and improvements.
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

Added
  • Native text-to-speech engine (
    tts_engine_native_default
    ), which uses the operating system's installed voices and languages, on:
    • Android, using the device's text-to-speech engine (
      android.speech.tts
      ). Voices are the device's installed offline voices. Requires
      JniHelpers.init()
      . Android finishes initializing text-to-speech on the main thread, so calls made from the main thread before it's ready see no voices; call from another thread to wait for them.
    • iOS 13 and later, using
      AVSpeechSynthesizer
      . On iOS 11 and 12,
      vx_tts_initialize
      returns
      tts_error_not_supported
      for the native engine.
    • Windows 10 and later (desktop builds), using
      Windows.Media.SpeechSynthesis
      . On Windows 7 and 8.1,
      vx_tts_initialize
      returns
      tts_error_not_supported
      for the native engine. UWP builds are unchanged.
    • Xbox One and Xbox Series X|S (GDK), using the console speech synthesizer (
      XSpeechSynthesizer
      ).
  • vx_tts_get_voice_info
    , which returns a text-to-speech voice's BCP-47 language tag (for example
    en-US
    ), or
    und
    if the engine doesn't report one. The existing Flite voices report
    en-US
    .
  • Directed messages sent by the logged-in account are now echoed back to that account through
    vx_evt_user_to_user_message
    , with
    is_current_user
    set and
    to_uri
    identifying the original recipient. This is controlled by
    vx_sdk_config_t.enable_dm_send_confirmation
    , which is enabled by default; set it to 0 for the previous behavior.
  • Text translation of incoming directed messages, their edits, and chat history results for a logged-in account, with either a fixed source and target language or languages resolved per message. Voice is never translated. Contact your Vivox representative to enable this feature, which is not yet generally available.
  • On-request translation of one or more texts into a target language. Contact your Vivox representative to enable this feature.
  • Support for PS5 14.00 SDK.
  • Support for Xbox GDK 260400.
Changed
  • Android: The minimum supported version is Android 6.0 (API 23), which the native library already required. The AAR manifest still declares
    minSdkVersion
    14 so that existing app builds aren't affected. A future release will raise it to 23.
Fixed
  • Directed messages sent by the logged-in account are now delivered back to that account, so the sender receives the server-assigned
    message_id
    that is required to edit or delete the message later.
  • Blocking with
    vx_req_account_control_communications
    now applies in both directions for channel text messages in text-only channels and when only one of the two users is connected to audio, including blocks set before a user joins the channel.
  • Account-level text mutes (
    mute_scope_text
    or
    mute_scope_all
    ) now hide the muted user's channel text in channels joined after the mute was set.
  • Logout with more than one session group, including empty ones created with
    vx_req_sessiongroup_create
    , no longer reports completion early or fails to complete. Empty session groups now also receive
    vx_evt_sessiongroup_removed
    at logout.
  • When presence is enabled, logout now sends unavailable presence before disconnecting.
  • Automatic Connection Recovery (ACR) now reports the text connection as recovered only when the server confirms it, and ends as soon as the server rejects the resume instead of waiting out the full 30-second recovery timeout.
  • vx_evt_account_edit_message.language
    is now populated. It was previously always NULL.
  • Fixed a crash in
    MessageQueue::Enqueue
    , most often seen on Windows after audio device changes, caused by the default memory pool returning NULL for some allocations of about 2 MB or larger when no custom allocator is supplied.
  • Fixed a crash (
    SIGABRT
    in
    StroConnection::~StroConnection
    , most often seen on Android) when an account was logged out or released while ACR was still attempting to reconnect.
  • Fixed a rare crash after text-to-speech playback, most often with queued local playback.
  • Fixed a crash in the XMPP connection's timer handling, most often seen on Nintendo Switch™, caused by a data race on the connection's internal timer collections.
  • Fixed apps failing to link against the static
    libvivoxsdk.a
    (for example on iOS) with
    -all_load
    , which caused duplicate symbol errors since 5.26.0.
  • Fixed builds with Clang on Windows (
    clang-cl
    , or Clang targeting MSVC) failing with
    -Werror
    on
    unknown pragma ignored [-Wunknown-pragmas]
    in
    Vxc.h
    . MSVC builds are unchanged.
  • Android:
    JniHelpers.init()
    now returns
    false
    instead of crashing the app when the native library can't be loaded. On devices older than Android 6.0 (API 23), it logs that the SDK requires API 23 or later and returns
    false
    .
  • Android: Disabling platform AEC (
    vx_set_platform_aec_enabled(0)
    ) on Android 12 (API 31) and later no longer leaves the device on the speakerphone communication route.
  • Android: Opening or switching the audio input device no longer initializes the microphone twice, so switching devices during a session is faster, by about 200 to 500 ms on tested devices.
  • Nintendo Switch™ 2: Fixed duplicate-symbol link errors in titles that also link another WebRTC-based library, such as Nintendo NPLN's
    libnn_npln_p2p_middleware.a
    .
  • PlayStation® 5 and PlayStation® 4: Fixed a TLS connection leak that could exhaust the SSL pool and cause XMPP login failures (error 5046) over time.
  • Xbox (GDK): Fixed audio device hotswap not switching to the new device on the first try while in a channel.

Public API Changes

  • New function:
    vx_tts_get_voice_info
    , returning a
    vx_tts_voice_info_t
    .
    vx_tts_voice_t
    and
    vx_tts_get_voices
    are unchanged.
  • tts_engine_native_default
    is now supported on Android, iOS 13 and later, Windows 10 and later (desktop builds), and Xbox (GDK).
  • New configuration field:
    vx_sdk_config_t.enable_dm_send_confirmation
    (enabled by default).
  • Event changes:
    vx_evt_user_to_user_message
    now contains
    is_current_user
    and
    to_uri
    .
  • Event changes:
    vx_evt_user_to_user_message
    ,
    vx_evt_account_edit_message
    , and
    vx_evt_account_archive_message
    now contain
    is_translated
    . When set, the message text is the translation and
    language
    is the language it was translated into.
  • New request:
    vx_req_account_translation_control
    , with
    source_language
    and
    target_language
    , or
    auto_languages
    (mutually exclusive with them), which takes the target from the first language supplied at login and the source from each incoming message.
  • New request:
    vx_req_account_translate_text
    , given a target language and optionally a source language. The response carries one
    vx_translated_text_t
    per text, in request order.

Known Issues

None.

Version 5.28.0

Release overview

The 5.28.0 release includes new features, introduces support for Linux arm64 and Nintendo SDK 22.2.0, and it contains various bug fixes and improvements.
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

Added
  • Ability to synchronize custom metadata between participants in sessions, a.k.a. "session presence custom metadata".
  • New noise reduction algorithm, RNNoise, for removing keystrokes, mouse clicks and other environmental transient noises.
  • Jitter compensation API.
  • Enumeration of audio devices on Linux.
  • Namespace and Body fields added to session and user-to-user message events.
  • New audio callbacks that separate local audio processing from voice session audio processing.
  • Support for Linux arm64.
  • Support for Nintendo SDK 22.2.0.
Changed
  • Local loopback audio has noise reduction applied in the same way that voice session audio does.
Fixed
  • Various minor bug fixes.

Public API Changes

  • New request:
    vx_req_session_set_presence_custom_metadata
    .
  • New event:
    vx_evt_participant_presence_custom_metadata_updated
    .
  • Event changes:
    vx_evt_session_archive_message
    and
    vx_evt_account_archive_message
    now contain
    application_stanza_namespace
    and
    application_stanza_body
    .
  • Callback change:
    pf_on_audio_unit_before_capture_audio_sent
    callback signature has changed.
    is_speaking
    is now an
    int *
    in/out parameter (was
    int
    ), and a new
    int *fade_speech_transition_ms
    parameter has been added.
  • New noise reduction API:
    vx_noise_reduction_rnnoise_set_enabled
    ,
    vx_noise_reduction_rnnoise_get_enabled
    ,
    vx_noise_reduction_rnnoise_set_strength
    ,
    vx_noise_reduction_rnnoise_get_strength
    ,
    vx_noise_reduction_webrtcns_set_enabled
    ,
    vx_noise_reduction_webrtcns_get_enabled
    ,
    vx_noise_reduction_webrtcns_set_level
    ,
    vx_noise_reduction_webrtcns_get_level
    .
  • Deprecated:
    vx_get_noise_suppression_enabled
    ,
    vx_set_noise_suppression_enabled
    ,
    vx_get_noise_suppression_level
    , and
    vx_set_noise_suppression_level
    . Use the new
    vx_noise_reduction_webrtcns_*
    functions instead.
  • New jitter compensation API:
    vx_set_jitter_compensation_periods
    and
    vx_get_jitter_compensation_periods
    .
  • New audio callbacks:
    pf_on_local_audio_unit_before_signal_processing
    ,
    pf_on_local_audio_unit_after_signal_processing
    , and
    pf_on_local_audio_unit_before_render
    .

Known Issues

None.

Version 5.27.3

Release overview

The 5.27.3 release introduces support for the PlayStation® 5 13.00 SDK and Linux x64, and it contains various bug fixes and improvements.
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

Added
  • Support for PS5 13.00 SDK.
  • Support for Linux x64.
Changed
  • Improved login latency.
  • Android: Disabled the default pooled allocator to avoid a rare memory alignment issue on ARM64.
  • Android: Bluetooth microphone devices now have software Acoustic Echo Cancellation enabled.
Fixed
  • Android: Fixed a race condition so that switching between devices doesn't stop Bluetooth microphones from streaming.
  • PlayStation: Increased TLS SSL pool size to prevent crashes at login under certain network conditions.

Public API Changes

  • Android:
    vx_set_force_pooled_allocator(int enable)
    added to allow for re-enabling the pooled allocator.

Known Issues

None.

Version 5.27.1

Release overview

The 5.27.1 release contains various bug fixes and improvements.
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

Added
  • Vivox clients now reconnect automatically when Vivox servers make live upgrades.
Changed
  • Windows: Only audio input devices now have the
    AudioCategory_GameChat
    AudioCategory specified by default due to Windows forcing some Bluetooth devices into a low quality mode when
    AudioCategory_GameChat
    was specified for an audio output device. Use
    vx_sdk_config_t.capture_audio_stream_category
    to change the capture audio stream category at initialization.
Fixed
  • Android: Building the SDKSampleApp from source is now achievable in modern Android Studio versions without major build file changes.

Version 5.27.0

Release overview

Version 5.27.0 introduces support for the Nintendo Switch™ 2 and fixes bugs related to Android and Automatic Connection Recovery (ACR).
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

  • Android armeabi/armeabi-v7a: Fixed a crash that would occur on certain SoCs at the time of Vivox login when custom allocators were not specified.
  • Fixed layered service provider debug log spam from Automatic Connection Recovery (ACR).
  • All time-dependent operations within the Vivox SDK are now immune to system clock changes.
Windows
  • Audio devices opened by the Vivox SDK now have their AudioCategory marked as
    AudioCategory_GameChat
    for client applications that have declared compatibility with Windows 10 and 11 in their manifest.
Platform-specific changes
  • Added support for Nintendo Switch™ 2.

Public API Changes

New error codes
  • Added
    VxErrorJobDependencyFailed (5111)
  • Added
    VxErrorFailed (1004)

Known Issues

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

Version 5.26.3

Release overview

Version 5.26.3 officially provides support for Nintendo Switch™ 2.

Key features and bugs addressed

  • Added support for Nintendo Switch™ 2.

API changes

None.

Known issues

None.

Version 5.26.0

Release overview

Version 5.26.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.
  • Vivox log levels were off-by-one. There may be more Vivox log statements now if initial_log_level was set 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
  • Android/iOS: Improved platform AEC control independent of DVPS

Implementation Considerations

  • Consider adjusting application volume presets due to new AGC behavior.

Public API Changes

New APIs

  • vx_get_noise_suppression_enabled
  • vx_get_noise_suppression_level
  • vx_set_noise_suppression_enabled
  • vx_set_noise_suppression_level
  • on_audio_unit_requesting_final_mix_for_echo_canceller_analysis

Modified APIs

  • vx_set_platform_aec_enabled
    - Now functions independently of Dynamic Voice Processing Switching (DVPS) status.

New Error Code

  • Added
    VxXmppErrorChannelAtCapacity (20507)

Known Issues

  • Android sample applications do not yet support 16KB page size despite native library support.