LibraryParams
class LibraryParams : VersionedParcelable
kotlin.Any | |
↳ | androidx.media2.session.MediaLibraryService.LibraryParams |
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 classes | |
---|---|
Builds a |
Public methods | |
---|---|
Bundle? |
Gets the extras. |
Boolean |
Returns |
Boolean |
isRecent() Returns |
Boolean |
Returns |
Public methods
getExtras
@Nullable fun getExtras(): Bundle?
Gets the extras.
Extras are the private contract between browser and library session.
isOffline
fun isOffline(): Boolean
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.
Return | |
---|---|
Boolean |
true for offline items. false otherwise. |
isRecent
fun isRecent(): Boolean
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.
Return | |
---|---|
Boolean |
true for recent items. false otherwise. |
isSuggested
fun isSuggested(): Boolean
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.
Return | |
---|---|
Boolean |
true for suggested items. false otherwise |