lightbulb_outline Help shape the future of the Google Play Console, Android Studio, and Firebase. Start survey

MediaRouteActionProvider

public class MediaRouteActionProvider
extends ActionProvider

java.lang.Object
   ↳ android.view.ActionProvider
     ↳ android.app.MediaRouteActionProvider


The media route action provider displays a media route button in the application's 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 the route types with the setRouteTypes(int) method.

Refer to 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.

Summary

Public constructors

MediaRouteActionProvider(Context context)

Public methods

boolean isVisible()

If overridesItemVisibility() returns true, the return value of this method will help determine the visibility of the MenuItem this ActionProvider is bound to.

View onCreateActionView()

This method is deprecated. use onCreateActionView(MenuItem)

View onCreateActionView(MenuItem item)

Factory method called by the Android framework to create new action views.

boolean onPerformDefaultAction()

Performs an optional default action.

boolean overridesItemVisibility()

The result of this method determines whether or not isVisible() will be used by the MenuItem this ActionProvider is bound to help determine its visibility.

void setExtendedSettingsClickListener(View.OnClickListener listener)
void setRouteTypes(int types)

Sets the types of routes that will be shown in the media route chooser dialog launched by this button.

Inherited methods

Public constructors

MediaRouteActionProvider

added in API level 16
public MediaRouteActionProvider (Context context)

Parameters
context Context

Public methods

isVisible

added in API level 16
public boolean isVisible ()

If overridesItemVisibility() returns true, the return value of this method will help determine the visibility of the MenuItem 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 API level 16
public View onCreateActionView ()

This method is deprecated.
use onCreateActionView(MenuItem)

Factory method called by the Android framework to create new action views.

This method has been deprecated in favor of onCreateActionView(MenuItem). Newer apps that wish to support platform versions prior to API 16 should also implement this method to return a valid action view.

Returns
View A new action view.

onCreateActionView

added in API level 16
public View onCreateActionView (MenuItem item)

Factory method called by the Android framework to create new action views. This method returns a new action view for the given MenuItem.

If your ActionProvider implementation overrides the deprecated no-argument overload onCreateActionView(), overriding this method for devices running API 16 or later is recommended but optional. The default implementation calls onCreateActionView() for compatibility with applications written for older platform versions.

Parameters
item MenuItem: MenuItem to create the action view for

Returns
View the new action view

onPerformDefaultAction

added in API level 16
public 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:

The default implementation does not perform any action and returns false.

Returns
boolean

overridesItemVisibility

added in API level 16
public boolean overridesItemVisibility ()

The result of this method determines whether or not isVisible() will be used by the MenuItem 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.

setExtendedSettingsClickListener

added in API level 16
public void setExtendedSettingsClickListener (View.OnClickListener listener)

Parameters
listener View.OnClickListener

setRouteTypes

added in API level 16
public void setRouteTypes (int types)

Sets the types of routes that will be shown in the media route chooser dialog launched by this button.

Parameters
types int: The route types to match.