MediaRouteActionProvider


class MediaRouteActionProvider : ActionProvider


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 a selector with the setRouteSelector method.

Refer to MediaRouteButton for a description of the button that will appear in the action bar menu.

Prerequisites

To use the media route action provider, the activity must be a subclass of 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.

<menu xmlns:android="http://schemas.android.com/apk/res/android"
        xmlns:app="http://schemas.android.com/apk/res-auto">
    <item android:id="@+id/media_route_menu_item"
        android:title="@string/media_route_menu_title"
        app:showAsAction="always"
        app:actionProviderClass="androidx.mediarouter.app.MediaRouteActionProvider"/>
</menu>

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 callback flag CALLBACK_FLAG_REQUEST_DISCOVERY on stop by calling
    // addCallback() again in order 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() {
        mRouter.addCallback(mSelector, mCallback, /* flags= */ 0);

        super.onStop();
    }

    // Remove the callback when the activity is destroyed.
    public void onDestroy() {
        mRouter.removeCallback(mCallback);

        super.onDestroy();
    }

    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

Summary

Public constructors

Creates the action provider.

Public functions

Unit

This function is deprecated.

Use setDialogType with DIALOG_TYPE_DYNAMIC_GROUP instead.

MediaRouteDialogFactory

Gets the media route dialog factory to use when showing the route chooser or controller dialog.

MediaRouteButton?

Gets the associated media route button, or null if it has not yet been created.

MediaRouteSelector

Gets the media route selector for filtering the routes that the user can select using the media route chooser dialog.

View

Factory method for creating new action views.

MediaRouteButton

Called when the media route button is being created.

Boolean

Performs an optional default action.

Unit
setAlwaysVisible(alwaysVisible: Boolean)

This function is deprecated.

The visibility of the button is no longer controlled from ActionProvider.

Unit

Sets the media route dialog factory to use when showing the route chooser or controller dialog.

Unit

Sets the media route selector for filtering the routes that the user can select using the media route chooser dialog.

Inherited functions

From androidx.core.view.ActionProvider
Context

Gets the context associated with this action provider.

Boolean

Determines if this ActionProvider has a submenu associated with it.

Boolean

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

View

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

Unit

Called to prepare an associated submenu for the menu item backed by this ActionProvider.

Boolean

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.

Unit

If this ActionProvider is associated with an item in a menu, refresh the visibility of the item based on overridesItemVisibility and isVisible.

Unit

Set a listener to be notified when this ActionProvider's overridden visibility changes.

Public constructors

MediaRouteActionProvider

Added in 1.1.0
MediaRouteActionProvider(context: Context)

Creates the action provider.

Parameters
context: Context

The context.

Public functions

enableDynamicGroup

Added in 1.1.0
Deprecated in 1.2.0
fun enableDynamicGroup(): Unit

Enables dynamic group feature. With this enabled, a different set of MediaRouteChooserDialog and MediaRouteControllerDialog is shown when the button is clicked. If a media route provider supports dynamic group, the users can use that feature with the dialogs.

getDialogFactory

Added in 1.1.0
fun getDialogFactory(): MediaRouteDialogFactory

Gets the media route dialog factory to use when showing the route chooser or controller dialog.

Returns
MediaRouteDialogFactory

The dialog factory, never null.

getMediaRouteButton

Added in 1.1.0
fun getMediaRouteButton(): MediaRouteButton?

Gets the associated media route button, or null if it has not yet been created.

getRouteSelector

Added in 1.1.0
fun getRouteSelector(): MediaRouteSelector

Gets the media route selector for filtering the routes that the user can select using the media route chooser dialog.

Returns
MediaRouteSelector

The selector, never null.

onCreateActionView

Added in 1.1.0
fun onCreateActionView(): View

Factory method for creating new action views.

Returns
View

A new action view.

onCreateMediaRouteButton

Added in 1.1.0
fun onCreateMediaRouteButton(): MediaRouteButton

Called when the media route button is being created.

Subclasses may override this method to customize the button.

onPerformDefaultAction

fun onPerformDefaultAction(): Boolean

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.

setAlwaysVisible

Added in 1.1.0
Deprecated in 1.6.0
fun setAlwaysVisible(alwaysVisible: Boolean): Unit

Does nothing. You should not call this method.

setDialogFactory

Added in 1.1.0
fun setDialogFactory(factory: MediaRouteDialogFactory): Unit

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 1.1.0
fun setRouteSelector(selector: MediaRouteSelector): Unit

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.