MediaLibraryService.LibraryParams

Artifact: androidx.media2:media2-session

View Source

Added in 1.0.0

Deprecated in 1.3.0

---

Kotlin |Java

public final class MediaLibraryService.LibraryParams implements VersionedParcelable

---

This class is deprecated.

androidx.media2 is deprecated. Please migrate to androidx.media3.

Contains information that the library service needs to send to the client.

When the browser supplies LibraryParams, it's optional field when getting the media item(s). The library session is recommended to do the best effort to provide such result. It's not an error even when the library session didn't return such items.

The library params returned in the library session callback must include the information about the returned media item(s).

Summary

Nested types
public final class MediaLibraryService.LibraryParams.Builder This class is deprecated. androidx.media2 is deprecated.

Public methods
@Nullable Bundle	getExtras() Gets the extras.
boolean	isOffline() Returns true for offline media items, which can be played without an internet connection.
boolean	isRecent() Returns true for recent media items.
boolean	isSuggested() Returns true for suggested media items.

Public methods

getExtras

Added in 1.0.0

Deprecated in 1.3.0

public @Nullable Bundle getExtras()

Gets the extras.

Extras are the private contract between browser and library session.

isOffline

Added in 1.0.0

Deprecated in 1.3.0

public boolean isOffline()

Returns true for offline media items, which can be played without an internet connection.

When the browser supplies LibraryParams with the true, library session is recommended to provide such media items. If so, the library session implementation must return the params with the true as well.

Returns
boolean	true for offline items. false otherwise.

isRecent

Added in 1.0.0

Deprecated in 1.3.0

public boolean isRecent()

Returns true for recent media items.

When the browser supplies LibraryParams with the true, library session is recommended to provide such media items. If so, the library session implementation must return the params with the true as well. The list of media items is considered ordered by relevance, first being the top suggestion.

Returns
boolean	true for recent items. false otherwise.

isSuggested

Added in 1.0.0

Deprecated in 1.3.0

public boolean isSuggested()

Returns true for suggested media items.

When the browser supplies LibraryParams with the true, library session is recommended to provide such media items. If so, the library session implementation must return the params with the true as well. The list of media items is considered ordered by relevance, first being the top suggestion.

Returns
boolean	true for suggested items. false otherwise