java.lang.Object | ||
↳ | android.app.Dialog | |
↳ | android.app.Presentation |
Base class for presentations.
A presentation is a special kind of dialog whose purpose is to present
content on a secondary display. A Presentation
is associated with
the target Display
at creation time and configures its context and
resource configuration according to the display's metrics.
Notably, the Context
of a presentation is different from the context
of its containing Activity
. It is important to inflate the layout
of a presentation and load other resources using the presentation's own context
to ensure that assets of the correct size and density for the target display
are loaded.
A presentation is automatically canceled (see cancel()
) when
the display to which it is attached is removed. An activity should take
care of pausing and resuming whatever content is playing within the presentation
whenever the activity itself is paused or resumed.
Before showing a Presentation
it's important to choose the Display
on which it will appear. Choosing a presentation display is sometimes difficult
because there may be multiple displays attached. Rather than trying to guess
which display is best, an application should let the system choose a suitable
presentation display.
There are two main ways to choose a Display
.
The easiest way to choose a presentation display is to use the
MediaRouter
API. The media router service keeps
track of which audio and video routes are available on the system.
The media router sends notifications whenever routes are selected or unselected
or when the preferred presentation display of a route changes.
So an application can simply watch for these notifications and show or dismiss
a presentation on the preferred presentation display automatically.
The preferred presentation display is the display that the media router recommends that the application should use if it wants to show content on the secondary display. Sometimes there may not be a preferred presentation display in which case the application should show its content locally without using a presentation.
Here's how to use the media router to create and show a presentation on the preferred
presentation display using getPresentationDisplay()
.
MediaRouter mediaRouter = (MediaRouter) context.getSystemService(Context.MEDIA_ROUTER_SERVICE); MediaRouter.RouteInfo route = mediaRouter.getSelectedRoute(); if (route != null) { Display presentationDisplay = route.getPresentationDisplay(); if (presentationDisplay != null) { Presentation presentation = new MyPresentation(context, presentationDisplay); presentation.show(); } }
The following sample code from ApiDemos
demonstrates how to use the media
router to automatically switch between showing content in the main activity and showing
the content in a presentation when a presentation display is available.
/** * <h3>Presentation Activity</h3> * * <p> * This demonstrates how to create an activity that shows some content * on a secondary display using a {@link Presentation}. * </p><p> * The activity uses the {@link MediaRouter} API to automatically detect when * a presentation display is available and to allow the user to control the * media routes using a menu item. When a presentation display is available, * we stop showing content in the main activity and instead open up a * {@link Presentation} on the preferred presentation display. When a presentation * display is removed, we revert to showing content in the main activity. * We also write information about displays and display-related events to * the Android log which you can read using <code>adb logcat</code>. * </p><p> * You can try this out using an HDMI or Wifi display or by using the * "Simulate secondary displays" feature in Development Settings to create a few * simulated secondary displays. Each display will appear in the list along with a * checkbox to show a presentation on that display. * </p><p> * See also the {@link PresentationActivity} sample which * uses the low-level display manager to enumerate displays and to show multiple * simultaneous presentations on different displays. * </p> */ public class PresentationWithMediaRouterActivity extends Activity { private final String TAG = "PresentationWithMediaRouterActivity"; private MediaRouter mMediaRouter; private DemoPresentation mPresentation; private GLSurfaceView mSurfaceView; private TextView mInfoTextView; private boolean mPaused; /** * Initialization of the Activity after it is first created. Must at least * call {@link android.app.Activity#setContentView setContentView()} to * describe what is to be displayed in the screen. */ @Override protected void onCreate(Bundle savedInstanceState) { // Be sure to call the super class. super.onCreate(savedInstanceState); // Get the media router service. mMediaRouter = (MediaRouter)getSystemService(Context.MEDIA_ROUTER_SERVICE); // See assets/res/any/layout/presentation_with_media_router_activity.xml for this // view layout definition, which is being set here as // the content of our screen. setContentView(R.layout.presentation_with_media_router_activity); // Set up the surface view for visual interest. mSurfaceView = (GLSurfaceView)findViewById(R.id.surface_view); mSurfaceView.setRenderer(new CubeRenderer(false)); // Get a text view where we will show information about what's happening. mInfoTextView = (TextView)findViewById(R.id.info); } @Override protected void onResume() { // Be sure to call the super class. super.onResume(); // Listen for changes to media routes. mMediaRouter.addCallback(MediaRouter.ROUTE_TYPE_LIVE_VIDEO, mMediaRouterCallback); // Update the presentation based on the currently selected route. mPaused = false; updatePresentation(); } @Override protected void onPause() { // Be sure to call the super class. super.onPause(); // Stop listening for changes to media routes. mMediaRouter.removeCallback(mMediaRouterCallback); // Pause rendering. mPaused = true; updateContents(); } @Override protected void onStop() { // Be sure to call the super class. super.onStop(); // Dismiss the presentation when the activity is not visible. if (mPresentation != null) { Log.i(TAG, "Dismissing presentation because the activity is no longer visible."); mPresentation.dismiss(); mPresentation = null; } } @Override public boolean onCreateOptionsMenu(Menu menu) { // Be sure to call the super class. super.onCreateOptionsMenu(menu); // Inflate the menu and configure the media router action provider. getMenuInflater().inflate(R.menu.presentation_with_media_router_menu, menu); MenuItem mediaRouteMenuItem = menu.findItem(R.id.menu_media_route); MediaRouteActionProvider mediaRouteActionProvider = (MediaRouteActionProvider)mediaRouteMenuItem.getActionProvider(); mediaRouteActionProvider.setRouteTypes(MediaRouter.ROUTE_TYPE_LIVE_VIDEO); // Return true to show the menu. return true; } private void updatePresentation() { // Get the current route and its presentation display. MediaRouter.RouteInfo route = mMediaRouter.getSelectedRoute( MediaRouter.ROUTE_TYPE_LIVE_VIDEO); Display presentationDisplay = route != null ? route.getPresentationDisplay() : null; // Dismiss the current presentation if the display has changed. if (mPresentation != null && mPresentation.getDisplay() != presentationDisplay) { Log.i(TAG, "Dismissing presentation because the current route no longer " + "has a presentation display."); mPresentation.dismiss(); mPresentation = null; } // Show a new presentation if needed. if (mPresentation == null && presentationDisplay != null) { Log.i(TAG, "Showing presentation on display: " + presentationDisplay); mPresentation = new DemoPresentation(this, presentationDisplay); mPresentation.setOnDismissListener(mOnDismissListener); try { mPresentation.show(); } catch (WindowManager.InvalidDisplayException ex) { Log.w(TAG, "Couldn't show presentation! Display was removed in " + "the meantime.", ex); mPresentation = null; } } // Update the contents playing in this activity. updateContents(); } private void updateContents() { // Show either the content in the main activity or the content in the presentation // along with some descriptive text about what is happening. if (mPresentation != null) { mInfoTextView.setText(getResources().getString( R.string.presentation_with_media_router_now_playing_remotely, mPresentation.getDisplay().getName())); mSurfaceView.setVisibility(View.INVISIBLE); mSurfaceView.onPause(); if (mPaused) { mPresentation.getSurfaceView().onPause(); } else { mPresentation.getSurfaceView().onResume(); } } else { mInfoTextView.setText(getResources().getString( R.string.presentation_with_media_router_now_playing_locally, getWindowManager().getDefaultDisplay().getName())); mSurfaceView.setVisibility(View.VISIBLE); if (mPaused) { mSurfaceView.onPause(); } else { mSurfaceView.onResume(); } } } private final MediaRouter.SimpleCallback mMediaRouterCallback = new MediaRouter.SimpleCallback() { @Override public void onRouteSelected(MediaRouter router, int type, RouteInfo info) { Log.d(TAG, "onRouteSelected: type=" + type + ", info=" + info); updatePresentation(); } @Override public void onRouteUnselected(MediaRouter router, int type, RouteInfo info) { Log.d(TAG, "onRouteUnselected: type=" + type + ", info=" + info); updatePresentation(); } @Override public void onRoutePresentationDisplayChanged(MediaRouter router, RouteInfo info) { Log.d(TAG, "onRoutePresentationDisplayChanged: info=" + info); updatePresentation(); } }; /** * Listens for when presentations are dismissed. */ private final DialogInterface.OnDismissListener mOnDismissListener = new DialogInterface.OnDismissListener() { @Override public void onDismiss(DialogInterface dialog) { if (dialog == mPresentation) { Log.i(TAG, "Presentation was dismissed."); mPresentation = null; updateContents(); } } }; /** * The presentation to show on the secondary display. * <p> * Note that this display may have different metrics from the display on which * the main activity is showing so we must be careful to use the presentation's * own {@link Context} whenever we load resources. * </p> */ private final static class DemoPresentation extends Presentation { private GLSurfaceView mSurfaceView; public DemoPresentation(Context context, Display display) { super(context, display); } @Override protected void onCreate(Bundle savedInstanceState) { // Be sure to call the super class. super.onCreate(savedInstanceState); // Get the resources for the context of the presentation. // Notice that we are getting the resources from the context of the presentation. Resources r = getContext().getResources(); // Inflate the layout. setContentView(R.layout.presentation_with_media_router_content); // Set up the surface view for visual interest. mSurfaceView = (GLSurfaceView)findViewById(R.id.surface_view); mSurfaceView.setRenderer(new CubeRenderer(false)); } public GLSurfaceView getSurfaceView() { return mSurfaceView; } } }
Another way to choose a presentation display is to use the DisplayManager
API
directly. The display manager service provides functions to enumerate and describe all
displays that are attached to the system including displays that may be used
for presentations.
The display manager keeps track of all displays in the system. However, not all displays are appropriate for showing presentations. For example, if an activity attempted to show a presentation on the main display it might obscure its own content (it's like opening a dialog on top of your activity).
Here's how to identify suitable displays for showing presentations using
getDisplays(String)
and the
DISPLAY_CATEGORY_PRESENTATION
category.
DisplayManager displayManager = (DisplayManager) context.getSystemService(Context.DISPLAY_SERVICE); Display[] presentationDisplays = displayManager.getDisplays(DisplayManager.DISPLAY_CATEGORY_PRESENTATION); if (presentationDisplays.length > 0) { // If there is more than one suitable presentation display, then we could consider // giving the user a choice. For this example, we simply choose the first display // which is the one the system recommends as the preferred presentation display. Display display = presentationDisplays[0]; Presentation presentation = new MyPresentation(context, presentationDisplay); presentation.show(); }
The following sample code from ApiDemos
demonstrates how to use the display
manager to enumerate displays and show content on multiple presentation displays
simultaneously.
/** * <h3>Presentation Activity</h3> * * <p> * This demonstrates how to create an activity that shows some content * on a secondary display using a {@link Presentation}. * </p><p> * The activity uses the {@link DisplayManager} API to enumerate displays. * When the user selects a display, the activity opens a {@link Presentation} * on that display. We show a different photograph in each presentation * on a unique background along with a label describing the display. * We also write information about displays and display-related events to * the Android log which you can read using <code>adb logcat</code>. * </p><p> * You can try this out using an HDMI or Wifi display or by using the * "Simulate secondary displays" feature in Development Settings to create a few * simulated secondary displays. Each display will appear in the list along with a * checkbox to show a presentation on that display. * </p><p> * See also the {@link PresentationWithMediaRouterActivity} sample which * uses the media router to automatically select a secondary display * on which to show content based on the currently selected route. * </p> */ public class PresentationActivity extends Activity implements OnCheckedChangeListener, OnClickListener { private final String TAG = "PresentationActivity"; // Key for storing saved instance state. private static final String PRESENTATION_KEY = "presentation"; // The content that we want to show on the presentation. private static final int[] PHOTOS = new int[] { R.drawable.frantic, R.drawable.photo1, R.drawable.photo2, R.drawable.photo3, R.drawable.photo4, R.drawable.photo5, R.drawable.photo6, R.drawable.sample_4, }; private DisplayManager mDisplayManager; private DisplayListAdapter mDisplayListAdapter; private CheckBox mShowAllDisplaysCheckbox; private ListView mListView; private int mNextImageNumber; // List of presentation contents indexed by displayId. // This state persists so that we can restore the old presentation // contents when the activity is paused or resumed. private SparseArray<PresentationContents> mSavedPresentationContents; // List of all currently visible presentations indexed by display id. private final SparseArray<DemoPresentation> mActivePresentations = new SparseArray<DemoPresentation>(); /** * Initialization of the Activity after it is first created. Must at least * call {@link android.app.Activity#setContentView setContentView()} to * describe what is to be displayed in the screen. */ @Override protected void onCreate(Bundle savedInstanceState) { // Be sure to call the super class. super.onCreate(savedInstanceState); // Restore saved instance state. if (savedInstanceState != null) { mSavedPresentationContents = savedInstanceState.getSparseParcelableArray(PRESENTATION_KEY); } else { mSavedPresentationContents = new SparseArray<PresentationContents>(); } // Get the display manager service. mDisplayManager = (DisplayManager)getSystemService(Context.DISPLAY_SERVICE); // See assets/res/any/layout/presentation_activity.xml for this // view layout definition, which is being set here as // the content of our screen. setContentView(R.layout.presentation_activity); // Set up checkbox to toggle between showing all displays or only presentation displays. mShowAllDisplaysCheckbox = (CheckBox)findViewById(R.id.show_all_displays); mShowAllDisplaysCheckbox.setOnCheckedChangeListener(this); // Set up the list of displays. mDisplayListAdapter = new DisplayListAdapter(this); mListView = (ListView)findViewById(R.id.display_list); mListView.setAdapter(mDisplayListAdapter); } @Override protected void onResume() { // Be sure to call the super class. super.onResume(); // Update our list of displays on resume. mDisplayListAdapter.updateContents(); // Restore presentations from before the activity was paused. final int numDisplays = mDisplayListAdapter.getCount(); for (int i = 0; i < numDisplays; i++) { final Display display = mDisplayListAdapter.getItem(i); final PresentationContents contents = mSavedPresentationContents.get(display.getDisplayId()); if (contents != null) { showPresentation(display, contents); } } mSavedPresentationContents.clear(); // Register to receive events from the display manager. mDisplayManager.registerDisplayListener(mDisplayListener, null); } @Override protected void onPause() { // Be sure to call the super class. super.onPause(); // Unregister from the display manager. mDisplayManager.unregisterDisplayListener(mDisplayListener); // Dismiss all of our presentations but remember their contents. Log.d(TAG, "Activity is being paused. Dismissing all active presentation."); for (int i = 0; i < mActivePresentations.size(); i++) { DemoPresentation presentation = mActivePresentations.valueAt(i); int displayId = mActivePresentations.keyAt(i); mSavedPresentationContents.put(displayId, presentation.mContents); presentation.dismiss(); } mActivePresentations.clear(); } @Override protected void onSaveInstanceState(Bundle outState) { // Be sure to call the super class. super.onSaveInstanceState(outState); outState.putSparseParcelableArray(PRESENTATION_KEY, mSavedPresentationContents); } /** * Shows a {@link Presentation} on the specified display. */ private void showPresentation(Display display, PresentationContents contents) { final int displayId = display.getDisplayId(); if (mActivePresentations.get(displayId) != null) { return; } Log.d(TAG, "Showing presentation photo #" + contents.photo + " on display #" + displayId + "."); DemoPresentation presentation = new DemoPresentation(this, display, contents); presentation.show(); presentation.setOnDismissListener(mOnDismissListener); mActivePresentations.put(displayId, presentation); } /** * Hides a {@link Presentation} on the specified display. */ private void hidePresentation(Display display) { final int displayId = display.getDisplayId(); DemoPresentation presentation = mActivePresentations.get(displayId); if (presentation == null) { return; } Log.d(TAG, "Dismissing presentation on display #" + displayId + "."); presentation.dismiss(); mActivePresentations.delete(displayId); } private int getNextPhoto() { final int photo = mNextImageNumber; mNextImageNumber = (mNextImageNumber + 1) % PHOTOS.length; return photo; } /** * Called when the show all displays checkbox is toggled or when * an item in the list of displays is checked or unchecked. */ @Override public void onCheckedChanged(CompoundButton buttonView, boolean isChecked) { if (buttonView == mShowAllDisplaysCheckbox) { // Show all displays checkbox was toggled. mDisplayListAdapter.updateContents(); } else { // Display item checkbox was toggled. final Display display = (Display)buttonView.getTag(); if (isChecked) { PresentationContents contents = new PresentationContents(getNextPhoto()); showPresentation(display, contents); } else { hidePresentation(display); } } } /** * Called when the Info button next to a display is clicked to show information * about the display. */ @Override public void onClick(View v) { Context context = v.getContext(); AlertDialog.Builder builder = new AlertDialog.Builder(context); final Display display = (Display)v.getTag(); Resources r = context.getResources(); AlertDialog alert = builder .setTitle(r.getString( R.string.presentation_alert_info_text, display.getDisplayId())) .setMessage(display.toString()) .setNeutralButton(R.string.presentation_alert_dismiss_text, new DialogInterface.OnClickListener() { @Override public void onClick(DialogInterface dialog, int which) { dialog.dismiss(); } }) .create(); alert.show(); } /** * Listens for displays to be added, changed or removed. * We use it to update the list and show a new {@link Presentation} when a * display is connected. * * Note that we don't bother dismissing the {@link Presentation} when a * display is removed, although we could. The presentation API takes care * of doing that automatically for us. */ private final DisplayManager.DisplayListener mDisplayListener = new DisplayManager.DisplayListener() { @Override public void onDisplayAdded(int displayId) { Log.d(TAG, "Display #" + displayId + " added."); mDisplayListAdapter.updateContents(); } @Override public void onDisplayChanged(int displayId) { Log.d(TAG, "Display #" + displayId + " changed."); mDisplayListAdapter.updateContents(); } @Override public void onDisplayRemoved(int displayId) { Log.d(TAG, "Display #" + displayId + " removed."); mDisplayListAdapter.updateContents(); } }; /** * Listens for when presentations are dismissed. */ private final DialogInterface.OnDismissListener mOnDismissListener = new DialogInterface.OnDismissListener() { @Override public void onDismiss(DialogInterface dialog) { DemoPresentation presentation = (DemoPresentation)dialog; int displayId = presentation.getDisplay().getDisplayId(); Log.d(TAG, "Presentation on display #" + displayId + " was dismissed."); mActivePresentations.delete(displayId); mDisplayListAdapter.notifyDataSetChanged(); } }; /** * List adapter. * Shows information about all displays. */ private final class DisplayListAdapter extends ArrayAdapter<Display> { final Context mContext; public DisplayListAdapter(Context context) { super(context, R.layout.presentation_list_item); mContext = context; } @Override public View getView(int position, View convertView, ViewGroup parent) { final View v; if (convertView == null) { v = ((Activity) mContext).getLayoutInflater().inflate( R.layout.presentation_list_item, null); } else { v = convertView; } final Display display = getItem(position); final int displayId = display.getDisplayId(); CheckBox cb = (CheckBox)v.findViewById(R.id.checkbox_presentation); cb.setTag(display); cb.setOnCheckedChangeListener(PresentationActivity.this); cb.setChecked(mActivePresentations.indexOfKey(displayId) >= 0 || mSavedPresentationContents.indexOfKey(displayId) >= 0); TextView tv = (TextView)v.findViewById(R.id.display_id); tv.setText(v.getContext().getResources().getString( R.string.presentation_display_id_text, displayId, display.getName())); Button b = (Button)v.findViewById(R.id.info); b.setTag(display); b.setOnClickListener(PresentationActivity.this); return v; } /** * Update the contents of the display list adapter to show * information about all current displays. */ public void updateContents() { clear(); String displayCategory = getDisplayCategory(); Display[] displays = mDisplayManager.getDisplays(displayCategory); addAll(displays); Log.d(TAG, "There are currently " + displays.length + " displays connected."); for (Display display : displays) { Log.d(TAG, " " + display); } } private String getDisplayCategory() { return mShowAllDisplaysCheckbox.isChecked() ? null : DisplayManager.DISPLAY_CATEGORY_PRESENTATION; } } /** * The presentation to show on the secondary display. * * Note that the presentation display may have different metrics from the display on which * the main activity is showing so we must be careful to use the presentation's * own {@link Context} whenever we load resources. */ private final class DemoPresentation extends Presentation { final PresentationContents mContents; public DemoPresentation(Context context, Display display, PresentationContents contents) { super(context, display); mContents = contents; } @Override protected void onCreate(Bundle savedInstanceState) { // Be sure to call the super class. super.onCreate(savedInstanceState); // Get the resources for the context of the presentation. // Notice that we are getting the resources from the context of the presentation. Resources r = getContext().getResources(); // Inflate the layout. setContentView(R.layout.presentation_content); final Display display = getDisplay(); final int displayId = display.getDisplayId(); final int photo = mContents.photo; // Show a caption to describe what's going on. TextView text = (TextView)findViewById(R.id.text); text.setText(r.getString(R.string.presentation_photo_text, photo, displayId, display.getName())); // Show a n image for visual interest. ImageView image = (ImageView)findViewById(R.id.image); image.setImageDrawable(r.getDrawable(PHOTOS[photo])); GradientDrawable drawable = new GradientDrawable(); drawable.setShape(GradientDrawable.RECTANGLE); drawable.setGradientType(GradientDrawable.RADIAL_GRADIENT); // Set the background to a random gradient. Point p = new Point(); getDisplay().getSize(p); drawable.setGradientRadius(Math.max(p.x, p.y) / 2); drawable.setColors(mContents.colors); findViewById(android.R.id.content).setBackground(drawable); } } /** * Information about the content we want to show in a presentation. */ private final static class PresentationContents implements Parcelable { final int photo; final int[] colors; public static final Creator<PresentationContents> CREATOR = new Creator<PresentationContents>() { @Override public PresentationContents createFromParcel(Parcel in) { return new PresentationContents(in); } @Override public PresentationContents[] newArray(int size) { return new PresentationContents[size]; } }; public PresentationContents(int photo) { this.photo = photo; colors = new int[] { ((int) (Math.random() * Integer.MAX_VALUE)) | 0xFF000000, ((int) (Math.random() * Integer.MAX_VALUE)) | 0xFF000000 }; } private PresentationContents(Parcel in) { photo = in.readInt(); colors = new int[] { in.readInt(), in.readInt() }; } @Override public int describeContents() { return 0; } @Override public void writeToParcel(Parcel dest, int flags) { dest.writeInt(photo); dest.writeInt(colors[0]); dest.writeInt(colors[1]); } } }
[Expand]
Inherited Constants | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
From interface
android.content.DialogInterface
|
Public Constructors | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Creates a new presentation that is attached to the specified display
using the default theme.
| |||||||||||
Creates a new presentation that is attached to the specified display
using the optionally specified theme.
|
Public Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Gets the
Display that this presentation appears on. | |||||||||||
Gets the
Resources that should be used to inflate the layout of this presentation. | |||||||||||
Called by the system when the properties of the
Display to which
the presentation is attached have changed. | |||||||||||
Called by the system when the
Display to which the presentation
is attached has been removed. | |||||||||||
Inherited from
show() . |
Protected Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Called when the dialog is starting.
| |||||||||||
Called to tell you that you're stopping.
|
[Expand]
Inherited Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
From class
android.app.Dialog
| |||||||||||
From class
java.lang.Object
| |||||||||||
From interface
android.content.DialogInterface
| |||||||||||
From interface
android.view.KeyEvent.Callback
| |||||||||||
From interface
android.view.View.OnCreateContextMenuListener
| |||||||||||
From interface
android.view.Window.Callback
|
Creates a new presentation that is attached to the specified display using the default theme.
outerContext | The context of the application that is showing the presentation.
The presentation will create its own context (see getContext() ) based
on this context and information about the associated display. |
---|---|
display | The display to which the presentation should be attached. |
Creates a new presentation that is attached to the specified display using the optionally specified theme.
outerContext | The context of the application that is showing the presentation.
The presentation will create its own context (see getContext() ) based
on this context and information about the associated display. |
---|---|
display | The display to which the presentation should be attached. |
theme | A style resource describing the theme to use for the window. See Style and Theme Resources for more information about defining and using styles. This theme is applied on top of the current theme in outerContext. If 0, the default presentation theme will be used. |
Gets the Display
that this presentation appears on.
Gets the Resources
that should be used to inflate the layout of this presentation.
This resources object has been configured according to the metrics of the
display that the presentation appears on.
Inherited from show()
. Will throw
WindowManager.InvalidDisplayException
if the specified secondary
Display
can't be found.