Release v2.1.1

• Event name and Client SDK version now included in diagnostics reporting
• Fix to UUID generation for automated tests
• Fix for localhost CORS error exception when sending diagnostics

Release v2.1.0

• Accepted values for userAttenuation, userRolloff and volumeThreshold are being updated (temporarily) to be more permissive
  • Now, NaN can be specified so that the respective default value for the zone/space is used
  • Documentation updated to indicate that in a future release that 0 (or userAttenuation and userRolloff) and null (for volumeThreshold) will no longer be used
• Bug fix to Quaternion.getAxis()
• Documentation improvements for setting personal gain adjustments for other users (HiFiCommunicator.setOtherUserGainsForThisConnection) and monitoring when the client has been muted or unmuted (OnMuteChangedCallback)

Release v2.0.0

Today, we are releasing v2.0.0 of the hifi-spatial-audio TypeScript client library.

• Developers who choose to upgrade (via npm i hifi-spatial-audio@main or otherwise) will no longer be able to use the client library to natively send or receive Euler angles for specifying a client’s orientation. Instead, developers must use Quaternions to send and receive client orientation data.
• Please reference our latest TypeScript documentation by clicking here.
• All of our sample applications will be updated to work with this new orientation format.
  • If you would like to view the changes that we made to our sample apps which were necessary to support the new client library, you can view those changes here.
• Documentation update to clarify how isStereo works

Release v1.5.0

• Kick and session timeout will now fully disconnect the client even if the client has reconnect enabled
• Setting the volumeThreshold on a client to null will now make the client default to the space's volumeThreshold
• Fixed bug where client incorrectly starts at 0,0,0 even when initial position data is passed in

Release v1.4.1

Patch release

• Fix to diagnostics that report when the user closes their tab or browser
• Updates to automated tests

Release v1.4.0

• This week’s release introduces some new connection states and may affect your application's connection handling behavior. In particular, if your application handles automatic reconnections for dropped sessions, or retries of failed connection attempts, you may need to review your code in light of this new release.

  • If your production code points to the latest version of the SDK, it will be updated automatically upon release. If you would like to remain on v1.3.0 of the SDK until you have a chance to test your production code with the latest version, change your application code to explicitly use v1.3.0 (available at https://hifi-spatial-audio-api.s3.amazonaws.com/releases/v1.3.0/HighFidelityAudio-latest.js or npm i [email protected]) until you are ready to move on to v1.4.0.
  • Highlights:
    • If a connection enters the "Failed" connection state, it will ALWAYS automatically disconnect itself and transition to "Disconnected." If you are handling your own reconnections, ensure the connection is fully "Disconnected" before attempting to reconnect.
    • The number of possible connection states has increased to include transition states such as "Connecting" and "Disconnecting." Please refer to the attached guide to see the list of all available states and when they are used.
    • It is now possible to configure the HiFiCommunicator to automatically reconnect dropped sessions or retry failed connection attempts. (This behavior defaults to "off." Please refer to the guide for instructions on enabling it.)

• Updates to automated integration tests

Release v1.3.0

• Updates to automated tests and internal health check testing
• import instead of require for pako package
• Added collection of diagnostics data for internal debugging of WebRTC-related connection issues

Release v1.2.1

• Ensure that the connection state is correctly set to 'Disconnected' when HiFiCommunicator connections are closed

Release v1.2.0

• Added ability for an application to specify custom TURN/STUN server
  -- By default, High Fidelity's TURN server will be used, which should suffice for most operations
  -- Specifying a custom TURN server is useful for testing or for specifying a commercial TURN server provider when dealing with particularly challenging client networks/firewalls
• Update to v7.4.6 of websocket library to address a published security vulnerability
• Fix so that client gets correct websocket port from URL (when provided)
• Updated to libravi v4.4.2
  -- Fixes to event handling
  -- Improved websocket connection handling
  -- More descriptive websocket connection error messages now propagated to client library
• Updates to the documentation of mute
• Updates to automated tests (added tests for attenuation and software muting, improved connection error messages)

Release v1.1.1

• Fix spatial audio JS client not responding to admin mute command
• Version clean up