MediaRouteChooserDialog

Artifact: androidx.mediarouter:mediarouter

Added in 1.1.0

Kotlin |Java

public class MediaRouteChooserDialog extends AppCompatDialog

java.lang.Object
↳	android.app.Dialog
	↳	androidx.activity.ComponentDialog
		↳	androidx.appcompat.app.AppCompatDialog
			↳	androidx.mediarouter.app.MediaRouteChooserDialog

This class implements the route chooser dialog for MediaRouter.

This dialog allows the user to choose a route that matches a given selector.

See also
`MediaRouteButton`
`MediaRouteActionProvider`

Summary

Public constructors
`MediaRouteChooserDialog(@NonNull Context context)`
`MediaRouteChooserDialog(@NonNull Context context, int theme)`

Public methods
`void`	`dismiss()`
`@NonNull MediaRouteSelector`	`getRouteSelector()` Gets the media route selector for filtering the routes that the user can select.
`void`	`onAttachedToWindow()`
`void`	`onDetachedFromWindow()`
`boolean`	`onFilterRoute(@NonNull MediaRouter.RouteInfo route)` Returns true if the route should be included in the list.
`void`	`onFilterRoutes(@NonNull List<MediaRouter.RouteInfo> routes)` Called to filter the set of routes that should be included in the list.
`void`	`refreshRoutes()` Refreshes the list of routes that are shown in the chooser dialog.
`void`	`setRouteSelector(@NonNull MediaRouteSelector selector)` Sets the media route selector for filtering the routes that the user can select.
`void`	`setTitle(@Nullable CharSequence title)`
`void`	`setTitle(int titleId)`

Protected methods
`void`	`onCreate(@Nullable Bundle savedInstanceState)`

Inherited Constants

From android.content.DialogInterface

`static final int`	`BUTTON1 = -1` This field is deprecated.
`static final int`	`BUTTON2 = -2` This field is deprecated.
`static final int`	`BUTTON3 = -3` This field is deprecated.
`static final int`	`BUTTON_NEGATIVE = -2`
`static final int`	`BUTTON_NEUTRAL = -3`
`static final int`	`BUTTON_POSITIVE = -1`

Inherited methods

From androidx.appcompat.app.AppCompatDialog

`void`	`addContentView(@NonNull View view, ViewGroup.LayoutParams params)`
`boolean`	`dispatchKeyEvent(KeyEvent event)`
`@Nullable T`	`<T extends View> findViewById(@IdRes int id)`
`@NonNull AppCompatDelegate`	`getDelegate()`
`ActionBar`	`getSupportActionBar()` Support library version of `getActionBar`.
`void`	`onStop()`
`void`	`onSupportActionModeFinished(ActionMode mode)` Called when a support action mode has finished.
`void`	`onSupportActionModeStarted(ActionMode mode)` Called when a support action mode has been started.
`@Nullable ActionMode`	`onWindowStartingSupportActionMode(ActionMode.Callback callback)` Called when a support action mode is being started for this window.
`void`	`setContentView(@LayoutRes int layoutResID)`
`void`	`setContentView(@NonNull View view)`
`void`	`setContentView(@NonNull View view, ViewGroup.LayoutParams params)`
`boolean`	`supportRequestWindowFeature(int featureId)` Enable extended support library window features.

From androidx.activity.ComponentDialog

`void`	`addContentView(View view, ViewGroup.LayoutParams params)`
`Lifecycle`	`getLifecycle()` Returns the Lifecycle of the provider.
`NavigationEventDispatcher`	`getNavigationEventDispatcher()` Lazily provides a `NavigationEventDispatcher` for back navigation handling, including support for predictive back gestures introduced in Android 13 (API 33+).
`final OnBackPressedDispatcher`	`getOnBackPressedDispatcher()` Retrieve the `OnBackPressedDispatcher` that will be triggered when `onBackPressed` is called.
`SavedStateRegistry`	`getSavedStateRegistry()` The `SavedStateRegistry` owned by this SavedStateRegistryOwner
`void`	`initializeViewTreeOwners()` Sets the view tree owners before setting the content view so that the inflation process and attach listeners will see them already present.
`void`	`onBackPressed()` This method is deprecated.
`void`	`onCreate(Bundle savedInstanceState)`
`Bundle`	`onSaveInstanceState()`
`void`	`onStart()`
`void`	`onStop()`
`void`	`setContentView(int layoutResID)`

From android.app.Dialog

`void`	`addContentView(View view, ViewGroup.LayoutParams params)`
`void`	`cancel()`
`void`	`closeOptionsMenu()`
`void`	`create()`
`void`	`dismiss()`
`boolean`	`dispatchGenericMotionEvent(MotionEvent ev)`
`boolean`	`dispatchKeyEvent(KeyEvent event)`
`boolean`	`dispatchKeyShortcutEvent(KeyEvent event)`
`boolean`	`dispatchPopulateAccessibilityEvent(AccessibilityEvent event)`
`boolean`	`dispatchTouchEvent(MotionEvent ev)`
`boolean`	`dispatchTrackballEvent(MotionEvent ev)`
`T`	`<T extends View> findViewById(int id)`
`ActionBar`	`getActionBar()`
`final Context`	`getContext()`
`View`	`getCurrentFocus()`
`LayoutInflater`	`getLayoutInflater()`
`OnBackInvokedDispatcher`	`getOnBackInvokedDispatcher()`
`final Activity`	`getOwnerActivity()`
`final SearchEvent`	`getSearchEvent()`
`final int`	`getVolumeControlStream()`
`Window`	`getWindow()`
`void`	`hide()`
`void`	`invalidateOptionsMenu()`
`boolean`	`isShowing()`
`void`	`onActionModeFinished(ActionMode mode)`
`void`	`onActionModeStarted(ActionMode mode)`
`void`	`onBackPressed()` This method is deprecated.
`void`	`onContentChanged()`
`boolean`	`onContextItemSelected(MenuItem item)`
`void`	`onContextMenuClosed(Menu menu)`
`void`	`onCreate(Bundle savedInstanceState)`
`void`	`onCreateContextMenu( ContextMenu menu, View v, ContextMenu.ContextMenuInfo menuInfo )`
`boolean`	`onCreateOptionsMenu(Menu menu)`
`boolean`	`onCreatePanelMenu(int featureId, Menu menu)`
`View`	`onCreatePanelView(int featureId)`
`boolean`	`onGenericMotionEvent(MotionEvent event)`
`boolean`	`onKeyDown(int keyCode, KeyEvent event)`
`boolean`	`onKeyLongPress(int keyCode, KeyEvent event)`
`boolean`	`onKeyMultiple(int keyCode, int repeatCount, KeyEvent event)`
`boolean`	`onKeyShortcut(int keyCode, KeyEvent event)`
`boolean`	`onKeyUp(int keyCode, KeyEvent event)`
`boolean`	`onMenuItemSelected(int featureId, MenuItem item)`
`boolean`	`onMenuOpened(int featureId, Menu menu)`
`boolean`	`onOptionsItemSelected(MenuItem item)`
`void`	`onOptionsMenuClosed(Menu menu)`
`void`	`onPanelClosed(int featureId, Menu menu)`
`boolean`	`onPrepareOptionsMenu(Menu menu)`
`boolean`	`onPreparePanel(int featureId, View view, Menu menu)`
`void`	`onRestoreInstanceState(Bundle savedInstanceState)`
`Bundle`	`onSaveInstanceState()`
`boolean`	`onSearchRequested()`
`void`	`onStart()`
`void`	`onStop()`
`boolean`	`onTouchEvent(MotionEvent event)`
`boolean`	`onTrackballEvent(MotionEvent event)`
`void`	`onWindowAttributesChanged(WindowManager.LayoutParams params)`
`void`	`onWindowFocusChanged(boolean hasFocus)`
`ActionMode`	`onWindowStartingActionMode(ActionMode.Callback callback)`
`void`	`openContextMenu(View view)`
`void`	`openOptionsMenu()`
`void`	`registerForContextMenu(View view)`
`final boolean`	`requestWindowFeature(int featureId)`
`final T`	`<T extends View> requireViewById(int id)`
`void`	`setCancelMessage(Message msg)`
`void`	`setCancelable(boolean flag)`
`void`	`setCanceledOnTouchOutside(boolean cancel)`
`void`	`setContentView(View view)`
`void`	`setDismissMessage(Message msg)`
`final void`	`setFeatureDrawable(int featureId, Drawable drawable)`
`final void`	`setFeatureDrawableAlpha(int featureId, int alpha)`
`final void`	`setFeatureDrawableResource(int featureId, int resId)`
`final void`	`setFeatureDrawableUri(int featureId, Uri uri)`
`void`	`setOnCancelListener(DialogInterface.OnCancelListener listener)`
`void`	`setOnDismissListener(DialogInterface.OnDismissListener listener)`
`void`	`setOnKeyListener(DialogInterface.OnKeyListener onKeyListener)`
`void`	`setOnShowListener(DialogInterface.OnShowListener listener)`
`final void`	`setOwnerActivity(Activity activity)`
`void`	`setTitle(int titleId)`
`final void`	`setVolumeControlStream(int streamType)`
`void`	`show()`
`void`	`takeKeyEvents(boolean get)`
`void`	`unregisterForContextMenu(View view)`

From androidx.lifecycle.LifecycleOwner

abstract Lifecycle

getLifecycle()

Returns the Lifecycle of the provider.

From androidx.navigationevent.NavigationEventDispatcherOwner

abstract NavigationEventDispatcher

getNavigationEventDispatcher()

The NavigationEventDispatcher that should handle the navigation events.

From androidx.activity.OnBackPressedDispatcherOwner

abstract OnBackPressedDispatcher

getOnBackPressedDispatcher()

The OnBackPressedDispatcher that should handle the system back button.

From androidx.savedstate.SavedStateRegistryOwner

abstract SavedStateRegistry

getSavedStateRegistry()

The SavedStateRegistry owned by this SavedStateRegistryOwner

From android.view.Window.Callback

`void`	`onPointerCaptureChanged(boolean hasCapture)`
`void`	`onProvideKeyboardShortcuts( List<KeyboardShortcutGroup> data, Menu menu, int deviceId )`

Public constructors

MediaRouteChooserDialog

Added in 1.1.0

public MediaRouteChooserDialog(@NonNull Context context)

MediaRouteChooserDialog

Added in 1.1.0

public MediaRouteChooserDialog(@NonNull Context context, int theme)

Public methods

dismiss

public void dismiss()

getRouteSelector

Added in 1.1.0

public @NonNull MediaRouteSelector getRouteSelector()

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

Returns
`@NonNull MediaRouteSelector`	The selector, never null.

onAttachedToWindow

public void onAttachedToWindow()

onDetachedFromWindow

public void onDetachedFromWindow()

onFilterRoute

Added in 1.1.0

public boolean onFilterRoute(@NonNull MediaRouter.RouteInfo route)

Returns true if the route should be included in the list.

The default implementation returns true for enabled non-default routes that match the selector. Subclasses can override this method to filter routes differently.

Parameters
`@NonNull MediaRouter.RouteInfo route`	The route to consider, never null.

Returns
`boolean`	True if the route should be included in the chooser dialog.

onFilterRoutes

Added in 1.1.0

public void onFilterRoutes(@NonNull List<MediaRouter.RouteInfo> routes)

Called to filter the set of routes that should be included in the list.

The default implementation iterates over all routes in the provided list and removes those for which onFilterRoute returns false.

Parameters
`@NonNull List<MediaRouter.RouteInfo> routes`	The list of routes to filter in-place, never null.

refreshRoutes

Added in 1.1.0

public void refreshRoutes()

Refreshes the list of routes that are shown in the chooser dialog.

setRouteSelector

Added in 1.1.0

public void setRouteSelector(@NonNull MediaRouteSelector selector)

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

Parameters
`@NonNull MediaRouteSelector selector`	The selector, must not be null.

setTitle

public void setTitle(@Nullable CharSequence title)

setTitle

public void setTitle(int titleId)

Protected methods

onCreate

protected void onCreate(@Nullable Bundle savedInstanceState)