# MediaRouteProvider

added in[version 22.1.0](https://developer.android.com/topic/libraries/support-library/revisions)  
belongs to Maven artifact com.android.support:mediarouter-v7:28.0.0-alpha1  
Summary:[Nested Classes](https://developer.android.com/reference/android/support/v7/media/MediaRouteProvider#nestedclasses)\|[Ctors](https://developer.android.com/reference/android/support/v7/media/MediaRouteProvider#pubctors)\|[Methods](https://developer.android.com/reference/android/support/v7/media/MediaRouteProvider#pubmethods)\|[Inherited Methods](https://developer.android.com/reference/android/support/v7/media/MediaRouteProvider#inhmethods)\|[\[Expand All\]](https://developer.android.com/reference/android/support/v7/media/MediaRouteProvider#)  

# MediaRouteProvider

| This package is part of the Android[support library](https://developer.android.com/topic/libraries/support-library)which is no longer maintained. The support library has been superseded by[AndroidX](https://developer.android.com/jetpack/androidx)which is part of[Jetpack](https://developer.android.com/jetpack). We recommend using the AndroidX libraries in all new projects. You should also consider[migrating](https://developer.android.com/jetpack/androidx/migrate)existing projects to AndroidX. To find the AndroidX class that maps to this deprecated class, see the AndroidX support library[class mappings](https://developer.android.com/jetpack/androidx/migrate/class-mappings).

`
public


abstract
class
MediaRouteProvider
`  
`

extends Object


``


`

|---|---------------------------------------------|
| java.lang.Object                               ||
| ↳ | android.support.v7.media.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[MediaRouteDiscoveryRequest](https://developer.android.com/reference/android/support/v7/media/MediaRouteDiscoveryRequest)and publish a[MediaRouteProviderDescriptor](https://developer.android.com/reference/android/support/v7/media/MediaRouteProviderDescriptor)with information about each route by calling[setDescriptor(MediaRouteProviderDescriptor)](https://developer.android.com/reference/android/support/v7/media/MediaRouteProvider#setDescriptor(android.support.v7.media.MediaRouteProviderDescriptor))to notify the currently registered[MediaRouteProvider.Callback](https://developer.android.com/reference/android/support/v7/media/MediaRouteProvider.Callback).

The provider should watch for changes to the discovery request by implementing[onDiscoveryRequestChanged(MediaRouteDiscoveryRequest)](https://developer.android.com/reference/android/support/v7/media/MediaRouteProvider#onDiscoveryRequestChanged(android.support.v7.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[media control intents](https://developer.android.com/reference/android/support/v7/media/MediaControlIntent)by implementing[onCreateRouteController(String)](https://developer.android.com/reference/android/support/v7/media/MediaRouteProvider#onCreateRouteController(java.lang.String))to return a[MediaRouteProvider.RouteController](https://developer.android.com/reference/android/support/v7/media/MediaRouteProvider.RouteController)for a particular route.

A media route provider may be used privately within the scope of a single application process by calling[MediaRouter.addProvider](https://developer.android.com/reference/android/support/v7/media/MediaRouter#addProvider(android.support.v7.media.MediaRouteProvider))to add it to the local[MediaRouter](https://developer.android.com/reference/android/support/v7/media/MediaRouter). A media route provider may also be made available globally to all applications by registering a[MediaRouteProviderService](https://developer.android.com/reference/android/support/v7/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.

<br />

## Summary

|                                                                                                  ### Nested classes                                                                                                  ||
|----------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| ` class` | [MediaRouteProvider.Callback](https://developer.android.com/reference/android/support/v7/media/MediaRouteProvider.Callback) Callback which is invoked when route information becomes available or changes. |
| ` class` | [MediaRouteProvider.ProviderMetadata](https://developer.android.com/reference/android/support/v7/media/MediaRouteProvider.ProviderMetadata) Describes properties of the route provider's implementation.   |
| ` class` | [MediaRouteProvider.RouteController](https://developer.android.com/reference/android/support/v7/media/MediaRouteProvider.RouteController) Provides control over a particular route.                        |

|                                                                                                                                  ### Public constructors                                                                                                                                  ||
|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|
| ` `[MediaRouteProvider](https://developer.android.com/reference/android/support/v7/media/MediaRouteProvider#MediaRouteProvider(android.content.Context))`(`[Context](https://developer.android.com/reference/android/content/Context.html)` context) ` Creates a media route provider. |

|                                                                                                                                                                                                                                                                                                                        ### Public methods                                                                                                                                                                                                                                                                                                                        ||
|------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| ` final `[Context](https://developer.android.com/reference/android/content/Context.html)                                                             | ` `[getContext](https://developer.android.com/reference/android/support/v7/media/MediaRouteProvider#getContext())`() ` Gets the context of the media route provider.                                                                                                                                                                                                                                                                                                                                       |
| ` final `[MediaRouteProviderDescriptor](https://developer.android.com/reference/android/support/v7/media/MediaRouteProviderDescriptor)               | ` `[getDescriptor](https://developer.android.com/reference/android/support/v7/media/MediaRouteProvider#getDescriptor())`() ` Gets the provider's descriptor.                                                                                                                                                                                                                                                                                                                                               |
| ` final `[MediaRouteDiscoveryRequest](https://developer.android.com/reference/android/support/v7/media/MediaRouteDiscoveryRequest)                   | ` `[getDiscoveryRequest](https://developer.android.com/reference/android/support/v7/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.                                                                                                                                                                                                                       |
| ` final `[Handler](https://developer.android.com/reference/android/os/Handler.html)                                                                  | ` `[getHandler](https://developer.android.com/reference/android/support/v7/media/MediaRouteProvider#getHandler())`() ` Gets the provider's handler which is associated with the main thread.                                                                                                                                                                                                                                                                                                               |
| ` final `[MediaRouteProvider.ProviderMetadata](https://developer.android.com/reference/android/support/v7/media/MediaRouteProvider.ProviderMetadata) | ` `[getMetadata](https://developer.android.com/reference/android/support/v7/media/MediaRouteProvider#getMetadata())`() ` Gets some metadata about the provider's implementation.                                                                                                                                                                                                                                                                                                                           |
| ` `[MediaRouteProvider.RouteController](https://developer.android.com/reference/android/support/v7/media/MediaRouteProvider.RouteController)         | ` `[onCreateRouteController](https://developer.android.com/reference/android/support/v7/media/MediaRouteProvider#onCreateRouteController(java.lang.String))`(String routeId) ` Called by the media router to obtain a route controller for a particular route.                                                                                                                                                                                                                                             |
| ` void`                                                                                                                                              | ` `[onDiscoveryRequestChanged](https://developer.android.com/reference/android/support/v7/media/MediaRouteProvider#onDiscoveryRequestChanged(android.support.v7.media.MediaRouteDiscoveryRequest))`(`[MediaRouteDiscoveryRequest](https://developer.android.com/reference/android/support/v7/media/MediaRouteDiscoveryRequest)` request) ` Called by the media router when the[discovery request](https://developer.android.com/reference/android/support/v7/media/MediaRouteDiscoveryRequest)has changed. |
| ` final void`                                                                                                                                        | ` `[setCallback](https://developer.android.com/reference/android/support/v7/media/MediaRouteProvider#setCallback(android.support.v7.media.MediaRouteProvider.Callback))`(`[MediaRouteProvider.Callback](https://developer.android.com/reference/android/support/v7/media/MediaRouteProvider.Callback)` callback) ` Sets a callback to invoke when the provider's descriptor changes.                                                                                                                       |
| ` final void`                                                                                                                                        | ` `[setDescriptor](https://developer.android.com/reference/android/support/v7/media/MediaRouteProvider#setDescriptor(android.support.v7.media.MediaRouteProviderDescriptor))`(`[MediaRouteProviderDescriptor](https://developer.android.com/reference/android/support/v7/media/MediaRouteProviderDescriptor)` descriptor) ` Sets the provider's descriptor.                                                                                                                                                |
| ` final void`                                                                                                                                        | ` `[setDiscoveryRequest](https://developer.android.com/reference/android/support/v7/media/MediaRouteProvider#setDiscoveryRequest(android.support.v7.media.MediaRouteDiscoveryRequest))`(`[MediaRouteDiscoveryRequest](https://developer.android.com/reference/android/support/v7/media/MediaRouteDiscoveryRequest)` request) ` 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.                   |

| ### Inherited methods |
|-----------------------|---|
| [![](https://developer.android.com/static/assets/images/styles/disclosure_down.png)](https://developer.android.com/reference/android/support/v7/media/MediaRouteProvider#)From class` java.lang.Object ` |-------------------|-------------------------------| | ` Object`         | ` clone() `                   | | ` boolean`        | ` equals(Object arg0) `       | | ` void`           | ` finalize() `                | | ` final Class<?>` | ` getClass() `                | | ` int`            | ` hashCode() `                | | ` final void`     | ` notify() `                  | | ` final void`     | ` notifyAll() `               | | ` String`         | ` toString() `                | | ` final void`     | ` wait(long arg0, int arg1) ` | | ` final void`     | ` wait(long arg0) `           | | ` final void`     | ` wait() `                    | ||

## Public constructors

### MediaRouteProvider

added in[version 22.1.0](https://developer.android.com/topic/libraries/support-library/revisions)  

```
MediaRouteProvider (Context context)
```

Creates a media route provider.

<br />

|                Parameters                 ||
|-----------|--------------------------------|
| `context` | `Context`: The context. <br /> |

## Public methods

### getContext

added in[version 22.1.0](https://developer.android.com/topic/libraries/support-library/revisions)  

```
Context getContext ()
```

Gets the context of the media route provider.

<br />

|                                         Returns                                         ||
|---------------------------------------------------------------------------------|--------|
| [Context](https://developer.android.com/reference/android/content/Context.html) | <br /> |

### getDescriptor

added in[version 22.1.0](https://developer.android.com/topic/libraries/support-library/revisions)  

```
MediaRouteProviderDescriptor getDescriptor ()
```

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[callback](https://developer.android.com/reference/android/support/v7/media/MediaRouteProvider.Callback)with[setCallback(MediaRouteProvider.Callback)](https://developer.android.com/reference/android/support/v7/media/MediaRouteProvider#setCallback(android.support.v7.media.MediaRouteProvider.Callback)).

<br />

<br />

|                                                                                           Returns                                                                                           ||
|-------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------|
| [MediaRouteProviderDescriptor](https://developer.android.com/reference/android/support/v7/media/MediaRouteProviderDescriptor) | The media route provider descriptor, or null if none. <br /> |

**See also:**

- [onDescriptorChanged(MediaRouteProvider, MediaRouteProviderDescriptor)](https://developer.android.com/reference/android/support/v7/media/MediaRouteProvider.Callback#onDescriptorChanged(android.support.v7.media.MediaRouteProvider, android.support.v7.media.MediaRouteProviderDescriptor))  

### getDiscoveryRequest

added in[version 22.1.0](https://developer.android.com/topic/libraries/support-library/revisions)  

```
MediaRouteDiscoveryRequest getDiscoveryRequest ()
```

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

<br />

|                                                                                                     Returns                                                                                                      ||
|---------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------|
| [MediaRouteDiscoveryRequest](https://developer.android.com/reference/android/support/v7/media/MediaRouteDiscoveryRequest) | The current discovery request, or null if no discovery is needed at this time. <br /> |

**See also:**

- [onDiscoveryRequestChanged(MediaRouteDiscoveryRequest)](https://developer.android.com/reference/android/support/v7/media/MediaRouteProvider#onDiscoveryRequestChanged(android.support.v7.media.MediaRouteDiscoveryRequest))  

### getHandler

added in[version 22.1.0](https://developer.android.com/topic/libraries/support-library/revisions)  

```
Handler getHandler ()
```

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

<br />

|                                      Returns                                       ||
|----------------------------------------------------------------------------|--------|
| [Handler](https://developer.android.com/reference/android/os/Handler.html) | <br /> |

### getMetadata

added in[version 22.1.0](https://developer.android.com/topic/libraries/support-library/revisions)  

```
MediaRouteProvider.ProviderMetadata getMetadata ()
```

Gets some metadata about the provider's implementation.

<br />

|                                                                       Returns                                                                       ||
|---------------------------------------------------------------------------------------------------------------------------------------------|--------|
| [MediaRouteProvider.ProviderMetadata](https://developer.android.com/reference/android/support/v7/media/MediaRouteProvider.ProviderMetadata) | <br /> |

### onCreateRouteController

added in[version 22.1.0](https://developer.android.com/topic/libraries/support-library/revisions)  

```
MediaRouteProvider.RouteController onCreateRouteController (String routeId)
```

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

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

<br />

<br />

|                       Parameters                        ||
|-----------|----------------------------------------------|
| `routeId` | `String`: The unique id of the route. <br /> |

|                                                                                                                                          Returns                                                                                                                                          ||
|-------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------|
| [MediaRouteProvider.RouteController](https://developer.android.com/reference/android/support/v7/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. <br /> |

### onDiscoveryRequestChanged

added in[version 22.1.0](https://developer.android.com/topic/libraries/support-library/revisions)  

```
void onDiscoveryRequestChanged (MediaRouteDiscoveryRequest request)
```

Called by the media router when the[discovery request](https://developer.android.com/reference/android/support/v7/media/MediaRouteDiscoveryRequest)has changed.

Whenever an applications calls[addCallback(MediaRouteSelector, MediaRouter.Callback)](https://developer.android.com/reference/android/support/v7/media/MediaRouter#addCallback(android.support.v7.media.MediaRouteSelector, android.support.v7.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[MediaRouteDiscoveryRequest](https://developer.android.com/reference/android/support/v7/media/MediaRouteDiscoveryRequest)and notifies each provider when a change occurs by calling[setDiscoveryRequest(MediaRouteDiscoveryRequest)](https://developer.android.com/reference/android/support/v7/media/MediaRouteProvider#setDiscoveryRequest(android.support.v7.media.MediaRouteDiscoveryRequest))which posts a message to invoke this method asynchronously.

The provider should examine the[media control categories](https://developer.android.com/reference/android/support/v7/media/MediaControlIntent)in the discovery request's[selector](https://developer.android.com/reference/android/support/v7/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.

<br />

<br />

|                                                         Parameters                                                         ||
|-----------|-----------------------------------------------------------------------------------------------------------------|
| `request` | `MediaRouteDiscoveryRequest`: The new discovery request, or null if no discovery is needed at this time. <br /> |

**See also:**

- [addCallback(MediaRouteSelector, MediaRouter.Callback)](https://developer.android.com/reference/android/support/v7/media/MediaRouter#addCallback(android.support.v7.media.MediaRouteSelector, android.support.v7.media.MediaRouter.Callback))  

### setCallback

added in[version 22.1.0](https://developer.android.com/topic/libraries/support-library/revisions)  

```
void setCallback (MediaRouteProvider.Callback callback)
```

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

<br />

|                                       Parameters                                        ||
|------------|-----------------------------------------------------------------------------|
| `callback` | `MediaRouteProvider.Callback`: The callback to use, or null if none. <br /> |

### setDescriptor

added in[version 22.1.0](https://developer.android.com/topic/libraries/support-library/revisions)  

```
void setDescriptor (MediaRouteProviderDescriptor descriptor)
```

Sets the provider's descriptor.

The provider must call this method to notify the currently registered[callback](https://developer.android.com/reference/android/support/v7/media/MediaRouteProvider.Callback)about the change to the provider's descriptor.

<br />

<br />

|                                                  Parameters                                                  ||
|--------------|------------------------------------------------------------------------------------------------|
| `descriptor` | `MediaRouteProviderDescriptor`: The updated route provider descriptor, or null if none. <br /> |

**See also:**

- [onDescriptorChanged(MediaRouteProvider, MediaRouteProviderDescriptor)](https://developer.android.com/reference/android/support/v7/media/MediaRouteProvider.Callback#onDescriptorChanged(android.support.v7.media.MediaRouteProvider, android.support.v7.media.MediaRouteProviderDescriptor))  

### setDiscoveryRequest

added in[version 22.1.0](https://developer.android.com/topic/libraries/support-library/revisions)  

```
void setDiscoveryRequest (MediaRouteDiscoveryRequest request)
```

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.

<br />

|                                                       Parameters                                                       ||
|-----------|-------------------------------------------------------------------------------------------------------------|
| `request` | `MediaRouteDiscoveryRequest`: The discovery request, or null if no discovery is needed at this time. <br /> |

**See also:**

- [onDiscoveryRequestChanged(MediaRouteDiscoveryRequest)](https://developer.android.com/reference/android/support/v7/media/MediaRouteProvider#onDiscoveryRequestChanged(android.support.v7.media.MediaRouteDiscoveryRequest))  
-

  ## Interfaces

  - [RemotePlaybackClient.OnMessageReceivedListener](https://developer.android.com/reference/android/support/v7/media/RemotePlaybackClient.OnMessageReceivedListener)
-

  ## Classes

  - [MediaControlIntent](https://developer.android.com/reference/android/support/v7/media/MediaControlIntent)
  - [MediaItemMetadata](https://developer.android.com/reference/android/support/v7/media/MediaItemMetadata)
  - [MediaItemStatus](https://developer.android.com/reference/android/support/v7/media/MediaItemStatus)
  - [MediaItemStatus.Builder](https://developer.android.com/reference/android/support/v7/media/MediaItemStatus.Builder)
  - [MediaRouteDescriptor](https://developer.android.com/reference/android/support/v7/media/MediaRouteDescriptor)
  - [MediaRouteDescriptor.Builder](https://developer.android.com/reference/android/support/v7/media/MediaRouteDescriptor.Builder)
  - [MediaRouteDiscoveryRequest](https://developer.android.com/reference/android/support/v7/media/MediaRouteDiscoveryRequest)
  - [MediaRouteProvider](https://developer.android.com/reference/android/support/v7/media/MediaRouteProvider)
  - [MediaRouteProvider.Callback](https://developer.android.com/reference/android/support/v7/media/MediaRouteProvider.Callback)
  - [MediaRouteProvider.ProviderMetadata](https://developer.android.com/reference/android/support/v7/media/MediaRouteProvider.ProviderMetadata)
  - [MediaRouteProvider.RouteController](https://developer.android.com/reference/android/support/v7/media/MediaRouteProvider.RouteController)
  - [MediaRouteProviderDescriptor](https://developer.android.com/reference/android/support/v7/media/MediaRouteProviderDescriptor)
  - [MediaRouteProviderDescriptor.Builder](https://developer.android.com/reference/android/support/v7/media/MediaRouteProviderDescriptor.Builder)
  - [MediaRouteProviderService](https://developer.android.com/reference/android/support/v7/media/MediaRouteProviderService)
  - [MediaRouter](https://developer.android.com/reference/android/support/v7/media/MediaRouter)
  - [MediaRouter.Callback](https://developer.android.com/reference/android/support/v7/media/MediaRouter.Callback)
  - [MediaRouter.ControlRequestCallback](https://developer.android.com/reference/android/support/v7/media/MediaRouter.ControlRequestCallback)
  - [MediaRouter.ProviderInfo](https://developer.android.com/reference/android/support/v7/media/MediaRouter.ProviderInfo)
  - [MediaRouter.RouteInfo](https://developer.android.com/reference/android/support/v7/media/MediaRouter.RouteInfo)
  - [MediaRouteSelector](https://developer.android.com/reference/android/support/v7/media/MediaRouteSelector)
  - [MediaRouteSelector.Builder](https://developer.android.com/reference/android/support/v7/media/MediaRouteSelector.Builder)
  - [MediaSessionStatus](https://developer.android.com/reference/android/support/v7/media/MediaSessionStatus)
  - [MediaSessionStatus.Builder](https://developer.android.com/reference/android/support/v7/media/MediaSessionStatus.Builder)
  - [RemotePlaybackClient](https://developer.android.com/reference/android/support/v7/media/RemotePlaybackClient)
  - [RemotePlaybackClient.ActionCallback](https://developer.android.com/reference/android/support/v7/media/RemotePlaybackClient.ActionCallback)
  - [RemotePlaybackClient.ItemActionCallback](https://developer.android.com/reference/android/support/v7/media/RemotePlaybackClient.ItemActionCallback)
  - [RemotePlaybackClient.SessionActionCallback](https://developer.android.com/reference/android/support/v7/media/RemotePlaybackClient.SessionActionCallback)
  - [RemotePlaybackClient.StatusCallback](https://developer.android.com/reference/android/support/v7/media/RemotePlaybackClient.StatusCallback)