From 31ef7ff088a15cb13c2e9e6c80f9128e4ddb0499 Mon Sep 17 00:00:00 2001
From: kimvde <kimvde@google.com>
Date: Wed, 16 Oct 2024 08:44:50 -0700
Subject: [PATCH] Clarify Javadoc of EditedMediaItem.Builder.setDurationUs

PiperOrigin-RevId: 686521901
---
 .../media3/transformer/EditedMediaItem.java       | 15 ++++++++-------
 1 file changed, 8 insertions(+), 7 deletions(-)

diff --git a/libraries/transformer/src/main/java/androidx/media3/transformer/EditedMediaItem.java b/libraries/transformer/src/main/java/androidx/media3/transformer/EditedMediaItem.java
index 16d06a8335..e368ea8fdd 100644
--- a/libraries/transformer/src/main/java/androidx/media3/transformer/EditedMediaItem.java
+++ b/libraries/transformer/src/main/java/androidx/media3/transformer/EditedMediaItem.java
@@ -152,18 +152,19 @@ public final class EditedMediaItem {
     /**
      * Sets the {@link MediaItem} duration in the output, in microseconds.
      *
-     * <p>For {@linkplain Transformer export}, this should be set for inputs that don't have an
-     * intrinsic duration (e.g. images). It will be ignored for inputs that do have an intrinsic
-     * duration (e.g. video).
+     * <p>For {@linkplain Transformer export}, this should be set for non-image inputs that don't
+     * have an intrinsic duration (e.g. raw video data). It will be ignored for inputs that do have
+     * an intrinsic duration (e.g. encoded video data from input file).
      *
-     * <p>This should always be set for {@linkplain CompositionPlayer preview}.
+     * <p>For {@linkplain CompositionPlayer preview}, this should be set for all non-image inputs
+     * (i.e. audio and video input).
+     *
+     * <p>This duration doesn't need to be set for images, because the default value is the {@link
+     * MediaItem}'s {@linkplain MediaItem.Builder#setImageDurationMs(long) image duration}.
      *
      * <p>If {@linkplain MediaItem#clippingConfiguration clipping} is applied, this should be the
      * duration before clipping.
      *
-     * <p>The default value is the {@link MediaItem}'s {@linkplain
-     * MediaItem.Builder#setImageDurationMs(long) image duration}.
-     *
      * @param durationUs The duration, in microseconds.
      * @return This builder.
      */