From cb7d565fd47fc0b818ec0d5c7529e19df44022b5 Mon Sep 17 00:00:00 2001 From: ibaker Date: Fri, 3 Mar 2023 19:08:33 +0000 Subject: [PATCH] Add missing `@param` tags Dackka generates a warning if a method has at least one `@param` tag, but not all of them are documented. #minor-release PiperOrigin-RevId: 513873453 --- .../src/main/java/androidx/media3/common/Timeline.java | 1 + .../src/main/java/androidx/media3/common/Tracks.java | 1 + .../src/main/java/androidx/media3/common/util/Util.java | 1 + .../java/androidx/media3/datasource/DataSourceUtil.java | 1 + .../java/androidx/media3/datasource/DefaultDataSource.java | 1 + .../main/java/androidx/media3/effect/BitmapOverlay.java | 3 +++ .../src/main/java/androidx/media3/effect/TextOverlay.java | 1 + .../androidx/media3/exoplayer/ExoPlaybackException.java | 2 ++ .../media3/exoplayer/drm/OfflineLicenseHelper.java | 1 + .../media3/exoplayer/mediacodec/MediaCodecRenderer.java | 1 + .../media3/exoplayer/offline/SegmentDownloader.java | 1 + .../exoplayer/trackselection/DefaultTrackSelector.java | 1 + .../exoplayer/trackselection/MappingTrackSelector.java | 1 + .../exoplayer/trackselection/RandomTrackSelection.java | 5 ++++- .../media3/exoplayer/video/DecoderVideoRenderer.java | 1 + .../androidx/media3/exoplayer/dash/DashChunkSource.java | 5 ++++- .../java/androidx/media3/exoplayer/hls/HlsMediaPeriod.java | 4 ++++ .../media3/exoplayer/hls/playlist/HlsMediaPlaylist.java | 4 ++++ .../java/androidx/media3/extractor/FlacFrameReader.java | 1 + .../media3/extractor/text/webvtt/WebvttCssStyle.java | 3 ++- .../main/java/androidx/media3/session/MediaSession.java | 1 + .../src/main/java/androidx/media3/test/utils/Action.java | 3 +++ .../java/androidx/media3/test/utils/ActionSchedule.java | 7 +++++-- .../androidx/media3/test/utils/BitmapPixelTestUtil.java | 2 ++ .../java/androidx/media3/test/utils/ExtractorAsserts.java | 3 +++ .../java/androidx/media3/test/utils/FakeMediaPeriod.java | 1 + .../java/androidx/media3/test/utils/FakeMediaSource.java | 1 + .../main/java/androidx/media3/test/utils/FakeTimeline.java | 3 +++ .../androidx/media3/test/utils/MediaSourceTestRunner.java | 1 + .../java/androidx/media3/test/utils/TimelineAsserts.java | 1 + 30 files changed, 57 insertions(+), 5 deletions(-) diff --git a/libraries/common/src/main/java/androidx/media3/common/Timeline.java b/libraries/common/src/main/java/androidx/media3/common/Timeline.java index d470b37b52..81459888a1 100644 --- a/libraries/common/src/main/java/androidx/media3/common/Timeline.java +++ b/libraries/common/src/main/java/androidx/media3/common/Timeline.java @@ -813,6 +813,7 @@ public abstract class Timeline implements Bundleable { * adGroupIndex}, or {@link AdPlaybackState#AD_STATE_UNAVAILABLE} if not yet known. * * @param adGroupIndex The ad group index. + * @param adIndexInAdGroup The index of the ad in the ad group. * @return The state of the ad, or {@link AdPlaybackState#AD_STATE_UNAVAILABLE} if not yet * known. */ diff --git a/libraries/common/src/main/java/androidx/media3/common/Tracks.java b/libraries/common/src/main/java/androidx/media3/common/Tracks.java index 28d2e89a97..734a8306b8 100644 --- a/libraries/common/src/main/java/androidx/media3/common/Tracks.java +++ b/libraries/common/src/main/java/androidx/media3/common/Tracks.java @@ -297,6 +297,7 @@ public final class Tracks implements Bundleable { * Returns true if at least one track of type {@code trackType} is {@link * Group#isTrackSupported(int, boolean) supported}. * + * @param trackType The track type to query support for. * @param allowExceedsCapabilities Whether to consider the track as supported if it has a * supported {@link Format#sampleMimeType MIME type}, but otherwise exceeds the advertised * capabilities of the device. For example, a video track for which there's a corresponding diff --git a/libraries/common/src/main/java/androidx/media3/common/util/Util.java b/libraries/common/src/main/java/androidx/media3/common/util/Util.java index 626598db1f..44f405e02b 100644 --- a/libraries/common/src/main/java/androidx/media3/common/util/Util.java +++ b/libraries/common/src/main/java/androidx/media3/common/util/Util.java @@ -1557,6 +1557,7 @@ public final class Util { * Returns the playout duration of {@code mediaDuration} of media. * * @param mediaDuration The duration to scale. + * @param speed The factor by which playback is sped up. * @return The scaled duration, in the same units as {@code mediaDuration}. */ @UnstableApi diff --git a/libraries/datasource/src/main/java/androidx/media3/datasource/DataSourceUtil.java b/libraries/datasource/src/main/java/androidx/media3/datasource/DataSourceUtil.java index e604619c7a..aa14615c8e 100644 --- a/libraries/datasource/src/main/java/androidx/media3/datasource/DataSourceUtil.java +++ b/libraries/datasource/src/main/java/androidx/media3/datasource/DataSourceUtil.java @@ -56,6 +56,7 @@ public final class DataSourceUtil { * array containing the read data. * * @param dataSource The source from which to read. + * @param length The number of bytes to read. * @return The read data. * @throws IOException If an error occurs reading from the source. * @throws IllegalStateException If the end of the source was reached before {@code length} bytes diff --git a/libraries/datasource/src/main/java/androidx/media3/datasource/DefaultDataSource.java b/libraries/datasource/src/main/java/androidx/media3/datasource/DefaultDataSource.java index 8a5e9d7df0..83de6a66e2 100644 --- a/libraries/datasource/src/main/java/androidx/media3/datasource/DefaultDataSource.java +++ b/libraries/datasource/src/main/java/androidx/media3/datasource/DefaultDataSource.java @@ -148,6 +148,7 @@ public final class DefaultDataSource implements DataSource { * Constructs a new instance, optionally configured to follow cross-protocol redirects. * * @param context A context. + * @param allowCrossProtocolRedirects Whether to allow cross-protocol redirects. */ @UnstableApi public DefaultDataSource(Context context, boolean allowCrossProtocolRedirects) { diff --git a/libraries/effect/src/main/java/androidx/media3/effect/BitmapOverlay.java b/libraries/effect/src/main/java/androidx/media3/effect/BitmapOverlay.java index 720b8d3477..0f12f16792 100644 --- a/libraries/effect/src/main/java/androidx/media3/effect/BitmapOverlay.java +++ b/libraries/effect/src/main/java/androidx/media3/effect/BitmapOverlay.java @@ -91,6 +91,8 @@ public abstract class BitmapOverlay extends TextureOverlay { /** * Creates a {@link BitmapOverlay} that shows the {@code overlayBitmap} in the same position and * size throughout the whole video. + * + * @param overlayBitmap The bitmap to overlay on the video. */ public static BitmapOverlay createStaticBitmapOverlay(Bitmap overlayBitmap) { return new BitmapOverlay() { @@ -105,6 +107,7 @@ public abstract class BitmapOverlay extends TextureOverlay { * Creates a {@link BitmapOverlay} that shows the {@code overlayBitmap} in the same {@link * OverlaySettings} throughout the whole video. * + * @param overlayBitmap The bitmap to overlay on the video. * @param overlaySettings The {@link OverlaySettings} configuring how the overlay is displayed on * the frames. */ diff --git a/libraries/effect/src/main/java/androidx/media3/effect/TextOverlay.java b/libraries/effect/src/main/java/androidx/media3/effect/TextOverlay.java index 9186c1c206..e0a95bdeaa 100644 --- a/libraries/effect/src/main/java/androidx/media3/effect/TextOverlay.java +++ b/libraries/effect/src/main/java/androidx/media3/effect/TextOverlay.java @@ -56,6 +56,7 @@ public abstract class TextOverlay extends BitmapOverlay { * Creates a {@link TextOverlay} that shows the {@code overlayText} with the same {@link * OverlaySettings} throughout the whole video. * + * @param overlayText The text to overlay on the video. * @param overlaySettings The {@link OverlaySettings} configuring how the overlay is displayed on * the frames. */ diff --git a/libraries/exoplayer/src/main/java/androidx/media3/exoplayer/ExoPlaybackException.java b/libraries/exoplayer/src/main/java/androidx/media3/exoplayer/ExoPlaybackException.java index 82a958ce16..3dc08580af 100644 --- a/libraries/exoplayer/src/main/java/androidx/media3/exoplayer/ExoPlaybackException.java +++ b/libraries/exoplayer/src/main/java/androidx/media3/exoplayer/ExoPlaybackException.java @@ -131,6 +131,8 @@ public final class ExoPlaybackException extends PlaybackException { * Creates an instance of type {@link #TYPE_RENDERER}. * * @param cause The cause of the failure. + * @param rendererName The {@linkplain Renderer#getName() name} of the renderer in which the + * failure occurred. * @param rendererIndex The index of the renderer in which the failure occurred. * @param rendererFormat The {@link Format} the renderer was using at the time of the exception, * or null if the renderer wasn't using a {@link Format}. diff --git a/libraries/exoplayer/src/main/java/androidx/media3/exoplayer/drm/OfflineLicenseHelper.java b/libraries/exoplayer/src/main/java/androidx/media3/exoplayer/drm/OfflineLicenseHelper.java index 3da5a1dbcd..ab7d4745d1 100644 --- a/libraries/exoplayer/src/main/java/androidx/media3/exoplayer/drm/OfflineLicenseHelper.java +++ b/libraries/exoplayer/src/main/java/androidx/media3/exoplayer/drm/OfflineLicenseHelper.java @@ -100,6 +100,7 @@ public final class OfflineLicenseHelper { * their own license URL. * @param forceDefaultLicenseUrl Whether to use {@code defaultLicenseUrl} for key requests that * include their own license URL. + * @param dataSourceFactory A factory from which to obtain {@link DataSource} instances. * @param optionalKeyRequestParameters An optional map of parameters to pass as the last argument * to {@link MediaDrm#getKeyRequest}. May be null. * @param eventDispatcher A {@link DrmSessionEventListener.EventDispatcher} used to distribute diff --git a/libraries/exoplayer/src/main/java/androidx/media3/exoplayer/mediacodec/MediaCodecRenderer.java b/libraries/exoplayer/src/main/java/androidx/media3/exoplayer/mediacodec/MediaCodecRenderer.java index 0f24ae5e17..4eae96de61 100644 --- a/libraries/exoplayer/src/main/java/androidx/media3/exoplayer/mediacodec/MediaCodecRenderer.java +++ b/libraries/exoplayer/src/main/java/androidx/media3/exoplayer/mediacodec/MediaCodecRenderer.java @@ -364,6 +364,7 @@ public abstract class MediaCodecRenderer extends BaseRenderer { /** * @param trackType The {@link C.TrackType track type} that the renderer handles. + * @param codecAdapterFactory A factory for {@link MediaCodecAdapter} instances. * @param mediaCodecSelector A decoder selector. * @param enableDecoderFallback Whether to enable fallback to lower-priority decoders if decoder * initialization fails. This may result in using a decoder that is less efficient or slower diff --git a/libraries/exoplayer/src/main/java/androidx/media3/exoplayer/offline/SegmentDownloader.java b/libraries/exoplayer/src/main/java/androidx/media3/exoplayer/offline/SegmentDownloader.java index 7a8ac0ba2b..9026fe11fa 100644 --- a/libraries/exoplayer/src/main/java/androidx/media3/exoplayer/offline/SegmentDownloader.java +++ b/libraries/exoplayer/src/main/java/androidx/media3/exoplayer/offline/SegmentDownloader.java @@ -326,6 +326,7 @@ public abstract class SegmentDownloader> impleme /** * Loads and parses a manifest. * + * @param dataSource The source to use when loading the manifest. * @param dataSpec The manifest {@link DataSpec}. * @param removing Whether the manifest is being loaded as part of the download being removed. * @return The loaded manifest. diff --git a/libraries/exoplayer/src/main/java/androidx/media3/exoplayer/trackselection/DefaultTrackSelector.java b/libraries/exoplayer/src/main/java/androidx/media3/exoplayer/trackselection/DefaultTrackSelector.java index 50a0ab216d..fcb61e3e8c 100644 --- a/libraries/exoplayer/src/main/java/androidx/media3/exoplayer/trackselection/DefaultTrackSelector.java +++ b/libraries/exoplayer/src/main/java/androidx/media3/exoplayer/trackselection/DefaultTrackSelector.java @@ -2446,6 +2446,7 @@ public class DefaultTrackSelector extends MappingTrackSelector { * renderer, track group and track (in that order). * @param rendererMixedMimeTypeAdaptationSupports The {@link AdaptiveSupport} for mixed MIME type * adaptation for the renderer. + * @param params The parameters to use for the track selection. * @return The {@link ExoTrackSelection.Definition}s for the renderers. A null entry indicates no * selection was made. * @throws ExoPlaybackException If an error occurs while selecting the tracks. diff --git a/libraries/exoplayer/src/main/java/androidx/media3/exoplayer/trackselection/MappingTrackSelector.java b/libraries/exoplayer/src/main/java/androidx/media3/exoplayer/trackselection/MappingTrackSelector.java index 8f111e73ab..de8f026c39 100644 --- a/libraries/exoplayer/src/main/java/androidx/media3/exoplayer/trackselection/MappingTrackSelector.java +++ b/libraries/exoplayer/src/main/java/androidx/media3/exoplayer/trackselection/MappingTrackSelector.java @@ -289,6 +289,7 @@ public abstract class MappingTrackSelector extends TrackSelector { * * @param rendererIndex The renderer index. * @param groupIndex The index of the track group. + * @param trackIndices The indices of the tracks in the track group for which to query support. * @return The {@link AdaptiveSupport}. */ public @AdaptiveSupport int getAdaptiveSupport( diff --git a/libraries/exoplayer/src/main/java/androidx/media3/exoplayer/trackselection/RandomTrackSelection.java b/libraries/exoplayer/src/main/java/androidx/media3/exoplayer/trackselection/RandomTrackSelection.java index 0db95a86bc..9e5d9a1b71 100644 --- a/libraries/exoplayer/src/main/java/androidx/media3/exoplayer/trackselection/RandomTrackSelection.java +++ b/libraries/exoplayer/src/main/java/androidx/media3/exoplayer/trackselection/RandomTrackSelection.java @@ -68,12 +68,15 @@ public final class RandomTrackSelection extends BaseTrackSelection { private int selectedIndex; /** + * Creates a new instance. + * * @param group The {@link TrackGroup}. Must not be null. * @param tracks The indices of the selected tracks within the {@link TrackGroup}. Must not be * null or empty. May be in any order. + * @param type The {@link Type} of this track selection. * @param random A source of random numbers. */ - public RandomTrackSelection(TrackGroup group, int[] tracks, int type, Random random) { + public RandomTrackSelection(TrackGroup group, int[] tracks, @Type int type, Random random) { super(group, tracks, type); this.random = random; selectedIndex = random.nextInt(length); diff --git a/libraries/exoplayer/src/main/java/androidx/media3/exoplayer/video/DecoderVideoRenderer.java b/libraries/exoplayer/src/main/java/androidx/media3/exoplayer/video/DecoderVideoRenderer.java index 2f247237d2..e1e03f875b 100644 --- a/libraries/exoplayer/src/main/java/androidx/media3/exoplayer/video/DecoderVideoRenderer.java +++ b/libraries/exoplayer/src/main/java/androidx/media3/exoplayer/video/DecoderVideoRenderer.java @@ -651,6 +651,7 @@ public abstract class DecoderVideoRenderer extends BaseRenderer { * *

The default implementation does not allow decoder reuse. * + * @param decoderName The name of the decoder. * @param oldFormat The previous format. * @param newFormat The new format. * @return The result of the evaluation. diff --git a/libraries/exoplayer_dash/src/main/java/androidx/media3/exoplayer/dash/DashChunkSource.java b/libraries/exoplayer_dash/src/main/java/androidx/media3/exoplayer/dash/DashChunkSource.java index 11c18a3970..f26c8fd734 100644 --- a/libraries/exoplayer_dash/src/main/java/androidx/media3/exoplayer/dash/DashChunkSource.java +++ b/libraries/exoplayer_dash/src/main/java/androidx/media3/exoplayer/dash/DashChunkSource.java @@ -50,6 +50,8 @@ public interface DashChunkSource extends ChunkSource { * if unknown. * @param enableEventMessageTrack Whether to output an event message track. * @param closedCaptionFormats The {@link Format Formats} of closed caption tracks to be output. + * @param playerEmsgHandler The track output to write emsg messages to, or null if emsgs + * shouldn't be written. * @param transferListener The transfer listener which should be informed of any data transfers. * May be null if no listener is available. * @param playerId The {@link PlayerId} of the player using this chunk source. @@ -75,8 +77,9 @@ public interface DashChunkSource extends ChunkSource { * Updates the manifest. * * @param newManifest The new manifest. + * @param newPeriodIndex The index of the period covered by {@code newManifest}. */ - void updateManifest(DashManifest newManifest, int periodIndex); + void updateManifest(DashManifest newManifest, int newPeriodIndex); /** * Updates the track selection. diff --git a/libraries/exoplayer_hls/src/main/java/androidx/media3/exoplayer/hls/HlsMediaPeriod.java b/libraries/exoplayer_hls/src/main/java/androidx/media3/exoplayer/hls/HlsMediaPeriod.java index c4bcfc50ec..63d2b931d1 100644 --- a/libraries/exoplayer_hls/src/main/java/androidx/media3/exoplayer/hls/HlsMediaPeriod.java +++ b/libraries/exoplayer_hls/src/main/java/androidx/media3/exoplayer/hls/HlsMediaPeriod.java @@ -104,13 +104,17 @@ public final class HlsMediaPeriod implements MediaPeriod, HlsPlaylistTracker.Pla * be null if no listener is available. * @param drmSessionManager The {@link DrmSessionManager} to acquire {@link DrmSession * DrmSessions} with. + * @param drmEventDispatcher A {@link DrmSessionEventListener.EventDispatcher} used to distribute + * DRM-related events. * @param loadErrorHandlingPolicy A {@link LoadErrorHandlingPolicy}. * @param eventDispatcher A dispatcher to notify of events. * @param allocator An {@link Allocator} from which to obtain media buffer allocations. * @param compositeSequenceableLoaderFactory A factory to create composite {@link * SequenceableLoader}s for when this media source loads data from multiple streams. * @param allowChunklessPreparation Whether chunkless preparation is allowed. + * @param metadataType The type of metadata to extract from the period. * @param useSessionKeys Whether to use #EXT-X-SESSION-KEY tags. + * @param playerId The ID of the current player. */ public HlsMediaPeriod( HlsExtractorFactory extractorFactory, diff --git a/libraries/exoplayer_hls/src/main/java/androidx/media3/exoplayer/hls/playlist/HlsMediaPlaylist.java b/libraries/exoplayer_hls/src/main/java/androidx/media3/exoplayer/hls/playlist/HlsMediaPlaylist.java index fb2444d4bb..5e6baec46b 100644 --- a/libraries/exoplayer_hls/src/main/java/androidx/media3/exoplayer/hls/playlist/HlsMediaPlaylist.java +++ b/libraries/exoplayer_hls/src/main/java/androidx/media3/exoplayer/hls/playlist/HlsMediaPlaylist.java @@ -462,16 +462,20 @@ public final class HlsMediaPlaylist extends HlsPlaylist { public final ServerControl serverControl; /** + * Constructs an instance. + * * @param playlistType See {@link #playlistType}. * @param baseUri See {@link #baseUri}. * @param tags See {@link #tags}. * @param startOffsetUs See {@link #startOffsetUs}. + * @param preciseStart See {@link #preciseStart}. * @param startTimeUs See {@link #startTimeUs}. * @param hasDiscontinuitySequence See {@link #hasDiscontinuitySequence}. * @param discontinuitySequence See {@link #discontinuitySequence}. * @param mediaSequence See {@link #mediaSequence}. * @param version See {@link #version}. * @param targetDurationUs See {@link #targetDurationUs}. + * @param partTargetDurationUs See {@link #partTargetDurationUs}. * @param hasIndependentSegments See {@link #hasIndependentSegments}. * @param hasEndTag See {@link #hasEndTag}. * @param hasProgramDateTime See {@link #hasProgramDateTime}. diff --git a/libraries/extractor/src/main/java/androidx/media3/extractor/FlacFrameReader.java b/libraries/extractor/src/main/java/androidx/media3/extractor/FlacFrameReader.java index 078982c6f0..79123d3c69 100644 --- a/libraries/extractor/src/main/java/androidx/media3/extractor/FlacFrameReader.java +++ b/libraries/extractor/src/main/java/androidx/media3/extractor/FlacFrameReader.java @@ -132,6 +132,7 @@ public final class FlacFrameReader { * there is no guarantee on the peek position. * * @param input Input stream to get the sample number from (starting from the read position). + * @param flacStreamMetadata The FLAC metadata of the stream. * @return The frame first sample number. * @throws ParserException If an error occurs parsing the sample number. * @throws IOException If peeking from the input fails. diff --git a/libraries/extractor/src/main/java/androidx/media3/extractor/text/webvtt/WebvttCssStyle.java b/libraries/extractor/src/main/java/androidx/media3/extractor/text/webvtt/WebvttCssStyle.java index e27eefdb0f..9908fe5a7b 100644 --- a/libraries/extractor/src/main/java/androidx/media3/extractor/text/webvtt/WebvttCssStyle.java +++ b/libraries/extractor/src/main/java/androidx/media3/extractor/text/webvtt/WebvttCssStyle.java @@ -152,12 +152,13 @@ public final class WebvttCssStyle { *

  • Universal selector matching scores 1. * * + *

    See also CSS Cascading. + * * @param id The id of the cue if present, {@code null} otherwise. * @param tag Name of the tag, {@code null} if it refers to the entire cue. * @param classes An array containing the classes the tag belongs to. Must not be null. * @param voice Annotated voice if present, {@code null} otherwise. * @return The score of the match, zero if there is no match. - * @see CSS Cascading */ public int getSpecificityScore( @Nullable String id, @Nullable String tag, Set classes, @Nullable String voice) { diff --git a/libraries/session/src/main/java/androidx/media3/session/MediaSession.java b/libraries/session/src/main/java/androidx/media3/session/MediaSession.java index d13592099b..e085401e69 100644 --- a/libraries/session/src/main/java/androidx/media3/session/MediaSession.java +++ b/libraries/session/src/main/java/androidx/media3/session/MediaSession.java @@ -817,6 +817,7 @@ public class MediaSession { * *

    A command is not accepted if it is not a custom command. * + * @param controller The controller to send the custom command to. * @param command A custom command. * @param args A {@link Bundle} for additional arguments. May be empty. * @return A {@link ListenableFuture} of {@link SessionResult} from the controller. diff --git a/libraries/test_utils/src/main/java/androidx/media3/test/utils/Action.java b/libraries/test_utils/src/main/java/androidx/media3/test/utils/Action.java index 5b5ed5b678..ac5aff5611 100644 --- a/libraries/test_utils/src/main/java/androidx/media3/test/utils/Action.java +++ b/libraries/test_utils/src/main/java/androidx/media3/test/utils/Action.java @@ -1098,7 +1098,10 @@ public abstract class Action { private final Runnable runnable; /** + * Constructs an instance. + * * @param tag A tag to use for logging. + * @param runnable The runnable to run. */ public ExecuteRunnable(@Size(max = 23) String tag, Runnable runnable) { super(tag, "ExecuteRunnable"); diff --git a/libraries/test_utils/src/main/java/androidx/media3/test/utils/ActionSchedule.java b/libraries/test_utils/src/main/java/androidx/media3/test/utils/ActionSchedule.java index 019b9c4699..beafa0419e 100644 --- a/libraries/test_utils/src/main/java/androidx/media3/test/utils/ActionSchedule.java +++ b/libraries/test_utils/src/main/java/androidx/media3/test/utils/ActionSchedule.java @@ -349,7 +349,7 @@ public final class ActionSchedule { } /** - * Schedules a set media items action to be executed. + * Schedules a set media source actions to be executed. * * @param mediaItemIndex The media item index to start playback from or {@link C#INDEX_UNSET} if * the playback position should not be reset. @@ -357,6 +357,7 @@ public final class ActionSchedule { * C#TIME_UNSET} is passed the default position is used. In any case, if {@code * mediaItemIndex} is set to {@link C#INDEX_UNSET} the position is not reset at all and this * parameter is ignored. + * @param sources The media sources to be set on the player. * @return The builder, for convenience. */ @CanIgnoreReturnValue @@ -365,9 +366,10 @@ public final class ActionSchedule { } /** - * Schedules a set media items action to be executed. + * Schedules a set media sources action to be executed. * * @param resetPosition Whether the playback position should be reset. + * @param sources The media sources to be set on the player. * @return The builder, for convenience. */ @CanIgnoreReturnValue @@ -490,6 +492,7 @@ public final class ActionSchedule { /** * Schedules sending a {@link PlayerMessage}. * + * @param target A message target. * @param positionMs The position in the current media item at which the message should be sent, * in milliseconds. * @return The builder, for convenience. diff --git a/libraries/test_utils/src/main/java/androidx/media3/test/utils/BitmapPixelTestUtil.java b/libraries/test_utils/src/main/java/androidx/media3/test/utils/BitmapPixelTestUtil.java index d620356819..50a3942d23 100644 --- a/libraries/test_utils/src/main/java/androidx/media3/test/utils/BitmapPixelTestUtil.java +++ b/libraries/test_utils/src/main/java/androidx/media3/test/utils/BitmapPixelTestUtil.java @@ -106,6 +106,8 @@ public class BitmapPixelTestUtil { /** * Returns a solid {@link Bitmap} with every pixel having the same color. * + * @param width The width of image to create, in pixels. + * @param height The height of image to create, in pixels. * @param color An RGBA color created by {@link Color}. */ public static Bitmap createArgb8888BitmapWithSolidColor(int width, int height, int color) { diff --git a/libraries/test_utils/src/main/java/androidx/media3/test/utils/ExtractorAsserts.java b/libraries/test_utils/src/main/java/androidx/media3/test/utils/ExtractorAsserts.java index 3ed82c380a..979ac9d097 100644 --- a/libraries/test_utils/src/main/java/androidx/media3/test/utils/ExtractorAsserts.java +++ b/libraries/test_utils/src/main/java/androidx/media3/test/utils/ExtractorAsserts.java @@ -360,6 +360,9 @@ public final class ExtractorAsserts { * *

    The output of the extractor is compared against prerecorded dump files. * + * @param factory An {@link ExtractorFactory} which creates instances of the {@link Extractor} + * class which is to be tested. + * @param file The input file to pass to the extractor. * @param assertionConfig Details of how to read and process the source and dump files. * @param simulationConfig Details on the environment to simulate and behaviours to assert. * @throws IOException If reading from the input fails. diff --git a/libraries/test_utils/src/main/java/androidx/media3/test/utils/FakeMediaPeriod.java b/libraries/test_utils/src/main/java/androidx/media3/test/utils/FakeMediaPeriod.java index 858a67f178..c3d00e0de8 100644 --- a/libraries/test_utils/src/main/java/androidx/media3/test/utils/FakeMediaPeriod.java +++ b/libraries/test_utils/src/main/java/androidx/media3/test/utils/FakeMediaPeriod.java @@ -375,6 +375,7 @@ public class FakeMediaPeriod implements MediaPeriod { /** * Creates a new {@link FakeSampleStream}. * + * @param allocator An {@link Allocator} from which to obtain media buffer allocations. * @param mediaSourceEventDispatcher A {@link MediaSourceEventListener.EventDispatcher} to notify * of media events. * @param drmSessionManager A {@link DrmSessionManager} for DRM interactions. diff --git a/libraries/test_utils/src/main/java/androidx/media3/test/utils/FakeMediaSource.java b/libraries/test_utils/src/main/java/androidx/media3/test/utils/FakeMediaSource.java index f72c34c1f4..8a9cc508a6 100644 --- a/libraries/test_utils/src/main/java/androidx/media3/test/utils/FakeMediaSource.java +++ b/libraries/test_utils/src/main/java/androidx/media3/test/utils/FakeMediaSource.java @@ -339,6 +339,7 @@ public class FakeMediaSource extends BaseMediaSource { * @param allocator An {@link Allocator} from which to obtain media buffer allocations. * @param mediaSourceEventDispatcher An {@link MediaSourceEventListener.EventDispatcher} to * dispatch media source events. + * @param drmSessionManager A {@link DrmSessionManager} to allow DRM interactions. * @param drmEventDispatcher An {@link MediaSourceEventListener.EventDispatcher} to dispatch DRM * events. * @param transferListener The transfer listener which should be informed of any data transfers. diff --git a/libraries/test_utils/src/main/java/androidx/media3/test/utils/FakeTimeline.java b/libraries/test_utils/src/main/java/androidx/media3/test/utils/FakeTimeline.java index 668da3bfdc..8b7ff8cad4 100644 --- a/libraries/test_utils/src/main/java/androidx/media3/test/utils/FakeTimeline.java +++ b/libraries/test_utils/src/main/java/androidx/media3/test/utils/FakeTimeline.java @@ -393,6 +393,7 @@ public final class FakeTimeline extends Timeline { /** * Creates a fake timeline with the given window definitions. * + * @param manifests The manifests of the windows. * @param windowDefinitions A list of {@link TimelineWindowDefinition}s. */ public FakeTimeline(Object[] manifests, TimelineWindowDefinition... windowDefinitions) { @@ -403,6 +404,8 @@ public final class FakeTimeline extends Timeline { * Creates a fake timeline with the given window definitions and {@link * androidx.media3.exoplayer.source.ShuffleOrder}. * + * @param manifests The manifests of the windows. + * @param shuffleOrder A shuffle ordering for the windows. * @param windowDefinitions A list of {@link TimelineWindowDefinition}s. */ public FakeTimeline( diff --git a/libraries/test_utils/src/main/java/androidx/media3/test/utils/MediaSourceTestRunner.java b/libraries/test_utils/src/main/java/androidx/media3/test/utils/MediaSourceTestRunner.java index c6c3970a79..7946e94345 100644 --- a/libraries/test_utils/src/main/java/androidx/media3/test/utils/MediaSourceTestRunner.java +++ b/libraries/test_utils/src/main/java/androidx/media3/test/utils/MediaSourceTestRunner.java @@ -152,6 +152,7 @@ public class MediaSourceTestRunner { * playback thread, asserting that a non-null {@link MediaPeriod} is returned. * * @param periodId The id of the period to create. + * @param startPositionUs The expected start position, in microseconds. * @return The created {@link MediaPeriod}. */ public MediaPeriod createPeriod(final MediaPeriodId periodId, long startPositionUs) { diff --git a/libraries/test_utils/src/main/java/androidx/media3/test/utils/TimelineAsserts.java b/libraries/test_utils/src/main/java/androidx/media3/test/utils/TimelineAsserts.java index 241a179fc4..c28e0f0926 100644 --- a/libraries/test_utils/src/main/java/androidx/media3/test/utils/TimelineAsserts.java +++ b/libraries/test_utils/src/main/java/androidx/media3/test/utils/TimelineAsserts.java @@ -50,6 +50,7 @@ public final class TimelineAsserts { /** * Asserts that window tags are set correctly. * + * @param timeline The timeline to read actual window tags from. * @param expectedWindowTags A list of expected window tags. If a tag is unknown or not important * {@code null} can be passed to skip this window. */