# MediaRouterParams

# 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)

*** ** * ** ***

Kotlin\|[Java](https://developer.android.com/reference/androidx/mediarouter/media/MediaRouterParams "View this page in Java")

<br />

```
class MediaRouterParams
```

<br />

*** ** * ** ***

MediaRouterParams are used in[MediaRouter](https://developer.android.com/reference/kotlin/androidx/mediarouter/media/MediaRouter)to denote routing functionality and UI types.

## Summary

|                                                                                                                              ### Nested types                                                                                                                               |
|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `class `[MediaRouterParams.Builder](https://developer.android.com/reference/kotlin/androidx/mediarouter/media/MediaRouterParams.Builder) Builder class for[MediaRouterParams](https://developer.android.com/reference/kotlin/androidx/mediarouter/media/MediaRouterParams). |

|                                        ### Constants                                         |
|----------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `const `[Int](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html)          | [DIALOG_TYPE_DEFAULT](https://developer.android.com/reference/kotlin/androidx/mediarouter/media/MediaRouterParams#DIALOG_TYPE_DEFAULT())` = 1` A dialog type used for default if not set.                                                                              |
| `const `[Int](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html)          | [DIALOG_TYPE_DYNAMIC_GROUP](https://developer.android.com/reference/kotlin/androidx/mediarouter/media/MediaRouterParams#DIALOG_TYPE_DYNAMIC_GROUP())` = 2` A dialog type supporting dynamic group.                                                                     |
| `const `[String](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html)`!` | [ENABLE_GROUP_VOLUME_UX](https://developer.android.com/reference/kotlin/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 functions                                 |
|-------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [Int](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html)         | [getDialogType](https://developer.android.com/reference/kotlin/androidx/mediarouter/media/MediaRouterParams#getDialogType())`()` Gets the media route controller dialog type.                                                                                                                                                                                                                            |
| [Boolean](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html) | [isMediaTransferReceiverEnabled](https://developer.android.com/reference/kotlin/androidx/mediarouter/media/MediaRouterParams#isMediaTransferReceiverEnabled())`()` Gets whether declared[MediaTransferReceiver](https://developer.android.com/reference/kotlin/androidx/mediarouter/media/MediaTransferReceiver)is enabled.                                                                              |
| [Boolean](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html) | [isMediaTransferRestrictedToSelfProviders](https://developer.android.com/reference/kotlin/androidx/mediarouter/media/MediaRouterParams#isMediaTransferRestrictedToSelfProviders())`()` Returns whether the declared[MediaTransferReceiver](https://developer.android.com/reference/kotlin/androidx/mediarouter/media/MediaTransferReceiver)feature is restricted to the app's own media route providers. |
| [Boolean](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html) | [isOutputSwitcherEnabled](https://developer.android.com/reference/kotlin/androidx/mediarouter/media/MediaRouterParams#isOutputSwitcherEnabled())`()` Gets whether the output switcher dialog is enabled.                                                                                                                                                                                                 |
| [Boolean](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html) | [isTransferToLocalEnabled](https://developer.android.com/reference/kotlin/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)  

```
const val DIALOG_TYPE_DEFAULT = 1: Int
```

A dialog type used for default if not set.[androidx.mediarouter.app.MediaRouteChooserDialog](https://developer.android.com/reference/kotlin/androidx/mediarouter/app/MediaRouteChooserDialog)and[androidx.mediarouter.app.MediaRouteControllerDialog](https://developer.android.com/reference/kotlin/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)  

```
const val DIALOG_TYPE_DYNAMIC_GROUP = 2: Int
```

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[MediaRouteProvider](https://developer.android.com/reference/kotlin/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)  

```
const val ENABLE_GROUP_VOLUME_UX = "androidx.mediarouter.media.MediaRouterParams.ENABLE_GROUP_VOLUME_UX": String!
```

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 functions

### getDialogType

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

```
fun getDialogType(): Int
```

Gets the media route controller dialog type.  

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

### isMediaTransferReceiverEnabled

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

```
fun isMediaTransferReceiverEnabled(): Boolean
```

Gets whether declared[MediaTransferReceiver](https://developer.android.com/reference/kotlin/androidx/mediarouter/media/MediaTransferReceiver)is enabled.  

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

### isMediaTransferRestrictedToSelfProviders

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

```
fun isMediaTransferRestrictedToSelfProviders(): Boolean
```

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

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

### isOutputSwitcherEnabled

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

```
fun isOutputSwitcherEnabled(): Boolean
```

Gets whether the output switcher dialog is enabled.

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

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

### isTransferToLocalEnabled

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

```
fun isTransferToLocalEnabled(): Boolean
```

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                                                                               |
|---------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|
| [setTransferToLocalEnabled](https://developer.android.com/reference/kotlin/androidx/mediarouter/media/MediaRouterParams.Builder#setTransferToLocalEnabled(boolean)) |   |