MediaBrowserServiceCompat.BrowserRoot

Added in 1.1.0

Kotlin |Java

public final class MediaBrowserServiceCompat.BrowserRoot

Contains information that the browser service needs to send to the client when first connected.

Summary

Constants
`static final String`	`EXTRA_OFFLINE = "android.service.media.extra.OFFLINE"` The lookup key for a boolean that indicates whether the browser service should return a browser root for offline media items.
`static final String`	`EXTRA_RECENT = "android.service.media.extra.RECENT"` The lookup key for a boolean that indicates whether the browser service should return a browser root for recently played media items.
`static final String`	`EXTRA_SUGGESTED = "android.service.media.extra.SUGGESTED"` The lookup key for a boolean that indicates whether the browser service should return a browser root for suggested media items.
`static final String`	`EXTRA_SUGGESTION_KEYWORDS = "android.service.media.extra.SUGGESTION_KEYWORDS"` This field is deprecated. The search functionality is now supported by the methods `search` and `onSearch`.

Public constructors
`BrowserRoot(@NonNull String rootId, @Nullable 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.

Constants

EXTRA_OFFLINE

Added in 1.1.0

public static final String EXTRA_OFFLINE = "android.service.media.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 onGetRoot is called back.

The root hint may contain multiple keys.

See also
`EXTRA_RECENT`
`EXTRA_SUGGESTED`

EXTRA_RECENT

Added in 1.1.0

public static final String EXTRA_RECENT = "android.service.media.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 onGetRoot is called back.

The root hint may contain multiple keys.

See also
`EXTRA_OFFLINE`
`EXTRA_SUGGESTED`

EXTRA_SUGGESTED

Added in 1.1.0

public static final String EXTRA_SUGGESTED = "android.service.media.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 onChildrenLoaded 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 onGetRoot is called back.

The root hint may contain multiple keys.

See also
`EXTRA_RECENT`
`EXTRA_OFFLINE`

EXTRA_SUGGESTION_KEYWORDS

Added in 1.1.0

Deprecated in 1.1.0

public static final String EXTRA_SUGGESTION_KEYWORDS = "android.service.media.extra.SUGGESTION_KEYWORDS"

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 onChildrenLoaded 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 onGetRoot is called back.

The root hint may contain multiple keys.

See also
`EXTRA_RECENT`
`EXTRA_OFFLINE`
`EXTRA_SUGGESTED`

Public constructors

BrowserRoot

Added in 1.1.0

public BrowserRoot(@NonNull String rootId, @Nullable Bundle extras)

Constructs a browser root.

Parameters
`@NonNull String rootId`	The root id for browsing.
`@Nullable Bundle extras`	Any extras about the browser service.

Public methods

getExtras

Added in 1.1.0

public Bundle getExtras()

Gets any extras about the browser service.

getRootId

Added in 1.1.0

public String getRootId()

Gets the root id for browsing.