Fix recursive loop when registering controller visibility listeners

There are two overloads of this method due to a type 'rename' from
`PlayerControlView.VisibilityListener` to
`PlayerView.ControllerVisibilityListener`. Currently when you call one
overload it passes `null` to the other one (to clear the other listener).
Unfortunately this results in it clearing itself, because it receives
a null call back!

This change tweaks the documentation to clarify that the 'other'
listener is only cleared if you pass a non-null listener in. This solves
the recursive problem, and allows the 'legacy' visibility listener to be
successfully registered.

Issue: androidx/media#229

#minor-release

PiperOrigin-RevId: 496876397
This commit is contained in:
ibaker 2022-12-21 10:58:36 +00:00 committed by Tianyi Feng
parent b7e887a58d
commit 37fd65a8e5

View file

@ -868,8 +868,8 @@ public class StyledPlayerView extends FrameLayout implements AdViewProvider {
/**
* Sets the {@link StyledPlayerControlView.VisibilityListener}.
*
* <p>Removes any listener set by {@link
* #setControllerVisibilityListener(StyledPlayerControlView.VisibilityListener)}.
* <p>If {@code listener} is non-null then any listener set by {@link
* #setControllerVisibilityListener(StyledPlayerControlView.VisibilityListener)} is removed.
*
* @param listener The listener to be notified about visibility changes, or null to remove the
* current listener.
@ -877,14 +877,16 @@ public class StyledPlayerView extends FrameLayout implements AdViewProvider {
@SuppressWarnings("deprecation") // Clearing the legacy listener.
public void setControllerVisibilityListener(@Nullable ControllerVisibilityListener listener) {
this.controllerVisibilityListener = listener;
setControllerVisibilityListener((StyledPlayerControlView.VisibilityListener) null);
if (listener != null) {
setControllerVisibilityListener((StyledPlayerControlView.VisibilityListener) null);
}
}
/**
* Sets the {@link StyledPlayerControlView.VisibilityListener}.
*
* <p>Removes any listener set by {@link
* #setControllerVisibilityListener(ControllerVisibilityListener)}.
* <p>If {@code listener} is non-null then any listener set by {@link
* #setControllerVisibilityListener(ControllerVisibilityListener)} is removed.
*
* @deprecated Use {@link #setControllerVisibilityListener(ControllerVisibilityListener)} instead.
*/
@ -903,8 +905,8 @@ public class StyledPlayerView extends FrameLayout implements AdViewProvider {
this.legacyControllerVisibilityListener = listener;
if (listener != null) {
controller.addVisibilityListener(listener);
setControllerVisibilityListener((ControllerVisibilityListener) null);
}
setControllerVisibilityListener((ControllerVisibilityListener) null);
}
/**