MediaBrowserServiceCompat.BrowserRoot
public
static
final
class
MediaBrowserServiceCompat.BrowserRoot
extends Object
java.lang.Object | |
↳ | androidx.media.MediaBrowserServiceCompat.BrowserRoot |
Contains information that the browser service needs to send to the client when first connected.
Summary
Constants | |
---|---|
String |
EXTRA_OFFLINE
The lookup key for a boolean that indicates whether the browser service should return a browser root for offline media items. |
String |
EXTRA_RECENT
The lookup key for a boolean that indicates whether the browser service should return a browser root for recently played media items. |
String |
EXTRA_SUGGESTED
The lookup key for a boolean that indicates whether the browser service should return a browser root for suggested media items. |
String |
EXTRA_SUGGESTION_KEYWORDS
This constant is deprecated.
The search functionality is now supported by the methods
|
Public constructors | |
---|---|
BrowserRoot(String rootId, Bundle extras)
Constructs a browser root. |
Public methods | |
---|---|
Bundle
|
getExtras()
Gets any extras about the browser service. |
String
|
getRootId()
Gets the root id for browsing. |
Inherited methods | |
---|---|
Constants
EXTRA_OFFLINE
public static final String EXTRA_OFFLINE
The lookup key for a boolean that indicates whether the browser service should return a browser root for offline media items.
When creating a media browser for a given media browser service, this key can be
supplied as a root hint for retrieving media items that are can be played without an
internet connection.
If the media browser service can provide such media items, the implementation must return
the key in the root hint when MediaBrowserServiceCompat.onGetRoot(String, int, Bundle)
is called back.
The root hint may contain multiple keys.
See also:
Constant Value: "android.service.media.extra.OFFLINE"
EXTRA_RECENT
public static final String EXTRA_RECENT
The lookup key for a boolean that indicates whether the browser service should return a browser root for recently played media items.
When creating a media browser for a given media browser service, this key can be
supplied as a root hint for retrieving media items that are recently played.
If the media browser service can provide such media items, the implementation must return
the key in the root hint when MediaBrowserServiceCompat.onGetRoot(String, int, Bundle)
is called back.
The root hint may contain multiple keys.
See also:
Constant Value: "android.service.media.extra.RECENT"
EXTRA_SUGGESTED
public static final String EXTRA_SUGGESTED
The lookup key for a boolean that indicates whether the browser service should return a browser root for suggested media items.
When creating a media browser for a given media browser service, this key can be
supplied as a root hint for retrieving the media items suggested by the media browser
service. The list of media items passed in MediaBrowserCompat.SubscriptionCallback.onChildrenLoaded(String, List)
is considered ordered by relevance, first being the top suggestion.
If the media browser service can provide such media items, the implementation must return
the key in the root hint when MediaBrowserServiceCompat.onGetRoot(String, int, Bundle)
is called back.
The root hint may contain multiple keys.
See also:
Constant Value: "android.service.media.extra.SUGGESTED"
EXTRA_SUGGESTION_KEYWORDS
public static final String EXTRA_SUGGESTION_KEYWORDS
This constant is deprecated.
The search functionality is now supported by the methods
MediaBrowserCompat.search(String, Bundle, MediaBrowserCompat.SearchCallback)
and MediaBrowserServiceCompat.onSearch(String, Bundle, MediaBrowserServiceCompat.Result
. Use those methods
instead.
>)
The lookup key for a string that indicates specific keywords which will be considered when the browser service suggests media items.
When creating a media browser for a given media browser service, this key can be
supplied as a root hint together with EXTRA_SUGGESTED
for retrieving suggested
media items related with the keywords. The list of media items passed in
MediaBrowser.SubscriptionCallback.onChildrenLoaded(String, List)
is considered ordered by relevance, first being the top suggestion.
If the media browser service can provide such media items, the implementation must return
the key in the root hint when MediaBrowserServiceCompat.onGetRoot(String, int, Bundle)
is called back.
The root hint may contain multiple keys.
See also:
Constant Value: "android.service.media.extra.SUGGESTION_KEYWORDS"
Public constructors
BrowserRoot
public BrowserRoot (String rootId, Bundle extras)
Constructs a browser root.
Parameters | |
---|---|
rootId |
String : The root id for browsing. |
extras |
Bundle : Any extras about the browser service.
|
Public methods
getRootId
public String getRootId ()
Gets the root id for browsing.
Returns | |
---|---|
String |