MediaLibraryService.LibraryParams
public
static
final
class
MediaLibraryService.LibraryParams
extends Object
implements
VersionedParcelable
java.lang.Object | |
↳ | androidx.media2.session.MediaLibraryService.LibraryParams |
Contains information that the library service needs to send to the client.
When the browser supplies MediaLibraryService.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 classes | |
---|---|
class |
MediaLibraryService.LibraryParams.Builder
Builds a |
Public methods | |
---|---|
Bundle
|
getExtras()
Gets the extras. |
boolean
|
isOffline()
Returns |
boolean
|
isRecent()
Returns |
boolean
|
isSuggested()
Returns |
Inherited methods | |
---|---|
Public methods
getExtras
public Bundle getExtras ()
Gets the extras.
Extras are the private contract between browser and library session.
Returns | |
---|---|
Bundle |
isOffline
public boolean isOffline ()
Returns true
for offline media items, which can be played without an internet
connection.
When the browser supplies MediaLibraryService.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
public boolean isRecent ()
Returns true
for recent media items.
When the browser supplies MediaLibraryService.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
public boolean isSuggested ()
Returns true
for suggested media items.
When the browser supplies MediaLibraryService.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
|
Content and code samples on this page are subject to the licenses described in the Content License. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2020-09-30 UTC.