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

Update javadoc

Browse Source
This commit is contained in:
Gaëtan Muller 2024-07-15 11:35:23 +02:00 committed by Ian Baker
parent 28edfcbb69
commit 7406b78fbc
8 changed files with 10 additions and 59 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
libraries/session/src/main/java/androidx/media3/session/legacy/MediaBrowserCompat.java
View File

@ -455,8 +455,6 @@ public final class MediaBrowserCompat {
* Creates an instance from a framework {@link android.media.browse.MediaBrowser.MediaItem}
* object.
*
* <p>This method is only supported on API 21+. On API 20 and below, it returns null.
*
* @param itemObj A {@link android.media.browse.MediaBrowser.MediaItem} object.
* @return An equivalent {@link MediaItem} object, or null if none.
*/
@ -476,8 +474,6 @@ public final class MediaBrowserCompat {
* Creates a list of {@link MediaItem} objects from a framework {@link
* android.media.browse.MediaBrowser.MediaItem} object list.
*
* <p>This method is only supported on API 21+. On API 20 and below, it returns null.
*
* @param itemList A list of {@link android.media.browse.MediaBrowser.MediaItem} objects.
* @return An equivalent list of {@link MediaItem} objects, or null if none.
*/

2
libraries/session/src/main/java/androidx/media3/session/legacy/MediaControllerCompat.java
View File

@ -642,8 +642,6 @@ public final class MediaControllerCompat {
/**
* Gets the underlying framework {@link android.media.session.MediaController} object.
*
* <p>This method is only supported on API 21+.
*
* @return The underlying {@link android.media.session.MediaController} object, or null if none.
*/
@Nullable

2
libraries/session/src/main/java/androidx/media3/session/legacy/MediaDescriptionCompat.java
View File

@ -346,8 +346,6 @@ public final class MediaDescriptionCompat implements Parcelable {
/**
* Creates an instance from a framework {@link android.media.MediaDescription} object.
*
* <p>This method is only supported on API 21+.
*
* @param descriptionObj A {@link android.media.MediaDescription} object, or null if none.
* @return An equivalent {@link MediaMetadataCompat} object, or null if none.
*/

2
libraries/session/src/main/java/androidx/media3/session/legacy/MediaMetadataCompat.java
View File

@ -555,8 +555,6 @@ public final class MediaMetadataCompat implements Parcelable {
/**
* Creates an instance from a framework {@link android.media.MediaMetadata} object.
*
* <p>This method is only supported on {@link android.os.Build.VERSION_CODES#LOLLIPOP} and later.
*
* @param metadataObj A {@link android.media.MediaMetadata} object, or null if none.
* @return An equivalent {@link MediaMetadataCompat} object, or null if none.
*/

50
libraries/session/src/main/java/androidx/media3/session/legacy/MediaSessionCompat.java
View File

@ -361,25 +361,19 @@ public class MediaSessionCompat {
* <p>The session will automatically be registered with the system but will not be published until
* {@link #setActive(boolean) setActive(true)} is called.
*
* <p>For API 20 or earlier, note that a media button receiver is required for handling {@link
* Intent#ACTION_MEDIA_BUTTON}. This constructor will attempt to find an appropriate {@link
* BroadcastReceiver} from your manifest if it's not specified. See {@link MediaButtonReceiver}
* for more details.
*
* @param context The context to use to create the session.
* @param tag A short name for debugging purposes.
* @param mbrComponent The component name for your media button receiver.
* @param mbrIntent The PendingIntent for your receiver component that handles media button
* events. This is optional and will be used on between {@link
* android.os.Build.VERSION_CODES#JELLY_BEAN_MR2} and {@link
* android.os.Build.VERSION_CODES#KITKAT_WATCH} instead of the component name.
* events. This is no longer used.
*/
@SuppressWarnings("unused")
public MediaSessionCompat(
Context context,
String tag,
@Nullable ComponentName mbrComponent,
@Nullable PendingIntent mbrIntent) {
this(context, tag, mbrComponent, mbrIntent, null);
this(context, tag, mbrComponent, null, null);
}
/**
@ -389,10 +383,7 @@ public class MediaSessionCompat {
* <p>The session will automatically be registered with the system but will not be published until
* {@link #setActive(boolean) setActive(true)} is called.
*
* <p>For API 20 or earlier, note that a media button receiver is required for handling {@link
* Intent#ACTION_MEDIA_BUTTON}. This constructor will attempt to find an appropriate {@link
* BroadcastReceiver} from your manifest if it's not specified. See {@link MediaButtonReceiver}
* for more details. The {@code sessionInfo} can include additional unchanging information about
* <p>The {@code sessionInfo} can include additional unchanging information about
* this session. For example, it can include the version of the application, or other app-specific
* unchanging information.
*
@ -400,21 +391,20 @@ public class MediaSessionCompat {
* @param tag A short name for debugging purposes.
* @param mbrComponent The component name for your media button receiver.
* @param mbrIntent The PendingIntent for your receiver component that handles media button
* events. This is optional and will be used on between {@link
* android.os.Build.VERSION_CODES#JELLY_BEAN_MR2} and {@link
* android.os.Build.VERSION_CODES#KITKAT_WATCH} instead of the component name.
* events. This is no longer used
* @param sessionInfo A bundle for additional information about this session, or {@link
* Bundle#EMPTY} if none. Controllers can get this information by calling {@link
* MediaControllerCompat#getSessionInfo()}. An {@link IllegalArgumentException} will be thrown
* if this contains any non-framework Parcelable objects.
*/
@SuppressWarnings("unused")
public MediaSessionCompat(
Context context,
String tag,
@Nullable ComponentName mbrComponent,
@Nullable PendingIntent mbrIntent,
@Nullable Bundle sessionInfo) {
this(context, tag, mbrComponent, mbrIntent, sessionInfo, null /* session2Token */);
this(context, tag, mbrComponent, null, sessionInfo, null /* session2Token */);
}
/** */
@ -554,9 +544,6 @@ public class MediaSessionCompat {
* session has been stopped. If your app is started in this way an {@link
* Intent#ACTION_MEDIA_BUTTON} intent will be sent via the pending intent.
*
* <p>This method will only work on {@link android.os.Build.VERSION_CODES#LOLLIPOP} and later.
* Earlier platform versions must include the media button receiver in the constructor.
*
* @param mbr The {@link PendingIntent} to send the media button event to.
*/
public void setMediaButtonReceiver(PendingIntent mbr) {
@ -591,10 +578,6 @@ public class MediaSessionCompat {
* {@link #setPlaybackToLocal} was previously called that stream will stop receiving volume
* changes for this session.
*
* <p>On platforms earlier than {@link android.os.Build.VERSION_CODES#LOLLIPOP} this will only
* allow an app to handle volume commands sent directly to the session by a {@link
* MediaControllerCompat}. System routing of volume keys will not use the volume provider.
*
* @param volumeProvider The provider that will handle volume changes. May not be null.
*/
public void setPlaybackToRemote(VolumeProviderCompat volumeProvider) {
@ -609,9 +592,6 @@ public class MediaSessionCompat {
* session's controller may not be discoverable. You must set the session to active before it can
* start receiving media button events or transport commands.
*
* <p>On platforms earlier than {@link android.os.Build.VERSION_CODES#LOLLIPOP}, a media button
* event receiver should be set via the constructor to receive media button events.
*
* @param active Whether this session is active or not.
*/
public void setActive(boolean active) {
@ -658,10 +638,6 @@ public class MediaSessionCompat {
* interacting with this session. The owner of the session is responsible for deciding how to
* distribute these tokens.
*
* <p>On platform versions before {@link android.os.Build.VERSION_CODES#LOLLIPOP} this token may
* only be used within your app as there is no way to guarantee other apps are using the same
* version of the support library.
*
* @return A token that can be used to create a media controller for this session.
*/
public Token getSessionToken() {
@ -807,8 +783,6 @@ public class MediaSessionCompat {
/**
* Gets the underlying framework {@link android.media.session.MediaSession} object.
*
* <p>This method is only supported on API 21+.
*
* @return The underlying {@link android.media.session.MediaSession} object, or null if none.
*/
@Nullable
@ -819,12 +793,12 @@ public class MediaSessionCompat {
/**
* Gets the underlying framework {@link android.media.RemoteControlClient} object.
*
* <p>This method is only supported on APIs 14-20. On API 21+ {@link #getMediaSession()} should be
* used instead.
*
* @return The underlying {@link android.media.RemoteControlClient} object, or null if none.
*
* @deprecated Use {@link #getMediaSession()}
*/
@Nullable
@Deprecated
public Object getRemoteControlClient() {
return mImpl.getRemoteControlClient();
}
@ -892,8 +866,6 @@ public class MediaSessionCompat {
/**
* Creates an instance from a framework {@link android.media.session.MediaSession} object.
*
* <p>This method is only supported on API 21+. On API 20 and below, it returns null.
*
* <p>Note: A {@link MediaSessionCompat} object returned from this method may not provide the full
* functionality of {@link MediaSessionCompat} until setting a new {@link
* MediaSessionCompat.Callback}. To avoid this, when both a {@link MediaSessionCompat} and a
@ -1868,8 +1840,6 @@ public class MediaSessionCompat {
/**
* Gets the underlying framework {@link android.media.session.MediaSession.Token} object.
*
* <p>This method is only supported on API 21+.
*
* @return The underlying {@link android.media.session.MediaSession.Token} object, or null if
* none.
*/

4
libraries/session/src/main/java/androidx/media3/session/legacy/PlaybackStateCompat.java
View File

@ -840,8 +840,6 @@ public final class PlaybackStateCompat implements Parcelable {
/**
* Creates an instance from a framework {@link android.media.session.PlaybackState} object.
*
* <p>This method is only supported on API 21+.
*
* @param stateObj A {@link android.media.session.PlaybackState} object, or null if none.
* @return An equivalent {@link PlaybackStateCompat} object, or null if none.
*/
@ -890,8 +888,6 @@ public final class PlaybackStateCompat implements Parcelable {
/**
* Gets the underlying framework {@link android.media.session.PlaybackState} object.
*
* <p>This method is only supported on API 21+.
*
* @return An equivalent {@link android.media.session.PlaybackState} object, or null if none.
*/
@Nullable

4
libraries/session/src/main/java/androidx/media3/session/legacy/RatingCompat.java
View File

@ -323,8 +323,6 @@ public final class RatingCompat implements Parcelable {
/**
* Creates an instance from a framework {@link android.media.Rating} object.
*
* <p>This method is only supported on API 19+.
*
* @param ratingObj A {@link android.media.Rating} object, or null if none.
* @return An equivalent {@link RatingCompat} object, or null if none.
*/
@ -366,8 +364,6 @@ public final class RatingCompat implements Parcelable {
/**
* Gets the underlying framework {@link android.media.Rating} object.
*
* <p>This method is only supported on API 19+.
*
* @return An equivalent {@link android.media.Rating} object, or null if none.
*/
@Nullable

1
libraries/ui/src/main/java/androidx/media3/ui/PlayerNotificationManager.java
View File

@ -1156,7 +1156,6 @@ public class PlayerNotificationManager {
* duration} (like for example a live stream).
* <li>The media is not {@link Player#isPlayingAd() interrupted by an ad}.
* <li>The media is played at {@link Player#getPlaybackParameters() regular speed}.
* <li>The device is running at least API 21 (Lollipop).
* </ul>
*
* <p>See {@link NotificationCompat.Builder#setUsesChronometer(boolean)}.