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

Commit 7fa62530 authored by Raj Goparaju's avatar Raj Goparaju
Browse files

Address review comments for fade manager configuration API 

- For easier reference by clients, make default fade out and
  fade in durations queriable through static methods.
- Remove IntDef references from JavaDoc. Add these definitions
  directly on the parameter itself.
- Remove redundant Null pointer exception details from the
  JavaDocs, as this is documented by the @NonNull annotation.
- Added explanation to clarify the term 'offending' players.
- Remove FADE_STATE_ENABLED_AUTO since no custom behavior
  available at this time.

Bug: 318430127
Bug: 319321475
API-Coverage-Bug: 308666800
Test: atest FadeManagerConfigurationUnitTest

Change-Id: I97011ca3f493f28600f9779e771646182acdc6e7
parent 861d81b9

core/api/system-current.txt

+2 −1
Original line number Diff line number Diff line
@@ -6954,6 +6954,8 @@ package android.media { 
  @FlaggedApi("android.media.audiopolicy.enable_fade_manager_configuration") public final class FadeManagerConfiguration implements android.os.Parcelable {

    method public int describeContents();

    method @NonNull public java.util.List<android.media.AudioAttributes> getAudioAttributesWithVolumeShaperConfigs();

    method public static long getDefaultFadeInDurationMillis();

    method public static long getDefaultFadeOutDurationMillis();

    method public long getFadeInDelayForOffenders();

    method public long getFadeInDurationForAudioAttributes(@NonNull android.media.AudioAttributes);

    method public long getFadeInDurationForUsage(int);
@@ -6979,7 +6981,6 @@ package android.media { 
    field @NonNull public static final android.os.Parcelable.Creator<android.media.FadeManagerConfiguration> CREATOR;

    field public static final long DURATION_NOT_SET = 0L; // 0x0L

    field public static final int FADE_STATE_DISABLED = 0; // 0x0

    field public static final int FADE_STATE_ENABLED_AUTO = 2; // 0x2

    field public static final int FADE_STATE_ENABLED_DEFAULT = 1; // 0x1

    field public static final String TAG = "FadeManagerConfiguration";

    field public static final int VOLUME_SHAPER_SYSTEM_FADE_ID = 2; // 0x2

media/java/android/media/FadeManagerConfiguration.java

+141 −127

File changed.

Preview size limit exceeded, changes collapsed.

media/tests/AudioPolicyTest/src/com/android/audiopolicytest/FadeManagerConfigurationUnitTest.java

+4 −12
Original line number Diff line number Diff line
@@ -45,8 +45,10 @@ import java.util.List; 
@RunWith(AndroidJUnit4.class)

@RequiresFlagsEnabled(FLAG_ENABLE_FADE_MANAGER_CONFIGURATION)

public final class FadeManagerConfigurationUnitTest {

    private static final long DEFAULT_FADE_OUT_DURATION_MS = 2_000;

    private static final long DEFAULT_FADE_IN_DURATION_MS = 1_000;

    private static final long DEFAULT_FADE_OUT_DURATION_MS =

            FadeManagerConfiguration.getDefaultFadeOutDurationMillis();

    private static final long DEFAULT_FADE_IN_DURATION_MS =

            FadeManagerConfiguration.getDefaultFadeInDurationMillis();

    private static final long TEST_FADE_OUT_DURATION_MS = 1_500;

    private static final long TEST_FADE_IN_DURATION_MS = 750;

    private static final int TEST_INVALID_USAGE = -10;
@@ -258,16 +260,6 @@ public final class FadeManagerConfigurationUnitTest { 
                .isEqualTo(fadeState);

    }



    @Test

    public void testSetFadeState_toEnableAuto() {

        final int fadeStateAuto = FadeManagerConfiguration.FADE_STATE_ENABLED_AUTO;

        FadeManagerConfiguration fmc = new FadeManagerConfiguration.Builder()

                .setFadeState(fadeStateAuto).build();



        expect.withMessage("Fade state when enabled for audio").that(fmc.getFadeState())

                .isEqualTo(fadeStateAuto);

    }



    @Test

    public void testSetFadeState_toInvalid_fails() {

        IllegalArgumentException thrown = assertThrows(IllegalArgumentException.class, () ->