Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit 36b71d1c authored by Ian Baker's avatar Ian Baker Committed by Marc Bächinger
Browse files

Update media2 session references to media3 in framework docs 

The androidx.media2 library is deprecated, and the source has been deleted.

Also make the summary fragment of these docs more useful by moving the
warning later in the docs.

Bug: 324249307
Test: Presubmit (javadoc only change)

Change-Id: Ib16ed3343fac426a857128d096d1e04a77f551e7
parent fcfc6c13

media/java/android/media/session/MediaSessionManager.java

+30 −35
Original line number Diff line number Diff line
@@ -155,11 +155,6 @@ public final class MediaSessionManager { 
    }



    /**

     * This API is not generally intended for third party application developers.

     * Use the <a href="{@docRoot}jetpack/androidx.html">AndroidX</a>

     * <a href="{@docRoot}reference/androidx/media2/session/package-summary.html">Media2 session

     * Library</a> for consistent behavior across all devices.

     * <p>

     * Notifies that a new {@link MediaSession2} with type {@link Session2Token#TYPE_SESSION} is

     * created.

     * <p>
@@ -283,16 +278,16 @@ public final class MediaSessionManager { 
    }



    /**

     * This API is not generally intended for third party application developers.

     * Use the <a href="{@docRoot}jetpack/androidx.html">AndroidX</a>

     * <a href="{@docRoot}reference/androidx/media2/session/package-summary.html">Media2 session

     * Library</a> for consistent behavior across all devices.

     * <p>

     * Gets a list of {@link Session2Token} with type {@link Session2Token#TYPE_SESSION} for the

     * current user.

     * <p>

     * Although this API can be used without any restriction, each session owners can accept or

     * reject your uses of {@link MediaSession2}.

     * <p>

     * This API is not generally intended for third party application developers. Apps wanting media

     * session functionality should use the

     * <a href="{@docRoot}reference/androidx/media3/session/package-summary.html">AndroidX Media3

     * Session Library</a>.

     *

     * @return A list of {@link Session2Token}.

     */
@@ -417,12 +412,12 @@ public final class MediaSessionManager { 
    }



    /**

     * This API is not generally intended for third party application developers.

     * Use the <a href="{@docRoot}jetpack/androidx.html">AndroidX</a>

     * <a href="{@docRoot}reference/androidx/media2/session/package-summary.html">Media2 session

     * Library</a> for consistent behavior across all devices.

     * <p>

     * Adds a listener to be notified when the {@link #getSession2Tokens()} changes.

     * <p>

     * This API is not generally intended for third party application developers. Apps wanting media

     * session functionality should use the

     * <a href="{@docRoot}reference/androidx/media3/session/package-summary.html">AndroidX Media3

     * Session Library</a>.

     *

     * @param listener The listener to add

     */
@@ -433,12 +428,12 @@ public final class MediaSessionManager { 
    }



    /**

     * This API is not generally intended for third party application developers.

     * Use the <a href="{@docRoot}jetpack/androidx.html">AndroidX</a>

     * <a href="{@docRoot}reference/androidx/media2/session/package-summary.html">Media2 session

     * Library</a> for consistent behavior across all devices.

     * <p>

     * Adds a listener to be notified when the {@link #getSession2Tokens()} changes.

     * <p>

     * This API is not generally intended for third party application developers. Apps wanting media

     * session functionality should use the

     * <a href="{@docRoot}reference/androidx/media3/session/package-summary.html">AndroidX Media3

     * Session Library</a>.

     *

     * @param listener The listener to add

     * @param handler The handler to call listener on.
@@ -451,16 +446,16 @@ public final class MediaSessionManager { 
    }



    /**

     * This API is not generally intended for third party application developers.

     * Use the <a href="{@docRoot}jetpack/androidx.html">AndroidX</a>

     * <a href="{@docRoot}reference/androidx/media2/session/package-summary.html">Media2 session

     * Library</a> for consistent behavior across all devices.

     * <p>

     * Adds a listener to be notified when the {@link #getSession2Tokens()} changes.

     * <p>

     * The calling application needs to hold the

     * {@link android.Manifest.permission#INTERACT_ACROSS_USERS_FULL} permission in order to

     * add listeners for user ids that do not belong to current process.

     * <p>

     * This API is not generally intended for third party application developers. Apps wanting media

     * session functionality should use the

     * <a href="{@docRoot}reference/androidx/media3/session/package-summary.html">AndroidX Media3

     * Session Library</a>.

     *

     * @param userHandle The userHandle to listen for changes on

     * @param listener The listener to add
@@ -496,12 +491,12 @@ public final class MediaSessionManager { 
    }



    /**

     * This API is not generally intended for third party application developers.

     * Use the <a href="{@docRoot}jetpack/androidx.html">AndroidX</a>

     * <a href="{@docRoot}reference/androidx/media2/session/package-summary.html">Media2 session

     * Library</a> for consistent behavior across all devices.

     * <p>

     * Removes the {@link OnSession2TokensChangedListener} to stop receiving session token updates.

     * <p>

     * This API is not generally intended for third party application developers. Apps wanting media

     * session functionality should use the

     * <a href="{@docRoot}reference/androidx/media3/session/package-summary.html">AndroidX Media3

     * Session Library</a>.

     *

     * @param listener The listener to remove.

     */
@@ -1061,13 +1056,13 @@ public final class MediaSessionManager { 
    }



    /**

     * This API is not generally intended for third party application developers.

     * Use the <a href="{@docRoot}jetpack/androidx.html">AndroidX</a>

     * <a href="{@docRoot}reference/androidx/media2/session/package-summary.html">Media2 session

     * Library</a> for consistent behavior across all devices.

     * <p>

     * Listens for changes to the {@link #getSession2Tokens()}. This can be added

     * using {@link #addOnSession2TokensChangedListener(OnSession2TokensChangedListener, Handler)}.

     * <p>

     * This API is not generally intended for third party application developers. Apps wanting media

     * session functionality should use the

     * <a href="{@docRoot}reference/androidx/media3/session/package-summary.html">AndroidX Media3

     * Session Library</a>.

     */

    public interface OnSession2TokensChangedListener {

        /**