MediaRouteChooserDialog

Artifact: androidx.mediarouter:mediarouter

Added in 1.1.0

Kotlin |Java

class MediaRouteChooserDialog : AppCompatDialog

kotlin.Any
↳	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(context: Context)`
`MediaRouteChooserDialog(context: Context, theme: Int)`

Public functions
`Unit`	`dismiss()`
`MediaRouteSelector`	`getRouteSelector()` Gets the media route selector for filtering the routes that the user can select.
`Unit`	`onAttachedToWindow()`
`Unit`	`onDetachedFromWindow()`
`Boolean`	`onFilterRoute(route: MediaRouter.RouteInfo)` Returns true if the route should be included in the list.
`Unit`	`onFilterRoutes(routes: (Mutable)List<MediaRouter.RouteInfo!>)` Called to filter the set of routes that should be included in the list.
`Unit`	`refreshRoutes()` Refreshes the list of routes that are shown in the chooser dialog.
`Unit`	`setRouteSelector(selector: MediaRouteSelector)` Sets the media route selector for filtering the routes that the user can select.
`Unit`	`setTitle(title: CharSequence?)`
`Unit`	`setTitle(titleId: Int)`

Protected functions
`Unit`	`onCreate(savedInstanceState: Bundle?)`

Inherited Constants

From android.content.DialogInterface

`const Int`	`BUTTON1 = -1` This property is deprecated.
`const Int`	`BUTTON2 = -2` This property is deprecated.
`const Int`	`BUTTON3 = -3` This property is deprecated.
`const Int`	`BUTTON_NEGATIVE = -2`
`const Int`	`BUTTON_NEUTRAL = -3`
`const Int`	`BUTTON_POSITIVE = -1`

Inherited functions

From androidx.appcompat.app.AppCompatDialog

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

From androidx.activity.ComponentDialog

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

From android.app.Dialog

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

From androidx.lifecycle.LifecycleOwner

abstract Lifecycle!

getLifecycle()

From androidx.navigationevent.NavigationEventDispatcherOwner

abstract NavigationEventDispatcher!

getNavigationEventDispatcher()

From androidx.savedstate.SavedStateRegistryOwner

abstract SavedStateRegistry!

getSavedStateRegistry()

From android.view.Window.Callback

`Unit`	`onPointerCaptureChanged(hasCapture: Boolean)`
`Unit`	`onProvideKeyboardShortcuts( data: (Mutable)List<KeyboardShortcutGroup!>!, menu: Menu!, deviceId: Int )`

Public constructors

MediaRouteChooserDialog

Added in 1.1.0

MediaRouteChooserDialog(context: Context)

MediaRouteChooserDialog

Added in 1.1.0

MediaRouteChooserDialog(context: Context, theme: Int)

Public functions

dismiss

fun dismiss(): Unit

getRouteSelector

Added in 1.1.0

fun getRouteSelector(): MediaRouteSelector

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

Returns
`MediaRouteSelector`	The selector, never null.

onAttachedToWindow

fun onAttachedToWindow(): Unit

onDetachedFromWindow

fun onDetachedFromWindow(): Unit

onFilterRoute

Added in 1.1.0

fun onFilterRoute(route: MediaRouter.RouteInfo): Boolean

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
`route: MediaRouter.RouteInfo`	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

fun onFilterRoutes(routes: (Mutable)List<MediaRouter.RouteInfo!>): Unit

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
`routes: (Mutable)List<MediaRouter.RouteInfo!>`	The list of routes to filter in-place, never null.

refreshRoutes

Added in 1.1.0

fun refreshRoutes(): Unit

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

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.

Parameters
`selector: MediaRouteSelector`	The selector, must not be null.

setTitle

fun setTitle(title: CharSequence?): Unit

setTitle

fun setTitle(titleId: Int): Unit

Protected functions

onCreate

protected fun onCreate(savedInstanceState: Bundle?): Unit