Clarify AudioFocusManager by renaming some methods/field

The current naming had cause confusinon in b/179369346
and #8545.

PiperOrigin-RevId: 355656404
This commit is contained in:
krocard 2021-02-04 18:23:20 +00:00 committed by Oliver Woodman
parent da52de669c
commit 91d3f47e45

View File

@ -103,7 +103,7 @@ import org.checkerframework.checker.nullness.qual.MonotonicNonNull;
@Nullable private AudioAttributes audioAttributes; @Nullable private AudioAttributes audioAttributes;
@AudioFocusState private int audioFocusState; @AudioFocusState private int audioFocusState;
@C.AudioFocusGain private int focusGain; @C.AudioFocusGain private int focusGainToRequest;
private float volumeMultiplier = VOLUME_MULTIPLIER_DEFAULT; private float volumeMultiplier = VOLUME_MULTIPLIER_DEFAULT;
private @MonotonicNonNull AudioFocusRequest audioFocusRequest; private @MonotonicNonNull AudioFocusRequest audioFocusRequest;
@ -142,9 +142,9 @@ import org.checkerframework.checker.nullness.qual.MonotonicNonNull;
public void setAudioAttributes(@Nullable AudioAttributes audioAttributes) { public void setAudioAttributes(@Nullable AudioAttributes audioAttributes) {
if (!Util.areEqual(this.audioAttributes, audioAttributes)) { if (!Util.areEqual(this.audioAttributes, audioAttributes)) {
this.audioAttributes = audioAttributes; this.audioAttributes = audioAttributes;
focusGain = convertAudioAttributesToFocusGain(audioAttributes); focusGainToRequest = convertAudioAttributesToFocusGain(audioAttributes);
Assertions.checkArgument( Assertions.checkArgument(
focusGain == C.AUDIOFOCUS_GAIN || focusGain == C.AUDIOFOCUS_NONE, focusGainToRequest == C.AUDIOFOCUS_GAIN || focusGainToRequest == C.AUDIOFOCUS_NONE,
"Automatic handling of audio focus is only available for USAGE_MEDIA and USAGE_GAME."); "Automatic handling of audio focus is only available for USAGE_MEDIA and USAGE_GAME.");
} }
} }
@ -158,8 +158,8 @@ import org.checkerframework.checker.nullness.qual.MonotonicNonNull;
*/ */
@PlayerCommand @PlayerCommand
public int updateAudioFocus(boolean playWhenReady, @Player.State int playbackState) { public int updateAudioFocus(boolean playWhenReady, @Player.State int playbackState) {
if (shouldAbandonAudioFocus(playbackState)) { if (shouldAbandonAudioFocusIfHeld(playbackState)) {
abandonAudioFocus(); abandonAudioFocusIfHeld();
return playWhenReady ? PLAYER_COMMAND_PLAY_WHEN_READY : PLAYER_COMMAND_DO_NOT_PLAY; return playWhenReady ? PLAYER_COMMAND_PLAY_WHEN_READY : PLAYER_COMMAND_DO_NOT_PLAY;
} }
return playWhenReady ? requestAudioFocus() : PLAYER_COMMAND_DO_NOT_PLAY; return playWhenReady ? requestAudioFocus() : PLAYER_COMMAND_DO_NOT_PLAY;
@ -171,7 +171,7 @@ import org.checkerframework.checker.nullness.qual.MonotonicNonNull;
*/ */
public void release() { public void release() {
playerControl = null; playerControl = null;
abandonAudioFocus(); abandonAudioFocusIfHeld();
} }
// Internal methods. // Internal methods.
@ -181,8 +181,8 @@ import org.checkerframework.checker.nullness.qual.MonotonicNonNull;
return focusListener; return focusListener;
} }
private boolean shouldAbandonAudioFocus(@Player.State int playbackState) { private boolean shouldAbandonAudioFocusIfHeld(@Player.State int playbackState) {
return playbackState == Player.STATE_IDLE || focusGain != C.AUDIOFOCUS_GAIN; return playbackState == Player.STATE_IDLE || focusGainToRequest != C.AUDIOFOCUS_GAIN;
} }
@PlayerCommand @PlayerCommand
@ -200,7 +200,7 @@ import org.checkerframework.checker.nullness.qual.MonotonicNonNull;
} }
} }
private void abandonAudioFocus() { private void abandonAudioFocusIfHeld() {
if (audioFocusState == AUDIO_FOCUS_STATE_NO_FOCUS) { if (audioFocusState == AUDIO_FOCUS_STATE_NO_FOCUS) {
return; return;
} }
@ -216,7 +216,7 @@ import org.checkerframework.checker.nullness.qual.MonotonicNonNull;
return audioManager.requestAudioFocus( return audioManager.requestAudioFocus(
focusListener, focusListener,
Util.getStreamTypeForAudioUsage(checkNotNull(audioAttributes).usage), Util.getStreamTypeForAudioUsage(checkNotNull(audioAttributes).usage),
focusGain); focusGainToRequest);
} }
@RequiresApi(26) @RequiresApi(26)
@ -224,7 +224,7 @@ import org.checkerframework.checker.nullness.qual.MonotonicNonNull;
if (audioFocusRequest == null || rebuildAudioFocusRequest) { if (audioFocusRequest == null || rebuildAudioFocusRequest) {
AudioFocusRequest.Builder builder = AudioFocusRequest.Builder builder =
audioFocusRequest == null audioFocusRequest == null
? new AudioFocusRequest.Builder(focusGain) ? new AudioFocusRequest.Builder(focusGainToRequest)
: new AudioFocusRequest.Builder(audioFocusRequest); : new AudioFocusRequest.Builder(audioFocusRequest);
boolean willPauseWhenDucked = willPauseWhenDucked(); boolean willPauseWhenDucked = willPauseWhenDucked();
@ -361,7 +361,7 @@ import org.checkerframework.checker.nullness.qual.MonotonicNonNull;
return; return;
case AudioManager.AUDIOFOCUS_LOSS: case AudioManager.AUDIOFOCUS_LOSS:
executePlayerCommand(PLAYER_COMMAND_DO_NOT_PLAY); executePlayerCommand(PLAYER_COMMAND_DO_NOT_PLAY);
abandonAudioFocus(); abandonAudioFocusIfHeld();
return; return;
case AudioManager.AUDIOFOCUS_LOSS_TRANSIENT: case AudioManager.AUDIOFOCUS_LOSS_TRANSIENT:
case AudioManager.AUDIOFOCUS_LOSS_TRANSIENT_CAN_DUCK: case AudioManager.AUDIOFOCUS_LOSS_TRANSIENT_CAN_DUCK: