From 25e99af9e7458d6fb4f32a020ce9b2cb42b6d260 Mon Sep 17 00:00:00 2001 From: huangdarwin Date: Fri, 12 Apr 2024 06:32:00 -0700 Subject: [PATCH] More strongly discourage use of DebugSurfaceView This was always intended as a debug API only, but its inclusion in media3.common and public visibility has led to partners sometimes experimenting with this API and complaining when it doesn't work as expected. PiperOrigin-RevId: 624158798 --- .../main/java/androidx/media3/common/DebugViewProvider.java | 6 +++++- .../java/androidx/media3/common/VideoFrameProcessor.java | 3 ++- 2 files changed, 7 insertions(+), 2 deletions(-) diff --git a/libraries/common/src/main/java/androidx/media3/common/DebugViewProvider.java b/libraries/common/src/main/java/androidx/media3/common/DebugViewProvider.java index 6f8e70d1c3..b225b5dc9c 100644 --- a/libraries/common/src/main/java/androidx/media3/common/DebugViewProvider.java +++ b/libraries/common/src/main/java/androidx/media3/common/DebugViewProvider.java @@ -19,7 +19,11 @@ import android.view.SurfaceView; import androidx.annotation.Nullable; import androidx.media3.common.util.UnstableApi; -/** Provider for views to show diagnostic information during an export, for debugging. */ +/** + * Provider for views to show diagnostic information during an export, for debugging. + * + *

This is not intended for production use-cases. + */ @UnstableApi public interface DebugViewProvider { diff --git a/libraries/common/src/main/java/androidx/media3/common/VideoFrameProcessor.java b/libraries/common/src/main/java/androidx/media3/common/VideoFrameProcessor.java index 041f6e8227..c0e3727076 100644 --- a/libraries/common/src/main/java/androidx/media3/common/VideoFrameProcessor.java +++ b/libraries/common/src/main/java/androidx/media3/common/VideoFrameProcessor.java @@ -81,7 +81,8 @@ public interface VideoFrameProcessor { * Creates a new {@link VideoFrameProcessor} instance. * * @param context A {@link Context}. - * @param debugViewProvider A {@link DebugViewProvider}. + * @param debugViewProvider A {@link DebugViewProvider}. In production usage, pass {@link + * DebugViewProvider#NONE}. * @param outputColorInfo The {@link ColorInfo} for the output frames. * @param renderFramesAutomatically If {@code true}, the instance will render output frames to * the {@linkplain #setOutputSurfaceInfo(SurfaceInfo) output surface} automatically as