Remove references to Renderer from VideoFrameReleaseHelper's Javadoc

With multi video sequences previewing in CompositionPlayer,
VideoFrameReleaseHelper won't be connected to a single renderer.
Multiple renderers will feed the VideoGraph at the same time, and the
VideoGraph output will be connected to the VideoFrameReleaseHelper.

PiperOrigin-RevId: 733250499
This commit is contained in:
kimvde 2025-03-04 02:48:46 -08:00 committed by Copybara-Service
parent 2da814c8ef
commit 7a00841323

View File

@ -33,11 +33,10 @@ import androidx.media3.common.Format;
import androidx.media3.common.util.Log;
import androidx.media3.common.util.UnstableApi;
import androidx.media3.common.util.Util;
import androidx.media3.exoplayer.Renderer;
import org.checkerframework.checker.nullness.qual.MonotonicNonNull;
/**
* Helps a video {@link Renderer} release frames to a {@link Surface}. The helper:
* A helper to release video frames to a {@link Surface}. This helper:
*
* <ul>
* <li>Adjusts frame release timestamps to achieve a smoother visual result. The release
@ -155,7 +154,7 @@ public final class VideoFrameReleaseHelper {
updateSurfacePlaybackFrameRate(/* forceUpdate= */ true);
}
/** Called when the renderer is started. */
/** Called when rendering starts. */
public void onStarted() {
started = true;
resetAdjustment();
@ -167,9 +166,9 @@ public final class VideoFrameReleaseHelper {
}
/**
* Called when the renderer changes which {@link Surface} it's rendering to renders to.
* Called when the {@link Surface} on which to render changes.
*
* @param surface The new {@link Surface}, or {@code null} if the renderer does not have one.
* @param surface The new {@link Surface}, or {@code null} if there is none.
*/
public void onSurfaceChanged(@Nullable Surface surface) {
if (this.surface == surface) {
@ -180,13 +179,13 @@ public final class VideoFrameReleaseHelper {
updateSurfacePlaybackFrameRate(/* forceUpdate= */ true);
}
/** Called when the renderer's position is reset. */
/** Called when the position is reset. */
public void onPositionReset() {
resetAdjustment();
}
/**
* Called when the renderer's playback speed changes.
* Called when the playback speed changes.
*
* @param playbackSpeed The factor by which playback is sped up.
*/
@ -197,7 +196,7 @@ public final class VideoFrameReleaseHelper {
}
/**
* Called when the renderer's output format changes.
* Called when the output format changes.
*
* @param formatFrameRate The format's frame rate, or {@link Format#NO_VALUE} if unknown.
*/
@ -208,7 +207,7 @@ public final class VideoFrameReleaseHelper {
}
/**
* Called by the renderer for each frame, prior to it being skipped, dropped or rendered.
* Called for each frame, prior to it being skipped, dropped or rendered.
*
* @param framePresentationTimeUs The frame presentation timestamp, in microseconds.
*/
@ -222,7 +221,7 @@ public final class VideoFrameReleaseHelper {
updateSurfaceMediaFrameRate();
}
/** Called when the renderer is stopped. */
/** Called when rendering stops. */
public void onStopped() {
started = false;
if (displayHelper != null) {
@ -337,7 +336,7 @@ public final class VideoFrameReleaseHelper {
/**
* Updates the playback frame rate of the current {@link #surface} based on the playback speed,
* frame rate of the content, and whether the renderer is started.
* frame rate of the content, and whether the rendering started.
*
* <p>Does nothing if {@link #changeFrameRateStrategy} is {@link
* C#VIDEO_CHANGE_FRAME_RATE_STRATEGY_OFF}.