# MediaRouteDiscoveryRequest

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

*** ** * ** ***


```
public final class MediaRouteDiscoveryRequest
```

<br />

*** ** * ** ***

Describes the kinds of routes that the media router would like to discover and whether to perform active scanning.

This object is immutable once created.

## Summary

| ### Public constructors |
|---|
| `https://developer.android.com/reference/androidx/mediarouter/media/MediaRouteDiscoveryRequest#MediaRouteDiscoveryRequest(androidx.mediarouter.media.MediaRouteSelector,boolean)( @https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/androidx/mediarouter/media/MediaRouteSelector selector, boolean activeScan )` Creates a media route discovery request. |

| ### Public methods |
|---|---|
| `@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/android/os/Bundle.html` | `https://developer.android.com/reference/androidx/mediarouter/media/MediaRouteDiscoveryRequest#asBundle()()` Converts this object to a bundle for serialization. |
| `boolean` | `https://developer.android.com/reference/androidx/mediarouter/media/MediaRouteDiscoveryRequest#equals(java.lang.Object)(https://developer.android.com/reference/java/lang/Object.html o)` |
| `static @https://jspecify.dev/docs/api/org/jspecify/annotations/Nullable.html https://developer.android.com/reference/androidx/mediarouter/media/MediaRouteDiscoveryRequest` | `https://developer.android.com/reference/androidx/mediarouter/media/MediaRouteDiscoveryRequest#fromBundle(android.os.Bundle)(@https://jspecify.dev/docs/api/org/jspecify/annotations/Nullable.html https://developer.android.com/reference/android/os/Bundle.html bundle)` Creates an instance from a bundle. |
| `@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/androidx/mediarouter/media/MediaRouteSelector` | `https://developer.android.com/reference/androidx/mediarouter/media/MediaRouteDiscoveryRequest#getSelector()()` Gets the route selector that specifies the kinds of routes to discover. |
| `int` | `https://developer.android.com/reference/androidx/mediarouter/media/MediaRouteDiscoveryRequest#hashCode()()` |
| `boolean` | `https://developer.android.com/reference/androidx/mediarouter/media/MediaRouteDiscoveryRequest#isActiveScan()()` Returns true if active scanning should be performed. |
| `boolean` | `https://developer.android.com/reference/androidx/mediarouter/media/MediaRouteDiscoveryRequest#isValid()()` Returns true if the discovery request has all of the required fields. |
| `boolean` | `https://developer.android.com/reference/androidx/mediarouter/media/MediaRouteDiscoveryRequest#shouldScanWithScreenOff()()` Returns true if scanning should be performed even when the screen is off. |
| `@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/java/lang/String.html` | `https://developer.android.com/reference/androidx/mediarouter/media/MediaRouteDiscoveryRequest#toString()()` |

## Public constructors

### MediaRouteDiscoveryRequest

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

```
public MediaRouteDiscoveryRequest(
    @NonNull MediaRouteSelector selector,
    boolean activeScan
)
```

Creates a media route discovery request.

| Parameters |
|---|---|
| `@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/androidx/mediarouter/media/MediaRouteSelector selector` | The route selector that specifies the kinds of routes to discover. |
| `boolean activeScan` | True if active scanning should be performed. |

## Public methods

### asBundle

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

```
public @NonNull Bundle asBundle()
```

Converts this object to a bundle for serialization.

| Returns |
|---|---|
| `@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/android/os/Bundle.html` | The contents of the object represented as a bundle. |

### equals

```
public boolean equals(Object o)
```

### fromBundle

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

```
public static @Nullable MediaRouteDiscoveryRequest fromBundle(@Nullable Bundle bundle)
```

Creates an instance from a bundle.

| Parameters |
|---|---|
| `@https://jspecify.dev/docs/api/org/jspecify/annotations/Nullable.html https://developer.android.com/reference/android/os/Bundle.html bundle` | The bundle, or null if none. |

| Returns |
|---|---|
| `@https://jspecify.dev/docs/api/org/jspecify/annotations/Nullable.html https://developer.android.com/reference/androidx/mediarouter/media/MediaRouteDiscoveryRequest` | The new instance, or null if the bundle was null. |

### getSelector

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

```
public @NonNull MediaRouteSelector getSelector()
```

Gets the route selector that specifies the kinds of routes to discover.

### hashCode

```
public int hashCode()
```

### isActiveScan

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

```
public boolean isActiveScan()
```

Returns true if active scanning should be performed.

| See also |
|---|---|
| `https://developer.android.com/reference/androidx/mediarouter/media/MediaRouter#CALLBACK_FLAG_PERFORM_ACTIVE_SCAN()` |   |

### isValid

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

```
public boolean isValid()
```

Returns true if the discovery request has all of the required fields.

### shouldScanWithScreenOff

Added in [1.9.0-rc01](https://developer.android.com/jetpack/androidx/releases/mediarouter#1.9.0-rc01)

```
public boolean shouldScanWithScreenOff()
```

Returns true if scanning should be performed even when the screen is off. This can only be true if `https://developer.android.com/reference/androidx/mediarouter/media/MediaRouteDiscoveryRequest#isActiveScan()` is true.

### toString

```
public @NonNull String toString()
```