Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit a99e72ca authored by Jean-Michel Trivi's avatar Jean-Michel Trivi
Browse files

Spatializer: document state getters when feature is unsupported 

Bug: 202834359
Test: atest SpatializerTest
Change-Id: I65b5cb097b84e7b4c8614cf74150c24dfa2f4f0f
parent 53a1d2e0

media/java/android/media/Spatializer.java

+7 −2
Original line number Diff line number Diff line
@@ -63,7 +63,9 @@ public class Spatializer { 
    /**

     * Returns whether spatialization is enabled or not.

     * A false value can originate for instance from the user electing to

     * disable the feature.<br>

     * disable the feature, or when the feature is not supported on the device (indicated

     * by {@link #getImmersiveAudioLevel()} returning {@link #SPATIALIZER_IMMERSIVE_LEVEL_NONE}).

     * <br>

     * Note that this state reflects a platform-wide state of the "desire" to use spatialization,

     * but availability of the audio processing is still dictated by the compatibility between

     * the effect and the hardware configuration, as indicated by {@link #isAvailable()}.
@@ -85,7 +87,10 @@ public class Spatializer { 
     * incompatible with sound spatialization, such as playback on a monophonic speaker.<br>

     * Note that spatialization can be available, but disabled by the user, in which case this

     * method would still return {@code true}, whereas {@link #isEnabled()}

     * would return {@code false}.

     * would return {@code false}.<br>

     * Also when the feature is not supported on the device (indicated

     * by {@link #getImmersiveAudioLevel()} returning {@link #SPATIALIZER_IMMERSIVE_LEVEL_NONE}),

     * the return value will be false.

     * @return {@code true} if the spatializer effect is available and capable

     *         of processing the audio for the current configuration of the device,

     *         {@code false} otherwise.