MediaSessionConnector: Support ACTION_SET_CAPTIONING_ENABLED

PiperOrigin-RevId: 283546707

RELEASENOTES.md

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

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

@@ -339,6 +339,21 @@ public final class MediaSessionConnector {
     void onSetRating(Player player, RatingCompat rating, Bundle extras);
     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. */
   /** Handles a media button event. */
   public interface MediaButtonEventHandler {
   public interface MediaButtonEventHandler {
     /**
     /**
@@ -420,6 +435,7 @@ public final class MediaSessionConnector {
   @Nullable private QueueNavigator queueNavigator;
   @Nullable private QueueNavigator queueNavigator;
   @Nullable private QueueEditor queueEditor;
   @Nullable private QueueEditor queueEditor;
   @Nullable private RatingCallback ratingCallback;
   @Nullable private RatingCallback ratingCallback;
+  @Nullable private CaptionCallback captionCallback;
   @Nullable private MediaButtonEventHandler mediaButtonEventHandler;
   @Nullable private MediaButtonEventHandler mediaButtonEventHandler;
 
 
   private long enabledPlaybackActions;
   private long enabledPlaybackActions;
@@ -606,7 +622,7 @@ public final class MediaSessionConnector {
    *
    *
    * @param ratingCallback The rating callback.
    * @param ratingCallback The rating callback.
    */
    */
-  public void setRatingCallback(RatingCallback ratingCallback) {
+  public void setRatingCallback(@Nullable RatingCallback ratingCallback) {
     if (this.ratingCallback != ratingCallback) {
     if (this.ratingCallback != ratingCallback) {
       unregisterCommandReceiver(this.ratingCallback);
       unregisterCommandReceiver(this.ratingCallback);
       this.ratingCallback = ratingCallback;
       this.ratingCallback = ratingCallback;
@@ -615,6 +631,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.
    * Sets a custom error on the session.
    *
    *
    * <p>This sets the error code via {@link PlaybackStateCompat.Builder#setErrorMessage(int,
    * <p>This sets the error code via {@link PlaybackStateCompat.Builder#setErrorMessage(int,
@@ -843,12 +872,14 @@ public final class MediaSessionConnector {
     boolean enableRewind = false;
     boolean enableRewind = false;
     boolean enableFastForward = false;
     boolean enableFastForward = false;
     boolean enableSetRating = false;
     boolean enableSetRating = false;
+    boolean enableSetCaptioningEnabled = false;
     Timeline timeline = player.getCurrentTimeline();
     Timeline timeline = player.getCurrentTimeline();
     if (!timeline.isEmpty() && !player.isPlayingAd()) {
     if (!timeline.isEmpty() && !player.isPlayingAd()) {
       enableSeeking = player.isCurrentWindowSeekable();
       enableSeeking = player.isCurrentWindowSeekable();
       enableRewind = enableSeeking && rewindMs > 0;
       enableRewind = enableSeeking && rewindMs > 0;
       enableFastForward = enableSeeking && fastForwardMs > 0;
       enableFastForward = enableSeeking && fastForwardMs > 0;
-      enableSetRating = true;
+      enableSetRating = ratingCallback != null;
+      enableSetCaptioningEnabled = captionCallback != null && captionCallback.hasCaptions(player);
     }
     }
 
 
     long playbackActions = BASE_PLAYBACK_ACTIONS;
     long playbackActions = BASE_PLAYBACK_ACTIONS;
@@ -868,9 +899,12 @@ public final class MediaSessionConnector {
       actions |=
       actions |=
           (QueueNavigator.ACTIONS & queueNavigator.getSupportedQueueNavigatorActions(player));
           (QueueNavigator.ACTIONS & queueNavigator.getSupportedQueueNavigatorActions(player));
     }
     }
-    if (ratingCallback != null && enableSetRating) {
+    if (enableSetRating) {
       actions |= PlaybackStateCompat.ACTION_SET_RATING;
       actions |= PlaybackStateCompat.ACTION_SET_RATING;
     }
     }
+    if (enableSetCaptioningEnabled) {
+      actions |= PlaybackStateCompat.ACTION_SET_CAPTIONING_ENABLED;
+    }
     return actions;
     return actions;
   }
   }
 
 
@@ -903,6 +937,13 @@ public final class MediaSessionConnector {
 
 
   @EnsuresNonNullIf(
   @EnsuresNonNullIf(
       result = true,
       result = true,
+      expression = {"player", "captionCallback"})
+  private boolean canDispatchSetCaptioningEnabled() {
+    return player != null && captionCallback != null;
+  }
+
+  @EnsuresNonNullIf(
+      result = true,
       expression = {"player", "queueEditor"})
       expression = {"player", "queueEditor"})
   private boolean canDispatchQueueEdit() {
   private boolean canDispatchQueueEdit() {
     return player != null && queueEditor != null;
     return player != null && queueEditor != null;
@@ -1354,6 +1395,13 @@ public final class MediaSessionConnector {
     }
     }
 
 
     @Override
     @Override
+    public void onSetCaptioningEnabled(boolean enabled) {
+      if (canDispatchSetCaptioningEnabled()) {
+        captionCallback.onSetCaptioningEnabled(player, enabled);
+      }
+    }
+
+    @Override
     public boolean onMediaButtonEvent(Intent mediaButtonEvent) {
     public boolean onMediaButtonEvent(Intent mediaButtonEvent) {
       boolean isHandled =
       boolean isHandled =
           canDispatchMediaButtonEvent()
           canDispatchMediaButtonEvent()