# MediaRouteProvider

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

*** ** * ** ***

<br />

```
abstract class MediaRouteProvider
```

<br />

*** ** * ** ***

Media route providers are used to publish additional media routes for use within an application. Media route providers may also be declared as a service to publish additional media routes to all applications in the system.

The purpose of a media route provider is to discover media routes that satisfy the criteria specified by the current `https://developer.android.com/reference/kotlin/androidx/mediarouter/media/MediaRouteDiscoveryRequest` and publish a `https://developer.android.com/reference/kotlin/androidx/mediarouter/media/MediaRouteProviderDescriptor` with information about each route by calling `https://developer.android.com/reference/kotlin/androidx/mediarouter/media/MediaRouteProvider#setDescriptor(androidx.mediarouter.media.MediaRouteProviderDescriptor)` to notify the currently registered `https://developer.android.com/reference/kotlin/androidx/mediarouter/media/MediaRouteProvider.Callback`.

The provider should watch for changes to the discovery request by implementing `https://developer.android.com/reference/kotlin/androidx/mediarouter/media/MediaRouteProvider#onDiscoveryRequestChanged(androidx.mediarouter.media.MediaRouteDiscoveryRequest)` and updating the set of routes that it is attempting to discover. It should also handle route control requests such as volume changes or `https://developer.android.com/reference/kotlin/androidx/mediarouter/media/MediaControlIntent` by implementing `https://developer.android.com/reference/kotlin/androidx/mediarouter/media/MediaRouteProvider#onCreateRouteController(java.lang.String,androidx.mediarouter.media.MediaRouteProvider.RouteControllerOptions)` to return a `https://developer.android.com/reference/kotlin/androidx/mediarouter/media/MediaRouteProvider.RouteController` for a particular route.

A media route provider can support `https://developer.android.com/reference/kotlin/androidx/mediarouter/media/MediaRouteProviderDescriptor#supportsDynamicGroupRoute()` that allows the user to add or remove a route from the selected route dynamically. To control dynamic group, `https://developer.android.com/reference/kotlin/androidx/mediarouter/media/MediaRouteProvider.DynamicGroupRouteController` returned by `https://developer.android.com/reference/kotlin/androidx/mediarouter/media/MediaRouteProvider#onCreateDynamicGroupRouteController(java.lang.String,androidx.mediarouter.media.MediaRouteProvider.RouteControllerOptions)` is used instead of `https://developer.android.com/reference/kotlin/androidx/mediarouter/media/MediaRouteProvider.RouteController`.

A media route provider may be used privately within the scope of a single application process by calling `https://developer.android.com/reference/kotlin/androidx/mediarouter/media/MediaRouter#addProvider(androidx.mediarouter.media.MediaRouteProvider)` to add it to the local `https://developer.android.com/reference/kotlin/androidx/mediarouter/media/MediaRouter`. A media route provider may also be made available globally to all applications by registering a `https://developer.android.com/reference/kotlin/androidx/mediarouter/media/MediaRouteProviderService` in the provider's manifest. When the media route provider is registered as a service, all applications that use the media router API will be able to discover and used the provider's routes without having to install anything else.

This object must only be accessed on the main thread.

## Summary

| ### Nested types |
|---|
| `abstract class https://developer.android.com/reference/kotlin/androidx/mediarouter/media/MediaRouteProvider.Callback` Callback which is invoked when route information becomes available or changes. |
| `abstract class https://developer.android.com/reference/kotlin/androidx/mediarouter/media/MediaRouteProvider.DynamicGroupRouteController : https://developer.android.com/reference/kotlin/androidx/mediarouter/media/MediaRouteProvider.RouteController` Provides control over a dynamic group route. |
| `class https://developer.android.com/reference/kotlin/androidx/mediarouter/media/MediaRouteProvider.DynamicGroupRouteController.DynamicRouteDescriptor` Contains a route, its selection state and its capabilities. |
| `class https://developer.android.com/reference/kotlin/androidx/mediarouter/media/MediaRouteProvider.DynamicGroupRouteController.DynamicRouteDescriptor.Builder` Builder for `https://developer.android.com/reference/kotlin/androidx/mediarouter/media/MediaRouteProvider.DynamicGroupRouteController.DynamicRouteDescriptor` |
| `class https://developer.android.com/reference/kotlin/androidx/mediarouter/media/MediaRouteProvider.ProviderMetadata` Describes properties of the route provider's implementation. |
| `abstract class https://developer.android.com/reference/kotlin/androidx/mediarouter/media/MediaRouteProvider.RouteController` Provides control over a particular route. |
| `class https://developer.android.com/reference/kotlin/androidx/mediarouter/media/MediaRouteProvider.RouteControllerOptions` Holds parameters for creating `https://developer.android.com/reference/kotlin/androidx/mediarouter/media/MediaRouteProvider.RouteController`. |
| `class https://developer.android.com/reference/kotlin/androidx/mediarouter/media/MediaRouteProvider.RouteControllerOptions.Builder` Builder for `https://developer.android.com/reference/kotlin/androidx/mediarouter/media/MediaRouteProvider.RouteControllerOptions`. |

| ### Public constructors |
|---|
| `https://developer.android.com/reference/kotlin/androidx/mediarouter/media/MediaRouteProvider#MediaRouteProvider(android.content.Context)(context: https://developer.android.com/reference/android/content/Context.html)` Creates a media route provider. |

| ### Public functions |
|---|---|
| `https://developer.android.com/reference/android/content/Context.html` | `https://developer.android.com/reference/kotlin/androidx/mediarouter/media/MediaRouteProvider#getContext()()` Gets the context of the media route provider. |
| `https://developer.android.com/reference/kotlin/androidx/mediarouter/media/MediaRouteProviderDescriptor?` | `https://developer.android.com/reference/kotlin/androidx/mediarouter/media/MediaRouteProvider#getDescriptor()()` Gets the provider's descriptor. |
| `https://developer.android.com/reference/kotlin/androidx/mediarouter/media/MediaRouteDiscoveryRequest?` | `https://developer.android.com/reference/kotlin/androidx/mediarouter/media/MediaRouteProvider#getDiscoveryRequest()()` Gets the current discovery request which informs the provider about the kinds of routes to discover and whether to perform active scanning. |
| `https://developer.android.com/reference/android/os/Handler.html` | `https://developer.android.com/reference/kotlin/androidx/mediarouter/media/MediaRouteProvider#getHandler()()` Gets the provider's handler which is associated with the main thread. |
| `https://developer.android.com/reference/kotlin/androidx/mediarouter/media/MediaRouteProvider.ProviderMetadata` | `https://developer.android.com/reference/kotlin/androidx/mediarouter/media/MediaRouteProvider#getMetadata()()` Gets some metadata about the provider's implementation. |
| `https://developer.android.com/reference/kotlin/androidx/mediarouter/media/MediaRouteProvider.DynamicGroupRouteController?` | `https://developer.android.com/reference/kotlin/androidx/mediarouter/media/MediaRouteProvider#onCreateDynamicGroupRouteController(java.lang.String)(initialMemberRouteId: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html)` Creates a `https://developer.android.com/reference/kotlin/androidx/mediarouter/media/MediaRouteProvider.DynamicGroupRouteController`. |
| `https://developer.android.com/reference/kotlin/androidx/mediarouter/media/MediaRouteProvider.DynamicGroupRouteController?` | `https://developer.android.com/reference/kotlin/androidx/mediarouter/media/MediaRouteProvider#onCreateDynamicGroupRouteController(java.lang.String,androidx.mediarouter.media.MediaRouteProvider.RouteControllerOptions)( initialMemberRouteId: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html, routeControllerOptions: https://developer.android.com/reference/kotlin/androidx/mediarouter/media/MediaRouteProvider.RouteControllerOptions )` Creates a `https://developer.android.com/reference/kotlin/androidx/mediarouter/media/MediaRouteProvider.DynamicGroupRouteController`. |
| `https://developer.android.com/reference/kotlin/androidx/mediarouter/media/MediaRouteProvider.RouteController?` | `https://developer.android.com/reference/kotlin/androidx/mediarouter/media/MediaRouteProvider#onCreateRouteController(java.lang.String)(routeId: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html)` Called by the media router to obtain a route controller for a particular route. |
| `https://developer.android.com/reference/kotlin/androidx/mediarouter/media/MediaRouteProvider.RouteController?` | `https://developer.android.com/reference/kotlin/androidx/mediarouter/media/MediaRouteProvider#onCreateRouteController(java.lang.String,androidx.mediarouter.media.MediaRouteProvider.RouteControllerOptions)( routeId: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html, routeControllerOptions: https://developer.android.com/reference/kotlin/androidx/mediarouter/media/MediaRouteProvider.RouteControllerOptions )` Creates a `https://developer.android.com/reference/kotlin/androidx/mediarouter/media/MediaRouteProvider.RouteController`. |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` | `https://developer.android.com/reference/kotlin/androidx/mediarouter/media/MediaRouteProvider#onDiscoveryRequestChanged(androidx.mediarouter.media.MediaRouteDiscoveryRequest)(request: https://developer.android.com/reference/kotlin/androidx/mediarouter/media/MediaRouteDiscoveryRequest?)` Called by the media router when the `https://developer.android.com/reference/kotlin/androidx/mediarouter/media/MediaRouteDiscoveryRequest` has changed. |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` | `https://developer.android.com/reference/kotlin/androidx/mediarouter/media/MediaRouteProvider#setCallback(androidx.mediarouter.media.MediaRouteProvider.Callback)(callback: https://developer.android.com/reference/kotlin/androidx/mediarouter/media/MediaRouteProvider.Callback?)` Sets a callback to invoke when the provider's descriptor changes. |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` | `https://developer.android.com/reference/kotlin/androidx/mediarouter/media/MediaRouteProvider#setDescriptor(androidx.mediarouter.media.MediaRouteProviderDescriptor)(descriptor: https://developer.android.com/reference/kotlin/androidx/mediarouter/media/MediaRouteProviderDescriptor?)` Sets the provider's descriptor. |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` | `https://developer.android.com/reference/kotlin/androidx/mediarouter/media/MediaRouteProvider#setDiscoveryRequest(androidx.mediarouter.media.MediaRouteDiscoveryRequest)(request: https://developer.android.com/reference/kotlin/androidx/mediarouter/media/MediaRouteDiscoveryRequest?)` Sets a discovery request to inform the provider about the kinds of routes that its clients would like to discover and whether to perform active scanning. |

## Public constructors

### MediaRouteProvider

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

```
MediaRouteProvider(context: Context)
```

Creates a media route provider.

| Parameters |
|---|---|
| `context: https://developer.android.com/reference/android/content/Context.html` | The context. |

## Public functions

### getContext

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

```
fun getContext(): Context
```

Gets the context of the media route provider.

### getDescriptor

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

```
fun getDescriptor(): MediaRouteProviderDescriptor?
```

Gets the provider's descriptor.

The descriptor describes the state of the media route provider and the routes that it publishes. Watch for changes to the descriptor by registering a `https://developer.android.com/reference/kotlin/androidx/mediarouter/media/MediaRouteProvider.Callback` with `https://developer.android.com/reference/kotlin/androidx/mediarouter/media/MediaRouteProvider#setCallback(androidx.mediarouter.media.MediaRouteProvider.Callback)`.

| Returns |
|---|---|
| `https://developer.android.com/reference/kotlin/androidx/mediarouter/media/MediaRouteProviderDescriptor?` | The media route provider descriptor, or null if none. |

| See also |
|---|---|
| `https://developer.android.com/reference/kotlin/androidx/mediarouter/media/MediaRouteProvider.Callback#onDescriptorChanged(androidx.mediarouter.media.MediaRouteProvider,androidx.mediarouter.media.MediaRouteProviderDescriptor)` |   |

### getDiscoveryRequest

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

```
fun getDiscoveryRequest(): MediaRouteDiscoveryRequest?
```

Gets the current discovery request which informs the provider about the kinds of routes to discover and whether to perform active scanning.

| Returns |
|---|---|
| `https://developer.android.com/reference/kotlin/androidx/mediarouter/media/MediaRouteDiscoveryRequest?` | The current discovery request, or null if no discovery is needed at this time. |

| See also |
|---|---|
| `https://developer.android.com/reference/kotlin/androidx/mediarouter/media/MediaRouteProvider#onDiscoveryRequestChanged(androidx.mediarouter.media.MediaRouteDiscoveryRequest)` |   |

### getHandler

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

```
fun getHandler(): Handler
```

Gets the provider's handler which is associated with the main thread.

### getMetadata

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

```
fun getMetadata(): MediaRouteProvider.ProviderMetadata
```

Gets some metadata about the provider's implementation.

### onCreateDynamicGroupRouteController

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

```
fun onCreateDynamicGroupRouteController(initialMemberRouteId: String): MediaRouteProvider.DynamicGroupRouteController?
```

Creates a `https://developer.android.com/reference/kotlin/androidx/mediarouter/media/MediaRouteProvider.DynamicGroupRouteController`.

It is equivalent to `https://developer.android.com/reference/kotlin/androidx/mediarouter/media/MediaRouteProvider#onCreateDynamicGroupRouteController(java.lang.String,androidx.mediarouter.media.MediaRouteProvider.RouteControllerOptions)`, except it doesn't take `RouteControllerOptions`.

This method is only called when the subclass doesn't implement `https://developer.android.com/reference/kotlin/androidx/mediarouter/media/MediaRouteProvider#onCreateDynamicGroupRouteController(java.lang.String,androidx.mediarouter.media.MediaRouteProvider.RouteControllerOptions)`.

| Parameters |
|---|---|
| `initialMemberRouteId: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html` | initially selected route's id. |

| Returns |
|---|---|
| `https://developer.android.com/reference/kotlin/androidx/mediarouter/media/MediaRouteProvider.DynamicGroupRouteController?` | `https://developer.android.com/reference/kotlin/androidx/mediarouter/media/MediaRouteProvider.DynamicGroupRouteController`. Returns null if there is no such route or if the route cannot be controlled using the `https://developer.android.com/reference/kotlin/androidx/mediarouter/media/MediaRouteProvider.DynamicGroupRouteController` interface. |

### onCreateDynamicGroupRouteController

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

```
fun onCreateDynamicGroupRouteController(
    initialMemberRouteId: String,
    routeControllerOptions: MediaRouteProvider.RouteControllerOptions
): MediaRouteProvider.DynamicGroupRouteController?
```

Creates a `https://developer.android.com/reference/kotlin/androidx/mediarouter/media/MediaRouteProvider.DynamicGroupRouteController`.

It will be called from an app or `https://developer.android.com/reference/kotlin/androidx/mediarouter/media/MediaRouter` when a single route or a single static group is selected.

| Parameters |
|---|---|
| `initialMemberRouteId: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html` | initially selected route's id. |
| `routeControllerOptions: https://developer.android.com/reference/kotlin/androidx/mediarouter/media/MediaRouteProvider.RouteControllerOptions` | the parameters to be used to create the route controller. |

| Returns |
|---|---|
| `https://developer.android.com/reference/kotlin/androidx/mediarouter/media/MediaRouteProvider.DynamicGroupRouteController?` | `https://developer.android.com/reference/kotlin/androidx/mediarouter/media/MediaRouteProvider.DynamicGroupRouteController`. Returns null if there is no such route or if the route cannot be controlled using the `https://developer.android.com/reference/kotlin/androidx/mediarouter/media/MediaRouteProvider.DynamicGroupRouteController` interface. |

### onCreateRouteController

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

```
fun onCreateRouteController(routeId: String): MediaRouteProvider.RouteController?
```

Called by the media router to obtain a route controller for a particular route.

The media router will invoke the `https://developer.android.com/reference/kotlin/androidx/mediarouter/media/MediaRouteProvider.RouteController#onRelease()` method of the route controller when it is no longer needed to allow it to free its resources.

| Parameters |
|---|---|
| `routeId: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html` | The unique id of the route. |

| Returns |
|---|---|
| `https://developer.android.com/reference/kotlin/androidx/mediarouter/media/MediaRouteProvider.RouteController?` | The route controller. Returns null if there is no such route or if the route cannot be controlled using the route controller interface. |

### onCreateRouteController

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

```
fun onCreateRouteController(
    routeId: String,
    routeControllerOptions: MediaRouteProvider.RouteControllerOptions
): MediaRouteProvider.RouteController?
```

Creates a `https://developer.android.com/reference/kotlin/androidx/mediarouter/media/MediaRouteProvider.RouteController`.

It will be called from an app or `https://developer.android.com/reference/kotlin/androidx/mediarouter/media/MediaRouter` when a single route is selected.

| Parameters |
|---|---|
| `routeId: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html` | the selected route's ID. |
| `routeControllerOptions: https://developer.android.com/reference/kotlin/androidx/mediarouter/media/MediaRouteProvider.RouteControllerOptions` | the parameters to be used to create the route controller. |

| Returns |
|---|---|
| `https://developer.android.com/reference/kotlin/androidx/mediarouter/media/MediaRouteProvider.RouteController?` | `https://developer.android.com/reference/kotlin/androidx/mediarouter/media/MediaRouteProvider.RouteController`. Returns null if there is no such route. |

### onDiscoveryRequestChanged

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

```
fun onDiscoveryRequestChanged(request: MediaRouteDiscoveryRequest?): Unit
```

Called by the media router when the `https://developer.android.com/reference/kotlin/androidx/mediarouter/media/MediaRouteDiscoveryRequest` has changed.

Whenever an applications calls `https://developer.android.com/reference/kotlin/androidx/mediarouter/media/MediaRouter#addCallback(androidx.mediarouter.media.MediaRouteSelector,androidx.mediarouter.media.MediaRouter.Callback)` to register a callback, it also provides a selector to specify the kinds of routes that it is interested in. The media router combines all of these selectors together to generate a `https://developer.android.com/reference/kotlin/androidx/mediarouter/media/MediaRouteDiscoveryRequest` and notifies each provider when a change occurs by calling `https://developer.android.com/reference/kotlin/androidx/mediarouter/media/MediaRouteProvider#setDiscoveryRequest(androidx.mediarouter.media.MediaRouteDiscoveryRequest)` which posts a message to invoke this method asynchronously.

The provider should examine the `https://developer.android.com/reference/kotlin/androidx/mediarouter/media/MediaControlIntent` in the discovery request's `https://developer.android.com/reference/kotlin/androidx/mediarouter/media/MediaRouteSelector` to determine what kinds of routes it should try to discover and whether it should perform active or passive scans. In many cases, the provider may be able to save power by determining that the selector does not contain any categories that it supports and it can therefore avoid performing any scans at all.

| Parameters |
|---|---|
| `request: https://developer.android.com/reference/kotlin/androidx/mediarouter/media/MediaRouteDiscoveryRequest?` | The new discovery request, or null if no discovery is needed at this time. |

| See also |
|---|---|
| `https://developer.android.com/reference/kotlin/androidx/mediarouter/media/MediaRouter#addCallback(androidx.mediarouter.media.MediaRouteSelector,androidx.mediarouter.media.MediaRouter.Callback)` |   |

### setCallback

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

```
fun setCallback(callback: MediaRouteProvider.Callback?): Unit
```

Sets a callback to invoke when the provider's descriptor changes.

| Parameters |
|---|---|
| `callback: https://developer.android.com/reference/kotlin/androidx/mediarouter/media/MediaRouteProvider.Callback?` | The callback to use, or null if none. |

### setDescriptor

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

```
fun setDescriptor(descriptor: MediaRouteProviderDescriptor?): Unit
```

Sets the provider's descriptor.

The provider must call this method to notify the currently registered `https://developer.android.com/reference/kotlin/androidx/mediarouter/media/MediaRouteProvider.Callback` about the change to the provider's descriptor.

| Parameters |
|---|---|
| `descriptor: https://developer.android.com/reference/kotlin/androidx/mediarouter/media/MediaRouteProviderDescriptor?` | The updated route provider descriptor, or null if none. |

| See also |
|---|---|
| `https://developer.android.com/reference/kotlin/androidx/mediarouter/media/MediaRouteProvider.Callback#onDescriptorChanged(androidx.mediarouter.media.MediaRouteProvider,androidx.mediarouter.media.MediaRouteProviderDescriptor)` |   |

### setDiscoveryRequest

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

```
fun setDiscoveryRequest(request: MediaRouteDiscoveryRequest?): Unit
```

Sets a discovery request to inform the provider about the kinds of routes that its clients would like to discover and whether to perform active scanning.

| Parameters |
|---|---|
| `request: https://developer.android.com/reference/kotlin/androidx/mediarouter/media/MediaRouteDiscoveryRequest?` | The discovery request, or null if no discovery is needed at this time. |

| See also |
|---|---|
| `https://developer.android.com/reference/kotlin/androidx/mediarouter/media/MediaRouteProvider#onDiscoveryRequestChanged(androidx.mediarouter.media.MediaRouteDiscoveryRequest)` |   |