V12 Documentation - Audio API Changes

[aaclayton]

Hello community! We are making significant progress on Version 12 development and are getting to the point where we are starting to have a clear picture of what changes Version 12 includes. This discussion deals specifically with changes to our Audio API as described in:

• Audio API Improvements - Consolidation of AudioContainer into Sound and more! #10092

These changes will be introduced in Version 12 Prototype 1. Please read the issue carefully and join the discussion if you have any questions, suggestions, or concerns.

Let's Discuss!

We are sharing this information in advance of V12 Prototype 1, which is expected in early December, so that you can provide early feedback and plan ahead for changes you will want to investigate or test in your own systems and modules. We still have plenty of time to make further changes or to adjust our approach if anything described in this issue raises concern for you, so we are beginning this discussion early and will keep this thread open for discussion and feedback until the end of the V12 API Development phase.

You may also discuss this change in Discord in the V12 Audio API Changes thread: https://discord.com/channels/170995199584108546/1166858723092865044

Frequently Asked Questions

Is this a breaking change?

There are some breaking changes documented in the issue. Most of these breaking changes remain backwards-compatible until version 14 at which point that compatibility layer will be removed. There are a few breaking changes which are immediately altered without replacement, as documented in the above issue.

Does this affect me?

• If your package doesn't do anything with audio playback: NO
• If your package iteracts with audio playback through the higher-level concepts of Playlist, PlaylistSound, and AmbientSound document types: NO
• If your package interacts with audio playback using the game.audio.create() method: NO
• If your package interacts with audio playback by creating or modifying low-level Sound or AudioContainer instances: YES