Skip to content

SDK / exoplayer

Go to a project
Commit 87d8ca0a by Ian Baker
Options

Reformat some javadoc

parent 90db1d86
Expand all
Inline Side-by-side
Showing with 861 additions and 287 deletions
demos/main/src/main/java/com/google/android/exoplayer2/demo/PlayerActivity.java
......@@ -260,7 +260,9 @@ public class PlayerActivity extends AppCompatActivity
setContentView(R.layout.player_activity);
}
/** @return Whether initialization was successful. */
/**
* @return Whether initialization was successful.
*/
protected boolean initializePlayer() {
if (player == null) {
Intent intent = getIntent();
......
extensions/cast/src/main/java/com/google/android/exoplayer2/ext/cast/CastTrackSelection.java
......@@ -31,7 +31,9 @@ import com.google.android.exoplayer2.util.Assertions;
private final TrackGroup trackGroup;
/** @param trackGroup The {@link TrackGroup} from which the first track will only be selected. */
/**
* @param trackGroup The {@link TrackGroup} from which the first track will only be selected.
*/
public CastTrackSelection(TrackGroup trackGroup) {
this.trackGroup = trackGroup;
}
......
extensions/cronet/src/main/java/com/google/android/exoplayer2/ext/cronet/CronetDataSource.java
......@@ -343,7 +343,9 @@ public class CronetDataSource extends BaseDataSource implements HttpDataSource {
*/
public final int cronetConnectionStatus;
/** @deprecated Use {@link #OpenException(IOException, DataSpec, int, int)}. */
/**
* @deprecated Use {@link #OpenException(IOException, DataSpec, int, int)}.
*/
@Deprecated
public OpenException(IOException cause, DataSpec dataSpec, int cronetConnectionStatus) {
super(cause, dataSpec, PlaybackException.ERROR_CODE_IO_UNSPECIFIED, TYPE_OPEN);
......@@ -359,7 +361,9 @@ public class CronetDataSource extends BaseDataSource implements HttpDataSource {
this.cronetConnectionStatus = cronetConnectionStatus;
}
/** @deprecated Use {@link #OpenException(String, DataSpec, int, int)}. */
/**
* @deprecated Use {@link #OpenException(String, DataSpec, int, int)}.
*/
@Deprecated
public OpenException(String errorMessage, DataSpec dataSpec, int cronetConnectionStatus) {
super(errorMessage, dataSpec, PlaybackException.ERROR_CODE_IO_UNSPECIFIED, TYPE_OPEN);
......
extensions/cronet/src/main/java/com/google/android/exoplayer2/ext/cronet/CronetDataSourceFactory.java
......@@ -25,7 +25,9 @@ import com.google.android.exoplayer2.upstream.TransferListener;
import java.util.concurrent.Executor;
import org.chromium.net.CronetEngine;
/** @deprecated Use {@link CronetDataSource.Factory} instead. */
/**
* @deprecated Use {@link CronetDataSource.Factory} instead.
*/
@Deprecated
public final class CronetDataSourceFactory extends BaseFactory {
......
extensions/okhttp/src/main/java/com/google/android/exoplayer2/ext/okhttp/OkHttpDataSource.java
......@@ -179,21 +179,27 @@ public class OkHttpDataSource extends BaseDataSource implements HttpDataSource {
private long bytesToRead;
private long bytesRead;
/** @deprecated Use {@link OkHttpDataSource.Factory} instead. */
/**
* @deprecated Use {@link OkHttpDataSource.Factory} instead.
*/
@SuppressWarnings("deprecation")
@Deprecated
public OkHttpDataSource(Call.Factory callFactory) {
this(callFactory, /* userAgent= */ null);
}
/** @deprecated Use {@link OkHttpDataSource.Factory} instead. */
/**
* @deprecated Use {@link OkHttpDataSource.Factory} instead.
*/
@SuppressWarnings("deprecation")
@Deprecated
public OkHttpDataSource(Call.Factory callFactory, @Nullable String userAgent) {
this(callFactory, userAgent, /* cacheControl= */ null, /* defaultRequestProperties= */ null);
}
/** @deprecated Use {@link OkHttpDataSource.Factory} instead. */
/**
* @deprecated Use {@link OkHttpDataSource.Factory} instead.
*/
@Deprecated
public OkHttpDataSource(
Call.Factory callFactory,
......
extensions/okhttp/src/main/java/com/google/android/exoplayer2/ext/okhttp/OkHttpDataSourceFactory.java
......@@ -22,7 +22,9 @@ import com.google.android.exoplayer2.upstream.TransferListener;
import okhttp3.CacheControl;
import okhttp3.Call;
/** @deprecated Use {@link OkHttpDataSource.Factory} instead. */
/**
* @deprecated Use {@link OkHttpDataSource.Factory} instead.
*/
@Deprecated
public final class OkHttpDataSourceFactory extends BaseFactory {
......
extensions/rtmp/src/main/java/com/google/android/exoplayer2/ext/rtmp/RtmpDataSourceFactory.java
......@@ -19,7 +19,9 @@ import androidx.annotation.Nullable;
import com.google.android.exoplayer2.upstream.DataSource;
import com.google.android.exoplayer2.upstream.TransferListener;
/** @deprecated Use {@link RtmpDataSource.Factory} instead. */
/**
* @deprecated Use {@link RtmpDataSource.Factory} instead.
*/
@Deprecated
public final class RtmpDataSourceFactory implements DataSource.Factory {
......@@ -29,7 +31,9 @@ public final class RtmpDataSourceFactory implements DataSource.Factory {
this(null);
}
/** @param listener An optional listener. */
/**
* @param listener An optional listener.
*/
public RtmpDataSourceFactory(@Nullable TransferListener listener) {
this.listener = listener;
}
......
extensions/workmanager/src/main/java/com/google/android/exoplayer2/ext/workmanager/WorkManagerScheduler.java
......@@ -54,7 +54,9 @@ public final class WorkManagerScheduler implements Scheduler {
private final WorkManager workManager;
private final String workName;
/** @deprecated Call {@link #WorkManagerScheduler(Context, String)} instead. */
/**
* @deprecated Call {@link #WorkManagerScheduler(Context, String)} instead.
*/
@Deprecated
@SuppressWarnings("deprecation")
public WorkManagerScheduler(String workName) {
......
library/common/src/main/java/com/google/android/exoplayer2/Format.java
......@@ -771,7 +771,9 @@ public final class Format implements Bundleable {
// Video.
/** @deprecated Use {@link Format.Builder}. */
/**
* @deprecated Use {@link Format.Builder}.
*/
@Deprecated
public static Format createVideoSampleFormat(
@Nullable String id,
......@@ -799,7 +801,9 @@ public final class Format implements Bundleable {
.build();
}
/** @deprecated Use {@link Format.Builder}. */
/**
* @deprecated Use {@link Format.Builder}.
*/
@Deprecated
public static Format createVideoSampleFormat(
@Nullable String id,
......@@ -833,7 +837,9 @@ public final class Format implements Bundleable {
// Audio.
/** @deprecated Use {@link Format.Builder}. */
/**
* @deprecated Use {@link Format.Builder}.
*/
@Deprecated
public static Format createAudioSampleFormat(
@Nullable String id,
......@@ -863,7 +869,9 @@ public final class Format implements Bundleable {
.build();
}
/** @deprecated Use {@link Format.Builder}. */
/**
* @deprecated Use {@link Format.Builder}.
*/
@Deprecated
public static Format createAudioSampleFormat(
@Nullable String id,
......@@ -897,7 +905,9 @@ public final class Format implements Bundleable {
// Generic.
/** @deprecated Use {@link Format.Builder}. */
/**
* @deprecated Use {@link Format.Builder}.
*/
@Deprecated
public static Format createContainerFormat(
@Nullable String id,
......@@ -923,7 +933,9 @@ public final class Format implements Bundleable {
.build();
}
/** @deprecated Use {@link Format.Builder}. */
/**
* @deprecated Use {@link Format.Builder}.
*/
@Deprecated
public static Format createSampleFormat(@Nullable String id, @Nullable String sampleMimeType) {
return new Builder().setId(id).setSampleMimeType(sampleMimeType).build();
......@@ -981,25 +993,33 @@ public final class Format implements Bundleable {
return new Builder(this);
}
/** @deprecated Use {@link #buildUpon()} and {@link Builder#setMaxInputSize(int)}. */
/**
* @deprecated Use {@link #buildUpon()} and {@link Builder#setMaxInputSize(int)}.
*/
@Deprecated
public Format copyWithMaxInputSize(int maxInputSize) {
return buildUpon().setMaxInputSize(maxInputSize).build();
}
/** @deprecated Use {@link #buildUpon()} and {@link Builder#setSubsampleOffsetUs(long)}. */
/**
* @deprecated Use {@link #buildUpon()} and {@link Builder#setSubsampleOffsetUs(long)}.
*/
@Deprecated
public Format copyWithSubsampleOffsetUs(long subsampleOffsetUs) {
return buildUpon().setSubsampleOffsetUs(subsampleOffsetUs).build();
}
/** @deprecated Use {@link #buildUpon()} and {@link Builder#setLabel(String)} . */
/**
* @deprecated Use {@link #buildUpon()} and {@link Builder#setLabel(String)} .
*/
@Deprecated
public Format copyWithLabel(@Nullable String label) {
return buildUpon().setLabel(label).build();
}
/** @deprecated Use {@link #withManifestFormatInfo(Format)}. */
/**
* @deprecated Use {@link #withManifestFormatInfo(Format)}.
*/
@Deprecated
public Format copyWithManifestFormatInfo(Format manifestFormat) {
return withManifestFormatInfo(manifestFormat);
......@@ -1081,19 +1101,25 @@ public final class Format implements Bundleable {
return buildUpon().setEncoderDelay(encoderDelay).setEncoderPadding(encoderPadding).build();
}
/** @deprecated Use {@link #buildUpon()} and {@link Builder#setFrameRate(float)}. */
/**
* @deprecated Use {@link #buildUpon()} and {@link Builder#setFrameRate(float)}.
*/
@Deprecated
public Format copyWithFrameRate(float frameRate) {
return buildUpon().setFrameRate(frameRate).build();
}
/** @deprecated Use {@link #buildUpon()} and {@link Builder#setDrmInitData(DrmInitData)}. */
/**
* @deprecated Use {@link #buildUpon()} and {@link Builder#setDrmInitData(DrmInitData)}.
*/
@Deprecated
public Format copyWithDrmInitData(@Nullable DrmInitData drmInitData) {
return buildUpon().setDrmInitData(drmInitData).build();
}
/** @deprecated Use {@link #buildUpon()} and {@link Builder#setMetadata(Metadata)}. */
/**
* @deprecated Use {@link #buildUpon()} and {@link Builder#setMetadata(Metadata)}.
*/
@Deprecated
public Format copyWithMetadata(@Nullable Metadata metadata) {
return buildUpon().setMetadata(metadata).build();
......
library/common/src/main/java/com/google/android/exoplayer2/MediaItem.java
......@@ -686,7 +686,9 @@ public final class MediaItem implements Bundleable {
/** The UUID of the protection scheme. */
public final UUID scheme;
/** @deprecated Use {@link #scheme} instead. */
/**
* @deprecated Use {@link #scheme} instead.
*/
@Deprecated public final UUID uuid;
/**
......@@ -695,7 +697,9 @@ public final class MediaItem implements Bundleable {
*/
@Nullable public final Uri licenseUri;
/** @deprecated Use {@link #licenseRequestHeaders} instead. */
/**
* @deprecated Use {@link #licenseRequestHeaders} instead.
*/
@Deprecated public final ImmutableMap<String, String> requestHeaders;
/** The headers to attach to requests sent to the DRM license server. */
......@@ -716,7 +720,9 @@ public final class MediaItem implements Bundleable {
*/
public final boolean forceDefaultLicenseUri;
/** @deprecated Use {@link #forcedSessionTrackTypes}. */
/**
* @deprecated Use {@link #forcedSessionTrackTypes}.
*/
@Deprecated public final ImmutableList<@C.TrackType Integer> sessionForClearTypes;
/**
* The types of tracks for which to always use a DRM session even if the content is unencrypted.
......@@ -903,7 +909,9 @@ public final class MediaItem implements Bundleable {
/** Optional subtitles to be sideloaded. */
public final ImmutableList<SubtitleConfiguration> subtitleConfigurations;
/** @deprecated Use {@link #subtitleConfigurations} instead. */
/**
* @deprecated Use {@link #subtitleConfigurations} instead.
*/
@Deprecated public final List<Subtitle> subtitles;
/**
......@@ -972,7 +980,9 @@ public final class MediaItem implements Bundleable {
}
}
/** @deprecated Use {@link LocalConfiguration}. */
/**
* @deprecated Use {@link LocalConfiguration}.
*/
@Deprecated
public static final class PlaybackProperties extends LocalConfiguration {
......@@ -1133,7 +1143,9 @@ public final class MediaItem implements Bundleable {
builder.maxPlaybackSpeed);
}
/** @deprecated Use {@link Builder} instead. */
/**
* @deprecated Use {@link Builder} instead.
*/
@Deprecated
public LiveConfiguration(
long targetOffsetMs,
......@@ -1397,24 +1409,32 @@ public final class MediaItem implements Bundleable {
}
}
/** @deprecated Use {@link MediaItem.SubtitleConfiguration} instead */
/**
* @deprecated Use {@link MediaItem.SubtitleConfiguration} instead
*/
@Deprecated
public static final class Subtitle extends SubtitleConfiguration {
/** @deprecated Use {@link Builder} instead. */
/**
* @deprecated Use {@link Builder} instead.
*/
@Deprecated
public Subtitle(Uri uri, String mimeType, @Nullable String language) {
this(uri, mimeType, language, /* selectionFlags= */ 0);
}
/** @deprecated Use {@link Builder} instead. */
/**
* @deprecated Use {@link Builder} instead.
*/
@Deprecated
public Subtitle(
Uri uri, String mimeType, @Nullable String language, @C.SelectionFlags int selectionFlags) {
this(uri, mimeType, language, selectionFlags, /* roleFlags= */ 0, /* label= */ null);
}
/** @deprecated Use {@link Builder} instead. */
/**
* @deprecated Use {@link Builder} instead.
*/
@Deprecated
public Subtitle(
Uri uri,
......@@ -1516,7 +1536,9 @@ public final class MediaItem implements Bundleable {
return buildClippingProperties();
}
/** @deprecated Use {@link #build()} instead. */
/**
* @deprecated Use {@link #build()} instead.
*/
@Deprecated
public ClippingProperties buildClippingProperties() {
return new ClippingProperties(this);
......@@ -1643,7 +1665,9 @@ public final class MediaItem implements Bundleable {
}
}
/** @deprecated Use {@link ClippingConfiguration} instead. */
/**
* @deprecated Use {@link ClippingConfiguration} instead.
*/
@Deprecated
public static final class ClippingProperties extends ClippingConfiguration {
public static final ClippingProperties UNSET =
......@@ -1671,7 +1695,9 @@ public final class MediaItem implements Bundleable {
* boundaries.
*/
@Nullable public final LocalConfiguration localConfiguration;
/** @deprecated Use {@link #localConfiguration} instead. */
/**
* @deprecated Use {@link #localConfiguration} instead.
*/
@Deprecated @Nullable public final PlaybackProperties playbackProperties;
/** The live playback configuration. */
......@@ -1682,7 +1708,9 @@ public final class MediaItem implements Bundleable {
/** The clipping properties. */
public final ClippingConfiguration clippingConfiguration;
/** @deprecated Use {@link #clippingConfiguration} instead. */
/**
* @deprecated Use {@link #clippingConfiguration} instead.
*/
@Deprecated public final ClippingProperties clippingProperties;
// Using PlaybackProperties and ClippingProperties until they're deleted.
......
library/common/src/main/java/com/google/android/exoplayer2/MediaMetadata.java
......@@ -247,7 +247,9 @@ public final class MediaMetadata implements Bundleable {
return this;
}
/** @deprecated Use {@link #setRecordingYear(Integer)} instead. */
/**
* @deprecated Use {@link #setRecordingYear(Integer)} instead.
*/
@Deprecated
public Builder setYear(@Nullable Integer year) {
return setRecordingYear(year);
......@@ -649,7 +651,9 @@ public final class MediaMetadata implements Bundleable {
@Nullable public final @FolderType Integer folderType;
/** Optional boolean for media playability. */
@Nullable public final Boolean isPlayable;
/** @deprecated Use {@link #recordingYear} instead. */
/**
* @deprecated Use {@link #recordingYear} instead.
*/
@Deprecated @Nullable public final Integer year;
/** Optional year of the recording date. */
@Nullable public final Integer recordingYear;
......
library/common/src/main/java/com/google/android/exoplayer2/Player.java
......@@ -148,7 +148,9 @@ public interface Player {
* The UID of the window, or {@code null} if the timeline is {@link Timeline#isEmpty() empty}.
*/
@Nullable public final Object windowUid;
/** @deprecated Use {@link #mediaItemIndex} instead. */
/**
* @deprecated Use {@link #mediaItemIndex} instead.
*/
@Deprecated public final int windowIndex;
/** The media item index. */
public final int mediaItemIndex;
......@@ -731,7 +733,9 @@ public interface Player {
*/
default void onIsLoadingChanged(boolean isLoading) {}
/** @deprecated Use {@link #onIsLoadingChanged(boolean)} instead. */
/**
* @deprecated Use {@link #onIsLoadingChanged(boolean)} instead.
*/
@Deprecated
default void onLoadingChanged(boolean isLoading) {}
......@@ -1439,23 +1443,31 @@ public interface Player {
int COMMAND_SEEK_TO_DEFAULT_POSITION = 4;
/** Command to seek anywhere into the current {@link MediaItem}. */
int COMMAND_SEEK_IN_CURRENT_MEDIA_ITEM = 5;
/** @deprecated Use {@link #COMMAND_SEEK_IN_CURRENT_MEDIA_ITEM} instead. */
/**
* @deprecated Use {@link #COMMAND_SEEK_IN_CURRENT_MEDIA_ITEM} instead.
*/
@Deprecated int COMMAND_SEEK_IN_CURRENT_WINDOW = COMMAND_SEEK_IN_CURRENT_MEDIA_ITEM;
/** Command to seek to the default position of the previous {@link MediaItem}. */
int COMMAND_SEEK_TO_PREVIOUS_MEDIA_ITEM = 6;
/** @deprecated Use {@link #COMMAND_SEEK_TO_PREVIOUS_MEDIA_ITEM} instead. */
/**
* @deprecated Use {@link #COMMAND_SEEK_TO_PREVIOUS_MEDIA_ITEM} instead.
*/
@Deprecated int COMMAND_SEEK_TO_PREVIOUS_WINDOW = COMMAND_SEEK_TO_PREVIOUS_MEDIA_ITEM;
/** Command to seek to an earlier position in the current or previous {@link MediaItem}. */
int COMMAND_SEEK_TO_PREVIOUS = 7;
/** Command to seek to the default position of the next {@link MediaItem}. */
int COMMAND_SEEK_TO_NEXT_MEDIA_ITEM = 8;
/** @deprecated Use {@link #COMMAND_SEEK_TO_NEXT_MEDIA_ITEM} instead. */
/**
* @deprecated Use {@link #COMMAND_SEEK_TO_NEXT_MEDIA_ITEM} instead.
*/
@Deprecated int COMMAND_SEEK_TO_NEXT_WINDOW = COMMAND_SEEK_TO_NEXT_MEDIA_ITEM;
/** Command to seek to a later position in the current or next {@link MediaItem}. */
int COMMAND_SEEK_TO_NEXT = 9;
/** Command to seek anywhere in any {@link MediaItem}. */
int COMMAND_SEEK_TO_MEDIA_ITEM = 10;
/** @deprecated Use {@link #COMMAND_SEEK_TO_MEDIA_ITEM} instead. */
/**
* @deprecated Use {@link #COMMAND_SEEK_TO_MEDIA_ITEM} instead.
*/
@Deprecated int COMMAND_SEEK_TO_WINDOW = COMMAND_SEEK_TO_MEDIA_ITEM;
/** Command to seek back by a fixed increment into the current {@link MediaItem}. */
int COMMAND_SEEK_BACK = 11;
......@@ -1881,11 +1893,15 @@ public interface Player {
*/
void seekForward();
/** @deprecated Use {@link #hasPreviousMediaItem()} instead. */
/**
* @deprecated Use {@link #hasPreviousMediaItem()} instead.
*/
@Deprecated
boolean hasPrevious();
/** @deprecated Use {@link #hasPreviousMediaItem()} instead. */
/**
* @deprecated Use {@link #hasPreviousMediaItem()} instead.
*/
@Deprecated
boolean hasPreviousWindow();
......@@ -1899,11 +1915,15 @@ public interface Player {
*/
boolean hasPreviousMediaItem();
/** @deprecated Use {@link #seekToPreviousMediaItem()} instead. */
/**
* @deprecated Use {@link #seekToPreviousMediaItem()} instead.
*/
@Deprecated
void previous();
/** @deprecated Use {@link #seekToPreviousMediaItem()} instead. */
/**
* @deprecated Use {@link #seekToPreviousMediaItem()} instead.
*/
@Deprecated
void seekToPreviousWindow();
......@@ -1949,11 +1969,15 @@ public interface Player {
*/
void seekToPrevious();
/** @deprecated Use {@link #hasNextMediaItem()} instead. */
/**
* @deprecated Use {@link #hasNextMediaItem()} instead.
*/
@Deprecated
boolean hasNext();
/** @deprecated Use {@link #hasNextMediaItem()} instead. */
/**
* @deprecated Use {@link #hasNextMediaItem()} instead.
*/
@Deprecated
boolean hasNextWindow();
......@@ -1967,11 +1991,15 @@ public interface Player {
*/
boolean hasNextMediaItem();
/** @deprecated Use {@link #seekToNextMediaItem()} instead. */
/**
* @deprecated Use {@link #seekToNextMediaItem()} instead.
*/
@Deprecated
void next();
/** @deprecated Use {@link #seekToNextMediaItem()} instead. */
/**
* @deprecated Use {@link #seekToNextMediaItem()} instead.
*/
@Deprecated
void seekToNextWindow();
......@@ -2151,7 +2179,9 @@ public interface Player {
/** Returns the index of the period currently being played. */
int getCurrentPeriodIndex();
/** @deprecated Use {@link #getCurrentMediaItemIndex()} instead. */
/**
* @deprecated Use {@link #getCurrentMediaItemIndex()} instead.
*/
@Deprecated
int getCurrentWindowIndex();
......@@ -2162,7 +2192,9 @@ public interface Player {
*/
int getCurrentMediaItemIndex();
/** @deprecated Use {@link #getNextMediaItemIndex()} instead. */
/**
* @deprecated Use {@link #getNextMediaItemIndex()} instead.
*/
@Deprecated
int getNextWindowIndex();
......@@ -2178,7 +2210,9 @@ public interface Player {
*/
int getNextMediaItemIndex();
/** @deprecated Use {@link #getPreviousMediaItemIndex()} instead. */
/**
* @deprecated Use {@link #getPreviousMediaItemIndex()} instead.
*/
@Deprecated
int getPreviousWindowIndex();
......@@ -2239,7 +2273,9 @@ public interface Player {
*/
long getTotalBufferedDuration();
/** @deprecated Use {@link #isCurrentMediaItemDynamic()} instead. */
/**
* @deprecated Use {@link #isCurrentMediaItemDynamic()} instead.
*/
@Deprecated
boolean isCurrentWindowDynamic();
......@@ -2251,7 +2287,9 @@ public interface Player {
*/
boolean isCurrentMediaItemDynamic();
/** @deprecated Use {@link #isCurrentMediaItemLive()} instead. */
/**
* @deprecated Use {@link #isCurrentMediaItemLive()} instead.
*/
@Deprecated
boolean isCurrentWindowLive();
......@@ -2276,7 +2314,9 @@ public interface Player {
*/
long getCurrentLiveOffset();
/** @deprecated Use {@link #isCurrentMediaItemSeekable()} instead. */
/**
* @deprecated Use {@link #isCurrentMediaItemSeekable()} instead.
*/
@Deprecated
boolean isCurrentWindowSeekable();
......
library/common/src/main/java/com/google/android/exoplayer2/Timeline.java
......@@ -169,7 +169,9 @@ public abstract class Timeline implements Bundleable {
*/
public Object uid;
/** @deprecated Use {@link #mediaItem} instead. */
/**
* @deprecated Use {@link #mediaItem} instead.
*/
@Deprecated @Nullable public Object tag;
/** The {@link MediaItem} associated to the window. Not necessarily unique. */
......@@ -212,7 +214,9 @@ public abstract class Timeline implements Bundleable {
/** Whether this window may change when the timeline is updated. */
public boolean isDynamic;
/** @deprecated Use {@link #isLive()} instead. */
/**
* @deprecated Use {@link #isLive()} instead.
*/
@Deprecated public boolean isLive;
/**
......@@ -1169,14 +1173,18 @@ public abstract class Timeline implements Bundleable {
== C.INDEX_UNSET;
}
/** @deprecated Use {@link #getPeriodPositionUs(Window, Period, int, long)} instead. */
/**
* @deprecated Use {@link #getPeriodPositionUs(Window, Period, int, long)} instead.
*/
@Deprecated
@InlineMe(replacement = "this.getPeriodPositionUs(window, period, windowIndex, windowPositionUs)")
public final Pair<Object, Long> getPeriodPosition(
Window window, Period period, int windowIndex, long windowPositionUs) {
return getPeriodPositionUs(window, period, windowIndex, windowPositionUs);
}
/** @deprecated Use {@link #getPeriodPositionUs(Window, Period, int, long, long)} instead. */
/**
* @deprecated Use {@link #getPeriodPositionUs(Window, Period, int, long, long)} instead.
*/
@Deprecated
@Nullable
@InlineMe(
......
library/common/src/main/java/com/google/android/exoplayer2/TracksInfo.java
......@@ -322,14 +322,18 @@ public final class TracksInfo implements Bundleable {
return false;
}
/** @deprecated Use {@link #containsType(int)} and {@link #isTypeSupported(int)}. */
/**
* @deprecated Use {@link #containsType(int)} and {@link #isTypeSupported(int)}.
*/
@Deprecated
@SuppressWarnings("deprecation")
public boolean isTypeSupportedOrEmpty(@C.TrackType int trackType) {
return isTypeSupportedOrEmpty(trackType, /* allowExceedsCapabilities= */ false);
}
/** @deprecated Use {@link #containsType(int)} and {@link #isTypeSupported(int, boolean)}. */
/**
* @deprecated Use {@link #containsType(int)} and {@link #isTypeSupported(int, boolean)}.
*/
@Deprecated
public boolean isTypeSupportedOrEmpty(
@C.TrackType int trackType, boolean allowExceedsCapabilities) {
......
library/common/src/main/java/com/google/android/exoplayer2/drm/DrmInitData.java
......@@ -91,7 +91,9 @@ public final class DrmInitData implements Comparator<SchemeData>, Parcelable {
/** Number of {@link SchemeData}s. */
public final int schemeDataCount;
/** @param schemeDatas Scheme initialization data for possibly multiple DRM schemes. */
/**
* @param schemeDatas Scheme initialization data for possibly multiple DRM schemes.
*/
public DrmInitData(List<SchemeData> schemeDatas) {
this(null, false, schemeDatas.toArray(new SchemeData[0]));
}
......@@ -104,7 +106,9 @@ public final class DrmInitData implements Comparator<SchemeData>, Parcelable {
this(schemeType, false, schemeDatas.toArray(new SchemeData[0]));
}
/** @param schemeDatas Scheme initialization data for possibly multiple DRM schemes. */
/**
* @param schemeDatas Scheme initialization data for possibly multiple DRM schemes.
*/
public DrmInitData(SchemeData... schemeDatas) {
this(null, schemeDatas);
}
......
library/common/src/main/java/com/google/android/exoplayer2/metadata/Metadata.java
......@@ -62,12 +62,16 @@ public final class Metadata implements Parcelable {
private final Entry[] entries;
/** @param entries The metadata entries. */
/**
* @param entries The metadata entries.
*/
public Metadata(Entry... entries) {
this.entries = entries;
}
/** @param entries The metadata entries. */
/**
* @param entries The metadata entries.
*/
public Metadata(List<? extends Entry> entries) {
this.entries = entries.toArray(new Entry[0]);
}
......
library/common/src/main/java/com/google/android/exoplayer2/offline/StreamKey.java
......@@ -42,7 +42,9 @@ public final class StreamKey implements Comparable<StreamKey>, Parcelable {
/** The stream index. */
public final int streamIndex;
/** @deprecated Use {@link #streamIndex}. */
/**
* @deprecated Use {@link #streamIndex}.
*/
@Deprecated public final int trackIndex;
/**
......
library/common/src/main/java/com/google/android/exoplayer2/trackselection/TrackSelectionArray.java
......@@ -30,7 +30,9 @@ public final class TrackSelectionArray {
// Lazily initialized hashcode.
private int hashCode;
/** @param trackSelections The selections. Must not be null, but may contain null elements. */
/**
* @param trackSelections The selections. Must not be null, but may contain null elements.
*/
public TrackSelectionArray(@NullableType TrackSelection... trackSelections) {
this.trackSelections = trackSelections;
this.length = trackSelections.length;
......
library/common/src/main/java/com/google/android/exoplayer2/ui/AdOverlayInfo.java
......@@ -96,13 +96,17 @@ public final class AdOverlayInfo {
/** An optional, detailed reason that the overlay view is needed. */
@Nullable public final String reasonDetail;
/** @deprecated Use {@link Builder} instead. */
/**
* @deprecated Use {@link Builder} instead.
*/
@Deprecated
public AdOverlayInfo(View view, @Purpose int purpose) {
this(view, purpose, /* detailedReason= */ null);
}
/** @deprecated Use {@link Builder} instead. */
/**
* @deprecated Use {@link Builder} instead.
*/
@Deprecated
public AdOverlayInfo(View view, @Purpose int purpose, @Nullable String detailedReason) {
this.view = view;
......
library/common/src/main/java/com/google/android/exoplayer2/util/Clock.java
......@@ -35,10 +35,14 @@ public interface Clock {
*/
long currentTimeMillis();
/** @see android.os.SystemClock#elapsedRealtime() */
/**
* @see android.os.SystemClock#elapsedRealtime()
*/
long elapsedRealtime();
/** @see android.os.SystemClock#uptimeMillis() */
/**
* @see android.os.SystemClock#uptimeMillis()
*/
long uptimeMillis();
/**
......
library/common/src/main/java/com/google/android/exoplayer2/util/LibraryLoader.java
......@@ -26,7 +26,9 @@ public abstract class LibraryLoader {
private boolean loadAttempted;
private boolean isAvailable;
/** @param libraries The names of the libraries to load. */
/**
* @param libraries The names of the libraries to load.
*/
public LibraryLoader(String... libraries) {
nativeLibraries = libraries;
}
......
library/common/src/main/java/com/google/android/exoplayer2/util/Log.java
......@@ -81,7 +81,9 @@ public final class Log {
Log.logStackTraces = logStackTraces;
}
/** @see android.util.Log#d(String, String) */
/**
* @see android.util.Log#d(String, String)
*/
@Pure
public static void d(@Size(max = 23) String tag, String message) {
if (logLevel == LOG_LEVEL_ALL) {
......@@ -89,13 +91,17 @@ public final class Log {
}
}
/** @see android.util.Log#d(String, String, Throwable) */
/**
* @see android.util.Log#d(String, String, Throwable)
*/
@Pure
public static void d(@Size(max = 23) String tag, String message, @Nullable Throwable throwable) {
d(tag, appendThrowableString(message, throwable));
}
/** @see android.util.Log#i(String, String) */
/**
* @see android.util.Log#i(String, String)
*/
@Pure
public static void i(@Size(max = 23) String tag, String message) {
if (logLevel <= LOG_LEVEL_INFO) {
......@@ -103,13 +109,17 @@ public final class Log {
}
}
/** @see android.util.Log#i(String, String, Throwable) */
/**
* @see android.util.Log#i(String, String, Throwable)
*/
@Pure
public static void i(@Size(max = 23) String tag, String message, @Nullable Throwable throwable) {
i(tag, appendThrowableString(message, throwable));
}
/** @see android.util.Log#w(String, String) */
/**
* @see android.util.Log#w(String, String)
*/
@Pure
public static void w(@Size(max = 23) String tag, String message) {
if (logLevel <= LOG_LEVEL_WARNING) {
......@@ -117,13 +127,17 @@ public final class Log {
}
}
/** @see android.util.Log#w(String, String, Throwable) */
/**
* @see android.util.Log#w(String, String, Throwable)
*/
@Pure
public static void w(@Size(max = 23) String tag, String message, @Nullable Throwable throwable) {
w(tag, appendThrowableString(message, throwable));
}
/** @see android.util.Log#e(String, String) */
/**
* @see android.util.Log#e(String, String)
*/
@Pure
public static void e(@Size(max = 23) String tag, String message) {
if (logLevel <= LOG_LEVEL_ERROR) {
......@@ -131,7 +145,9 @@ public final class Log {
}
}
/** @see android.util.Log#e(String, String, Throwable) */
/**
* @see android.util.Log#e(String, String, Throwable)
*/
@Pure
public static void e(@Size(max = 23) String tag, String message, @Nullable Throwable throwable) {
e(tag, appendThrowableString(message, throwable));
......
library/common/src/main/java/com/google/android/exoplayer2/util/LongArray.java
......@@ -29,7 +29,9 @@ public final class LongArray {
this(DEFAULT_INITIAL_CAPACITY);
}
/** @param initialCapacity The initial capacity of the array. */
/**
* @param initialCapacity The initial capacity of the array.
*/
public LongArray(int initialCapacity) {
values = new long[initialCapacity];
}
......
library/common/src/main/java/com/google/android/exoplayer2/util/NotificationUtil.java
......@@ -53,17 +53,29 @@ public final class NotificationUtil {
IMPORTANCE_HIGH
})
public @interface Importance {}
/** @see NotificationManager#IMPORTANCE_UNSPECIFIED */
/**
* @see NotificationManager#IMPORTANCE_UNSPECIFIED
*/
public static final int IMPORTANCE_UNSPECIFIED = NotificationManager.IMPORTANCE_UNSPECIFIED;
/** @see NotificationManager#IMPORTANCE_NONE */
/**
* @see NotificationManager#IMPORTANCE_NONE
*/
public static final int IMPORTANCE_NONE = NotificationManager.IMPORTANCE_NONE;
/** @see NotificationManager#IMPORTANCE_MIN */
/**
* @see NotificationManager#IMPORTANCE_MIN
*/
public static final int IMPORTANCE_MIN = NotificationManager.IMPORTANCE_MIN;
/** @see NotificationManager#IMPORTANCE_LOW */
/**
* @see NotificationManager#IMPORTANCE_LOW
*/
public static final int IMPORTANCE_LOW = NotificationManager.IMPORTANCE_LOW;
/** @see NotificationManager#IMPORTANCE_DEFAULT */
/**
* @see NotificationManager#IMPORTANCE_DEFAULT
*/
public static final int IMPORTANCE_DEFAULT = NotificationManager.IMPORTANCE_DEFAULT;
/** @see NotificationManager#IMPORTANCE_HIGH */
/**
* @see NotificationManager#IMPORTANCE_HIGH
*/
public static final int IMPORTANCE_HIGH = NotificationManager.IMPORTANCE_HIGH;
/**
......
library/core/src/main/java/com/google/android/exoplayer2/AudioFocusManager.java
......@@ -112,17 +112,27 @@ import org.checkerframework.checker.nullness.qual.MonotonicNonNull;
AUDIOFOCUS_GAIN_TRANSIENT_EXCLUSIVE
})
private @interface AudioFocusGain {}
/** @see AudioManager#AUDIOFOCUS_NONE */
/**
* @see AudioManager#AUDIOFOCUS_NONE
*/
@SuppressWarnings("InlinedApi")
private static final int AUDIOFOCUS_NONE = AudioManager.AUDIOFOCUS_NONE;
/** @see AudioManager#AUDIOFOCUS_GAIN */
/**
* @see AudioManager#AUDIOFOCUS_GAIN
*/
private static final int AUDIOFOCUS_GAIN = AudioManager.AUDIOFOCUS_GAIN;
/** @see AudioManager#AUDIOFOCUS_GAIN_TRANSIENT */
/**
* @see AudioManager#AUDIOFOCUS_GAIN_TRANSIENT
*/
private static final int AUDIOFOCUS_GAIN_TRANSIENT = AudioManager.AUDIOFOCUS_GAIN_TRANSIENT;
/** @see AudioManager#AUDIOFOCUS_GAIN_TRANSIENT_MAY_DUCK */
/**
* @see AudioManager#AUDIOFOCUS_GAIN_TRANSIENT_MAY_DUCK
*/
private static final int AUDIOFOCUS_GAIN_TRANSIENT_MAY_DUCK =
AudioManager.AUDIOFOCUS_GAIN_TRANSIENT_MAY_DUCK;
/** @see AudioManager#AUDIOFOCUS_GAIN_TRANSIENT_EXCLUSIVE */
/**
* @see AudioManager#AUDIOFOCUS_GAIN_TRANSIENT_EXCLUSIVE
*/
@SuppressWarnings("InlinedApi")
private static final int AUDIOFOCUS_GAIN_TRANSIENT_EXCLUSIVE =
AudioManager.AUDIOFOCUS_GAIN_TRANSIENT_EXCLUSIVE;
......
library/core/src/main/java/com/google/android/exoplayer2/DefaultLoadControl.java
......@@ -221,7 +221,9 @@ public class DefaultLoadControl implements LoadControl {
return this;
}
/** @deprecated use {@link #build} instead. */
/**
* @deprecated use {@link #build} instead.
*/
@Deprecated
public DefaultLoadControl createDefaultLoadControl() {
return build();
......
library/core/src/main/java/com/google/android/exoplayer2/DefaultRenderersFactory.java
......@@ -101,7 +101,9 @@ public class DefaultRenderersFactory implements RenderersFactory {
private boolean enableAudioTrackPlaybackParams;
private boolean enableOffload;
/** @param context A {@link Context}. */
/**
* @param context A {@link Context}.
*/
public DefaultRenderersFactory(Context context) {
this.context = context;
codecAdapterFactory = new DefaultMediaCodecAdapterFactory();
......
library/core/src/main/java/com/google/android/exoplayer2/ExoPlayer.java
......@@ -153,43 +153,63 @@ public interface ExoPlayer extends Player {
@Deprecated
interface AudioComponent {
/** @deprecated Use {@link ExoPlayer#setAudioAttributes(AudioAttributes, boolean)} instead. */
/**
* @deprecated Use {@link ExoPlayer#setAudioAttributes(AudioAttributes, boolean)} instead.
*/
@Deprecated
void setAudioAttributes(AudioAttributes audioAttributes, boolean handleAudioFocus);
/** @deprecated Use {@link Player#getAudioAttributes()} instead. */
/**
* @deprecated Use {@link Player#getAudioAttributes()} instead.
*/
@Deprecated
AudioAttributes getAudioAttributes();
/** @deprecated Use {@link ExoPlayer#setAudioSessionId(int)} instead. */
/**
* @deprecated Use {@link ExoPlayer#setAudioSessionId(int)} instead.
*/
@Deprecated
void setAudioSessionId(int audioSessionId);
/** @deprecated Use {@link ExoPlayer#getAudioSessionId()} instead. */
/**
* @deprecated Use {@link ExoPlayer#getAudioSessionId()} instead.
*/
@Deprecated
int getAudioSessionId();
/** @deprecated Use {@link ExoPlayer#setAuxEffectInfo(AuxEffectInfo)} instead. */
/**
* @deprecated Use {@link ExoPlayer#setAuxEffectInfo(AuxEffectInfo)} instead.
*/
@Deprecated
void setAuxEffectInfo(AuxEffectInfo auxEffectInfo);
/** @deprecated Use {@link ExoPlayer#clearAuxEffectInfo()} instead. */
/**
* @deprecated Use {@link ExoPlayer#clearAuxEffectInfo()} instead.
*/
@Deprecated
void clearAuxEffectInfo();
/** @deprecated Use {@link Player#setVolume(float)} instead. */
/**
* @deprecated Use {@link Player#setVolume(float)} instead.
*/
@Deprecated
void setVolume(float audioVolume);
/** @deprecated Use {@link Player#getVolume()} instead. */
/**
* @deprecated Use {@link Player#getVolume()} instead.
*/
@Deprecated
float getVolume();
/** @deprecated Use {@link ExoPlayer#setSkipSilenceEnabled(boolean)} instead. */
/**
* @deprecated Use {@link ExoPlayer#setSkipSilenceEnabled(boolean)} instead.
*/
@Deprecated
void setSkipSilenceEnabled(boolean skipSilenceEnabled);
/** @deprecated Use {@link ExoPlayer#getSkipSilenceEnabled()} instead. */
/**
* @deprecated Use {@link ExoPlayer#getSkipSilenceEnabled()} instead.
*/
@Deprecated
boolean getSkipSilenceEnabled();
}
......@@ -201,21 +221,29 @@ public interface ExoPlayer extends Player {
@Deprecated
interface VideoComponent {
/** @deprecated Use {@link ExoPlayer#setVideoScalingMode(int)} instead. */
/**
* @deprecated Use {@link ExoPlayer#setVideoScalingMode(int)} instead.
*/
@Deprecated
void setVideoScalingMode(@C.VideoScalingMode int videoScalingMode);
/** @deprecated Use {@link ExoPlayer#getVideoScalingMode()} instead. */
/**
* @deprecated Use {@link ExoPlayer#getVideoScalingMode()} instead.
*/
@Deprecated
@C.VideoScalingMode
int getVideoScalingMode();
/** @deprecated Use {@link ExoPlayer#setVideoChangeFrameRateStrategy(int)} instead. */
/**
* @deprecated Use {@link ExoPlayer#setVideoChangeFrameRateStrategy(int)} instead.
*/
@Deprecated
void setVideoChangeFrameRateStrategy(
@C.VideoChangeFrameRateStrategy int videoChangeFrameRateStrategy);
/** @deprecated Use {@link ExoPlayer#getVideoChangeFrameRateStrategy()} instead. */
/**
* @deprecated Use {@link ExoPlayer#getVideoChangeFrameRateStrategy()} instead.
*/
@Deprecated
@C.VideoChangeFrameRateStrategy
int getVideoChangeFrameRateStrategy();
......@@ -234,7 +262,9 @@ public interface ExoPlayer extends Player {
@Deprecated
void clearVideoFrameMetadataListener(VideoFrameMetadataListener listener);
/** @deprecated Use {@link ExoPlayer#setCameraMotionListener(CameraMotionListener)} instead. */
/**
* @deprecated Use {@link ExoPlayer#setCameraMotionListener(CameraMotionListener)} instead.
*/
@Deprecated
void setCameraMotionListener(CameraMotionListener listener);
......@@ -244,43 +274,63 @@ public interface ExoPlayer extends Player {
@Deprecated
void clearCameraMotionListener(CameraMotionListener listener);
/** @deprecated Use {@link Player#clearVideoSurface()} instead. */
/**
* @deprecated Use {@link Player#clearVideoSurface()} instead.
*/
@Deprecated
void clearVideoSurface();
/** @deprecated Use {@link Player#clearVideoSurface(Surface)} instead. */
/**
* @deprecated Use {@link Player#clearVideoSurface(Surface)} instead.
*/
@Deprecated
void clearVideoSurface(@Nullable Surface surface);
/** @deprecated Use {@link Player#setVideoSurface(Surface)} instead. */
/**
* @deprecated Use {@link Player#setVideoSurface(Surface)} instead.
*/
@Deprecated
void setVideoSurface(@Nullable Surface surface);
/** @deprecated Use {@link Player#setVideoSurfaceHolder(SurfaceHolder)} instead. */
/**
* @deprecated Use {@link Player#setVideoSurfaceHolder(SurfaceHolder)} instead.
*/
@Deprecated
void setVideoSurfaceHolder(@Nullable SurfaceHolder surfaceHolder);
/** @deprecated Use {@link Player#clearVideoSurfaceHolder(SurfaceHolder)} instead. */
/**
* @deprecated Use {@link Player#clearVideoSurfaceHolder(SurfaceHolder)} instead.
*/
@Deprecated
void clearVideoSurfaceHolder(@Nullable SurfaceHolder surfaceHolder);
/** @deprecated Use {@link Player#setVideoSurfaceView(SurfaceView)} instead. */
/**
* @deprecated Use {@link Player#setVideoSurfaceView(SurfaceView)} instead.
*/
@Deprecated
void setVideoSurfaceView(@Nullable SurfaceView surfaceView);
/** @deprecated Use {@link Player#clearVideoSurfaceView(SurfaceView)} instead. */
/**
* @deprecated Use {@link Player#clearVideoSurfaceView(SurfaceView)} instead.
*/
@Deprecated
void clearVideoSurfaceView(@Nullable SurfaceView surfaceView);
/** @deprecated Use {@link Player#setVideoTextureView(TextureView)} instead. */
/**
* @deprecated Use {@link Player#setVideoTextureView(TextureView)} instead.
*/
@Deprecated
void setVideoTextureView(@Nullable TextureView textureView);
/** @deprecated Use {@link Player#clearVideoTextureView(TextureView)} instead. */
/**
* @deprecated Use {@link Player#clearVideoTextureView(TextureView)} instead.
*/
@Deprecated
void clearVideoTextureView(@Nullable TextureView textureView);
/** @deprecated Use {@link Player#getVideoSize()} instead. */
/**
* @deprecated Use {@link Player#getVideoSize()} instead.
*/
@Deprecated
VideoSize getVideoSize();
}
......@@ -292,7 +342,9 @@ public interface ExoPlayer extends Player {
@Deprecated
interface TextComponent {
/** @deprecated Use {@link Player#getCurrentCues()} instead. */
/**
* @deprecated Use {@link Player#getCurrentCues()} instead.
*/
@Deprecated
List<Cue> getCurrentCues();
}
......@@ -304,31 +356,45 @@ public interface ExoPlayer extends Player {
@Deprecated
interface DeviceComponent {
/** @deprecated Use {@link Player#getDeviceInfo()} instead. */
/**
* @deprecated Use {@link Player#getDeviceInfo()} instead.
*/
@Deprecated
DeviceInfo getDeviceInfo();
/** @deprecated Use {@link Player#getDeviceVolume()} instead. */
/**
* @deprecated Use {@link Player#getDeviceVolume()} instead.
*/
@Deprecated
int getDeviceVolume();
/** @deprecated Use {@link Player#isDeviceMuted()} instead. */
/**
* @deprecated Use {@link Player#isDeviceMuted()} instead.
*/
@Deprecated
boolean isDeviceMuted();
/** @deprecated Use {@link Player#setDeviceVolume(int)} instead. */
/**
* @deprecated Use {@link Player#setDeviceVolume(int)} instead.
*/
@Deprecated
void setDeviceVolume(int volume);
/** @deprecated Use {@link Player#increaseDeviceVolume()} instead. */
/**
* @deprecated Use {@link Player#increaseDeviceVolume()} instead.
*/
@Deprecated
void increaseDeviceVolume();
/** @deprecated Use {@link Player#decreaseDeviceVolume()} instead. */
/**
* @deprecated Use {@link Player#decreaseDeviceVolume()} instead.
*/
@Deprecated
void decreaseDeviceVolume();
/** @deprecated Use {@link Player#setDeviceMuted(boolean)} instead. */
/**
* @deprecated Use {@link Player#setDeviceMuted(boolean)} instead.
*/
@Deprecated
void setDeviceMuted(boolean muted);
}
......@@ -1107,11 +1173,15 @@ public interface ExoPlayer extends Player {
/** Returns the {@link Clock} used for playback. */
Clock getClock();
/** @deprecated Use {@link #prepare()} instead. */
/**
* @deprecated Use {@link #prepare()} instead.
*/
@Deprecated
void retry();
/** @deprecated Use {@link #setMediaSource(MediaSource)} and {@link #prepare()} instead. */
/**
* @deprecated Use {@link #setMediaSource(MediaSource)} and {@link #prepare()} instead.
*/
@Deprecated
void prepare(MediaSource mediaSource);
......@@ -1433,7 +1503,9 @@ public interface ExoPlayer extends Player {
*/
void setHandleAudioBecomingNoisy(boolean handleAudioBecomingNoisy);
/** @deprecated Use {@link #setWakeMode(int)} instead. */
/**
* @deprecated Use {@link #setWakeMode(int)} instead.
*/
@Deprecated
void setHandleWakeLock(boolean handleWakeLock);
......
library/core/src/main/java/com/google/android/exoplayer2/PlayerMessage.java
......@@ -148,7 +148,9 @@ public final class PlayerMessage {
return payload;
}
/** @deprecated Use {@link #setLooper(Looper)} instead. */
/**
* @deprecated Use {@link #setLooper(Looper)} instead.
*/
@Deprecated
public PlayerMessage setHandler(Handler handler) {
return setLooper(handler.getLooper());
......
library/core/src/main/java/com/google/android/exoplayer2/RendererCapabilities.java
......@@ -27,7 +27,9 @@ import java.lang.annotation.Target;
/** Defines the capabilities of a {@link Renderer}. */
public interface RendererCapabilities {
/** @deprecated Use {@link C.FormatSupport} instead. */
/**
* @deprecated Use {@link C.FormatSupport} instead.
*/
@SuppressWarnings("deprecation")
@Documented
@Retention(RetentionPolicy.SOURCE)
......@@ -43,15 +45,25 @@ public interface RendererCapabilities {
@interface FormatSupport {}
/** A mask to apply to {@link Capabilities} to obtain the {@link C.FormatSupport} only. */
int FORMAT_SUPPORT_MASK = 0b111;
/** @deprecated Use {@link C#FORMAT_HANDLED} instead. */
/**
* @deprecated Use {@link C#FORMAT_HANDLED} instead.
*/
@Deprecated int FORMAT_HANDLED = C.FORMAT_HANDLED;
/** @deprecated Use {@link C#FORMAT_EXCEEDS_CAPABILITIES} instead. */
/**
* @deprecated Use {@link C#FORMAT_EXCEEDS_CAPABILITIES} instead.
*/
@Deprecated int FORMAT_EXCEEDS_CAPABILITIES = C.FORMAT_EXCEEDS_CAPABILITIES;
/** @deprecated Use {@link C#FORMAT_UNSUPPORTED_DRM} instead. */
/**
* @deprecated Use {@link C#FORMAT_UNSUPPORTED_DRM} instead.
*/
@Deprecated int FORMAT_UNSUPPORTED_DRM = C.FORMAT_UNSUPPORTED_DRM;
/** @deprecated Use {@link C#FORMAT_UNSUPPORTED_SUBTYPE} instead. */
/**
* @deprecated Use {@link C#FORMAT_UNSUPPORTED_SUBTYPE} instead.
*/
@Deprecated int FORMAT_UNSUPPORTED_SUBTYPE = C.FORMAT_UNSUPPORTED_SUBTYPE;
/** @deprecated Use {@link C#FORMAT_UNSUPPORTED_TYPE} instead. */
/**
* @deprecated Use {@link C#FORMAT_UNSUPPORTED_TYPE} instead.
*/
@Deprecated int FORMAT_UNSUPPORTED_TYPE = C.FORMAT_UNSUPPORTED_TYPE;
/**
......
library/core/src/main/java/com/google/android/exoplayer2/RendererConfiguration.java
......@@ -27,7 +27,9 @@ public final class RendererConfiguration {
/** Whether to enable tunneling. */
public final boolean tunneling;
/** @param tunneling Whether to enable tunneling. */
/**
* @param tunneling Whether to enable tunneling.
*/
public RendererConfiguration(boolean tunneling) {
this.tunneling = tunneling;
}
......
library/core/src/main/java/com/google/android/exoplayer2/SimpleExoPlayer.java
......@@ -47,7 +47,9 @@ import com.google.android.exoplayer2.video.VideoSize;
import com.google.android.exoplayer2.video.spherical.CameraMotionListener;
import java.util.List;
/** @deprecated Use {@link ExoPlayer} instead. */
/**
* @deprecated Use {@link ExoPlayer} instead.
*/
@Deprecated
public class SimpleExoPlayer extends BasePlayer
implements ExoPlayer,
......@@ -56,20 +58,26 @@ public class SimpleExoPlayer extends BasePlayer
ExoPlayer.TextComponent,
ExoPlayer.DeviceComponent {
/** @deprecated Use {@link ExoPlayer.Builder} instead. */
/**
* @deprecated Use {@link ExoPlayer.Builder} instead.
*/
@Deprecated
@SuppressWarnings("deprecation")
public static final class Builder {
private final ExoPlayer.Builder wrappedBuilder;
/** @deprecated Use {@link ExoPlayer.Builder#Builder(Context)} instead. */
/**
* @deprecated Use {@link ExoPlayer.Builder#Builder(Context)} instead.
*/
@Deprecated
public Builder(Context context) {
wrappedBuilder = new ExoPlayer.Builder(context);
}
/** @deprecated Use {@link ExoPlayer.Builder#Builder(Context, RenderersFactory)} instead. */
/**
* @deprecated Use {@link ExoPlayer.Builder#Builder(Context, RenderersFactory)} instead.
*/
@Deprecated
public Builder(Context context, RenderersFactory renderersFactory) {
wrappedBuilder = new ExoPlayer.Builder(context, renderersFactory);
......@@ -133,7 +141,9 @@ public class SimpleExoPlayer extends BasePlayer
return this;
}
/** @deprecated Use {@link ExoPlayer.Builder#setTrackSelector(TrackSelector)} instead. */
/**
* @deprecated Use {@link ExoPlayer.Builder#setTrackSelector(TrackSelector)} instead.
*/
@Deprecated
public Builder setTrackSelector(TrackSelector trackSelector) {
wrappedBuilder.setTrackSelector(trackSelector);
......@@ -149,21 +159,27 @@ public class SimpleExoPlayer extends BasePlayer
return this;
}
/** @deprecated Use {@link ExoPlayer.Builder#setLoadControl(LoadControl)} instead. */
/**
* @deprecated Use {@link ExoPlayer.Builder#setLoadControl(LoadControl)} instead.
*/
@Deprecated
public Builder setLoadControl(LoadControl loadControl) {
wrappedBuilder.setLoadControl(loadControl);
return this;
}
/** @deprecated Use {@link ExoPlayer.Builder#setBandwidthMeter(BandwidthMeter)} instead. */
/**
* @deprecated Use {@link ExoPlayer.Builder#setBandwidthMeter(BandwidthMeter)} instead.
*/
@Deprecated
public Builder setBandwidthMeter(BandwidthMeter bandwidthMeter) {
wrappedBuilder.setBandwidthMeter(bandwidthMeter);
return this;
}
/** @deprecated Use {@link ExoPlayer.Builder#setLooper(Looper)} instead. */
/**
* @deprecated Use {@link ExoPlayer.Builder#setLooper(Looper)} instead.
*/
@Deprecated
public Builder setLooper(Looper looper) {
wrappedBuilder.setLooper(looper);
......@@ -199,35 +215,45 @@ public class SimpleExoPlayer extends BasePlayer
return this;
}
/** @deprecated Use {@link ExoPlayer.Builder#setWakeMode(int)} instead. */
/**
* @deprecated Use {@link ExoPlayer.Builder#setWakeMode(int)} instead.
*/
@Deprecated
public Builder setWakeMode(@C.WakeMode int wakeMode) {
wrappedBuilder.setWakeMode(wakeMode);
return this;
}
/** @deprecated Use {@link ExoPlayer.Builder#setHandleAudioBecomingNoisy(boolean)} instead. */
/**
* @deprecated Use {@link ExoPlayer.Builder#setHandleAudioBecomingNoisy(boolean)} instead.
*/
@Deprecated
public Builder setHandleAudioBecomingNoisy(boolean handleAudioBecomingNoisy) {
wrappedBuilder.setHandleAudioBecomingNoisy(handleAudioBecomingNoisy);
return this;
}
/** @deprecated Use {@link ExoPlayer.Builder#setSkipSilenceEnabled(boolean)} instead. */
/**
* @deprecated Use {@link ExoPlayer.Builder#setSkipSilenceEnabled(boolean)} instead.
*/
@Deprecated
public Builder setSkipSilenceEnabled(boolean skipSilenceEnabled) {
wrappedBuilder.setSkipSilenceEnabled(skipSilenceEnabled);
return this;
}
/** @deprecated Use {@link ExoPlayer.Builder#setVideoScalingMode(int)} instead. */
/**
* @deprecated Use {@link ExoPlayer.Builder#setVideoScalingMode(int)} instead.
*/
@Deprecated
public Builder setVideoScalingMode(@C.VideoScalingMode int videoScalingMode) {
wrappedBuilder.setVideoScalingMode(videoScalingMode);
return this;
}
/** @deprecated Use {@link ExoPlayer.Builder#setVideoChangeFrameRateStrategy(int)} instead. */
/**
* @deprecated Use {@link ExoPlayer.Builder#setVideoChangeFrameRateStrategy(int)} instead.
*/
@Deprecated
public Builder setVideoChangeFrameRateStrategy(
@C.VideoChangeFrameRateStrategy int videoChangeFrameRateStrategy) {
......@@ -235,49 +261,63 @@ public class SimpleExoPlayer extends BasePlayer
return this;
}
/** @deprecated Use {@link ExoPlayer.Builder#setUseLazyPreparation(boolean)} instead. */
/**
* @deprecated Use {@link ExoPlayer.Builder#setUseLazyPreparation(boolean)} instead.
*/
@Deprecated
public Builder setUseLazyPreparation(boolean useLazyPreparation) {
wrappedBuilder.setUseLazyPreparation(useLazyPreparation);
return this;
}
/** @deprecated Use {@link ExoPlayer.Builder#setSeekParameters(SeekParameters)} instead. */
/**
* @deprecated Use {@link ExoPlayer.Builder#setSeekParameters(SeekParameters)} instead.
*/
@Deprecated
public Builder setSeekParameters(SeekParameters seekParameters) {
wrappedBuilder.setSeekParameters(seekParameters);
return this;
}
/** @deprecated Use {@link ExoPlayer.Builder#setSeekBackIncrementMs(long)} instead. */
/**
* @deprecated Use {@link ExoPlayer.Builder#setSeekBackIncrementMs(long)} instead.
*/
@Deprecated
public Builder setSeekBackIncrementMs(@IntRange(from = 1) long seekBackIncrementMs) {
wrappedBuilder.setSeekBackIncrementMs(seekBackIncrementMs);
return this;
}
/** @deprecated Use {@link ExoPlayer.Builder#setSeekForwardIncrementMs(long)} instead. */
/**
* @deprecated Use {@link ExoPlayer.Builder#setSeekForwardIncrementMs(long)} instead.
*/
@Deprecated
public Builder setSeekForwardIncrementMs(@IntRange(from = 1) long seekForwardIncrementMs) {
wrappedBuilder.setSeekForwardIncrementMs(seekForwardIncrementMs);
return this;
}
/** @deprecated Use {@link ExoPlayer.Builder#setReleaseTimeoutMs(long)} instead. */
/**
* @deprecated Use {@link ExoPlayer.Builder#setReleaseTimeoutMs(long)} instead.
*/
@Deprecated
public Builder setReleaseTimeoutMs(long releaseTimeoutMs) {
wrappedBuilder.setReleaseTimeoutMs(releaseTimeoutMs);
return this;
}
/** @deprecated Use {@link ExoPlayer.Builder#setDetachSurfaceTimeoutMs(long)} instead. */
/**
* @deprecated Use {@link ExoPlayer.Builder#setDetachSurfaceTimeoutMs(long)} instead.
*/
@Deprecated
public Builder setDetachSurfaceTimeoutMs(long detachSurfaceTimeoutMs) {
wrappedBuilder.setDetachSurfaceTimeoutMs(detachSurfaceTimeoutMs);
return this;
}
/** @deprecated Use {@link ExoPlayer.Builder#setPauseAtEndOfMediaItems(boolean)} instead. */
/**
* @deprecated Use {@link ExoPlayer.Builder#setPauseAtEndOfMediaItems(boolean)} instead.
*/
@Deprecated
public Builder setPauseAtEndOfMediaItems(boolean pauseAtEndOfMediaItems) {
wrappedBuilder.setPauseAtEndOfMediaItems(pauseAtEndOfMediaItems);
......@@ -294,7 +334,9 @@ public class SimpleExoPlayer extends BasePlayer
return this;
}
/** @deprecated Use {@link ExoPlayer.Builder#setClock(Clock)} instead. */
/**
* @deprecated Use {@link ExoPlayer.Builder#setClock(Clock)} instead.
*/
@Deprecated
@VisibleForTesting
public Builder setClock(Clock clock) {
......@@ -302,7 +344,9 @@ public class SimpleExoPlayer extends BasePlayer
return this;
}
/** @deprecated Use {@link ExoPlayer.Builder#build()} instead. */
/**
* @deprecated Use {@link ExoPlayer.Builder#build()} instead.
*/
@Deprecated
public SimpleExoPlayer build() {
return wrappedBuilder.buildSimpleExoPlayer();
......@@ -312,7 +356,9 @@ public class SimpleExoPlayer extends BasePlayer
private final ExoPlayerImpl player;
private final ConditionVariable constructorFinished;
/** @deprecated Use the {@link ExoPlayer.Builder}. */
/**
* @deprecated Use the {@link ExoPlayer.Builder}.
*/
@Deprecated
protected SimpleExoPlayer(
Context context,
......@@ -339,12 +385,16 @@ public class SimpleExoPlayer extends BasePlayer
.setLooper(applicationLooper));
}
/** @param builder The {@link Builder} to obtain all construction parameters. */
/**
* @param builder The {@link Builder} to obtain all construction parameters.
*/
protected SimpleExoPlayer(Builder builder) {
this(builder.wrappedBuilder);
}
/** @param builder The {@link ExoPlayer.Builder} to obtain all construction parameters. */
/**
* @param builder The {@link ExoPlayer.Builder} to obtain all construction parameters.
*/
/* package */ SimpleExoPlayer(ExoPlayer.Builder builder) {
constructorFinished = new ConditionVariable();
try {
......@@ -686,7 +736,9 @@ public class SimpleExoPlayer extends BasePlayer
return player.getPlayerError();
}
/** @deprecated Use {@link #prepare()} instead. */
/**
* @deprecated Use {@link #prepare()} instead.
*/
@Deprecated
@Override
@SuppressWarnings("deprecation") // Calling deprecated method.
......
library/core/src/main/java/com/google/android/exoplayer2/analytics/AnalyticsListener.java
......@@ -667,7 +667,9 @@ public interface AnalyticsListener {
*/
default void onIsLoadingChanged(EventTime eventTime, boolean isLoading) {}
/** @deprecated Use {@link #onIsLoadingChanged(EventTime, boolean)} instead. */
/**
* @deprecated Use {@link #onIsLoadingChanged(EventTime, boolean)} instead.
*/
@Deprecated
default void onLoadingChanged(EventTime eventTime, boolean isLoading) {}
......@@ -838,7 +840,9 @@ public interface AnalyticsListener {
*/
default void onCues(EventTime eventTime, List<Cue> cues) {}
/** @deprecated Use {@link #onAudioEnabled} and {@link #onVideoEnabled} instead. */
/**
* @deprecated Use {@link #onAudioEnabled} and {@link #onVideoEnabled} instead.
*/
@Deprecated
default void onDecoderEnabled(
EventTime eventTime, int trackType, DecoderCounters decoderCounters) {}
......@@ -858,7 +862,9 @@ public interface AnalyticsListener {
@Deprecated
default void onDecoderInputFormatChanged(EventTime eventTime, int trackType, Format format) {}
/** @deprecated Use {@link #onAudioDisabled} and {@link #onVideoDisabled} instead. */
/**
* @deprecated Use {@link #onAudioDisabled} and {@link #onVideoDisabled} instead.
*/
@Deprecated
default void onDecoderDisabled(
EventTime eventTime, int trackType, DecoderCounters decoderCounters) {}
......@@ -887,7 +893,9 @@ public interface AnalyticsListener {
long initializedTimestampMs,
long initializationDurationMs) {}
/** @deprecated Use {@link #onAudioDecoderInitialized(EventTime, String, long, long)}. */
/**
* @deprecated Use {@link #onAudioDecoderInitialized(EventTime, String, long, long)}.
*/
@Deprecated
default void onAudioDecoderInitialized(
EventTime eventTime, String decoderName, long initializationDurationMs) {}
......@@ -1056,7 +1064,9 @@ public interface AnalyticsListener {
long initializedTimestampMs,
long initializationDurationMs) {}
/** @deprecated Use {@link #onVideoDecoderInitialized(EventTime, String, long, long)}. */
/**
* @deprecated Use {@link #onVideoDecoderInitialized(EventTime, String, long, long)}.
*/
@Deprecated
default void onVideoDecoderInitialized(
EventTime eventTime, String decoderName, long initializationDurationMs) {}
......@@ -1162,7 +1172,9 @@ public interface AnalyticsListener {
*/
default void onVideoSizeChanged(EventTime eventTime, VideoSize videoSize) {}
/** @deprecated Implement {@link #onVideoSizeChanged(EventTime eventTime, VideoSize)} instead. */
/**
* @deprecated Implement {@link #onVideoSizeChanged(EventTime eventTime, VideoSize)} instead.
*/
@Deprecated
default void onVideoSizeChanged(
EventTime eventTime,
......@@ -1182,7 +1194,9 @@ public interface AnalyticsListener {
*/
default void onSurfaceSizeChanged(EventTime eventTime, int width, int height) {}
/** @deprecated Implement {@link #onDrmSessionAcquired(EventTime, int)} instead. */
/**
* @deprecated Implement {@link #onDrmSessionAcquired(EventTime, int)} instead.
*/
@Deprecated
default void onDrmSessionAcquired(EventTime eventTime) {}
......
library/core/src/main/java/com/google/android/exoplayer2/audio/AudioRendererEventListener.java
......@@ -57,7 +57,9 @@ public interface AudioRendererEventListener {
default void onAudioDecoderInitialized(
String decoderName, long initializedTimestampMs, long initializationDurationMs) {}
/** @deprecated Use {@link #onAudioInputFormatChanged(Format, DecoderReuseEvaluation)}. */
/**
* @deprecated Use {@link #onAudioInputFormatChanged(Format, DecoderReuseEvaluation)}.
*/
@Deprecated
default void onAudioInputFormatChanged(Format format) {}
......
library/core/src/main/java/com/google/android/exoplayer2/audio/AudioTrackPositionTracker.java
......@@ -116,11 +116,17 @@ import java.lang.reflect.Method;
@Target(TYPE_USE)
@IntDef({PLAYSTATE_STOPPED, PLAYSTATE_PAUSED, PLAYSTATE_PLAYING})
private @interface PlayState {}
/** @see AudioTrack#PLAYSTATE_STOPPED */
/**
* @see AudioTrack#PLAYSTATE_STOPPED
*/
private static final int PLAYSTATE_STOPPED = AudioTrack.PLAYSTATE_STOPPED;
/** @see AudioTrack#PLAYSTATE_PAUSED */
/**
* @see AudioTrack#PLAYSTATE_PAUSED
*/
private static final int PLAYSTATE_PAUSED = AudioTrack.PLAYSTATE_PAUSED;
/** @see AudioTrack#PLAYSTATE_PLAYING */
/**
* @see AudioTrack#PLAYSTATE_PLAYING
*/
private static final int PLAYSTATE_PLAYING = AudioTrack.PLAYSTATE_PLAYING;
/**
......
library/core/src/main/java/com/google/android/exoplayer2/audio/DefaultAudioSink.java
......@@ -524,7 +524,9 @@ public final class DefaultAudioSink implements AudioSink {
private boolean offloadDisabledUntilNextConfiguration;
private boolean isWaitingForOffloadEndOfStreamHandled;
/** @deprecated Use {@link Builder}. */
/**
* @deprecated Use {@link Builder}.
*/
@Deprecated
@InlineMeValidationDisabled("Migrate constructor to Builder")
@InlineMe(
......@@ -542,7 +544,9 @@ public final class DefaultAudioSink implements AudioSink {
.setAudioProcessors(audioProcessors));
}
/** @deprecated Use {@link Builder}. */
/**
* @deprecated Use {@link Builder}.
*/
@Deprecated
@InlineMeValidationDisabled("Migrate constructor to Builder")
@InlineMe(
......@@ -564,7 +568,9 @@ public final class DefaultAudioSink implements AudioSink {
.setEnableFloatOutput(enableFloatOutput));
}
/** @deprecated Use {@link Builder}. */
/**
* @deprecated Use {@link Builder}.
*/
@Deprecated
@InlineMeValidationDisabled("Migrate constructor to Builder")
@InlineMe(
......
library/core/src/main/java/com/google/android/exoplayer2/drm/DrmSessionEventListener.java
......@@ -28,7 +28,9 @@ import java.util.concurrent.CopyOnWriteArrayList;
/** Listener of {@link DrmSessionManager} events. */
public interface DrmSessionEventListener {
/** @deprecated Implement {@link #onDrmSessionAcquired(int, MediaPeriodId, int)} instead. */
/**
* @deprecated Implement {@link #onDrmSessionAcquired(int, MediaPeriodId, int)} instead.
*/
@Deprecated
default void onDrmSessionAcquired(int windowIndex, @Nullable MediaPeriodId mediaPeriodId) {}
......
library/core/src/main/java/com/google/android/exoplayer2/drm/LocalMediaDrmCallback.java
......@@ -30,7 +30,9 @@ public final class LocalMediaDrmCallback implements MediaDrmCallback {
private final byte[] keyResponse;
/** @param keyResponse The fixed response for all key requests. */
/**
* @param keyResponse The fixed response for all key requests.
*/
public LocalMediaDrmCallback(byte[] keyResponse) {
this.keyResponse = Assertions.checkNotNull(keyResponse);
}
......
library/core/src/main/java/com/google/android/exoplayer2/drm/UnsupportedDrmException.java
......@@ -49,7 +49,9 @@ public final class UnsupportedDrmException extends Exception {
/** Either {@link #REASON_UNSUPPORTED_SCHEME} or {@link #REASON_INSTANTIATION_ERROR}. */
public final @Reason int reason;
/** @param reason {@link #REASON_UNSUPPORTED_SCHEME} or {@link #REASON_INSTANTIATION_ERROR}. */
/**
* @param reason {@link #REASON_UNSUPPORTED_SCHEME} or {@link #REASON_INSTANTIATION_ERROR}.
*/
public UnsupportedDrmException(@Reason int reason) {
this.reason = reason;
}
......
library/core/src/main/java/com/google/android/exoplayer2/offline/DownloadException.java
......@@ -20,12 +20,16 @@ import java.io.IOException;
/** Thrown on an error during downloading. */
public final class DownloadException extends IOException {
/** @param message The message for the exception. */
/**
* @param message The message for the exception.
*/
public DownloadException(String message) {
super(message);
}
/** @param cause The cause for the exception. */
/**
* @param cause The cause for the exception.
*/
public DownloadException(Throwable cause) {
super(cause);
}
......
library/core/src/main/java/com/google/android/exoplayer2/offline/DownloadHelper.java
......@@ -170,13 +170,17 @@ public final class DownloadHelper {
return capabilities;
}
/** @deprecated Use {@link #forMediaItem(Context, MediaItem)} */
/**
* @deprecated Use {@link #forMediaItem(Context, MediaItem)}
*/
@Deprecated
public static DownloadHelper forProgressive(Context context, Uri uri) {
return forMediaItem(context, new MediaItem.Builder().setUri(uri).build());
}
/** @deprecated Use {@link #forMediaItem(Context, MediaItem)} */
/**
* @deprecated Use {@link #forMediaItem(Context, MediaItem)}
*/
@Deprecated
public static DownloadHelper forProgressive(Context context, Uri uri, @Nullable String cacheKey) {
return forMediaItem(
......
library/core/src/main/java/com/google/android/exoplayer2/offline/DownloadService.java
......@@ -224,7 +224,9 @@ public abstract class DownloadService extends Service {
/* channelDescriptionResourceId= */ 0);
}
/** @deprecated Use {@link #DownloadService(int, long, String, int, int)}. */
/**
* @deprecated Use {@link #DownloadService(int, long, String, int, int)}.
*/
@Deprecated
protected DownloadService(
int foregroundNotificationId,
......
library/core/src/main/java/com/google/android/exoplayer2/scheduler/Requirements.java
......@@ -74,7 +74,9 @@ public final class Requirements implements Parcelable {
private final @RequirementFlags int requirements;
/** @param requirements A combination of requirement flags. */
/**
* @param requirements A combination of requirement flags.
*/
public Requirements(@RequirementFlags int requirements) {
if ((requirements & NETWORK_UNMETERED) != 0) {
// Make sure network requirement flags are consistent.
......
library/core/src/main/java/com/google/android/exoplayer2/source/ClippingMediaSource.java
......@@ -63,7 +63,9 @@ public final class ClippingMediaSource extends CompositeMediaSource<Void> {
/** The reason clipping failed. */
public final @Reason int reason;
/** @param reason The reason clipping failed. */
/**
* @param reason The reason clipping failed.
*/
public IllegalClippingException(@Reason int reason) {
super("Illegal clipping: " + getReasonDescription(reason));
this.reason = reason;
......
library/core/src/main/java/com/google/android/exoplayer2/source/DefaultMediaSourceFactory.java
......@@ -96,7 +96,9 @@ import org.checkerframework.checker.nullness.compatqual.NullableType;
@SuppressWarnings("deprecation") // Implement deprecated type for backwards compatibility.
public final class DefaultMediaSourceFactory implements MediaSourceFactory {
/** @deprecated Use {@link AdsLoader.Provider} instead. */
/**
* @deprecated Use {@link AdsLoader.Provider} instead.
*/
@Deprecated
public interface AdsLoaderProvider extends AdsLoader.Provider {}
......
library/core/src/main/java/com/google/android/exoplayer2/source/MediaSourceFactory.java
......@@ -21,7 +21,9 @@ import com.google.android.exoplayer2.MediaItem;
import com.google.android.exoplayer2.drm.DrmSessionManagerProvider;
import com.google.android.exoplayer2.upstream.LoadErrorHandlingPolicy;
/** @deprecated Use {@link MediaSource.Factory}. */
/**
* @deprecated Use {@link MediaSource.Factory}.
*/
@Deprecated
public interface MediaSourceFactory extends MediaSource.Factory {
......
library/core/src/main/java/com/google/android/exoplayer2/source/MergingMediaSource.java
......@@ -61,7 +61,9 @@ public final class MergingMediaSource extends CompositeMediaSource<Integer> {
/** The reason the merge failed. */
public final @Reason int reason;
/** @param reason The reason the merge failed. */
/**
* @param reason The reason the merge failed.
*/
public IllegalMergeException(@Reason int reason) {
this.reason = reason;
}
......
library/core/src/main/java/com/google/android/exoplayer2/trackselection/DefaultTrackSelector.java
......@@ -1476,19 +1476,25 @@ public class DefaultTrackSelector extends MappingTrackSelector {
private final ExoTrackSelection.Factory trackSelectionFactory;
private final AtomicReference<Parameters> parametersReference;
/** @deprecated Use {@link #DefaultTrackSelector(Context)} instead. */
/**
* @deprecated Use {@link #DefaultTrackSelector(Context)} instead.
*/
@Deprecated
public DefaultTrackSelector() {
this(Parameters.DEFAULT_WITHOUT_CONTEXT, new AdaptiveTrackSelection.Factory());
}
/** @deprecated Use {@link #DefaultTrackSelector(Context, ExoTrackSelection.Factory)}. */
/**
* @deprecated Use {@link #DefaultTrackSelector(Context, ExoTrackSelection.Factory)}.
*/
@Deprecated
public DefaultTrackSelector(ExoTrackSelection.Factory trackSelectionFactory) {
this(Parameters.DEFAULT_WITHOUT_CONTEXT, trackSelectionFactory);
}
/** @param context Any {@link Context}. */
/**
* @param context Any {@link Context}.
*/
public DefaultTrackSelector(Context context) {
this(context, new AdaptiveTrackSelection.Factory());
}
......
library/core/src/main/java/com/google/android/exoplayer2/trackselection/RandomTrackSelection.java
......@@ -40,7 +40,9 @@ public final class RandomTrackSelection extends BaseTrackSelection {
random = new Random();
}
/** @param seed A seed for the {@link Random} instance used by the factory. */
/**
* @param seed A seed for the {@link Random} instance used by the factory.
*/
public Factory(int seed) {
random = new Random(seed);
}
......
library/core/src/main/java/com/google/android/exoplayer2/upstream/DefaultBandwidthMeter.java
......@@ -285,7 +285,9 @@ public final class DefaultBandwidthMeter implements BandwidthMeter, TransferList
private boolean networkTypeOverrideSet;
private @C.NetworkType int networkTypeOverride;
/** @deprecated Use {@link Builder} instead. */
/**
* @deprecated Use {@link Builder} instead.
*/
@Deprecated
public DefaultBandwidthMeter() {
this(
......
library/core/src/main/java/com/google/android/exoplayer2/upstream/DefaultLoadErrorHandlingPolicy.java
......@@ -38,7 +38,9 @@ public class DefaultLoadErrorHandlingPolicy implements LoadErrorHandlingPolicy {
public static final int DEFAULT_MIN_LOADABLE_RETRY_COUNT_PROGRESSIVE_LIVE = 6;
/** The default duration for which a track is excluded in milliseconds. */
public static final long DEFAULT_TRACK_EXCLUSION_MS = 60_000;
/** @deprecated Use {@link #DEFAULT_TRACK_EXCLUSION_MS} instead. */
/**
* @deprecated Use {@link #DEFAULT_TRACK_EXCLUSION_MS} instead.
*/
@Deprecated public static final long DEFAULT_TRACK_BLACKLIST_MS = DEFAULT_TRACK_EXCLUSION_MS;
/** The default duration for which a location is excluded in milliseconds. */
public static final long DEFAULT_LOCATION_EXCLUSION_MS = 5 * 60_000;
......
library/core/src/main/java/com/google/android/exoplayer2/upstream/SlidingPercentile.java
......@@ -55,7 +55,9 @@ public class SlidingPercentile {
private int totalWeight;
private int recycledSampleCount;
/** @param maxWeight The maximum weight. */
/**
* @param maxWeight The maximum weight.
*/
public SlidingPercentile(int maxWeight) {
this.maxWeight = maxWeight;
recycledSamples = new Sample[MAX_RECYCLED_SAMPLES];
......
library/core/src/main/java/com/google/android/exoplayer2/video/VideoDecoderGLSurfaceView.java
......@@ -48,7 +48,9 @@ public final class VideoDecoderGLSurfaceView extends GLSurfaceView
private final Renderer renderer;
/** @param context A {@link Context}. */
/**
* @param context A {@link Context}.
*/
public VideoDecoderGLSurfaceView(Context context) {
this(context, /* attrs= */ null);
}
......@@ -72,7 +74,9 @@ public final class VideoDecoderGLSurfaceView extends GLSurfaceView
renderer.setOutputBuffer(outputBuffer);
}
/** @deprecated This class implements {@link VideoDecoderOutputBufferRenderer} directly. */
/**
* @deprecated This class implements {@link VideoDecoderOutputBufferRenderer} directly.
*/
@Deprecated
public VideoDecoderOutputBufferRenderer getVideoDecoderOutputBufferRenderer() {
return this;
......
library/core/src/main/java/com/google/android/exoplayer2/video/VideoRendererEventListener.java
......@@ -56,7 +56,9 @@ public interface VideoRendererEventListener {
default void onVideoDecoderInitialized(
String decoderName, long initializedTimestampMs, long initializationDurationMs) {}
/** @deprecated Use {@link #onVideoInputFormatChanged(Format, DecoderReuseEvaluation)}. */
/**
* @deprecated Use {@link #onVideoInputFormatChanged(Format, DecoderReuseEvaluation)}.
*/
@Deprecated
default void onVideoInputFormatChanged(Format format) {}
......
library/dash/src/main/java/com/google/android/exoplayer2/source/dash/DashMediaSource.java
......@@ -299,7 +299,9 @@ public final class DashMediaSource extends BaseMediaSource {
* if no value is defined in the {@link MediaItem} or the manifest.
*/
public static final long DEFAULT_FALLBACK_TARGET_LIVE_OFFSET_MS = 30_000;
/** @deprecated Use {@link #DEFAULT_FALLBACK_TARGET_LIVE_OFFSET_MS} instead. */
/**
* @deprecated Use {@link #DEFAULT_FALLBACK_TARGET_LIVE_OFFSET_MS} instead.
*/
@Deprecated public static final long DEFAULT_LIVE_PRESENTATION_DELAY_MS = 30_000;
/** The media id used by media items of dash media sources without a manifest URI. */
public static final String DEFAULT_MEDIA_ID = "DashMediaSource";
......
library/dash/src/main/java/com/google/android/exoplayer2/source/dash/manifest/SingleSegmentIndex.java
......@@ -23,7 +23,9 @@ import com.google.android.exoplayer2.source.dash.DashSegmentIndex;
private final RangedUri uri;
/** @param uri A {@link RangedUri} defining the location of the segment data. */
/**
* @param uri A {@link RangedUri} defining the location of the segment data.
*/
public SingleSegmentIndex(RangedUri uri) {
this.uri = uri;
}
......
library/database/src/main/java/com/google/android/exoplayer2/database/ExoDatabaseProvider.java
......@@ -17,7 +17,9 @@ package com.google.android.exoplayer2.database;
import android.content.Context;
/** @deprecated Use {@link StandaloneDatabaseProvider}. */
/**
* @deprecated Use {@link StandaloneDatabaseProvider}.
*/
@Deprecated
public final class ExoDatabaseProvider extends StandaloneDatabaseProvider {
......
library/datasource/src/main/java/com/google/android/exoplayer2/upstream/AssetDataSource.java
......@@ -35,7 +35,9 @@ public final class AssetDataSource extends BaseDataSource {
/** Thrown when an {@link IOException} is encountered reading a local asset. */
public static final class AssetDataSourceException extends DataSourceException {
/** @deprecated Use {@link #AssetDataSourceException(Throwable, int)}. */
/**
* @deprecated Use {@link #AssetDataSourceException(Throwable, int)}.
*/
@Deprecated
public AssetDataSourceException(IOException cause) {
super(cause, PlaybackException.ERROR_CODE_IO_UNSPECIFIED);
......@@ -60,7 +62,9 @@ public final class AssetDataSource extends BaseDataSource {
private long bytesRemaining;
private boolean opened;
/** @param context A context. */
/**
* @param context A context.
*/
public AssetDataSource(Context context) {
super(/* isNetwork= */ false);
this.assetManager = context.getAssets();
......
library/datasource/src/main/java/com/google/android/exoplayer2/upstream/ByteArrayDataSource.java
......@@ -34,7 +34,9 @@ public final class ByteArrayDataSource extends BaseDataSource {
private int bytesRemaining;
private boolean opened;
/** @param data The data to be read. */
/**
* @param data The data to be read.
*/
public ByteArrayDataSource(byte[] data) {
super(/* isNetwork= */ false);
Assertions.checkNotNull(data);
......
library/datasource/src/main/java/com/google/android/exoplayer2/upstream/ContentDataSource.java
......@@ -44,7 +44,9 @@ public final class ContentDataSource extends BaseDataSource {
/** Thrown when an {@link IOException} is encountered reading from a content URI. */
public static class ContentDataSourceException extends DataSourceException {
/** @deprecated Use {@link #ContentDataSourceException(IOException, int)}. */
/**
* @deprecated Use {@link #ContentDataSourceException(IOException, int)}.
*/
@Deprecated
public ContentDataSourceException(IOException cause) {
this(cause, PlaybackException.ERROR_CODE_IO_UNSPECIFIED);
......@@ -65,7 +67,9 @@ public final class ContentDataSource extends BaseDataSource {
private long bytesRemaining;
private boolean opened;
/** @param context A context. */
/**
* @param context A context.
*/
public ContentDataSource(Context context) {
super(/* isNetwork= */ false);
this.resolver = context.getContentResolver();
......
library/datasource/src/main/java/com/google/android/exoplayer2/upstream/DefaultDataSourceFactory.java
......@@ -19,7 +19,9 @@ import android.content.Context;
import androidx.annotation.Nullable;
import com.google.android.exoplayer2.upstream.DataSource.Factory;
/** @deprecated Use {@link DefaultDataSource.Factory} instead. */
/**
* @deprecated Use {@link DefaultDataSource.Factory} instead.
*/
@Deprecated
public final class DefaultDataSourceFactory implements Factory {
......
library/datasource/src/main/java/com/google/android/exoplayer2/upstream/DefaultHttpDataSource.java
......@@ -227,21 +227,27 @@ public class DefaultHttpDataSource extends BaseDataSource implements HttpDataSou
private long bytesToRead;
private long bytesRead;
/** @deprecated Use {@link DefaultHttpDataSource.Factory} instead. */
/**
* @deprecated Use {@link DefaultHttpDataSource.Factory} instead.
*/
@SuppressWarnings("deprecation")
@Deprecated
public DefaultHttpDataSource() {
this(/* userAgent= */ null, DEFAULT_CONNECT_TIMEOUT_MILLIS, DEFAULT_READ_TIMEOUT_MILLIS);
}
/** @deprecated Use {@link DefaultHttpDataSource.Factory} instead. */
/**
* @deprecated Use {@link DefaultHttpDataSource.Factory} instead.
*/
@SuppressWarnings("deprecation")
@Deprecated
public DefaultHttpDataSource(@Nullable String userAgent) {
this(userAgent, DEFAULT_CONNECT_TIMEOUT_MILLIS, DEFAULT_READ_TIMEOUT_MILLIS);
}
/** @deprecated Use {@link DefaultHttpDataSource.Factory} instead. */
/**
* @deprecated Use {@link DefaultHttpDataSource.Factory} instead.
*/
@SuppressWarnings("deprecation")
@Deprecated
public DefaultHttpDataSource(
......@@ -254,7 +260,9 @@ public class DefaultHttpDataSource extends BaseDataSource implements HttpDataSou
/* defaultRequestProperties= */ null);
}
/** @deprecated Use {@link DefaultHttpDataSource.Factory} instead. */
/**
* @deprecated Use {@link DefaultHttpDataSource.Factory} instead.
*/
@Deprecated
public DefaultHttpDataSource(
@Nullable String userAgent,
......
library/datasource/src/main/java/com/google/android/exoplayer2/upstream/FileDataSource.java
......@@ -39,13 +39,17 @@ public final class FileDataSource extends BaseDataSource {
/** Thrown when a {@link FileDataSource} encounters an error reading a file. */
public static class FileDataSourceException extends DataSourceException {
/** @deprecated Use {@link #FileDataSourceException(Throwable, int)} */
/**
* @deprecated Use {@link #FileDataSourceException(Throwable, int)}
*/
@Deprecated
public FileDataSourceException(Exception cause) {
super(cause, PlaybackException.ERROR_CODE_IO_UNSPECIFIED);
}
/** @deprecated Use {@link #FileDataSourceException(String, Throwable, int)} */
/**
* @deprecated Use {@link #FileDataSourceException(String, Throwable, int)}
*/
@Deprecated
public FileDataSourceException(String message, IOException cause) {
super(message, cause, PlaybackException.ERROR_CODE_IO_UNSPECIFIED);
......
library/datasource/src/main/java/com/google/android/exoplayer2/upstream/PriorityDataSourceFactory.java
......@@ -18,7 +18,9 @@ package com.google.android.exoplayer2.upstream;
import com.google.android.exoplayer2.upstream.DataSource.Factory;
import com.google.android.exoplayer2.util.PriorityTaskManager;
/** @deprecated Use {@link PriorityDataSource.Factory}. */
/**
* @deprecated Use {@link PriorityDataSource.Factory}.
*/
@Deprecated
public final class PriorityDataSourceFactory implements Factory {
......
library/datasource/src/main/java/com/google/android/exoplayer2/upstream/RawResourceDataSource.java
......@@ -56,13 +56,17 @@ public final class RawResourceDataSource extends BaseDataSource {
/** Thrown when an {@link IOException} is encountered reading from a raw resource. */
public static class RawResourceDataSourceException extends DataSourceException {
/** @deprecated Use {@link #RawResourceDataSourceException(String, Throwable, int)}. */
/**
* @deprecated Use {@link #RawResourceDataSourceException(String, Throwable, int)}.
*/
@Deprecated
public RawResourceDataSourceException(String message) {
super(message, /* cause= */ null, PlaybackException.ERROR_CODE_IO_UNSPECIFIED);
}
/** @deprecated Use {@link #RawResourceDataSourceException(String, Throwable, int)}. */
/**
* @deprecated Use {@link #RawResourceDataSourceException(String, Throwable, int)}.
*/
@Deprecated
public RawResourceDataSourceException(Throwable cause) {
super(cause, PlaybackException.ERROR_CODE_IO_UNSPECIFIED);
......@@ -99,7 +103,9 @@ public final class RawResourceDataSource extends BaseDataSource {
private long bytesRemaining;
private boolean opened;
/** @param context A context. */
/**
* @param context A context.
*/
public RawResourceDataSource(Context context) {
super(/* isNetwork= */ false);
this.resources = context.getResources();
......
library/datasource/src/main/java/com/google/android/exoplayer2/upstream/cache/CacheFileMetadataIndex.java
......@@ -94,7 +94,9 @@ import org.checkerframework.checker.nullness.qual.MonotonicNonNull;
}
}
/** @param databaseProvider Provides the database in which the index is stored. */
/**
* @param databaseProvider Provides the database in which the index is stored.
*/
public CacheFileMetadataIndex(DatabaseProvider databaseProvider) {
this.databaseProvider = databaseProvider;
}
......
library/datasource/src/main/java/com/google/android/exoplayer2/upstream/cache/DefaultContentMetadata.java
......@@ -41,7 +41,9 @@ public final class DefaultContentMetadata implements ContentMetadata {
this(Collections.emptyMap());
}
/** @param metadata The metadata entries in their raw byte array form. */
/**
* @param metadata The metadata entries in their raw byte array form.
*/
public DefaultContentMetadata(Map<String, byte[]> metadata) {
this.metadata = Collections.unmodifiableMap(metadata);
}
......
library/decoder/src/main/java/com/google/android/exoplayer2/decoder/CryptoInfo.java
......@@ -67,9 +67,13 @@ public final class CryptoInfo {
* @see android.media.MediaCodec.CryptoInfo#numSubSamples
*/
public int numSubSamples;
/** @see android.media.MediaCodec.CryptoInfo.Pattern */
/**
* @see android.media.MediaCodec.CryptoInfo.Pattern
*/
public int encryptedBlocks;
/** @see android.media.MediaCodec.CryptoInfo.Pattern */
/**
* @see android.media.MediaCodec.CryptoInfo.Pattern
*/
public int clearBlocks;
private final android.media.MediaCodec.CryptoInfo frameworkCryptoInfo;
......@@ -80,7 +84,9 @@ public final class CryptoInfo {
patternHolder = Util.SDK_INT >= 24 ? new PatternHolderV24(frameworkCryptoInfo) : null;
}
/** @see android.media.MediaCodec.CryptoInfo#set(int, int[], int[], byte[], byte[], int) */
/**
* @see android.media.MediaCodec.CryptoInfo#set(int, int[], int[], byte[], byte[], int)
*/
public void set(
int numSubSamples,
int[] numBytesOfClearData,
......
library/extractor/src/main/java/com/google/android/exoplayer2/extractor/BinarySearchSeeker.java
......@@ -532,7 +532,9 @@ public abstract class BinarySearchSeeker {
return durationUs;
}
/** @see SeekTimestampConverter#timeUsToTargetTime(long) */
/**
* @see SeekTimestampConverter#timeUsToTargetTime(long)
*/
public long timeUsToTargetTime(long timeUs) {
return seekTimestampConverter.timeUsToTargetTime(timeUs);
}
......
library/extractor/src/main/java/com/google/android/exoplayer2/extractor/SeekMap.java
......@@ -73,7 +73,9 @@ public interface SeekMap {
/** The second seek point, or {@link #first} if there's only one seek point. */
public final SeekPoint second;
/** @param point The single seek point. */
/**
* @param point The single seek point.
*/
public SeekPoints(SeekPoint point) {
this(point, point);
}
......
library/extractor/src/main/java/com/google/android/exoplayer2/extractor/amr/AmrExtractor.java
......@@ -169,7 +169,9 @@ public final class AmrExtractor implements Extractor {
this(/* flags= */ 0);
}
/** @param flags Flags that control the extractor's behavior. */
/**
* @param flags Flags that control the extractor's behavior.
*/
public AmrExtractor(@Flags int flags) {
if ((flags & FLAG_ENABLE_CONSTANT_BITRATE_SEEKING_ALWAYS) != 0) {
flags |= FLAG_ENABLE_CONSTANT_BITRATE_SEEKING;
......
library/extractor/src/main/java/com/google/android/exoplayer2/extractor/flv/TagPayloadReader.java
......@@ -33,7 +33,9 @@ import com.google.android.exoplayer2.util.ParsableByteArray;
protected final TrackOutput output;
/** @param output A {@link TrackOutput} to which samples should be written. */
/**
* @param output A {@link TrackOutput} to which samples should be written.
*/
protected TagPayloadReader(TrackOutput output) {
this.output = output;
}
......
library/extractor/src/main/java/com/google/android/exoplayer2/extractor/flv/VideoTagPayloadReader.java
......@@ -48,7 +48,9 @@ import com.google.android.exoplayer2.video.AvcConfig;
private boolean hasOutputKeyframe;
private int frameType;
/** @param output A {@link TrackOutput} to which samples should be written. */
/**
* @param output A {@link TrackOutput} to which samples should be written.
*/
public VideoTagPayloadReader(TrackOutput output) {
super(output);
nalStartCode = new ParsableByteArray(NalUnitUtil.NAL_START_CODE);
......
library/extractor/src/main/java/com/google/android/exoplayer2/extractor/mp3/Mp3Extractor.java
......@@ -169,7 +169,9 @@ public final class Mp3Extractor implements Extractor {
this(0);
}
/** @param flags Flags that control the extractor's behavior. */
/**
* @param flags Flags that control the extractor's behavior.
*/
public Mp3Extractor(@Flags int flags) {
this(flags, C.TIME_UNSET);
}
......
library/extractor/src/main/java/com/google/android/exoplayer2/extractor/mp4/FragmentedMp4Extractor.java
......@@ -186,7 +186,9 @@ public class FragmentedMp4Extractor implements Extractor {
this(0);
}
/** @param flags Flags that control the extractor's behavior. */
/**
* @param flags Flags that control the extractor's behavior.
*/
public FragmentedMp4Extractor(@Flags int flags) {
this(flags, /* timestampAdjuster= */ null);
}
......
library/extractor/src/main/java/com/google/android/exoplayer2/extractor/ogg/StreamReader.java
......@@ -90,7 +90,9 @@ import org.checkerframework.checker.nullness.qual.RequiresNonNull;
currentGranule = 0;
}
/** @see Extractor#seek(long, long) */
/**
* @see Extractor#seek(long, long)
*/
final void seek(long position, long timeUs) {
oggPacket.reset();
if (position == 0) {
......@@ -104,7 +106,9 @@ import org.checkerframework.checker.nullness.qual.RequiresNonNull;
}
}
/** @see Extractor#read(ExtractorInput, PositionHolder) */
/**
* @see Extractor#read(ExtractorInput, PositionHolder)
*/
final int read(ExtractorInput input, PositionHolder seekPosition) throws IOException {
assertInitialized();
switch (state) {
......
library/extractor/src/main/java/com/google/android/exoplayer2/extractor/ts/AdtsReader.java
......@@ -98,7 +98,9 @@ public final class AdtsReader implements ElementaryStreamReader {
private @MonotonicNonNull TrackOutput currentOutput;
private long currentSampleDuration;
/** @param exposeId3 True if the reader should expose ID3 information. */
/**
* @param exposeId3 True if the reader should expose ID3 information.
*/
public AdtsReader(boolean exposeId3) {
this(exposeId3, null);
}
......
library/extractor/src/main/java/com/google/android/exoplayer2/extractor/ts/DvbSubtitleReader.java
......@@ -39,7 +39,9 @@ public final class DvbSubtitleReader implements ElementaryStreamReader {
private int sampleBytesWritten;
private long sampleTimeUs;
/** @param subtitleInfos Information about the DVB subtitles associated to the stream. */
/**
* @param subtitleInfos Information about the DVB subtitles associated to the stream.
*/
public DvbSubtitleReader(List<DvbSubtitleInfo> subtitleInfos) {
this.subtitleInfos = subtitleInfos;
outputs = new TrackOutput[subtitleInfos.size()];
......
library/extractor/src/main/java/com/google/android/exoplayer2/extractor/ts/H265Reader.java
......@@ -76,7 +76,9 @@ public final class H265Reader implements ElementaryStreamReader {
// Scratch variables to avoid allocations.
private final ParsableByteArray seiWrapper;
/** @param seiReader An SEI reader for consuming closed caption channels. */
/**
* @param seiReader An SEI reader for consuming closed caption channels.
*/
public H265Reader(SeiReader seiReader) {
this.seiReader = seiReader;
prefixFlags = new boolean[3];
......
library/extractor/src/main/java/com/google/android/exoplayer2/extractor/ts/LatmReader.java
......@@ -73,7 +73,9 @@ public final class LatmReader implements ElementaryStreamReader {
private int channelCount;
@Nullable private String codecs;
/** @param language Track language. */
/**
* @param language Track language.
*/
public LatmReader(@Nullable String language) {
this.language = language;
sampleDataBuffer = new ParsableByteArray(INITIAL_BUFFER_SIZE);
......
library/extractor/src/main/java/com/google/android/exoplayer2/extractor/ts/SeiReader.java
......@@ -33,7 +33,9 @@ public final class SeiReader {
private final List<Format> closedCaptionFormats;
private final TrackOutput[] outputs;
/** @param closedCaptionFormats A list of formats for the closed caption channels to expose. */
/**
* @param closedCaptionFormats A list of formats for the closed caption channels to expose.
*/
public SeiReader(List<Format> closedCaptionFormats) {
this.closedCaptionFormats = closedCaptionFormats;
outputs = new TrackOutput[closedCaptionFormats.size()];
......
library/extractor/src/main/java/com/google/android/exoplayer2/metadata/flac/VorbisComment.java
......@@ -23,7 +23,9 @@ import androidx.annotation.Nullable;
import com.google.android.exoplayer2.MediaMetadata;
import com.google.android.exoplayer2.metadata.Metadata;
/** @deprecated Use {@link com.google.android.exoplayer2.metadata.vorbis.VorbisComment} instead. */
/**
* @deprecated Use {@link com.google.android.exoplayer2.metadata.vorbis.VorbisComment} instead.
*/
@Deprecated
public class VorbisComment implements Metadata.Entry {
......
library/extractor/src/main/java/com/google/android/exoplayer2/text/SimpleSubtitleDecoder.java
......@@ -28,7 +28,9 @@ public abstract class SimpleSubtitleDecoder
private final String name;
/** @param name The name of the decoder. */
/**
* @param name The name of the decoder.
*/
@SuppressWarnings("nullness:method.invocation")
protected SimpleSubtitleDecoder(String name) {
super(new SubtitleInputBuffer[2], new SubtitleOutputBuffer[2]);
......
library/extractor/src/main/java/com/google/android/exoplayer2/text/SubtitleDecoderException.java
......@@ -21,12 +21,16 @@ import com.google.android.exoplayer2.decoder.DecoderException;
/** Thrown when an error occurs decoding subtitle data. */
public class SubtitleDecoderException extends DecoderException {
/** @param message The detail message for this exception. */
/**
* @param message The detail message for this exception.
*/
public SubtitleDecoderException(String message) {
super(message);
}
/** @param cause The cause of this exception, or {@code null}. */
/**
* @param cause The cause of this exception, or {@code null}.
*/
public SubtitleDecoderException(@Nullable Throwable cause) {
super(cause);
}
......
library/extractor/src/main/java/com/google/android/exoplayer2/text/cea/CeaSubtitle.java
......@@ -27,7 +27,9 @@ import java.util.List;
private final List<Cue> cues;
/** @param cues The subtitle cues. */
/**
* @param cues The subtitle cues.
*/
public CeaSubtitle(List<Cue> cues) {
this.cues = cues;
}
......
library/hls/src/main/java/com/google/android/exoplayer2/source/hls/DefaultHlsDataSourceFactory.java
......@@ -22,7 +22,9 @@ public final class DefaultHlsDataSourceFactory implements HlsDataSourceFactory {
private final DataSource.Factory dataSourceFactory;
/** @param dataSourceFactory The {@link DataSource.Factory} to use for all data types. */
/**
* @param dataSourceFactory The {@link DataSource.Factory} to use for all data types.
*/
public DefaultHlsDataSourceFactory(DataSource.Factory dataSourceFactory) {
this.dataSourceFactory = dataSourceFactory;
}
......
library/hls/src/main/java/com/google/android/exoplayer2/source/hls/HlsManifest.java
......@@ -22,7 +22,9 @@ import com.google.android.exoplayer2.source.hls.playlist.HlsMultivariantPlaylist
/** Holds a multivariant playlist along with a snapshot of one of its media playlists. */
public final class HlsManifest {
/** @deprecated Use {@link #multivariantPlaylist} instead. */
/**
* @deprecated Use {@link #multivariantPlaylist} instead.
*/
@Deprecated
@SuppressWarnings("deprecation") // Keeping deprecated field with deprecated class.
public final HlsMasterPlaylist masterPlaylist;
......
library/hls/src/main/java/com/google/android/exoplayer2/source/hls/SampleQueueMappingException.java
......@@ -23,7 +23,9 @@ import java.io.IOException;
/** Thrown when it is not possible to map a {@link TrackGroup} to a {@link SampleQueue}. */
public final class SampleQueueMappingException extends IOException {
/** @param mimeType The mime type of the track group whose mapping failed. */
/**
* @param mimeType The mime type of the track group whose mapping failed.
*/
public SampleQueueMappingException(@Nullable String mimeType) {
super("Unable to bind a sample queue to TrackGroup with mime type " + mimeType + ".");
}
......
library/hls/src/main/java/com/google/android/exoplayer2/source/hls/playlist/HlsMasterPlaylist.java
......@@ -21,7 +21,9 @@ import com.google.android.exoplayer2.drm.DrmInitData;
import java.util.List;
import java.util.Map;
/** @deprecated Use {@link HlsMultivariantPlaylist} instead. */
/**
* @deprecated Use {@link HlsMultivariantPlaylist} instead.
*/
@Deprecated
public final class HlsMasterPlaylist extends HlsMultivariantPlaylist {
......
library/smoothstreaming/src/main/java/com/google/android/exoplayer2/source/smoothstreaming/manifest/SsManifestParser.java
......@@ -223,17 +223,23 @@ public class SsManifestParser implements ParsingLoadable.Parser<SsManifest> {
// Do nothing.
}
/** @param xmlParser The underlying {@link XmlPullParser} */
/**
* @param xmlParser The underlying {@link XmlPullParser}
*/
protected void parseText(XmlPullParser xmlParser) {
// Do nothing.
}
/** @param xmlParser The underlying {@link XmlPullParser} */
/**
* @param xmlParser The underlying {@link XmlPullParser}
*/
protected void parseEndTag(XmlPullParser xmlParser) {
// Do nothing.
}
/** @param parsedChild A parsed child object. */
/**
* @param parsedChild A parsed child object.
*/
protected void addChild(Object parsedChild) {
// Do nothing.
}
......
library/transformer/src/main/java/com/google/android/exoplayer2/transformer/Transformer.java
......@@ -106,7 +106,9 @@ public final class Transformer {
private Clock clock;
private Codec.EncoderFactory encoderFactory;
/** @deprecated Use {@link #Builder(Context)} instead. */
/**
* @deprecated Use {@link #Builder(Context)} instead.
*/
@Deprecated
public Builder() {
muxerFactory = new FrameworkMuxer.Factory();
......@@ -152,7 +154,9 @@ public final class Transformer {
this.clock = transformer.clock;
}
/** @deprecated Use {@link #Builder(Context)} instead. */
/**
* @deprecated Use {@link #Builder(Context)} instead.
*/
@Deprecated
public Builder setContext(Context context) {
this.context = context.getApplicationContext();
......@@ -425,7 +429,9 @@ public final class Transformer {
onTransformationCompleted(inputMediaItem);
}
/** @deprecated Use {@link #onTransformationError(MediaItem, TransformationException)}. */
/**
* @deprecated Use {@link #onTransformationError(MediaItem, TransformationException)}.
*/
@Deprecated
default void onTransformationError(MediaItem inputMediaItem, Exception exception) {
onTransformationError(inputMediaItem, (TransformationException) exception);
......
library/ui/src/main/java/com/google/android/exoplayer2/ui/DefaultTrackNameProvider.java
......@@ -30,7 +30,9 @@ public class DefaultTrackNameProvider implements TrackNameProvider {
private final Resources resources;
/** @param resources Resources from which to obtain strings. */
/**
* @param resources Resources from which to obtain strings.
*/
public DefaultTrackNameProvider(Resources resources) {
this.resources = Assertions.checkNotNull(resources);
}
......
library/ui/src/main/java/com/google/android/exoplayer2/ui/TimeBar.java
......@@ -38,7 +38,9 @@ public interface TimeBar {
*/
void removeListener(OnScrubListener listener);
/** @see View#isEnabled() */
/**
* @see View#isEnabled()
*/
void setEnabled(boolean enabled);
/**
......
testutils/src/main/java/com/google/android/exoplayer2/testutil/Action.java
......@@ -321,7 +321,9 @@ public abstract class Action {
/** Calls {@link ExoPlayer#clearMediaItems()}}. */
public static class ClearMediaItems extends Action {
/** @param tag A tag to use for logging. */
/**
* @param tag A tag to use for logging.
*/
public ClearMediaItems(String tag) {
super(tag, "ClearMediaItems");
}
......@@ -424,7 +426,9 @@ public abstract class Action {
/** Calls {@link ExoPlayer#clearVideoSurface()}. */
public static final class ClearVideoSurface extends Action {
/** @param tag A tag to use for logging. */
/**
* @param tag A tag to use for logging.
*/
public ClearVideoSurface(String tag) {
super(tag, "ClearVideoSurface");
}
......@@ -439,7 +443,9 @@ public abstract class Action {
/** Calls {@link ExoPlayer#setVideoSurface(Surface)}. */
public static final class SetVideoSurface extends Action {
/** @param tag A tag to use for logging. */
/**
* @param tag A tag to use for logging.
*/
public SetVideoSurface(String tag) {
super(tag, "SetVideoSurface");
}
......@@ -478,7 +484,9 @@ public abstract class Action {
/** Calls {@link ExoPlayer#prepare()}. */
public static final class Prepare extends Action {
/** @param tag A tag to use for logging. */
/**
* @param tag A tag to use for logging.
*/
public Prepare(String tag) {
super(tag, "Prepare");
}
......@@ -815,7 +823,9 @@ public abstract class Action {
*/
public static final class WaitForPositionDiscontinuity extends Action {
/** @param tag A tag to use for logging. */
/**
* @param tag A tag to use for logging.
*/
public WaitForPositionDiscontinuity(String tag) {
super(tag, "WaitForPositionDiscontinuity");
}
......@@ -1044,7 +1054,9 @@ public abstract class Action {
/** Waits until the player acknowledged all pending player commands. */
public static final class WaitForPendingPlayerCommands extends Action {
/** @param tag A tag to use for logging. */
/**
* @param tag A tag to use for logging.
*/
public WaitForPendingPlayerCommands(String tag) {
super(tag, "WaitForPendingPlayerCommands");
}
......@@ -1081,7 +1093,9 @@ public abstract class Action {
private final Runnable runnable;
/** @param tag A tag to use for logging. */
/**
* @param tag A tag to use for logging.
*/
public ExecuteRunnable(@Size(max = 23) String tag, Runnable runnable) {
super(tag, "ExecuteRunnable");
this.runnable = runnable;
......
testutils/src/main/java/com/google/android/exoplayer2/testutil/ActionSchedule.java
......@@ -112,7 +112,9 @@ public final class ActionSchedule {
private long currentDelayMs;
private ActionNode previousNode;
/** @param tag A tag to use for logging. */
/**
* @param tag A tag to use for logging.
*/
public Builder(String tag) {
this.tag = tag;
rootNode = new ActionNode(new RootAction(tag), 0);
......
testutils/src/main/java/com/google/android/exoplayer2/testutil/DownloadBuilder.java
......@@ -106,91 +106,121 @@ public final class DownloadBuilder {
this.progress = new DownloadProgress();
}
/** @see DownloadRequest#uri */
/**
* @see DownloadRequest#uri
*/
public DownloadBuilder setUri(String uri) {
this.uri = Uri.parse(uri);
return this;
}
/** @see DownloadRequest#uri */
/**
* @see DownloadRequest#uri
*/
public DownloadBuilder setUri(Uri uri) {
this.uri = uri;
return this;
}
/** @see DownloadRequest#mimeType */
/**
* @see DownloadRequest#mimeType
*/
public DownloadBuilder setMimeType(String mimeType) {
this.mimeType = mimeType;
return this;
}
/** @see DownloadRequest#keySetId */
/**
* @see DownloadRequest#keySetId
*/
public DownloadBuilder setKeySetId(byte[] keySetId) {
this.keySetId = keySetId;
return this;
}
/** @see DownloadRequest#customCacheKey */
/**
* @see DownloadRequest#customCacheKey
*/
public DownloadBuilder setCacheKey(@Nullable String cacheKey) {
this.cacheKey = cacheKey;
return this;
}
/** @see Download#state */
/**
* @see Download#state
*/
public DownloadBuilder setState(@Download.State int state) {
this.state = state;
return this;
}
/** @see DownloadProgress#percentDownloaded */
/**
* @see DownloadProgress#percentDownloaded
*/
public DownloadBuilder setPercentDownloaded(float percentDownloaded) {
progress.percentDownloaded = percentDownloaded;
return this;
}
/** @see DownloadProgress#bytesDownloaded */
/**
* @see DownloadProgress#bytesDownloaded
*/
public DownloadBuilder setBytesDownloaded(long bytesDownloaded) {
progress.bytesDownloaded = bytesDownloaded;
return this;
}
/** @see Download#contentLength */
/**
* @see Download#contentLength
*/
public DownloadBuilder setContentLength(long contentLength) {
this.contentLength = contentLength;
return this;
}
/** @see Download#failureReason */
/**
* @see Download#failureReason
*/
public DownloadBuilder setFailureReason(int failureReason) {
this.failureReason = failureReason;
return this;
}
/** @see Download#stopReason */
/**
* @see Download#stopReason
*/
public DownloadBuilder setStopReason(int stopReason) {
this.stopReason = stopReason;
return this;
}
/** @see Download#startTimeMs */
/**
* @see Download#startTimeMs
*/
public DownloadBuilder setStartTimeMs(long startTimeMs) {
this.startTimeMs = startTimeMs;
return this;
}
/** @see Download#updateTimeMs */
/**
* @see Download#updateTimeMs
*/
public DownloadBuilder setUpdateTimeMs(long updateTimeMs) {
this.updateTimeMs = updateTimeMs;
return this;
}
/** @see DownloadRequest#streamKeys */
/**
* @see DownloadRequest#streamKeys
*/
public DownloadBuilder setStreamKeys(StreamKey... streamKeys) {
this.streamKeys = Arrays.asList(streamKeys);
return this;
}
/** @see DownloadRequest#data */
/**
* @see DownloadRequest#data
*/
public DownloadBuilder setCustomMetadata(byte[] customMetadata) {
this.customMetadata = customMetadata;
return this;
......
testutils/src/main/java/com/google/android/exoplayer2/testutil/FakeExoMediaDrm.java
......@@ -171,13 +171,17 @@ public final class FakeExoMediaDrm implements ExoMediaDrm {
private int referenceCount;
@Nullable private OnEventListener onEventListener;
/** @deprecated Use {@link Builder} instead. */
/**
* @deprecated Use {@link Builder} instead.
*/
@Deprecated
public FakeExoMediaDrm() {
this(/* maxConcurrentSessions= */ Integer.MAX_VALUE);
}
/** @deprecated Use {@link Builder} instead. */
/**
* @deprecated Use {@link Builder} instead.
*/
@Deprecated
public FakeExoMediaDrm(int maxConcurrentSessions) {
this(
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or sign in to comment