loliball/media3
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Ensure ForwardingPlayer users do listener registration correctly

Browse Source 
The `@CallSuper` annotation should help catch cases where subclasses are
calling `delegate.addListener` instead of `super.addListener` but it
will also (unintentionally) prevent subclasses from either completely
no-opping the listener registration, or implementing it themselves in a
very custom way. I think that's probably OK, since these cases are
probably unusual, and they should be able to suppress the warning/error.

Issue: androidx/media#258

#minor-release

PiperOrigin-RevId: 513848402
This commit is contained in:
ibaker 2023-03-03 17:32:36 +00:00 committed by Rohit Singh
parent efaf4e3f33
commit 5d23a92923
1 changed files with 18 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
libraries/common/src/main/java/androidx/media3/common/ForwardingPlayer.java
View File

@ -20,6 +20,7 @@ import android.view.Surface;
import android.view.SurfaceHolder; import android.view.SurfaceHolder;
import android.view.SurfaceView; import android.view.SurfaceView;
import android.view.TextureView; import android.view.TextureView;
import androidx.annotation.CallSuper;
import androidx.annotation.Nullable; import androidx.annotation.Nullable;
import androidx.media3.common.text.Cue; import androidx.media3.common.text.Cue;
import androidx.media3.common.text.CueGroup; import androidx.media3.common.text.CueGroup;
@ -47,14 +48,29 @@ public class ForwardingPlayer implements Player {
return player.getApplicationLooper(); return player.getApplicationLooper();
} }
/** Calls {@link Player#addListener(Listener)} on the delegate. */ /**
* Calls {@link Player#addListener(Listener)} on the delegate.
*
* <p>Overrides of this method must delegate to {@code super.addListener} and not {@code
* delegate.addListener}, in order to ensure the correct {@link Player} instance is passed to
* {@link Player.Listener#onEvents(Player, Events)} (i.e. this forwarding instance, and not the
* underlying {@code delegate} instance).
*/
@Override @Override
@CallSuper
public void addListener(Listener listener) { public void addListener(Listener listener) {
player.addListener(new ForwardingListener(this, listener)); player.addListener(new ForwardingListener(this, listener));
} }
/** Calls {@link Player#removeListener(Listener)} on the delegate. */ /**
* Calls {@link Player#removeListener(Listener)} on the delegate.
*
* <p>Overrides of this method must delegate to {@code super.removeListener} and not {@code
* delegate.removeListener}, in order to ensure the listener 'matches' the listener added via
* {@link #addListener} (otherwise the listener registered on the delegate won't be removed).
*/
@Override @Override
@CallSuper
public void removeListener(Listener listener) { public void removeListener(Listener listener) {
player.removeListener(new ForwardingListener(this, listener)); player.removeListener(new ForwardingListener(this, listener));
} }