MediaRouteControllerDialog

Artifact: androidx.mediarouter:mediarouter

Added in 1.1.0

Kotlin |Java

class MediaRouteControllerDialog : AlertDialog

kotlin.Any
↳	android.app.Dialog
	↳	androidx.activity.ComponentDialog
		↳	androidx.appcompat.app.AppCompatDialog
			↳	androidx.appcompat.app.AlertDialog
				↳	androidx.mediarouter.app.MediaRouteControllerDialog

This class implements the route controller dialog for MediaRouter.

This dialog allows the user to control or disconnect from the currently selected route.

See also
`MediaRouteButton`
`MediaRouteActionProvider`

Summary

Public constructors
`MediaRouteControllerDialog(context: Context)`
`MediaRouteControllerDialog(context: Context, theme: Int)`

Public functions
`View?`	`getMediaControlView()` Gets the media control view that was created by `onCreateMediaControlView`.
`MediaSessionCompat.Token?`	`getMediaSession()` Gets the session to use for metadata and transport controls.
`MediaRouter.RouteInfo`	`getRoute()` Gets the route that this dialog is controlling.
`Boolean`	`isVolumeControlEnabled()` Returns whether to enable the volume slider and volume control using the volume keys when the route supports it.
`Unit`	`onAttachedToWindow()`
`View?`	`onCreateMediaControlView(savedInstanceState: Bundle?)` Provides the subclass an opportunity to create a view that will replace the default media controls for the currently playing content.
`Unit`	`onDetachedFromWindow()`
`Boolean`	`onKeyDown(keyCode: Int, event: KeyEvent)`
`Boolean`	`onKeyUp(keyCode: Int, event: KeyEvent)`
`Unit`	`setVolumeControlEnabled(enable: Boolean)` Sets whether to enable the volume slider and volume control using the volume keys when the route supports it.

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.AlertDialog

`Button!`	`getButton(whichButton: Int)` Gets one of the buttons used in the dialog.
`ListView!`	`getListView()` Gets the list view used in the dialog.
`Unit`	`setButton( whichButton: Int, text: CharSequence!, listener: DialogInterface.OnClickListener! )` Sets a listener to be invoked when the positive button of the dialog is pressed.
`Unit`	`setButton(whichButton: Int, text: CharSequence!, msg: Message!)` Sets a message to be sent when a button is pressed.
`Unit`	`setButton( whichButton: Int, text: CharSequence!, icon: Drawable!, listener: DialogInterface.OnClickListener! )` Sets an icon to be displayed along with the button text and a listener to be invoked when the positive button of the dialog is pressed.
`Unit`	`setCustomTitle(customTitleView: View!)` This method has no effect if called after `show`.
`Unit`	`setIcon(icon: Drawable!)` Set the `Drawable` to be used in the title.
`Unit`	`setIcon(resId: Int)` Set resId to 0 if you don't want an icon.
`Unit`	`setIconAttribute(attrId: Int)` Sets an icon as supplied by a theme attribute. e.g. android.R.attr.alertDialogIcon
`Unit`	`setMessage(message: CharSequence!)` Sets the message to display.
`Unit`	`setTitle(title: CharSequence!)`
`Unit`	`setView(view: View!)` Set the view to display in the dialog.
`Unit`	`setView( view: View!, viewSpacingLeft: Int, viewSpacingTop: Int, viewSpacingRight: Int, viewSpacingBottom: Int )` Set the view to display in the dialog, specifying the spacing to appear around that view.

From androidx.appcompat.app.AppCompatDialog

`Unit`	`addContentView(view: View, params: ViewGroup.LayoutParams!)`
`Unit`	`dismiss()`
`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!)`
`Unit`	`setTitle(titleId: Int)`
`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`	`closeOptionsMenu()`
`Unit`	`create()`
`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 android.content.DialogInterface

`abstract Unit`	`cancel()`
`abstract Unit`	`dismiss()`

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

MediaRouteControllerDialog

Added in 1.1.0

MediaRouteControllerDialog(context: Context)

MediaRouteControllerDialog

Added in 1.1.0

MediaRouteControllerDialog(context: Context, theme: Int)

Public functions

getMediaControlView

Added in 1.1.0

fun getMediaControlView(): View?

Gets the media control view that was created by onCreateMediaControlView.

Returns
`View?`	The media control view, or null if none.

getMediaSession

Added in 1.1.0

fun getMediaSession(): MediaSessionCompat.Token?

Gets the session to use for metadata and transport controls.

Returns
`MediaSessionCompat.Token?`	The token for the session to use or null if none.

getRoute

Added in 1.1.0

fun getRoute(): MediaRouter.RouteInfo

Gets the route that this dialog is controlling.

isVolumeControlEnabled

Added in 1.1.0

fun isVolumeControlEnabled(): Boolean

Returns whether to enable the volume slider and volume control using the volume keys when the route supports it.

onAttachedToWindow

fun onAttachedToWindow(): Unit

onCreateMediaControlView

Added in 1.1.0

fun onCreateMediaControlView(savedInstanceState: Bundle?): View?

Provides the subclass an opportunity to create a view that will replace the default media controls for the currently playing content.

Parameters
`savedInstanceState: Bundle?`	The dialog's saved instance state.

Returns
`View?`	The media control view, or null if none.

onDetachedFromWindow

fun onDetachedFromWindow(): Unit

onKeyDown

fun onKeyDown(keyCode: Int, event: KeyEvent): Boolean

onKeyUp

fun onKeyUp(keyCode: Int, event: KeyEvent): Boolean

setVolumeControlEnabled

Added in 1.1.0

fun setVolumeControlEnabled(enable: Boolean): Unit

Sets whether to enable the volume slider and volume control using the volume keys when the route supports it.

The default value is true.

Protected functions

onCreate

protected fun onCreate(savedInstanceState: Bundle?): Unit