Rename fastForward/rewind to seekForward/Back in Player

This matches the Javadoc better.

PiperOrigin-RevId: 383228021

RELEASENOTES.md

@@ -4,7 +4,7 @@
 
 *   Core Library:
     *   Add `needsReconfiguration` API to the `MediaCodecAdapter` interface.
-    *   Add `fastForward` and `rewind` methods to `Player`.
+    *   Add `seekForward` and `seekBack` methods to `Player`.
     *   Make `Player` depend on the new `PlaybackException` class instead of
         `ExoPlaybackException`:
         *   `Player.getPlayerError` now returns a `PlaybackException`.

extensions/cast/src/main/java/com/google/android/exoplayer2/ext/cast/CastPlayer.java

@@ -94,8 +94,8 @@ public final class CastPlayer extends BasePlayer {
               COMMAND_PREPARE_STOP,
               COMMAND_SEEK_TO_DEFAULT_POSITION,
               COMMAND_SEEK_TO_MEDIA_ITEM,
-              COMMAND_SET_FAST_FORWARD_INCREMENT,
-              COMMAND_SET_REWIND_INCREMENT,
+              COMMAND_SET_SEEK_FORWARD_INCREMENT,
+              COMMAND_SET_SEEK_BACK_INCREMENT,
               COMMAND_SET_REPEAT_MODE,
               COMMAND_GET_CURRENT_MEDIA_ITEM,
               COMMAND_GET_MEDIA_ITEMS,
@@ -144,8 +144,8 @@ public final class CastPlayer extends BasePlayer {
   private int pendingSeekWindowIndex;
   private long pendingSeekPositionMs;
   @Nullable private PositionInfo pendingMediaItemRemovalPosition;
-  private long fastForwardIncrementMs;
-  private long rewindIncrementMs;
+  private long seekForwardIncrementMs;
+  private long seekBackIncrementMs;
 
   /**
    * Creates a new cast player that uses a {@link DefaultMediaItemConverter}.
@@ -183,8 +183,8 @@ public final class CastPlayer extends BasePlayer {
     availableCommands = new Commands.Builder().addAll(PERMANENT_AVAILABLE_COMMANDS).build();
     pendingSeekWindowIndex = C.INDEX_UNSET;
     pendingSeekPositionMs = C.TIME_UNSET;
-    fastForwardIncrementMs = DEFAULT_FAST_FORWARD_INCREMENT_MS;
-    rewindIncrementMs = DEFAULT_REWIND_INCREMENT_MS;
+    seekForwardIncrementMs = DEFAULT_SEEK_FORWARD_INCREMENT_MS;
+    seekBackIncrementMs = DEFAULT_SEEK_BACK_INCREMENT_MS;
 
     SessionManager sessionManager = castContext.getSessionManager();
     sessionManager.addSessionManagerListener(statusListener, CastSession.class);
@@ -419,37 +419,37 @@ public final class CastPlayer extends BasePlayer {
   }
 
   @Override
-  public void setFastForwardIncrement(long fastForwardIncrementMs) {
-    checkArgument(fastForwardIncrementMs > 0);
-    if (this.fastForwardIncrementMs != fastForwardIncrementMs) {
-      this.fastForwardIncrementMs = fastForwardIncrementMs;
+  public void setSeekForwardIncrement(long seekForwardIncrementMs) {
+    checkArgument(seekForwardIncrementMs > 0);
+    if (this.seekForwardIncrementMs != seekForwardIncrementMs) {
+      this.seekForwardIncrementMs = seekForwardIncrementMs;
       listeners.queueEvent(
-          Player.EVENT_FAST_FORWARD_INCREMENT_CHANGED,
-          listener -> listener.onFastForwardIncrementChanged(fastForwardIncrementMs));
+          Player.EVENT_SEEK_FORWARD_INCREMENT_CHANGED,
+          listener -> listener.onSeekForwardIncrementChanged(seekForwardIncrementMs));
       listeners.flushEvents();
     }
   }
 
   @Override
-  public long getFastForwardIncrement() {
-    return fastForwardIncrementMs;
+  public long getSeekForwardIncrement() {
+    return seekForwardIncrementMs;
   }
 
   @Override
-  public void setRewindIncrement(long rewindIncrementMs) {
-    checkArgument(rewindIncrementMs > 0);
-    if (this.rewindIncrementMs != rewindIncrementMs) {
-      this.rewindIncrementMs = rewindIncrementMs;
+  public void setSeekBackIncrement(long seekBackIncrementMs) {
+    checkArgument(seekBackIncrementMs > 0);
+    if (this.seekBackIncrementMs != seekBackIncrementMs) {
+      this.seekBackIncrementMs = seekBackIncrementMs;
       listeners.queueEvent(
-          Player.EVENT_REWIND_INCREMENT_CHANGED,
-          listener -> listener.onRewindIncrementChanged(rewindIncrementMs));
+          Player.EVENT_SEEK_BACK_INCREMENT_CHANGED,
+          listener -> listener.onSeekBackIncrementChanged(seekBackIncrementMs));
       listeners.flushEvents();
     }
   }
 
   @Override
-  public long getRewindIncrement() {
-    return rewindIncrementMs;
+  public long getSeekBackIncrement() {
+    return seekBackIncrementMs;
   }
 
   @Override

library/common/src/main/java/com/google/android/exoplayer2/BasePlayer.java

@@ -122,13 +122,13 @@ public abstract class BasePlayer implements Player {
   }
 
   @Override
-  public final void fastForward() {
-    seekToOffset(getFastForwardIncrement());
+  public final void seekForward() {
+    seekToOffset(getSeekForwardIncrement());
   }
 
   @Override
-  public final void rewind() {
-    seekToOffset(-getRewindIncrement());
+  public final void seekBack() {
+    seekToOffset(-getSeekBackIncrement());
   }
 
   @Override
@@ -267,8 +267,8 @@ public abstract class BasePlayer implements Player {
         .addIf(COMMAND_SEEK_TO_NEXT_MEDIA_ITEM, hasNext() && !isPlayingAd())
         .addIf(COMMAND_SEEK_TO_PREVIOUS_MEDIA_ITEM, hasPrevious() && !isPlayingAd())
         .addIf(COMMAND_SEEK_TO_MEDIA_ITEM, !isPlayingAd())
-        .addIf(COMMAND_FAST_FORWARD, isCurrentWindowSeekable() && !isPlayingAd())
-        .addIf(COMMAND_REWIND, isCurrentWindowSeekable() && !isPlayingAd())
+        .addIf(COMMAND_SEEK_FORWARD, isCurrentWindowSeekable() && !isPlayingAd())
+        .addIf(COMMAND_SEEK_BACK, isCurrentWindowSeekable() && !isPlayingAd())
         .build();
   }
 

library/common/src/main/java/com/google/android/exoplayer2/ForwardingPlayer.java

@@ -248,33 +248,33 @@ public class ForwardingPlayer implements Player {
   }
 
   @Override
-  public void setFastForwardIncrement(long fastForwardIncrementMs) {
-    player.setFastForwardIncrement(fastForwardIncrementMs);
+  public void setSeekForwardIncrement(long seekForwardIncrementMs) {
+    player.setSeekForwardIncrement(seekForwardIncrementMs);
   }
 
   @Override
-  public long getFastForwardIncrement() {
-    return player.getFastForwardIncrement();
+  public long getSeekForwardIncrement() {
+    return player.getSeekForwardIncrement();
   }
 
   @Override
-  public void fastForward() {
-    player.fastForward();
+  public void seekForward() {
+    player.seekForward();
   }
 
   @Override
-  public void setRewindIncrement(long rewindIncrementMs) {
-    player.setRewindIncrement(rewindIncrementMs);
+  public void setSeekBackIncrement(long seekBackIncrementMs) {
+    player.setSeekBackIncrement(seekBackIncrementMs);
   }
 
   @Override
-  public long getRewindIncrement() {
-    return player.getRewindIncrement();
+  public long getSeekBackIncrement() {
+    return player.getSeekBackIncrement();
   }
 
   @Override
-  public void rewind() {
-    player.rewind();
+  public void seekBack() {
+    player.seekBack();
   }
 
   @Override
@@ -707,13 +707,13 @@ public class ForwardingPlayer implements Player {
     }
 
     @Override
-    public void onFastForwardIncrementChanged(long fastForwardIncrementMs) {
-      eventListener.onFastForwardIncrementChanged(fastForwardIncrementMs);
+    public void onSeekForwardIncrementChanged(long seekForwardIncrementMs) {
+      eventListener.onSeekForwardIncrementChanged(seekForwardIncrementMs);
     }
 
     @Override
-    public void onRewindIncrementChanged(long rewindIncrementMs) {
-      eventListener.onRewindIncrementChanged(rewindIncrementMs);
+    public void onSeekBackIncrementChanged(long seekBackIncrementMs) {
+      eventListener.onSeekBackIncrementChanged(seekBackIncrementMs);
     }
 
     @Override

library/core/src/main/java/com/google/android/exoplayer2/ExoPlayerImpl.java

@@ -104,8 +104,8 @@ import java.util.concurrent.CopyOnWriteArraySet;
   private Commands availableCommands;
   private MediaMetadata mediaMetadata;
   private MediaMetadata playlistMetadata;
-  private long fastForwardIncrementMs;
-  private long rewindIncrementMs;
+  private long seekForwardIncrementMs;
+  private long seekBackIncrementMs;
 
   // Playback information when there is no pending seek/set source operation.
   private PlaybackInfo playbackInfo;
@@ -197,8 +197,8 @@ import java.util.concurrent.CopyOnWriteArraySet;
             .addAll(
                 COMMAND_PLAY_PAUSE,
                 COMMAND_PREPARE_STOP,
-                COMMAND_SET_FAST_FORWARD_INCREMENT,
-                COMMAND_SET_REWIND_INCREMENT,
+                COMMAND_SET_SEEK_FORWARD_INCREMENT,
+                COMMAND_SET_SEEK_BACK_INCREMENT,
                 COMMAND_SET_SPEED_AND_PITCH,
                 COMMAND_SET_SHUFFLE_MODE,
                 COMMAND_SET_REPEAT_MODE,
@@ -217,8 +217,8 @@ import java.util.concurrent.CopyOnWriteArraySet;
             .build();
     mediaMetadata = MediaMetadata.EMPTY;
     playlistMetadata = MediaMetadata.EMPTY;
-    fastForwardIncrementMs = DEFAULT_FAST_FORWARD_INCREMENT_MS;
-    rewindIncrementMs = DEFAULT_REWIND_INCREMENT_MS;
+    seekForwardIncrementMs = DEFAULT_SEEK_FORWARD_INCREMENT_MS;
+    seekBackIncrementMs = DEFAULT_SEEK_BACK_INCREMENT_MS;
     maskingWindowIndex = C.INDEX_UNSET;
     playbackInfoUpdateHandler = clock.createHandler(applicationLooper, /* callback= */ null);
     playbackInfoUpdateListener =
@@ -720,37 +720,37 @@ import java.util.concurrent.CopyOnWriteArraySet;
   }
 
   @Override
-  public void setFastForwardIncrement(long fastForwardIncrementMs) {
-    checkArgument(fastForwardIncrementMs > 0);
-    if (this.fastForwardIncrementMs != fastForwardIncrementMs) {
-      this.fastForwardIncrementMs = fastForwardIncrementMs;
+  public void setSeekForwardIncrement(long seekForwardIncrementMs) {
+    checkArgument(seekForwardIncrementMs > 0);
+    if (this.seekForwardIncrementMs != seekForwardIncrementMs) {
+      this.seekForwardIncrementMs = seekForwardIncrementMs;
       listeners.queueEvent(
-          Player.EVENT_FAST_FORWARD_INCREMENT_CHANGED,
-          listener -> listener.onFastForwardIncrementChanged(fastForwardIncrementMs));
+          Player.EVENT_SEEK_FORWARD_INCREMENT_CHANGED,
+          listener -> listener.onSeekForwardIncrementChanged(seekForwardIncrementMs));
       listeners.flushEvents();
     }
   }
 
   @Override
-  public long getFastForwardIncrement() {
-    return fastForwardIncrementMs;
+  public long getSeekForwardIncrement() {
+    return seekForwardIncrementMs;
   }
 
   @Override
-  public void setRewindIncrement(long rewindIncrementMs) {
-    checkArgument(rewindIncrementMs > 0);
-    if (this.rewindIncrementMs != rewindIncrementMs) {
-      this.rewindIncrementMs = rewindIncrementMs;
+  public void setSeekBackIncrement(long seekBackIncrementMs) {
+    checkArgument(seekBackIncrementMs > 0);
+    if (this.seekBackIncrementMs != seekBackIncrementMs) {
+      this.seekBackIncrementMs = seekBackIncrementMs;
       listeners.queueEvent(
-          Player.EVENT_REWIND_INCREMENT_CHANGED,
-          listener -> listener.onRewindIncrementChanged(rewindIncrementMs));
+          Player.EVENT_SEEK_BACK_INCREMENT_CHANGED,
+          listener -> listener.onSeekBackIncrementChanged(seekBackIncrementMs));
       listeners.flushEvents();
     }
   }
 
   @Override
-  public long getRewindIncrement() {
-    return rewindIncrementMs;
+  public long getSeekBackIncrement() {
+    return seekBackIncrementMs;
   }
 
   @Override

library/core/src/main/java/com/google/android/exoplayer2/SimpleExoPlayer.java

@@ -1563,27 +1563,27 @@ public class SimpleExoPlayer extends BasePlayer
   }
 
   @Override
-  public void setFastForwardIncrement(long fastForwardIncrementMs) {
+  public void setSeekForwardIncrement(long seekForwardIncrementMs) {
     verifyApplicationThread();
-    player.setFastForwardIncrement(fastForwardIncrementMs);
+    player.setSeekForwardIncrement(seekForwardIncrementMs);
   }
 
   @Override
-  public long getFastForwardIncrement() {
+  public long getSeekForwardIncrement() {
     verifyApplicationThread();
-    return player.getFastForwardIncrement();
+    return player.getSeekForwardIncrement();
   }
 
   @Override
-  public void setRewindIncrement(long rewindIncrementMs) {
+  public void setSeekBackIncrement(long seekBackIncrementMs) {
     verifyApplicationThread();
-    player.setRewindIncrement(rewindIncrementMs);
+    player.setSeekBackIncrement(seekBackIncrementMs);
   }
 
   @Override
-  public long getRewindIncrement() {
+  public long getSeekBackIncrement() {
     verifyApplicationThread();
-    return player.getRewindIncrement();
+    return player.getSeekBackIncrement();
   }
 
   @Override

library/core/src/main/java/com/google/android/exoplayer2/analytics/AnalyticsCollector.java

@@ -743,21 +743,21 @@ public class AnalyticsCollector
   }
 
   @Override
-  public void onFastForwardIncrementChanged(long fastForwardIncrementMs) {
+  public void onSeekForwardIncrementChanged(long seekForwardIncrementMs) {
     EventTime eventTime = generateCurrentPlayerMediaPeriodEventTime();
     sendEvent(
         eventTime,
-        AnalyticsListener.EVENT_FAST_FORWARD_INCREMENT_CHANGED,
-        listener -> listener.onFastForwardIncrementChanged(eventTime, fastForwardIncrementMs));
+        AnalyticsListener.EVENT_SEEK_FORWARD_INCREMENT_CHANGED,
+        listener -> listener.onSeekForwardIncrementChanged(eventTime, seekForwardIncrementMs));
   }
 
   @Override
-  public void onRewindIncrementChanged(long rewindIncrementMs) {
+  public void onSeekBackIncrementChanged(long seekBackIncrementMs) {
     EventTime eventTime = generateCurrentPlayerMediaPeriodEventTime();
     sendEvent(
         eventTime,
-        AnalyticsListener.EVENT_REWIND_INCREMENT_CHANGED,
-        listener -> listener.onRewindIncrementChanged(eventTime, rewindIncrementMs));
+        AnalyticsListener.EVENT_SEEK_BACK_INCREMENT_CHANGED,
+        listener -> listener.onSeekBackIncrementChanged(eventTime, seekBackIncrementMs));
   }
 
   @Override

library/core/src/main/java/com/google/android/exoplayer2/analytics/AnalyticsListener.java

@@ -172,8 +172,8 @@ public interface AnalyticsListener {
     EVENT_AVAILABLE_COMMANDS_CHANGED,
     EVENT_MEDIA_METADATA_CHANGED,
     EVENT_PLAYLIST_METADATA_CHANGED,
-    EVENT_FAST_FORWARD_INCREMENT_CHANGED,
-    EVENT_REWIND_INCREMENT_CHANGED,
+    EVENT_SEEK_FORWARD_INCREMENT_CHANGED,
+    EVENT_SEEK_BACK_INCREMENT_CHANGED,
     EVENT_LOAD_STARTED,
     EVENT_LOAD_COMPLETED,
     EVENT_LOAD_CANCELED,
@@ -256,10 +256,10 @@ public interface AnalyticsListener {
   int EVENT_MEDIA_METADATA_CHANGED = Player.EVENT_MEDIA_METADATA_CHANGED;
   /** {@link Player#getPlaylistMetadata()} changed. */
   int EVENT_PLAYLIST_METADATA_CHANGED = Player.EVENT_PLAYLIST_METADATA_CHANGED;
-  /** {@link Player#getFastForwardIncrement()} changed. */
-  int EVENT_FAST_FORWARD_INCREMENT_CHANGED = Player.EVENT_FAST_FORWARD_INCREMENT_CHANGED;
-  /** {@link Player#getRewindIncrement()} changed. */
-  int EVENT_REWIND_INCREMENT_CHANGED = Player.EVENT_REWIND_INCREMENT_CHANGED;
+  /** {@link Player#getSeekForwardIncrement()} changed. */
+  int EVENT_SEEK_FORWARD_INCREMENT_CHANGED = Player.EVENT_SEEK_FORWARD_INCREMENT_CHANGED;
+  /** {@link Player#getSeekBackIncrement()} changed. */
+  int EVENT_SEEK_BACK_INCREMENT_CHANGED = Player.EVENT_SEEK_BACK_INCREMENT_CHANGED;
   /** A source started loading data. */
   int EVENT_LOAD_STARTED = 1000; // Intentional gap to leave space for new Player events
   /** A source started completed loading data. */
@@ -596,20 +596,20 @@ public interface AnalyticsListener {
       EventTime eventTime, PlaybackParameters playbackParameters) {}
 
   /**
-   * Called when the fast forward increment changed.
+   * Called when the seek forward increment changed.
    *
    * @param eventTime The event time.
-   * @param fastForwardIncrementMs The fast forward increment, in milliseconds.
+   * @param seekForwardIncrementMs The seek forward increment, in milliseconds.
    */
-  default void onFastForwardIncrementChanged(EventTime eventTime, long fastForwardIncrementMs) {}
+  default void onSeekForwardIncrementChanged(EventTime eventTime, long seekForwardIncrementMs) {}
 
   /**
-   * Called when the rewind increment changed.
+   * Called when the seek back increment changed.
    *
    * @param eventTime The event time.
-   * @param rewindIncrementMs The rewind increment, in milliseconds.
+   * @param seekBackIncrementMs The seek back increment, in milliseconds.
    */
-  default void onRewindIncrementChanged(EventTime eventTime, long rewindIncrementMs) {}
+  default void onSeekBackIncrementChanged(EventTime eventTime, long seekBackIncrementMs) {}
 
   /**
    * Called when the repeat mode changed.

testutils/src/main/java/com/google/android/exoplayer2/testutil/StubExoPlayer.java

@@ -300,22 +300,22 @@ public class StubExoPlayer extends BasePlayer implements ExoPlayer {
   }
 
   @Override
-  public void setFastForwardIncrement(long fastForwardIncrementMs) {
+  public void setSeekForwardIncrement(long seekForwardIncrementMs) {
     throw new UnsupportedOperationException();
   }
 
   @Override
-  public long getFastForwardIncrement() {
+  public long getSeekForwardIncrement() {
     throw new UnsupportedOperationException();
   }
 
   @Override
-  public void setRewindIncrement(long rewindIncrementMs) {
+  public void setSeekBackIncrement(long seekBackIncrementMs) {
     throw new UnsupportedOperationException();
   }
 
   @Override
-  public long getRewindIncrement() {
+  public long getSeekBackIncrement() {
     throw new UnsupportedOperationException();
   }