# MediaRouterParams

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

*** ** * ** ***


```
public class MediaRouterParams
```

<br />

*** ** * ** ***

MediaRouterParams are used in `https://developer.android.com/reference/androidx/mediarouter/media/MediaRouter` to denote routing functionality and UI types.

## Summary

| ### Nested types |
|---|
| `public final class https://developer.android.com/reference/androidx/mediarouter/media/MediaRouterParams.Builder` Builder class for `https://developer.android.com/reference/androidx/mediarouter/media/MediaRouterParams`. |

| ### Constants |
|---|---|
| `static final int` | `https://developer.android.com/reference/androidx/mediarouter/media/MediaRouterParams#DIALOG_TYPE_DEFAULT() = 1` A dialog type used for default if not set. |
| `static final int` | `https://developer.android.com/reference/androidx/mediarouter/media/MediaRouterParams#DIALOG_TYPE_DYNAMIC_GROUP() = 2` A dialog type supporting dynamic group. |
| `static final https://developer.android.com/reference/java/lang/String.html` | `https://developer.android.com/reference/androidx/mediarouter/media/MediaRouterParams#ENABLE_GROUP_VOLUME_UX() = "androidx.mediarouter.media.MediaRouterParams.ENABLE_GROUP_VOLUME_UX"` Bundle key used for enabling group volume UX. |

| ### Public methods |
|---|---|
| `int` | `https://developer.android.com/reference/androidx/mediarouter/media/MediaRouterParams#getDialogType()()` Gets the media route controller dialog type. |
| `boolean` | `https://developer.android.com/reference/androidx/mediarouter/media/MediaRouterParams#isMediaTransferReceiverEnabled()()` Gets whether declared `https://developer.android.com/reference/androidx/mediarouter/media/MediaTransferReceiver` is enabled. |
| `boolean` | `https://developer.android.com/reference/androidx/mediarouter/media/MediaRouterParams#isMediaTransferRestrictedToSelfProviders()()` Returns whether the declared `https://developer.android.com/reference/androidx/mediarouter/media/MediaTransferReceiver` feature is restricted to the app's own media route providers. |
| `boolean` | `https://developer.android.com/reference/androidx/mediarouter/media/MediaRouterParams#isOutputSwitcherEnabled()()` Gets whether the output switcher dialog is enabled. |
| `boolean` | `https://developer.android.com/reference/androidx/mediarouter/media/MediaRouterParams#isTransferToLocalEnabled()()` Returns whether transferring media from remote to local is enabled. |

## Constants

### DIALOG_TYPE_DEFAULT

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

```
public static final int DIALOG_TYPE_DEFAULT = 1
```

A dialog type used for default if not set. `https://developer.android.com/reference/androidx/mediarouter/app/MediaRouteChooserDialog` and `https://developer.android.com/reference/androidx/mediarouter/app/MediaRouteControllerDialog` will be shown

### DIALOG_TYPE_DYNAMIC_GROUP

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

```
public static final int DIALOG_TYPE_DYNAMIC_GROUP = 2
```

A dialog type supporting dynamic group. Users can dynamically group and ungroup route devices via this type of route dialog when the selected routes are from a `https://developer.android.com/reference/androidx/mediarouter/media/MediaRouteProvider` that supports dynamic group.

### ENABLE_GROUP_VOLUME_UX

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

```
public static final String ENABLE_GROUP_VOLUME_UX = "androidx.mediarouter.media.MediaRouterParams.ENABLE_GROUP_VOLUME_UX"
```

Bundle key used for enabling group volume UX. The default value is `true`. To disable the group volume UX, set the value `false`.

TYPE: boolean

## Public methods

### getDialogType

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

```
public int getDialogType()
```

Gets the media route controller dialog type.

| See also |
|---|---|
| `https://developer.android.com/reference/androidx/mediarouter/media/MediaRouterParams.Builder#setDialogType(int)` |   |

### isMediaTransferReceiverEnabled

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

```
public boolean isMediaTransferReceiverEnabled()
```

Gets whether declared `https://developer.android.com/reference/androidx/mediarouter/media/MediaTransferReceiver` is enabled.

| See also |
|---|---|
| `https://developer.android.com/reference/androidx/mediarouter/media/MediaRouterParams.Builder#setMediaTransferReceiverEnabled(boolean)` |   |

### isMediaTransferRestrictedToSelfProviders

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

```
public boolean isMediaTransferRestrictedToSelfProviders()
```

Returns whether the declared `https://developer.android.com/reference/androidx/mediarouter/media/MediaTransferReceiver` feature is restricted to the app's own media route providers.

| See also |
|---|---|
| `https://developer.android.com/reference/androidx/mediarouter/media/MediaRouterParams.Builder#setMediaTransferRestrictedToSelfProviders(boolean)` |   |

### isOutputSwitcherEnabled

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

```
public boolean isOutputSwitcherEnabled()
```

Gets whether the output switcher dialog is enabled.

Note that it always returns `false` for Android versions earlier than Android R.

| See also |
|---|---|
| `https://developer.android.com/reference/androidx/mediarouter/media/MediaRouterParams.Builder#setOutputSwitcherEnabled(boolean)` |   |

### isTransferToLocalEnabled

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

```
public boolean isTransferToLocalEnabled()
```

Returns whether transferring media from remote to local is enabled.

Note that it always returns `false` for Android versions earlier than Android R.

| See also |
|---|---|
| `https://developer.android.com/reference/androidx/mediarouter/media/MediaRouterParams.Builder#setTransferToLocalEnabled(boolean)` |   |