# MediaRouteActionProvider 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:[Ctors](https://developer.android.com/reference/android/support/v7/app/MediaRouteActionProvider#pubctors)\|[Methods](https://developer.android.com/reference/android/support/v7/app/MediaRouteActionProvider#pubmethods)\|[Inherited Methods](https://developer.android.com/reference/android/support/v7/app/MediaRouteActionProvider#inhmethods)\|[\[Expand All\]](https://developer.android.com/reference/android/support/v7/app/MediaRouteActionProvider#) # MediaRouteActionProvider | 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 class MediaRouteActionProvider ` ` `` extends `[ActionProvider](https://developer.android.com/reference/android/support/v4/view/ActionProvider)` `` ` |---|---|-------------------------------------------------| | java.lang.Object ||| | ↳ | [android.support.v4.view.ActionProvider](https://developer.android.com/reference/android/support/v4/view/ActionProvider) || | | ↳ | android.support.v7.app.MediaRouteActionProvider |
*** ** * ** *** The media route action provider displays a[media route button](https://developer.android.com/reference/android/support/v7/app/MediaRouteButton)in the application's[ActionBar](https://developer.android.com/reference/android/support/v7/app/ActionBar)to allow the user to select routes and to control the currently selected route. The application must specify the kinds of routes that the user should be allowed to select by specifying a[selector](https://developer.android.com/reference/android/support/v7/media/MediaRouteSelector)with the[setRouteSelector(MediaRouteSelector)](https://developer.android.com/reference/android/support/v7/app/MediaRouteActionProvider#setRouteSelector(android.support.v7.media.MediaRouteSelector))method. Refer to[MediaRouteButton](https://developer.android.com/reference/android/support/v7/app/MediaRouteButton)for a description of the button that will appear in the action bar menu. Note that instead of disabling the button when no routes are available, the action provider will instead make the menu item invisible. In this way, the button will only be visible when it is possible for the user to discover and select a matching route. ### Prerequisites To use the media route action provider, the activity must be a subclass of[AppCompatActivity](https://developer.android.com/reference/android/support/v7/app/AppCompatActivity)from the`android.support.v7.appcompat`support library. Refer to support library documentation for details. ### Example
The application should define a menu resource to include the provider in the action bar options menu. Note that the support library action bar uses attributes that are defined in the application's resource namespace rather than the framework's resource namespace to configure each item. ``` ``` Then configure the menu and set the route selector for the chooser. ``` public class MyActivity extends AppCompatActivity { private MediaRouter mRouter; private MediaRouter.Callback mCallback; private MediaRouteSelector mSelector; protected void onCreate(Bundle savedInstanceState) { super.onCreate(savedInstanceState); mRouter = Mediarouter.getInstance(this); mSelector = new MediaRouteSelector.Builder() .addControlCategory(MediaControlIntent.CATEGORY_LIVE_AUDIO) .addControlCategory(MediaControlIntent.CATEGORY_REMOTE_PLAYBACK) .build(); mCallback = new MyCallback(); } // Add the callback on start to tell the media router what kinds of routes // the application is interested in so that it can try to discover suitable ones. public void onStart() { super.onStart(); mediaRouter.addCallback(mSelector, mCallback, MediaRouter.CALLBACK_FLAG_REQUEST_DISCOVERY); MediaRouter.RouteInfo route = mediaRouter.updateSelectedRoute(mSelector); // do something with the route... } // Remove the selector on stop to tell the media router that it no longer // needs to invest effort trying to discover routes of these kinds for now. public void onStop() { super.onStop(); mediaRouter.removeCallback(mCallback); } public boolean onCreateOptionsMenu(Menu menu) { super.onCreateOptionsMenu(menu); getMenuInflater().inflate(R.menu.sample_media_router_menu, menu); MenuItem mediaRouteMenuItem = menu.findItem(R.id.media_route_menu_item); MediaRouteActionProvider mediaRouteActionProvider = (MediaRouteActionProvider)MenuItemCompat.getActionProvider(mediaRouteMenuItem); mediaRouteActionProvider.setRouteSelector(mSelector); return true; } private final class MyCallback extends MediaRouter.Callback { // Implement callback methods as needed. } } ```
**See also:** - [setRouteSelector(MediaRouteSelector)](https://developer.android.com/reference/android/support/v7/app/MediaRouteActionProvider#setRouteSelector(android.support.v7.media.MediaRouteSelector)) ## Summary | ### Public constructors || |-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---| | ` `[MediaRouteActionProvider](https://developer.android.com/reference/android/support/v7/app/MediaRouteActionProvider#MediaRouteActionProvider(android.content.Context))`(`[Context](https://developer.android.com/reference/android/content/Context.html)` context) ` Creates the action provider. | | ### Public methods || |----------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | ` `[MediaRouteDialogFactory](https://developer.android.com/reference/android/support/v7/app/MediaRouteDialogFactory) | ` `[getDialogFactory](https://developer.android.com/reference/android/support/v7/app/MediaRouteActionProvider#getDialogFactory())`() ` Gets the media route dialog factory to use when showing the route chooser or controller dialog. | | ` `[MediaRouteButton](https://developer.android.com/reference/android/support/v7/app/MediaRouteButton) | ` `[getMediaRouteButton](https://developer.android.com/reference/android/support/v7/app/MediaRouteActionProvider#getMediaRouteButton())`() ` Gets the associated media route button, or null if it has not yet been created. | | ` `[MediaRouteSelector](https://developer.android.com/reference/android/support/v7/media/MediaRouteSelector) | ` `[getRouteSelector](https://developer.android.com/reference/android/support/v7/app/MediaRouteActionProvider#getRouteSelector())`() ` Gets the media route selector for filtering the routes that the user can select using the media route chooser dialog. | | ` boolean` | ` `[isVisible](https://developer.android.com/reference/android/support/v7/app/MediaRouteActionProvider#isVisible())`() ` If[overridesItemVisibility()](https://developer.android.com/reference/android/support/v4/view/ActionProvider#overridesItemVisibility())returns true, the return value of this method will help determine the visibility of the[MenuItem](https://developer.android.com/reference/android/view/MenuItem.html)this ActionProvider is bound to. | | ` `[View](https://developer.android.com/reference/android/view/View.html) | ` `[onCreateActionView](https://developer.android.com/reference/android/support/v7/app/MediaRouteActionProvider#onCreateActionView())`() ` Factory method for creating new action views. | | ` `[MediaRouteButton](https://developer.android.com/reference/android/support/v7/app/MediaRouteButton) | ` `[onCreateMediaRouteButton](https://developer.android.com/reference/android/support/v7/app/MediaRouteActionProvider#onCreateMediaRouteButton())`() ` Called when the media route button is being created. | | ` boolean` | ` `[onPerformDefaultAction](https://developer.android.com/reference/android/support/v7/app/MediaRouteActionProvider#onPerformDefaultAction())`() ` Performs an optional default action. | | ` boolean` | ` `[overridesItemVisibility](https://developer.android.com/reference/android/support/v7/app/MediaRouteActionProvider#overridesItemVisibility())`() ` The result of this method determines whether or not[isVisible()](https://developer.android.com/reference/android/support/v4/view/ActionProvider#isVisible())will be used by the[MenuItem](https://developer.android.com/reference/android/view/MenuItem.html)this ActionProvider is bound to help determine its visibility. | | ` void` | ` `[setDialogFactory](https://developer.android.com/reference/android/support/v7/app/MediaRouteActionProvider#setDialogFactory(android.support.v7.app.MediaRouteDialogFactory))`(`[MediaRouteDialogFactory](https://developer.android.com/reference/android/support/v7/app/MediaRouteDialogFactory)` factory) ` Sets the media route dialog factory to use when showing the route chooser or controller dialog. | | ` void` | ` `[setRouteSelector](https://developer.android.com/reference/android/support/v7/app/MediaRouteActionProvider#setRouteSelector(android.support.v7.media.MediaRouteSelector))`(`[MediaRouteSelector](https://developer.android.com/reference/android/support/v7/media/MediaRouteSelector)` selector) ` Sets the media route selector for filtering the routes that the user can select using the media route chooser dialog. | | ### Inherited methods | |-----------------------|---| | [![](https://developer.android.com/static/assets/images/styles/disclosure_down.png)](https://developer.android.com/reference/android/support/v7/app/MediaRouteActionProvider#)From class` `[android.support.v4.view.ActionProvider](https://developer.android.com/reference/android/support/v4/view/ActionProvider)` ` |------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | ` `[Context](https://developer.android.com/reference/android/content/Context.html) | ` `[getContext](https://developer.android.com/reference/android/support/v4/view/ActionProvider#getContext())`() ` Gets the context associated with this action provider. | | ` boolean` | ` `[hasSubMenu](https://developer.android.com/reference/android/support/v4/view/ActionProvider#hasSubMenu())`() ` Determines if this ActionProvider has a submenu associated with it. | | ` boolean` | ` `[isVisible](https://developer.android.com/reference/android/support/v4/view/ActionProvider#isVisible())`() ` If[overridesItemVisibility()](https://developer.android.com/reference/android/support/v4/view/ActionProvider#overridesItemVisibility())returns true, the return value of this method will help determine the visibility of the[MenuItem](https://developer.android.com/reference/android/view/MenuItem.html)this ActionProvider is bound to. | | ` abstract `[View](https://developer.android.com/reference/android/view/View.html) | ` `[onCreateActionView](https://developer.android.com/reference/android/support/v4/view/ActionProvider#onCreateActionView())`() ` Factory method for creating new action views. | | ` `[View](https://developer.android.com/reference/android/view/View.html) | ` `[onCreateActionView](https://developer.android.com/reference/android/support/v4/view/ActionProvider#onCreateActionView(android.view.MenuItem))`(`[MenuItem](https://developer.android.com/reference/android/view/MenuItem.html)` forItem) ` Factory method called by the Android framework to create new action views. | | ` boolean` | ` `[onPerformDefaultAction](https://developer.android.com/reference/android/support/v4/view/ActionProvider#onPerformDefaultAction())`() ` Performs an optional default action. | | ` void` | ` `[onPrepareSubMenu](https://developer.android.com/reference/android/support/v4/view/ActionProvider#onPrepareSubMenu(android.view.SubMenu))`(`[SubMenu](https://developer.android.com/reference/android/view/SubMenu.html)` subMenu) ` Called to prepare an associated submenu for the menu item backed by this ActionProvider. | | ` boolean` | ` `[overridesItemVisibility](https://developer.android.com/reference/android/support/v4/view/ActionProvider#overridesItemVisibility())`() ` The result of this method determines whether or not[isVisible()](https://developer.android.com/reference/android/support/v4/view/ActionProvider#isVisible())will be used by the[MenuItem](https://developer.android.com/reference/android/view/MenuItem.html)this ActionProvider is bound to help determine its visibility. | | ` void` | ` `[refreshVisibility](https://developer.android.com/reference/android/support/v4/view/ActionProvider#refreshVisibility())`() ` If this ActionProvider is associated with an item in a menu, refresh the visibility of the item based on[overridesItemVisibility()](https://developer.android.com/reference/android/support/v4/view/ActionProvider#overridesItemVisibility())and[isVisible()](https://developer.android.com/reference/android/support/v4/view/ActionProvider#isVisible()). | | ` void` | ` `[setVisibilityListener](https://developer.android.com/reference/android/support/v4/view/ActionProvider#setVisibilityListener(android.support.v4.view.ActionProvider.VisibilityListener))`(`[ActionProvider.VisibilityListener](https://developer.android.com/reference/android/support/v4/view/ActionProvider.VisibilityListener)` listener) ` Set a listener to be notified when this ActionProvider's overridden visibility changes. | || | [![](https://developer.android.com/static/assets/images/styles/disclosure_down.png)](https://developer.android.com/reference/android/support/v7/app/MediaRouteActionProvider#)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 ### MediaRouteActionProvider added in[version 22.1.0](https://developer.android.com/topic/libraries/support-library/revisions) ``` MediaRouteActionProvider (Context context) ``` Creates the action provider.
| Parameters || |-----------|--------------------------------| | `context` | `Context`: The context.
| ## Public methods ### getDialogFactory added in[version 22.1.0](https://developer.android.com/topic/libraries/support-library/revisions) ``` MediaRouteDialogFactory getDialogFactory () ``` Gets the media route dialog factory to use when showing the route chooser or controller dialog.
| Returns || |-------------------------------------------------------------------------------------------------------------------|----------------------------------------| | [MediaRouteDialogFactory](https://developer.android.com/reference/android/support/v7/app/MediaRouteDialogFactory) | The dialog factory, never null.
| ### getMediaRouteButton added in[version 22.1.0](https://developer.android.com/topic/libraries/support-library/revisions) ``` MediaRouteButton getMediaRouteButton () ``` Gets the associated media route button, or null if it has not yet been created.
| Returns || |-----------------------------------------------------------------------------------------------------|--------| | [MediaRouteButton](https://developer.android.com/reference/android/support/v7/app/MediaRouteButton) |
| ### getRouteSelector added in[version 22.1.0](https://developer.android.com/topic/libraries/support-library/revisions) ``` MediaRouteSelector getRouteSelector () ``` Gets the media route selector for filtering the routes that the user can select using the media route chooser dialog.
| Returns || |-----------------------------------------------------------------------------------------------------------|----------------------------------| | [MediaRouteSelector](https://developer.android.com/reference/android/support/v7/media/MediaRouteSelector) | The selector, never null.
| ### isVisible added in[version 22.1.0](https://developer.android.com/topic/libraries/support-library/revisions) ``` boolean isVisible () ``` If[overridesItemVisibility()](https://developer.android.com/reference/android/support/v4/view/ActionProvider#overridesItemVisibility())returns true, the return value of this method will help determine the visibility of the[MenuItem](https://developer.android.com/reference/android/view/MenuItem.html)this ActionProvider is bound to. If the MenuItem's visibility is explicitly set to false by the application, the MenuItem will not be shown, even if this method returns true.

| Returns || |-----------|--------------------------------------------------------------------------------------------------------------------------------------------| | `boolean` | true if the MenuItem this ActionProvider is bound to is visible, false if it is invisible. The default implementation returns true.
| ### onCreateActionView added in[version 22.1.0](https://developer.android.com/topic/libraries/support-library/revisions) ``` View onCreateActionView () ``` Factory method for creating new action views.
| Returns || |------------------------------------------------------------------------|---------------------------| | [View](https://developer.android.com/reference/android/view/View.html) | A new action view.
| ### onCreateMediaRouteButton added in[version 22.1.0](https://developer.android.com/topic/libraries/support-library/revisions) ``` MediaRouteButton onCreateMediaRouteButton () ``` Called when the media route button is being created. Subclasses may override this method to customize the button.

| Returns || |-----------------------------------------------------------------------------------------------------|--------| | [MediaRouteButton](https://developer.android.com/reference/android/support/v7/app/MediaRouteButton) |
| ### onPerformDefaultAction added in[version 22.1.0](https://developer.android.com/topic/libraries/support-library/revisions) ``` boolean onPerformDefaultAction () ``` Performs an optional default action. For the case of an action provider placed in a menu item not shown as an action this method is invoked if previous callbacks for processing menu selection has handled the event. A menu item selection is processed in the following order: - Receiving a call to[MenuItem.OnMenuItemClickListener.onMenuItemClick](https://developer.android.com/reference/android/view/MenuItem.OnMenuItemClickListener.html#onMenuItemClick(android.view.MenuItem)). - Receiving a call to[onOptionsItemSelected(android.view.MenuItem)](https://developer.android.com/reference/android/app/Activity.html#onOptionsItemSelected(android.view.MenuItem))FragmentActivity.onOptionsItemSelected(MenuItem)} - Receiving a call to[onOptionsItemSelected(android.view.MenuItem)](https://developer.android.com/reference/android/support/v4/app/Fragment#onOptionsItemSelected(android.view.MenuItem))Fragment.onOptionsItemSelected(MenuItem)} - Launching the[Intent](https://developer.android.com/reference/android/content/Intent.html)set via[MenuItem.setIntent(android.content.Intent)](https://developer.android.com/reference/android/view/MenuItem.html#setIntent(android.content.Intent)) - Invoking this method. The default implementation does not perform any action and returns false.
| Returns || |-----------|--------| | `boolean` |
| ### overridesItemVisibility added in[version 22.1.0](https://developer.android.com/topic/libraries/support-library/revisions) ``` boolean overridesItemVisibility () ``` The result of this method determines whether or not[isVisible()](https://developer.android.com/reference/android/support/v4/view/ActionProvider#isVisible())will be used by the[MenuItem](https://developer.android.com/reference/android/view/MenuItem.html)this ActionProvider is bound to help determine its visibility.
| Returns || |-----------|--------------------------------------------------------------------------------------------------------------------------------------------------------| | `boolean` | true if this ActionProvider overrides the visibility of the MenuItem it is bound to, false otherwise. The default implementation returns false.
| ### setDialogFactory added in[version 22.1.0](https://developer.android.com/topic/libraries/support-library/revisions) ``` void setDialogFactory (MediaRouteDialogFactory factory) ``` Sets the media route dialog factory to use when showing the route chooser or controller dialog.
| Parameters || |-----------|-------------------------------------------------------------------------| | `factory` | `MediaRouteDialogFactory`: The dialog factory, must not be null.
| ### setRouteSelector added in[version 22.1.0](https://developer.android.com/topic/libraries/support-library/revisions) ``` void setRouteSelector (MediaRouteSelector selector) ``` Sets the media route selector for filtering the routes that the user can select using the media route chooser dialog.
| Parameters || |------------|--------------------------------------------------------------| | `selector` | `MediaRouteSelector`: The selector, must not be null.
| - ## Interfaces - [ActionBar.OnMenuVisibilityListener](https://developer.android.com/reference/android/support/v7/app/ActionBar.OnMenuVisibilityListener) - [ActionBar.OnNavigationListener](https://developer.android.com/reference/android/support/v7/app/ActionBar.OnNavigationListener) - [ActionBar.TabListener](https://developer.android.com/reference/android/support/v7/app/ActionBar.TabListener) - [ActionBarDrawerToggle.Delegate](https://developer.android.com/reference/android/support/v7/app/ActionBarDrawerToggle.Delegate) - [ActionBarDrawerToggle.DelegateProvider](https://developer.android.com/reference/android/support/v7/app/ActionBarDrawerToggle.DelegateProvider) - [AppCompatCallback](https://developer.android.com/reference/android/support/v7/app/AppCompatCallback) - ## Classes - [ActionBar](https://developer.android.com/reference/android/support/v7/app/ActionBar) - [ActionBar.LayoutParams](https://developer.android.com/reference/android/support/v7/app/ActionBar.LayoutParams) - [ActionBar.Tab](https://developer.android.com/reference/android/support/v7/app/ActionBar.Tab) - [ActionBarDrawerToggle](https://developer.android.com/reference/android/support/v7/app/ActionBarDrawerToggle) - [AlertDialog](https://developer.android.com/reference/android/support/v7/app/AlertDialog) - [AlertDialog.Builder](https://developer.android.com/reference/android/support/v7/app/AlertDialog.Builder) - [AppCompatActivity](https://developer.android.com/reference/android/support/v7/app/AppCompatActivity) - [AppCompatDelegate](https://developer.android.com/reference/android/support/v7/app/AppCompatDelegate) - [AppCompatDialog](https://developer.android.com/reference/android/support/v7/app/AppCompatDialog) - [AppCompatDialogFragment](https://developer.android.com/reference/android/support/v7/app/AppCompatDialogFragment) - [AppCompatViewInflater](https://developer.android.com/reference/android/support/v7/app/AppCompatViewInflater) - [MediaRouteActionProvider](https://developer.android.com/reference/android/support/v7/app/MediaRouteActionProvider) - [MediaRouteButton](https://developer.android.com/reference/android/support/v7/app/MediaRouteButton) - [MediaRouteChooserDialog](https://developer.android.com/reference/android/support/v7/app/MediaRouteChooserDialog) - [MediaRouteChooserDialogFragment](https://developer.android.com/reference/android/support/v7/app/MediaRouteChooserDialogFragment) - [MediaRouteControllerDialog](https://developer.android.com/reference/android/support/v7/app/MediaRouteControllerDialog) - [MediaRouteControllerDialogFragment](https://developer.android.com/reference/android/support/v7/app/MediaRouteControllerDialogFragment) - [MediaRouteDialogFactory](https://developer.android.com/reference/android/support/v7/app/MediaRouteDialogFactory) - [MediaRouteDiscoveryFragment](https://developer.android.com/reference/android/support/v7/app/MediaRouteDiscoveryFragment)