# MediaBrowserServiceCompat.BrowserRoot

Artifact: [androidx.media:media](https://developer.android.com/jetpack/androidx/releases/media) [View Source](https://cs.android.com/search?q=file:androidx/media/MediaBrowserServiceCompat.java+class:androidx.media.MediaBrowserServiceCompat.BrowserRoot) Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/media#1.1.0) Deprecated in [1.8.0](https://developer.android.com/jetpack/androidx/releases/media#1.8.0)

*** ** * ** ***


```
public final class MediaBrowserServiceCompat.BrowserRoot
```

<br />

*** ** * ** ***

> [!CAUTION]
> **This class is deprecated.**   
>
> androidx.media is deprecated. Please migrate to [androidx.media3](https://developer.android.com/media/media3).

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

## Summary

| ### Constants |
|---|---|
| `static final https://developer.android.com/reference/java/lang/String.html` | `https://developer.android.com/reference/androidx/media/MediaBrowserServiceCompat.BrowserRoot#EXTRA_OFFLINE() = "android.service.media.extra.OFFLINE"` **This field is deprecated.** Deprecated in Java |
| `static final https://developer.android.com/reference/java/lang/String.html` | `https://developer.android.com/reference/androidx/media/MediaBrowserServiceCompat.BrowserRoot#EXTRA_RECENT() = "android.service.media.extra.RECENT"` **This field is deprecated.** Deprecated in Java |
| `static final https://developer.android.com/reference/java/lang/String.html` | `https://developer.android.com/reference/androidx/media/MediaBrowserServiceCompat.BrowserRoot#EXTRA_SUGGESTED() = "android.service.media.extra.SUGGESTED"` **This field is deprecated.** Deprecated in Java |
| `static final https://developer.android.com/reference/java/lang/String.html` | `https://developer.android.com/reference/androidx/media/MediaBrowserServiceCompat.BrowserRoot#EXTRA_SUGGESTION_KEYWORDS() = "android.service.media.extra.SUGGESTION_KEYWORDS"` **This field is deprecated.** The search functionality is now supported by the methods `https://developer.android.com/reference/android/support/v4/media/MediaBrowserCompat#search(java.lang.String,android.os.Bundle,android.support.v4.media.MediaBrowserCompat.SearchCallback)` and `https://developer.android.com/reference/androidx/media/MediaBrowserServiceCompat#onSearch(java.lang.String,android.os.Bundle,androidx.media.MediaBrowserServiceCompat.Result<java.util.List<android.support.v4.media.MediaBrowserCompat.MediaItem>>)`. <br /> |

| ### Public constructors |
|---|
| `[BrowserRoot](https://developer.android.com/reference/androidx/media/MediaBrowserServiceCompat.BrowserRoot#BrowserRoot(java.lang.String,android.os.Bundle))(@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/java/lang/String.html rootId, @https://jspecify.dev/docs/api/org/jspecify/annotations/Nullable.html https://developer.android.com/reference/android/os/Bundle.html extras)` **This method is deprecated.** Deprecated in Java |

| ### Public methods |
|---|---|
| `https://developer.android.com/reference/android/os/Bundle.html` | `[getExtras](https://developer.android.com/reference/androidx/media/MediaBrowserServiceCompat.BrowserRoot#getExtras())()` **This method is deprecated.** Deprecated in Java |
| `https://developer.android.com/reference/java/lang/String.html` | `[getRootId](https://developer.android.com/reference/androidx/media/MediaBrowserServiceCompat.BrowserRoot#getRootId())()` **This method is deprecated.** Deprecated in Java |

## Constants

### EXTRA_OFFLINE

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/media#1.1.0) Deprecated in [1.8.0](https://developer.android.com/jetpack/androidx/releases/media#1.8.0)

```
public static final String EXTRA_OFFLINE = "android.service.media.extra.OFFLINE"
```

> [!CAUTION]
> **This field is deprecated.**   
> Deprecated in Java

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 `https://developer.android.com/reference/androidx/media/MediaBrowserServiceCompat#onGetRoot(java.lang.String,int,android.os.Bundle)` is called back.

The root hint may contain multiple keys.

| See also |
|---|---|
| `https://developer.android.com/reference/androidx/media/MediaBrowserServiceCompat.BrowserRoot#EXTRA_RECENT()` |   |
| `https://developer.android.com/reference/androidx/media/MediaBrowserServiceCompat.BrowserRoot#EXTRA_SUGGESTED()` |   |

### EXTRA_RECENT

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/media#1.1.0) Deprecated in [1.8.0](https://developer.android.com/jetpack/androidx/releases/media#1.8.0)

```
public static final String EXTRA_RECENT = "android.service.media.extra.RECENT"
```

> [!CAUTION]
> **This field is deprecated.**   
> Deprecated in Java

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 `https://developer.android.com/reference/androidx/media/MediaBrowserServiceCompat#onGetRoot(java.lang.String,int,android.os.Bundle)` is called back.

The root hint may contain multiple keys.

| See also |
|---|---|
| `https://developer.android.com/reference/androidx/media/MediaBrowserServiceCompat.BrowserRoot#EXTRA_OFFLINE()` |   |
| `https://developer.android.com/reference/androidx/media/MediaBrowserServiceCompat.BrowserRoot#EXTRA_SUGGESTED()` |   |

### EXTRA_SUGGESTED

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/media#1.1.0) Deprecated in [1.8.0](https://developer.android.com/jetpack/androidx/releases/media#1.8.0)

```
public static final String EXTRA_SUGGESTED = "android.service.media.extra.SUGGESTED"
```

> [!CAUTION]
> **This field is deprecated.**   
> Deprecated in Java

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 `https://developer.android.com/reference/android/support/v4/media/MediaBrowserCompat.SubscriptionCallback#onChildrenLoaded(java.lang.String,java.util.List<android.support.v4.media.MediaBrowserCompat.MediaItem>)` 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 `https://developer.android.com/reference/androidx/media/MediaBrowserServiceCompat#onGetRoot(java.lang.String,int,android.os.Bundle)` is called back.

The root hint may contain multiple keys.

| See also |
|---|---|
| `https://developer.android.com/reference/androidx/media/MediaBrowserServiceCompat.BrowserRoot#EXTRA_RECENT()` |   |
| `https://developer.android.com/reference/androidx/media/MediaBrowserServiceCompat.BrowserRoot#EXTRA_OFFLINE()` |   |

### EXTRA_SUGGESTION_KEYWORDS

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/media#1.1.0) Deprecated in [1.1.0](https://developer.android.com/jetpack/androidx/releases/media#1.1.0)

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

> [!CAUTION]
> **This field is deprecated.**   
>
> The search functionality is now supported by the methods `https://developer.android.com/reference/android/support/v4/media/MediaBrowserCompat#search(java.lang.String,android.os.Bundle,android.support.v4.media.MediaBrowserCompat.SearchCallback)` and `https://developer.android.com/reference/androidx/media/MediaBrowserServiceCompat#onSearch(java.lang.String,android.os.Bundle,androidx.media.MediaBrowserServiceCompat.Result<java.util.List<android.support.v4.media.MediaBrowserCompat.MediaItem>>)`. 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 `https://developer.android.com/reference/androidx/media/MediaBrowserServiceCompat.BrowserRoot#EXTRA_SUGGESTED()` for retrieving suggested media items related with the keywords. The list of media items passed in `https://developer.android.com/reference/android/media/browse/MediaBrowser.SubscriptionCallback.html#onChildrenLoaded(java.lang.String, java.util.List&lt;android.media.browse.MediaBrowser.MediaItem&gt;)` 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 `https://developer.android.com/reference/androidx/media/MediaBrowserServiceCompat#onGetRoot(java.lang.String,int,android.os.Bundle)` is called back.

The root hint may contain multiple keys.

| See also |
|---|---|
| `https://developer.android.com/reference/androidx/media/MediaBrowserServiceCompat.BrowserRoot#EXTRA_RECENT()` |   |
| `https://developer.android.com/reference/androidx/media/MediaBrowserServiceCompat.BrowserRoot#EXTRA_OFFLINE()` |   |
| `https://developer.android.com/reference/androidx/media/MediaBrowserServiceCompat.BrowserRoot#EXTRA_SUGGESTED()` |   |

## Public constructors

### BrowserRoot

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/media#1.1.0) Deprecated in [1.8.0](https://developer.android.com/jetpack/androidx/releases/media#1.8.0)

```
public [BrowserRoot](https://developer.android.com/reference/androidx/media/MediaBrowserServiceCompat.BrowserRoot#BrowserRoot(java.lang.String,android.os.Bundle))(@NonNull String rootId, @Nullable Bundle extras)
```

> [!CAUTION]
> **This method is deprecated.**   
> Deprecated in Java

Constructs a browser root.

| Parameters |
|---|---|
| `@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/java/lang/String.html rootId` | The root id for browsing. |
| `@https://jspecify.dev/docs/api/org/jspecify/annotations/Nullable.html https://developer.android.com/reference/android/os/Bundle.html extras` | Any extras about the browser service. |

## Public methods

### getExtras

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/media#1.1.0) Deprecated in [1.8.0](https://developer.android.com/jetpack/androidx/releases/media#1.8.0)

```
public Bundle [getExtras](https://developer.android.com/reference/androidx/media/MediaBrowserServiceCompat.BrowserRoot#getExtras())()
```

> [!CAUTION]
> **This method is deprecated.**   
> Deprecated in Java

Gets any extras about the browser service.

### getRootId

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/media#1.1.0) Deprecated in [1.8.0](https://developer.android.com/jetpack/androidx/releases/media#1.8.0)

```
public String [getRootId](https://developer.android.com/reference/androidx/media/MediaBrowserServiceCompat.BrowserRoot#getRootId())()
```

> [!CAUTION]
> **This method is deprecated.**   
> Deprecated in Java

Gets the root id for browsing.