Replace AudioStreamPlayer mix target with output channels #106266
+132
−47
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR replaces the limiting
mix_target
options of AudioStreamPlayer with more granularoutput_channels
. For example, it is currently not possible to output to only the rear speakers, or only one side. This change allows audio to be output to any combination of speakers, or even just a single one.In addition, I've added a
downmix
option which will take the desired output channels and use a standard downmixing equation to best preserve positional audio when using an output device with fewer channels. This is enabled by default, but can be disabled to only play audio when the desired channel is available. A good use case for disabling it would be a speaker test.While a majority of the work is done, I need some assistance properly removing
mix_target
in favor ofoutput_channels
to not break existing projects. The conversion should be straightforward, but I'm not familiar with that process at all unfortunately.