SessionToken

Artifact: androidx.media3:media3-session

Kotlin |Java

public final class SessionToken

A token that represents an ongoing MediaSession or a service (MediaSessionService, MediaLibraryService, or androix.media.MediaBrowserServiceCompat). If it represents a service, it may not be ongoing.

This may be passed to apps by the session owner to allow them to create a MediaController or a MediaBrowser to communicate with the session.

It can also be obtained by getAllServiceTokens.

Summary

Nested types
`@Documented @Retention(value = RetentionPolicy.SOURCE) @Target(value = ElementType.TYPE_USE) @IntDef(value = ) public annotation SessionToken.TokenType` Types of `SessionToken`.

Constants
`static final int`	`PLATFORM_SESSION_VERSION = 0` `Session version` for a platform `android.media.session.MediaSession` or legacy `android.support.v4.media.session.MediaSessionCompat`.
`static final int`	`TYPE_LIBRARY_SERVICE = 2` Type for `MediaLibraryService`.
`static final int`	`TYPE_SESSION = 0` Type for `MediaSession`.
`static final int`	`TYPE_SESSION_SERVICE = 1` Type for `MediaSessionService`.
`static final int`	`@UnstableApi UNKNOWN_INTERFACE_VERSION = 0` Unknown `interface version` for a `MediaSession` that isn't connected yet, for an older session that didn't publish its interface version, for a platform `android.media.session.MediaSession` or for a legacy `android.support.v4.media.session.MediaSessionCompat`.
`static final int`	`UNKNOWN_SESSION_VERSION = 1000000` Unknown `session version` for a `MediaSession` that isn't connected yet.

Public constructors
`SessionToken(Context context, ComponentName serviceComponent)` Creates a token for `MediaController` or `MediaBrowser` to connect to one of `MediaSessionService`, `MediaLibraryService`, or `androidx.media.MediaBrowserServiceCompat`.

Public methods
`static ListenableFuture<SessionToken>`	`createSessionToken(Context context, MediaSession.Token token)` Creates a token from a platform `Token`.
`static ListenableFuture<SessionToken>`	`@UnstableApi createSessionToken(Context context, Parcelable token)` Creates a token from a platform `Token` or `android.support.v4.media.session.MediaSessionCompat.Token`.
`static ListenableFuture<SessionToken>`	`@UnstableApi createSessionToken( Context context, MediaSession.Token token, Looper completionLooper )` Creates a token from a platform `Token`.
`static ListenableFuture<SessionToken>`	`@UnstableApi createSessionToken( Context context, Parcelable token, Looper completionLooper )` Creates a token from a platform `Token` or `android.support.v4.media.session.MediaSessionCompat.Token`.
`boolean`	`equals(@Nullable Object obj)`
`static SessionToken`	`@UnstableApi fromBundle(Bundle bundle)` Restores a `SessionToken` from a `Bundle`.
`static ImmutableSet<SessionToken>`	`getAllServiceTokens(Context context)` Returns an `ImmutableSet` of `session tokens` for media session services; `MediaSessionService`, `MediaLibraryService`, and `androidx.media.MediaBrowserServiceCompat` regardless of their activeness.
`Bundle`	`getExtras()` Returns the extra `Bundle` of this token.
`int`	`@UnstableApi getInterfaceVersion()` Returns the interface version of the session or `UNKNOWN_INTERFACE_VERSION`.
`String`	`getPackageName()` Returns the package name of the session
`String`	`getServiceName()` Returns the service name of the session.
`int`	`getSessionVersion()` Returns the library version of the session, `UNKNOWN_SESSION_VERSION`, or `PLATFORM_SESSION_VERSION`.
`int`	`@SessionToken.TokenType getType()` Returns the type of this token.
`int`	`getUid()` Returns the UID of the session process, or `INDEX_UNSET` if the UID can't be determined due to missing package visibility.
`int`	`hashCode()`
`Bundle`	`@UnstableApi toBundle()`
`String`	`toString()`

Constants

PLATFORM_SESSION_VERSION

public static final int PLATFORM_SESSION_VERSION = 0

Session version for a platform android.media.session.MediaSession or legacy android.support.v4.media.session.MediaSessionCompat.

TYPE_LIBRARY_SERVICE

public static final int TYPE_LIBRARY_SERVICE = 2

Type for MediaLibraryService.

TYPE_SESSION

public static final int TYPE_SESSION = 0

Type for MediaSession.

TYPE_SESSION_SERVICE

public static final int TYPE_SESSION_SERVICE = 1

Type for MediaSessionService.

UNKNOWN_INTERFACE_VERSION

@UnstableApi
public static final int UNKNOWN_INTERFACE_VERSION = 0

Unknown interface version for a MediaSession that isn't connected yet, for an older session that didn't publish its interface version, for a platform android.media.session.MediaSession or for a legacy android.support.v4.media.session.MediaSessionCompat.

Note: Use getConnectedToken to obtain the version after connecting a controller.

UNKNOWN_SESSION_VERSION

public static final int UNKNOWN_SESSION_VERSION = 1000000

Unknown session version for a MediaSession that isn't connected yet.

Note: Use getConnectedToken to obtain the version after connecting a controller.

Public constructors

SessionToken

public SessionToken(Context context, ComponentName serviceComponent)

Creates a token for MediaController or MediaBrowser to connect to one of MediaSessionService, MediaLibraryService, or androidx.media.MediaBrowserServiceCompat.

Parameters
`Context context`	The context.
`ComponentName serviceComponent`	The component name of the service.

Public methods

createSessionToken

public static ListenableFuture<SessionToken> createSessionToken(Context context, MediaSession.Token token)

Creates a token from a platform Token.

Parameters
`Context context`	A `Context`.
`MediaSession.Token token`	The platform `Token`.

Returns
`ListenableFuture<SessionToken>`	A `ListenableFuture` for the `SessionToken`.

createSessionToken

@UnstableApi
public static ListenableFuture<SessionToken> createSessionToken(Context context, Parcelable token)

Creates a token from a platform Token or android.support.v4.media.session.MediaSessionCompat.Token.

Parameters
`Context context`	A `Context`.
`Parcelable token`	The `Token` or `android.support.v4.media.session.MediaSessionCompat.Token`.

Returns
`ListenableFuture<SessionToken>`	A `ListenableFuture` for the `SessionToken`.

createSessionToken

@UnstableApi
public static ListenableFuture<SessionToken> createSessionToken(
    Context context,
    MediaSession.Token token,
    Looper completionLooper
)

Creates a token from a platform Token.

Parameters
`Context context`	A `Context`.
`MediaSession.Token token`	The platform `Token`.
`Looper completionLooper`	The `Looper` on which the returned `ListenableFuture` completes. This `Looper` can't be used to call `future.get()` on the returned `ListenableFuture`.

Returns
`ListenableFuture<SessionToken>`	A `ListenableFuture` for the `SessionToken`.

createSessionToken

@UnstableApi
public static ListenableFuture<SessionToken> createSessionToken(
    Context context,
    Parcelable token,
    Looper completionLooper
)

Creates a token from a platform Token or android.support.v4.media.session.MediaSessionCompat.Token.

Parameters
`Context context`	A `Context`.
`Parcelable token`	The `Token` or `android.support.v4.media.session.MediaSessionCompat.Token`.
`Looper completionLooper`	The `Looper` on which the returned `ListenableFuture` completes. This `Looper` can't be used to call `future.get()` on the returned `ListenableFuture`.

Returns
`ListenableFuture<SessionToken>`	A `ListenableFuture` for the `SessionToken`.

equals

public boolean equals(@Nullable Object obj)

fromBundle

@UnstableApi
public static SessionToken fromBundle(Bundle bundle)

Restores a SessionToken from a Bundle.

getAllServiceTokens

public static ImmutableSet<SessionToken> getAllServiceTokens(Context context)

Returns an ImmutableSet of session tokens for media session services; MediaSessionService, MediaLibraryService, and androidx.media.MediaBrowserServiceCompat regardless of their activeness.

The app targeting API level 30 or higher must include a <queries> element in their manifest to get service tokens of other apps. See the following example and this guide for more information.

<intent>
  <action android:name="androidx.media3.session.MediaSessionService" />
</intent>
<intent>
  <action android:name="androidx.media3.session.MediaLibraryService" />
</intent>
<intent>
  <action android:name="android.media.browse.MediaBrowserService" />
</intent>

getExtras

public Bundle getExtras()

Returns the extra Bundle of this token.

See also
`setExtras`

getInterfaceVersion

@UnstableApi
public int getInterfaceVersion()

Returns the interface version of the session or UNKNOWN_INTERFACE_VERSION.

getPackageName

public String getPackageName()

Returns the package name of the session

getServiceName

public String getServiceName()

Returns the service name of the session. It will be an empty string if the type is TYPE_SESSION.

getSessionVersion

public int getSessionVersion()

Returns the library version of the session, UNKNOWN_SESSION_VERSION, or PLATFORM_SESSION_VERSION.

If the session is a platform android.media.session.MediaSession or legacy android.support.v4.media.session.MediaSessionCompat, this will be PLATFORM_SESSION_VERSION.
If the token's type is TYPE_SESSION, this will be the same as VERSION_INT of the session.
If the token's type is TYPE_SESSION_SERVICE or TYPE_LIBRARY_SERVICE, this will be UNKNOWN_SESSION_VERSION. You can obtain the actual session version after a connecting a controller via the connected token of type TYPE_SESSION.

getType

@SessionToken.TokenType
public int getType()

Returns the type of this token. One of TYPE_SESSION, TYPE_SESSION_SERVICE, or TYPE_LIBRARY_SERVICE.

getUid

public int getUid()

Returns the UID of the session process, or INDEX_UNSET if the UID can't be determined due to missing package visibility.

hashCode

public int hashCode()

toBundle

@UnstableApi
public Bundle toBundle()

toString

public String toString()

SessionToken

Summary

Nested types

Constants

Public constructors

Public methods

Constants

PLATFORM_SESSION_VERSION

TYPE_LIBRARY_SERVICE

TYPE_SESSION

TYPE_SESSION_SERVICE

UNKNOWN_INTERFACE_VERSION

UNKNOWN_SESSION_VERSION

Public constructors

SessionToken

Public methods

createSessionToken

createSessionToken

createSessionToken

createSessionToken

equals

fromBundle

getAllServiceTokens

getExtras

getInterfaceVersion

getPackageName

getServiceName

getSessionVersion

getType

getUid

hashCode

toBundle

toString