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

MediaSessionConnector: Support ACTION_SET_CAPTIONING_ENABLED

Browse Source 
PiperOrigin-RevId: 283546707
This commit is contained in:
bachinger 2019-12-03 16:05:27 +00:00
parent 23b54a95d2
commit 6c10c94f94
2 changed files with 52 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
RELEASENOTES.md
View File

@ -21,6 +21,7 @@
speed ([#5978](https://github.com/google/ExoPlayer/issues/5978)).
* Allow `AdtsExtractor` to encounter EoF when calculating average frame size
([#6700](https://github.com/google/ExoPlayer/issues/6700)).
* Make media session connector dispatch ACTION_SET_CAPTIONING_ENABLED.
### 2.11.0 (not yet released) ###

54
extensions/mediasession/src/main/java/com/google/android/exoplayer2/ext/mediasession/MediaSessionConnector.java
View File

@ -339,6 +339,21 @@ public final class MediaSessionConnector {
void onSetRating(Player player, RatingCompat rating, Bundle extras);
}
/** Handles requests for enabling or disabling captions. */
public interface CaptionCallback extends CommandReceiver {
/** See {@link MediaSessionCompat.Callback#onSetCaptioningEnabled(boolean)}. */
void onSetCaptioningEnabled(Player player, boolean enabled);
/**
* Returns whether the media currently being played has captions.
*
* <p>This method is called each time the media session playback state needs to be updated and
* published upon a player state change.
*/
boolean hasCaptions(Player player);
}
/** Handles a media button event. */
public interface MediaButtonEventHandler {
/**
@ -420,6 +435,7 @@ public final class MediaSessionConnector {
@Nullable private QueueNavigator queueNavigator;
@Nullable private QueueEditor queueEditor;
@Nullable private RatingCallback ratingCallback;
@Nullable private CaptionCallback captionCallback;
@Nullable private MediaButtonEventHandler mediaButtonEventHandler;
private long enabledPlaybackActions;
@ -606,7 +622,7 @@ public final class MediaSessionConnector {
*
* @param ratingCallback The rating callback.
*/
public void setRatingCallback(RatingCallback ratingCallback) {
public void setRatingCallback(@Nullable RatingCallback ratingCallback) {
if (this.ratingCallback != ratingCallback) {
unregisterCommandReceiver(this.ratingCallback);
this.ratingCallback = ratingCallback;
@ -614,6 +630,19 @@ public final class MediaSessionConnector {
}
}
/**
* Sets the {@link CaptionCallback} to handle requests to enable or disable captions.
*
* @param captionCallback The caption callback.
*/
public void setCaptionCallback(@Nullable CaptionCallback captionCallback) {
if (this.captionCallback != captionCallback) {
unregisterCommandReceiver(this.captionCallback);
this.captionCallback = captionCallback;
registerCommandReceiver(this.captionCallback);
}
}
/**
* Sets a custom error on the session.
*
@ -843,12 +872,14 @@ public final class MediaSessionConnector {
boolean enableRewind = false;
boolean enableFastForward = false;
boolean enableSetRating = false;
boolean enableSetCaptioningEnabled = false;
Timeline timeline = player.getCurrentTimeline();
if (!timeline.isEmpty() && !player.isPlayingAd()) {
enableSeeking = player.isCurrentWindowSeekable();
enableRewind = enableSeeking && rewindMs > 0;
enableFastForward = enableSeeking && fastForwardMs > 0;
enableSetRating = true;
enableSetRating = ratingCallback != null;
enableSetCaptioningEnabled = captionCallback != null && captionCallback.hasCaptions(player);
}
long playbackActions = BASE_PLAYBACK_ACTIONS;
@ -868,9 +899,12 @@ public final class MediaSessionConnector {
actions |=
(QueueNavigator.ACTIONS & queueNavigator.getSupportedQueueNavigatorActions(player));
}
if (ratingCallback != null && enableSetRating) {
if (enableSetRating) {
actions |= PlaybackStateCompat.ACTION_SET_RATING;
}
if (enableSetCaptioningEnabled) {
actions |= PlaybackStateCompat.ACTION_SET_CAPTIONING_ENABLED;
}
return actions;
}
@ -901,6 +935,13 @@ public final class MediaSessionConnector {
return player != null && ratingCallback != null;
}
@EnsuresNonNullIf(
result = true,
expression = {"player", "captionCallback"})
private boolean canDispatchSetCaptioningEnabled() {
return player != null && captionCallback != null;
}
@EnsuresNonNullIf(
result = true,
expression = {"player", "queueEditor"})
@ -1353,6 +1394,13 @@ public final class MediaSessionConnector {
}
}
@Override
public void onSetCaptioningEnabled(boolean enabled) {
if (canDispatchSetCaptioningEnabled()) {
captionCallback.onSetCaptioningEnabled(player, enabled);
}
}
@Override
public boolean onMediaButtonEvent(Intent mediaButtonEvent) {
boolean isHandled =