Document that the order of cues passed to TextOutput is important

Fix WebViewSubtitleOutput to respect this (CanvasSubtitleOutput already does). Issue: #8704 PiperOrigin-RevId: 365534018
google · Apr 1, 2021 · dd3597c · dd3597c
1 parent 9be84e4
commit dd3597c
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 0 deletions.
diff --git a/library/common/src/main/java/com/google/android/exoplayer2/text/TextOutput.java b/library/common/src/main/java/com/google/android/exoplayer2/text/TextOutput.java
@@ -25,6 +25,9 @@ public interface TextOutput {
   /**
    * Called when there is a change in the {@link Cue Cues}.
    *
+   * <p>{@code cues} is in ascending order of priority. If any of the cue boxes overlap when
+   * displayed, the {@link Cue} nearer the end of the list should be shown on top.
+   *
    * @param cues The {@link Cue Cues}. May be empty.
    */
   void onCues(List<Cue> cues);

diff --git a/library/ui/src/main/java/com/google/android/exoplayer2/ui/WebViewSubtitleOutput.java b/library/ui/src/main/java/com/google/android/exoplayer2/ui/WebViewSubtitleOutput.java
@@ -278,6 +278,7 @@ private void updateWebView() {
               Util.formatInvariant(
                   "<div style='"
                       + "position:absolute;"
+                      + "z-index:%s;"
                       + "%s:%.2f%%;"
                       + "%s:%s;"
                       + "%s:%s;"
@@ -287,6 +288,7 @@ private void updateWebView() {
                       + "background-color:%s;"
                       + "transform:translate(%s%%,%s%%);"
                       + "'>",
+                  /* z-index */ i,
                   positionProperty,
                   positionPercent,
                   lineProperty,