Added in API level 21

Summary: Constants | Ctors | Methods | Inherited Methods

MediaBrowserService.BrowserRoot

Kotlin |Java

public static final class MediaBrowserService.BrowserRoot
extends Object

java.lang.Object
↳	android.service.media.MediaBrowserService.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.

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

From class


        
          java.lang.Object

`Object`	`clone()` Creates and returns a copy of this object.
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`final Class<?>`	`getClass()` Returns the runtime class of this `Object`.
`int`	`hashCode()` Returns a hash code value for the object.
`final void`	`notify()` Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()` Wakes up all threads that are waiting on this object's monitor.
`String`	`toString()` Returns a string representation of the object.
`final void`	`wait(long timeoutMillis, int nanos)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait(long timeoutMillis)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait()` Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

Constants

EXTRA_OFFLINE

Added in API level 24

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 MediaBrowserService.onGetRoot(java.lang.String, int, android.os.Bundle) is called back.

The root hint may contain multiple keys.

See also:

EXTRA_RECENT
EXTRA_SUGGESTED

Constant Value: "android.service.media.extra.OFFLINE"

EXTRA_RECENT

Added in API level 24

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 MediaBrowserService.onGetRoot(java.lang.String, int, android.os.Bundle) is called back.

The root hint may contain multiple keys.

See also:

EXTRA_OFFLINE
EXTRA_SUGGESTED

Constant Value: "android.service.media.extra.RECENT"

EXTRA_SUGGESTED

Added in API level 24

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 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 MediaBrowserService.onGetRoot(java.lang.String, int, android.os.Bundle) is called back.

The root hint may contain multiple keys.

See also:

EXTRA_RECENT
EXTRA_OFFLINE

Constant Value: "android.service.media.extra.SUGGESTED"

Public constructors

BrowserRoot

Added in API level 21

public BrowserRoot (String rootId, 
                Bundle extras)

Constructs a browser root.

Parameters
`rootId`	`String`: The root id for browsing. This value cannot be `null`.
`extras`	`Bundle`: Any extras about the browser service. This value may be `null`.

Public methods

getExtras

Added in API level 21

public Bundle getExtras ()

Gets any extras about the browser service.

Returns
`Bundle`

getRootId

Added in API level 21

public String getRootId ()

Gets the root id for browsing.

Returns
`String`