Android APIs
public class

MediaRouteControllerDialog

extends Dialog
java.lang.Object
   ↳ android.app.Dialog
     ↳ android.support.v7.app.MediaRouteControllerDialog

Class Overview

This class implements the route controller dialog for MediaRouter.

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

Summary

[Expand]
Inherited Constants
From interface android.content.DialogInterface
Public Constructors
MediaRouteControllerDialog(Context context)
MediaRouteControllerDialog(Context context, int theme)
Public Methods
View getMediaControlView()
Gets the media control view that was created by onCreateMediaControlView(Bundle).
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.
void onAttachedToWindow()
Called when the window has been attached to the window manager.
View onCreateMediaControlView(Bundle savedInstanceState)
Provides the subclass an opportunity to create a view that will be included within the body of the dialog to offer additional media controls for the currently playing content.
void onDetachedFromWindow()
Called when the window has been attached to the window manager.
boolean onKeyDown(int keyCode, KeyEvent event)
A key was pressed down.
boolean onKeyUp(int keyCode, KeyEvent event)
A key was released.
void setVolumeControlEnabled(boolean enable)
Sets whether to enable the volume slider and volume control using the volume keys when the route supports it.
Protected Methods
void onCreate(Bundle savedInstanceState)
Similar to onCreate(Bundle), you should initialize your dialog in this method, including calling setContentView(View).
[Expand]
Inherited Methods
From class android.app.Dialog
From class java.lang.Object
From interface android.content.DialogInterface
From interface android.view.Window.Callback
From interface android.view.KeyEvent.Callback
From interface android.view.View.OnCreateContextMenuListener

Public Constructors

public MediaRouteControllerDialog (Context context)

public MediaRouteControllerDialog (Context context, int theme)

Public Methods

public View getMediaControlView ()

Gets the media control view that was created by onCreateMediaControlView(Bundle).

Returns
  • The media control view, or null if none.

public MediaRouter.RouteInfo getRoute ()

Gets the route that this dialog is controlling.

public boolean isVolumeControlEnabled ()

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

public void onAttachedToWindow ()

Called when the window has been attached to the window manager. See View.onAttachedToWindow() for more information.

public View onCreateMediaControlView (Bundle savedInstanceState)

Provides the subclass an opportunity to create a view that will be included within the body of the dialog to offer additional media controls for the currently playing content.

Parameters
savedInstanceState The dialog's saved instance state.
Returns
  • The media control view, or null if none.

public void onDetachedFromWindow ()

Called when the window has been attached to the window manager. See View.onDetachedFromWindow() for more information.

public boolean onKeyDown (int keyCode, KeyEvent event)

A key was pressed down.

If the focused view didn't want this event, this method is called.

The default implementation consumed the KEYCODE_BACK to later handle it in onKeyUp(int, KeyEvent).

Parameters
keyCode The value in event.getKeyCode().
event Description of the key event.
Returns
  • If you handled the event, return true. If you want to allow the event to be handled by the next receiver, return false.

public boolean onKeyUp (int keyCode, KeyEvent event)

A key was released.

The default implementation handles KEYCODE_BACK to close the dialog.

Parameters
keyCode The value in event.getKeyCode().
event Description of the key event.
Returns
  • If you handled the event, return true. If you want to allow the event to be handled by the next receiver, return false.

public void setVolumeControlEnabled (boolean enable)

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 Methods

protected void onCreate (Bundle savedInstanceState)

Similar to onCreate(Bundle), you should initialize your dialog in this method, including calling setContentView(View).

Parameters
savedInstanceState If this dialog is being reinitalized after a the hosting activity was previously shut down, holds the result from the most recent call to onSaveInstanceState(), or null if this is the first time.