loliball/media3
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Transformer: Split javadoc summary fragment and descriptive text.

Browse Source 
PiperOrigin-RevId: 435368283
This commit is contained in:
huangdarwin 2022-03-17 16:33:35 +00:00 committed by Ian Baker
parent 3848595377
commit 481b9bd63d
5 changed files with 57 additions and 34 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
libraries/common/src/main/java/androidx/media3/common/util/GlUtil.java
View File

@ -119,7 +119,8 @@ public final class GlUtil {
/** /**
* Returns whether creating a GL context with {@value #EXTENSION_PROTECTED_CONTENT} is possible. * Returns whether creating a GL context with {@value #EXTENSION_PROTECTED_CONTENT} is possible.
* If {@code true}, the device supports a protected output path for DRM content when using GL. *
* <p>If {@code true}, the device supports a protected output path for DRM content when using GL.
*/ */
public static boolean isProtectedContentExtensionSupported(Context context) { public static boolean isProtectedContentExtensionSupported(Context context) {
if (Util.SDK_INT < 24) { if (Util.SDK_INT < 24) {

5
libraries/transformer/src/main/java/androidx/media3/transformer/AdvancedFrameProcessor.java
View File

@ -43,8 +43,9 @@ import org.checkerframework.checker.nullness.qual.MonotonicNonNull;
private static final String FRAGMENT_SHADER_PATH = "shaders/fragment_shader_copy_es2.glsl"; private static final String FRAGMENT_SHADER_PATH = "shaders/fragment_shader_copy_es2.glsl";
/** /**
* Returns a 4x4, column-major Matrix float array, from an input {@link Matrix}. This is useful * Returns a 4x4, column-major Matrix float array, from an input {@link Matrix}.
* for converting to the 4x4 column-major format commonly used in OpenGL. *
* <p>This is useful for converting to the 4x4 column-major format commonly used in OpenGL.
*/ */
private static float[] getGlMatrixArray(Matrix matrix) { private static float[] getGlMatrixArray(Matrix matrix) {
float[] matrix3x3Array = new float[9]; float[] matrix3x3Array = new float[9];

7
libraries/transformer/src/main/java/androidx/media3/transformer/DefaultEncoderFactory.java
View File

@ -194,9 +194,10 @@ public final class DefaultEncoderFactory implements Codec.EncoderFactory {
} }
/** /**
* Finds a {@link MediaCodecInfo encoder} that supports the requested format most closely. Returns * Finds a {@link MediaCodecInfo encoder} that supports the requested format most closely.
* the {@link MediaCodecInfo encoder} and the supported {@link Format} in a {@link Pair}, or *
* {@code null} if none is found. * <p>Returns the {@link MediaCodecInfo encoder} and the supported {@link Format} in a {@link
* Pair}, or {@code null} if none is found.
*/ */
@RequiresNonNull("#1.sampleMimeType") @RequiresNonNull("#1.sampleMimeType")
@Nullable @Nullable

33
libraries/transformer/src/main/java/androidx/media3/transformer/TransformationRequest.java
View File

@ -62,7 +62,9 @@ public final class TransformationRequest {
} }
/** /**
* Sets the transformation matrix. The default value is to apply no change. * Sets the transformation matrix.
*
* <p>The default value is to apply no change.
* *
* <p>This can be used to perform operations supported by {@link Matrix}, like scaling and * <p>This can be used to perform operations supported by {@link Matrix}, like scaling and
* rotating the video. * rotating the video.
@ -84,10 +86,11 @@ public final class TransformationRequest {
} }
/** /**
* Sets whether the input should be flattened for media containing slow motion markers. The * Sets whether the input should be flattened for media containing slow motion markers.
* transformed output is obtained by removing the slow motion metadata and by actually slowing *
* down the parts of the video and audio streams defined in this metadata. The default value for * <p>The transformed output is obtained by removing the slow motion metadata and by actually
* {@code flattenForSlowMotion} is {@code false}. * slowing down the parts of the video and audio streams defined in this metadata. The default
* value for {@code flattenForSlowMotion} is {@code false}.
* *
* <p>Only Samsung Extension Format (SEF) slow motion metadata type is supported. The * <p>Only Samsung Extension Format (SEF) slow motion metadata type is supported. The
* transformation has no effect if the input does not contain this metadata type. * transformation has no effect if the input does not contain this metadata type.
@ -114,9 +117,11 @@ public final class TransformationRequest {
} }
/** /**
* Sets the output resolution using the output height. The default value {@link C#LENGTH_UNSET} * Sets the output resolution using the output height.
* corresponds to using the same height as the input. Output width of the displayed video will *
* scale to preserve the video's aspect ratio after other transformations. * <p>The default value {@link C#LENGTH_UNSET} corresponds to using the same height as the
* input. Output width of the displayed video will scale to preserve the video's aspect ratio
* after other transformations.
* *
* <p>For example, a 1920x1440 video can be scaled to 640x480 by calling setResolution(480). * <p>For example, a 1920x1440 video can be scaled to 640x480 by calling setResolution(480).
* *
@ -130,8 +135,10 @@ public final class TransformationRequest {
} }
/** /**
* Sets the video MIME type of the output. The default value is {@code null} which corresponds * Sets the video MIME type of the output.
* to using the same MIME type as the input. Supported MIME types are: *
* <p>The default value is {@code null} which corresponds to using the same MIME type as the
* input. Supported MIME types are:
* *
* <ul> * <ul>
* <li>{@link MimeTypes#VIDEO_H263} * <li>{@link MimeTypes#VIDEO_H263}
@ -154,8 +161,10 @@ public final class TransformationRequest {
} }
/** /**
* Sets the audio MIME type of the output. The default value is {@code null} which corresponds * Sets the audio MIME type of the output.
* to using the same MIME type as the input. Supported MIME types are: *
* <p>The default value is {@code null} which corresponds to using the same MIME type as the
* input. Supported MIME types are:
* *
* <ul> * <ul>
* <li>{@link MimeTypes#AUDIO_AAC} * <li>{@link MimeTypes#AUDIO_AAC}

43
libraries/transformer/src/main/java/androidx/media3/transformer/Transformer.java
View File

@ -177,9 +177,10 @@ public final class Transformer {
} }
/** /**
* Sets the {@link MediaSource.Factory} to be used to retrieve the inputs to transform. The * Sets the {@link MediaSource.Factory} to be used to retrieve the inputs to transform.
* default value is a {@link DefaultMediaSourceFactory} built with the context provided in *
* {@link #Builder(Context) the constructor}. * <p>The default value is a {@link DefaultMediaSourceFactory} built with the context provided
* in {@link #Builder(Context) the constructor}.
* *
* @param mediaSourceFactory A {@link MediaSource.Factory}. * @param mediaSourceFactory A {@link MediaSource.Factory}.
* @return This builder. * @return This builder.
@ -190,7 +191,9 @@ public final class Transformer {
} }
/** /**
* Sets whether to remove the audio from the output. The default value is {@code false}. * Sets whether to remove the audio from the output.
*
* <p>The default value is {@code false}.
* *
* <p>The audio and video cannot both be removed because the output would not contain any * <p>The audio and video cannot both be removed because the output would not contain any
* samples. * samples.
@ -204,7 +207,9 @@ public final class Transformer {
} }
/** /**
* Sets whether to remove the video from the output. The default value is {@code false}. * Sets whether to remove the video from the output.
*
* <p>The default value is {@code false}.
* *
* <p>The audio and video cannot both be removed because the output would not contain any * <p>The audio and video cannot both be removed because the output would not contain any
* samples. * samples.
@ -289,9 +294,10 @@ public final class Transformer {
/** /**
* Sets the {@link Looper} that must be used for all calls to the transformer and that is used * Sets the {@link Looper} that must be used for all calls to the transformer and that is used
* to call listeners on. The default value is the Looper of the thread that this builder was * to call listeners on.
* created on, or if that thread does not have a Looper, the Looper of the application's main *
* thread. * <p>The default value is the Looper of the thread that this builder was created on, or if that
* thread does not have a Looper, the Looper of the application's main thread.
* *
* @param looper A {@link Looper}. * @param looper A {@link Looper}.
* @return This builder. * @return This builder.
@ -303,8 +309,9 @@ public final class Transformer {
} }
/** /**
* Sets the {@link Codec.EncoderFactory} that will be used by the transformer. The default value * Sets the {@link Codec.EncoderFactory} that will be used by the transformer.
* is {@link Codec.EncoderFactory#DEFAULT}. *
* <p>The default value is {@link Codec.EncoderFactory#DEFAULT}.
* *
* @param encoderFactory The {@link Codec.EncoderFactory} instance. * @param encoderFactory The {@link Codec.EncoderFactory} instance.
* @return This builder. * @return This builder.
@ -316,8 +323,10 @@ public final class Transformer {
/** /**
* Sets a provider for views to show diagnostic information (if available) during * Sets a provider for views to show diagnostic information (if available) during
* transformation. This is intended for debugging. The default value is {@link * transformation.
* DebugViewProvider#NONE}, which doesn't show any debug info. *
* <p>This is intended for debugging. The default value is {@link DebugViewProvider#NONE}, which
* doesn't show any debug info.
* *
* <p>Not all transformations will result in debug views being populated. * <p>Not all transformations will result in debug views being populated.
* *
@ -330,8 +339,9 @@ public final class Transformer {
} }
/** /**
* Sets the {@link Clock} that will be used by the transformer. The default value is {@link * Sets the {@link Clock} that will be used by the transformer.
* Clock#DEFAULT}. *
* <p>The default value is {@link Clock#DEFAULT}.
* *
* @param clock The {@link Clock} instance. * @param clock The {@link Clock} instance.
* @return This builder. * @return This builder.
@ -344,8 +354,9 @@ public final class Transformer {
} }
/** /**
* Sets the factory for muxers that write the media container. The default value is a {@link * Sets the factory for muxers that write the media container.
* FrameworkMuxer.Factory}. *
* <p>The default value is a {@link FrameworkMuxer.Factory}.
* *
* @param muxerFactory A {@link Muxer.Factory}. * @param muxerFactory A {@link Muxer.Factory}.
* @return This builder. * @return This builder.