/*
* Copyright (C) 2013 The Android Open Source Project
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package android.support.v7.media;
import android.app.ActivityManager;
import android.content.ComponentName;
import android.content.ContentResolver;
import android.content.Context;
import android.content.Intent;
import android.content.IntentFilter;
import android.content.IntentSender;
import android.content.pm.PackageManager.NameNotFoundException;
import android.content.res.Resources;
import android.net.Uri;
import android.os.Bundle;
import android.os.Handler;
import android.os.Looper;
import android.os.Message;
import android.support.annotation.IntDef;
import android.support.annotation.NonNull;
import android.support.annotation.Nullable;
import android.support.v4.app.ActivityManagerCompat;
import android.support.v4.hardware.display.DisplayManagerCompat;
import android.support.v4.media.VolumeProviderCompat;
import android.support.v4.media.session.MediaSessionCompat;
import android.support.v4.util.Pair;
import android.support.v7.media.MediaRouteProvider.ProviderMetadata;
import android.support.v7.media.MediaRouteProvider.RouteController;
import android.text.TextUtils;
import android.util.Log;
import android.view.Display;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.ref.WeakReference;
import java.util.ArrayList;
import java.util.Collections;
import java.util.HashMap;
import java.util.HashSet;
import java.util.Iterator;
import java.util.List;
import java.util.Locale;
import java.util.Map;
import java.util.Set;
/**
* MediaRouter allows applications to control the routing of media channels
* and streams from the current device to external speakers and destination devices.
*
* A MediaRouter instance is retrieved through {@link #getInstance}. Applications
* can query the media router about the currently selected route and its capabilities
* to determine how to send content to the route's destination. Applications can
* also {@link RouteInfo#sendControlRequest send control requests} to the route
* to ask the route's destination to perform certain remote control functions
* such as playing media.
*
* See also {@link MediaRouteProvider} for information on how an application
* can publish new media routes to the media router.
*
* The media router API is not thread-safe; all interactions with it must be
* done from the main thread of the process.
*
*/
public final class MediaRouter {
private static final String TAG = "MediaRouter";
private static final boolean DEBUG = Log.isLoggable(TAG, Log.DEBUG);
/**
* Passed to {@link android.support.v7.media.MediaRouteProvider.RouteController#onUnselect(int)}
* and {@link Callback#onRouteUnselected(MediaRouter, RouteInfo, int)} when the reason the route
* was unselected is unknown.
*/
public static final int UNSELECT_REASON_UNKNOWN = 0;
/**
* Passed to {@link android.support.v7.media.MediaRouteProvider.RouteController#onUnselect(int)}
* and {@link Callback#onRouteUnselected(MediaRouter, RouteInfo, int)} when the user pressed
* the disconnect button to disconnect and keep playing.
*
*
* @see {@link MediaRouteDescriptor#canDisconnectAndKeepPlaying()}.
*/
public static final int UNSELECT_REASON_DISCONNECTED = 1;
/**
* Passed to {@link android.support.v7.media.MediaRouteProvider.RouteController#onUnselect(int)}
* and {@link Callback#onRouteUnselected(MediaRouter, RouteInfo, int)} when the user pressed
* the stop casting button.
*/
public static final int UNSELECT_REASON_STOPPED = 2;
/**
* Passed to {@link android.support.v7.media.MediaRouteProvider.RouteController#onUnselect(int)}
* and {@link Callback#onRouteUnselected(MediaRouter, RouteInfo, int)} when the user selected
* a different route.
*/
public static final int UNSELECT_REASON_ROUTE_CHANGED = 3;
// Maintains global media router state for the process.
// This field is initialized in MediaRouter.getInstance() before any
// MediaRouter objects are instantiated so it is guaranteed to be
// valid whenever any instance method is invoked.
static GlobalMediaRouter sGlobal;
// Context-bound state of the media router.
final Context mContext;
final ArrayList mCallbackRecords = new ArrayList();
/** @hide */
@IntDef(flag = true,
value = {
CALLBACK_FLAG_PERFORM_ACTIVE_SCAN,
CALLBACK_FLAG_REQUEST_DISCOVERY,
CALLBACK_FLAG_UNFILTERED_EVENTS
}
)
@Retention(RetentionPolicy.SOURCE)
private @interface CallbackFlags {}
/**
* Flag for {@link #addCallback}: Actively scan for routes while this callback
* is registered.
*
* When this flag is specified, the media router will actively scan for new
* routes. Certain routes, such as wifi display routes, may not be discoverable
* except when actively scanning. This flag is typically used when the route picker
* dialog has been opened by the user to ensure that the route information is
* up to date.
*
* Active scanning may consume a significant amount of power and may have intrusive
* effects on wireless connectivity. Therefore it is important that active scanning
* only be requested when it is actually needed to satisfy a user request to
* discover and select a new route.
*
* This flag implies {@link #CALLBACK_FLAG_REQUEST_DISCOVERY} but performing
* active scans is much more expensive than a normal discovery request.
*
*
* @see #CALLBACK_FLAG_REQUEST_DISCOVERY
*/
public static final int CALLBACK_FLAG_PERFORM_ACTIVE_SCAN = 1 << 0;
/**
* Flag for {@link #addCallback}: Do not filter route events.
*
* When this flag is specified, the callback will be invoked for events that affect any
* route even if they do not match the callback's filter.
*
*/
public static final int CALLBACK_FLAG_UNFILTERED_EVENTS = 1 << 1;
/**
* Flag for {@link #addCallback}: Request passive route discovery while this
* callback is registered, except on {@link ActivityManager#isLowRamDevice low-RAM devices}.
*
* When this flag is specified, the media router will try to discover routes.
* Although route discovery is intended to be efficient, checking for new routes may
* result in some network activity and could slowly drain the battery. Therefore
* applications should only specify {@link #CALLBACK_FLAG_REQUEST_DISCOVERY} when
* they are running in the foreground and would like to provide the user with the
* option of connecting to new routes.
*
* Applications should typically add a callback using this flag in the
* {@link android.app.Activity activity's} {@link android.app.Activity#onStart onStart}
* method and remove it in the {@link android.app.Activity#onStop onStop} method.
* The {@link android.support.v7.app.MediaRouteDiscoveryFragment} fragment may
* also be used for this purpose.
*
* On {@link ActivityManager#isLowRamDevice low-RAM devices} this flag
* will be ignored. Refer to
* {@link #addCallback(MediaRouteSelector, Callback, int) addCallback} for details.
*
*
* @see android.support.v7.app.MediaRouteDiscoveryFragment
*/
public static final int CALLBACK_FLAG_REQUEST_DISCOVERY = 1 << 2;
/**
* Flag for {@link #addCallback}: Request passive route discovery while this
* callback is registered, even on {@link ActivityManager#isLowRamDevice low-RAM devices}.
*
* This flag has a significant performance impact on low-RAM devices
* since it may cause many media route providers to be started simultaneously.
* It is much better to use {@link #CALLBACK_FLAG_REQUEST_DISCOVERY} instead to avoid
* performing passive discovery on these devices altogether. Refer to
* {@link #addCallback(MediaRouteSelector, Callback, int) addCallback} for details.
*
*
* @see android.support.v7.app.MediaRouteDiscoveryFragment
*/
public static final int CALLBACK_FLAG_FORCE_DISCOVERY = 1 << 3;
/**
* Flag for {@link #isRouteAvailable}: Ignore the default route.
*
* This flag is used to determine whether a matching non-default route is available.
* This constraint may be used to decide whether to offer the route chooser dialog
* to the user. There is no point offering the chooser if there are no
* non-default choices.
*
*/
public static final int AVAILABILITY_FLAG_IGNORE_DEFAULT_ROUTE = 1 << 0;
/**
* Flag for {@link #isRouteAvailable}: Require an actual route to be matched.
*
* If this flag is not set, then {@link #isRouteAvailable} will return true
* if it is possible to discover a matching route even if discovery is not in
* progress or if no matching route has yet been found. This feature is used to
* save resources by removing the need to perform passive route discovery on
* {@link ActivityManager#isLowRamDevice low-RAM devices}.
*
* If this flag is set, then {@link #isRouteAvailable} will only return true if
* a matching route has actually been discovered.
*
*/
public static final int AVAILABILITY_FLAG_REQUIRE_MATCH = 1 << 1;
MediaRouter(Context context) {
mContext = context;
}
/**
* Gets an instance of the media router service associated with the context.
*
* The application is responsible for holding a strong reference to the returned
* {@link MediaRouter} instance, such as by storing the instance in a field of
* the {@link android.app.Activity}, to ensure that the media router remains alive
* as long as the application is using its features.
*
* In other words, the support library only holds a {@link WeakReference weak reference}
* to each media router instance. When there are no remaining strong references to the
* media router instance, all of its callbacks will be removed and route discovery
* will no longer be performed on its behalf.
*
*
* @return The media router instance for the context. The application must hold
* a strong reference to this object as long as it is in use.
*/
public static MediaRouter getInstance(@NonNull Context context) {
if (context == null) {
throw new IllegalArgumentException("context must not be null");
}
checkCallingThread();
if (sGlobal == null) {
sGlobal = new GlobalMediaRouter(context.getApplicationContext());
sGlobal.start();
}
return sGlobal.getRouter(context);
}
/**
* Gets information about the {@link MediaRouter.RouteInfo routes} currently known to
* this media router.
*/
public List getRoutes() {
checkCallingThread();
return sGlobal.getRoutes();
}
/**
* Gets information about the {@link MediaRouter.ProviderInfo route providers}
* currently known to this media router.
*/
public List getProviders() {
checkCallingThread();
return sGlobal.getProviders();
}
/**
* Gets the default route for playing media content on the system.
*
* The system always provides a default route.
*
*
* @return The default route, which is guaranteed to never be null.
*/
@NonNull
public RouteInfo getDefaultRoute() {
checkCallingThread();
return sGlobal.getDefaultRoute();
}
/**
* Gets the currently selected route.
*
* The application should examine the route's
* {@link RouteInfo#getControlFilters media control intent filters} to assess the
* capabilities of the route before attempting to use it.
*
*
* Example
*
* public boolean playMovie() {
* MediaRouter mediaRouter = MediaRouter.getInstance(context);
* MediaRouter.RouteInfo route = mediaRouter.getSelectedRoute();
*
* // First try using the remote playback interface, if supported.
* if (route.supportsControlCategory(MediaControlIntent.CATEGORY_REMOTE_PLAYBACK)) {
* // The route supports remote playback.
* // Try to send it the Uri of the movie to play.
* Intent intent = new Intent(MediaControlIntent.ACTION_PLAY);
* intent.addCategory(MediaControlIntent.CATEGORY_REMOTE_PLAYBACK);
* intent.setDataAndType("http://example.com/videos/movie.mp4", "video/mp4");
* if (route.supportsControlRequest(intent)) {
* route.sendControlRequest(intent, null);
* return true; // sent the request to play the movie
* }
* }
*
* // If remote playback was not possible, then play locally.
* if (route.supportsControlCategory(MediaControlIntent.CATEGORY_LIVE_VIDEO)) {
* // The route supports live video streaming.
* // Prepare to play content locally in a window or in a presentation.
* return playMovieInWindow();
* }
*
* // Neither interface is supported, so we can't play the movie to this route.
* return false;
* }
*
*
* @return The selected route, which is guaranteed to never be null.
*
* @see RouteInfo#getControlFilters
* @see RouteInfo#supportsControlCategory
* @see RouteInfo#supportsControlRequest
*/
@NonNull
public RouteInfo getSelectedRoute() {
checkCallingThread();
return sGlobal.getSelectedRoute();
}
/**
* Returns the selected route if it matches the specified selector, otherwise
* selects the default route and returns it. If there is one live audio route
* (usually Bluetooth A2DP), it will be selected instead of default route.
*
* @param selector The selector to match.
* @return The previously selected route if it matched the selector, otherwise the
* newly selected default route which is guaranteed to never be null.
*
* @see MediaRouteSelector
* @see RouteInfo#matchesSelector
*/
@NonNull
public RouteInfo updateSelectedRoute(@NonNull MediaRouteSelector selector) {
if (selector == null) {
throw new IllegalArgumentException("selector must not be null");
}
checkCallingThread();
if (DEBUG) {
Log.d(TAG, "updateSelectedRoute: " + selector);
}
RouteInfo route = sGlobal.getSelectedRoute();
if (!route.isDefaultOrBluetooth() && !route.matchesSelector(selector)) {
route = sGlobal.chooseFallbackRoute();
sGlobal.selectRoute(route);
}
return route;
}
/**
* Selects the specified route.
*
* @param route The route to select.
*/
public void selectRoute(@NonNull RouteInfo route) {
if (route == null) {
throw new IllegalArgumentException("route must not be null");
}
checkCallingThread();
if (DEBUG) {
Log.d(TAG, "selectRoute: " + route);
}
sGlobal.selectRoute(route);
}
/**
* Unselects the current round and selects the default route instead.
*
* The reason given must be one of:
*
* - {@link MediaRouter#UNSELECT_REASON_UNKNOWN}
* - {@link MediaRouter#UNSELECT_REASON_DISCONNECTED}
* - {@link MediaRouter#UNSELECT_REASON_STOPPED}
* - {@link MediaRouter#UNSELECT_REASON_ROUTE_CHANGED}
*
*
* @param reason The reason for disconnecting the current route.
*/
public void unselect(int reason) {
if (reason < MediaRouter.UNSELECT_REASON_UNKNOWN ||
reason > MediaRouter.UNSELECT_REASON_ROUTE_CHANGED) {
throw new IllegalArgumentException("Unsupported reason to unselect route");
}
checkCallingThread();
// Choose the fallback route if it's not already selected.
// Otherwise, select the default route.
RouteInfo fallbackRoute = sGlobal.chooseFallbackRoute();
if (sGlobal.getSelectedRoute() != fallbackRoute) {
sGlobal.selectRoute(fallbackRoute, reason);
} else {
sGlobal.selectRoute(sGlobal.getDefaultRoute(), reason);
}
}
/**
* Returns true if there is a route that matches the specified selector.
*
* This method returns true if there are any available routes that match the
* selector regardless of whether they are enabled or disabled. If the
* {@link #AVAILABILITY_FLAG_IGNORE_DEFAULT_ROUTE} flag is specified, then
* the method will only consider non-default routes.
*
*
* On {@link ActivityManager#isLowRamDevice low-RAM devices} this method
* will return true if it is possible to discover a matching route even if
* discovery is not in progress or if no matching route has yet been found.
* Use {@link #AVAILABILITY_FLAG_REQUIRE_MATCH} to require an actual match.
*
*
* @param selector The selector to match.
* @param flags Flags to control the determination of whether a route may be
* available. May be zero or some combination of
* {@link #AVAILABILITY_FLAG_IGNORE_DEFAULT_ROUTE} and
* {@link #AVAILABILITY_FLAG_REQUIRE_MATCH}.
* @return True if a matching route may be available.
*/
public boolean isRouteAvailable(@NonNull MediaRouteSelector selector, int flags) {
if (selector == null) {
throw new IllegalArgumentException("selector must not be null");
}
checkCallingThread();
return sGlobal.isRouteAvailable(selector, flags);
}
/**
* Registers a callback to discover routes that match the selector and to receive
* events when they change.
*
* This is a convenience method that has the same effect as calling
* {@link #addCallback(MediaRouteSelector, Callback, int)} without flags.
*
*
* @param selector A route selector that indicates the kinds of routes that the
* callback would like to discover.
* @param callback The callback to add.
* @see #removeCallback
*/
public void addCallback(MediaRouteSelector selector, Callback callback) {
addCallback(selector, callback, 0);
}
/**
* Registers a callback to discover routes that match the selector and to receive
* events when they change.
*
* The selector describes the kinds of routes that the application wants to
* discover. For example, if the application wants to use
* live audio routes then it should include the
* {@link MediaControlIntent#CATEGORY_LIVE_AUDIO live audio media control intent category}
* in its selector when it adds a callback to the media router.
* The selector may include any number of categories.
*
* If the callback has already been registered, then the selector is added to
* the set of selectors being monitored by the callback.
*
* By default, the callback will only be invoked for events that affect routes
* that match the specified selector. Event filtering may be disabled by specifying
* the {@link #CALLBACK_FLAG_UNFILTERED_EVENTS} flag when the callback is registered.
*
* Applications should use the {@link #isRouteAvailable} method to determine
* whether is it possible to discover a route with the desired capabilities
* and therefore whether the media route button should be shown to the user.
*
* The {@link #CALLBACK_FLAG_REQUEST_DISCOVERY} flag should be used while the application
* is in the foreground to request that passive discovery be performed if there are
* sufficient resources to allow continuous passive discovery.
* On {@link ActivityManager#isLowRamDevice low-RAM devices} this flag will be
* ignored to conserve resources.
*
* The {@link #CALLBACK_FLAG_FORCE_DISCOVERY} flag should be used when
* passive discovery absolutely must be performed, even on low-RAM devices.
* This flag has a significant performance impact on low-RAM devices
* since it may cause many media route providers to be started simultaneously.
* It is much better to use {@link #CALLBACK_FLAG_REQUEST_DISCOVERY} instead to avoid
* performing passive discovery on these devices altogether.
*
* The {@link #CALLBACK_FLAG_PERFORM_ACTIVE_SCAN} flag should be used when the
* media route chooser dialog is showing to confirm the presence of available
* routes that the user may connect to. This flag may use substantially more
* power.
*
*
* Example
*
* public class MyActivity extends Activity {
* private MediaRouter mRouter;
* private MediaRouter.Callback mCallback;
* private MediaRouteSelector mSelector;
*
* protected void onCreate(Bundle savedInstanceState) {
* super.onCreate(savedInstanceState);
*
* mRouter = Mediarouter.getInstance(this);
* mCallback = new MyCallback();
* mSelector = new MediaRouteSelector.Builder()
* .addControlCategory(MediaControlIntent.CATEGORY_LIVE_AUDIO)
* .addControlCategory(MediaControlIntent.CATEGORY_REMOTE_PLAYBACK)
* .build();
* }
*
* // Add the callback on start to tell the media router what kinds of routes
* // the application is interested in so that it can try to discover suitable ones.
* public void onStart() {
* super.onStart();
*
* mediaRouter.addCallback(mSelector, mCallback,
* MediaRouter.CALLBACK_FLAG_REQUEST_DISCOVERY);
*
* MediaRouter.RouteInfo route = mediaRouter.updateSelectedRoute(mSelector);
* // do something with the route...
* }
*
* // Remove the selector on stop to tell the media router that it no longer
* // needs to invest effort trying to discover routes of these kinds for now.
* public void onStop() {
* super.onStop();
*
* mediaRouter.removeCallback(mCallback);
* }
*
* private final class MyCallback extends MediaRouter.Callback {
* // Implement callback methods as needed.
* }
* }
*
*
* @param selector A route selector that indicates the kinds of routes that the
* callback would like to discover.
* @param callback The callback to add.
* @param flags Flags to control the behavior of the callback.
* May be zero or a combination of {@link #CALLBACK_FLAG_PERFORM_ACTIVE_SCAN} and
* {@link #CALLBACK_FLAG_UNFILTERED_EVENTS}.
* @see #removeCallback
*/
public void addCallback(@NonNull MediaRouteSelector selector, @NonNull Callback callback,
@CallbackFlags int flags) {
if (selector == null) {
throw new IllegalArgumentException("selector must not be null");
}
if (callback == null) {
throw new IllegalArgumentException("callback must not be null");
}
checkCallingThread();
if (DEBUG) {
Log.d(TAG, "addCallback: selector=" + selector
+ ", callback=" + callback + ", flags=" + Integer.toHexString(flags));
}
CallbackRecord record;
int index = findCallbackRecord(callback);
if (index < 0) {
record = new CallbackRecord(this, callback);
mCallbackRecords.add(record);
} else {
record = mCallbackRecords.get(index);
}
boolean updateNeeded = false;
if ((flags & ~record.mFlags) != 0) {
record.mFlags |= flags;
updateNeeded = true;
}
if (!record.mSelector.contains(selector)) {
record.mSelector = new MediaRouteSelector.Builder(record.mSelector)
.addSelector(selector)
.build();
updateNeeded = true;
}
if (updateNeeded) {
sGlobal.updateDiscoveryRequest();
}
}
/**
* Removes the specified callback. It will no longer receive events about
* changes to media routes.
*
* @param callback The callback to remove.
* @see #addCallback
*/
public void removeCallback(@NonNull Callback callback) {
if (callback == null) {
throw new IllegalArgumentException("callback must not be null");
}
checkCallingThread();
if (DEBUG) {
Log.d(TAG, "removeCallback: callback=" + callback);
}
int index = findCallbackRecord(callback);
if (index >= 0) {
mCallbackRecords.remove(index);
sGlobal.updateDiscoveryRequest();
}
}
private int findCallbackRecord(Callback callback) {
final int count = mCallbackRecords.size();
for (int i = 0; i < count; i++) {
if (mCallbackRecords.get(i).mCallback == callback) {
return i;
}
}
return -1;
}
/**
* Registers a media route provider within this application process.
*
* The provider will be added to the list of providers that all {@link MediaRouter}
* instances within this process can use to discover routes.
*
*
* @param providerInstance The media route provider instance to add.
*
* @see MediaRouteProvider
* @see #removeCallback
*/
public void addProvider(@NonNull MediaRouteProvider providerInstance) {
if (providerInstance == null) {
throw new IllegalArgumentException("providerInstance must not be null");
}
checkCallingThread();
if (DEBUG) {
Log.d(TAG, "addProvider: " + providerInstance);
}
sGlobal.addProvider(providerInstance);
}
/**
* Unregisters a media route provider within this application process.
*
* The provider will be removed from the list of providers that all {@link MediaRouter}
* instances within this process can use to discover routes.
*
*
* @param providerInstance The media route provider instance to remove.
*
* @see MediaRouteProvider
* @see #addCallback
*/
public void removeProvider(@NonNull MediaRouteProvider providerInstance) {
if (providerInstance == null) {
throw new IllegalArgumentException("providerInstance must not be null");
}
checkCallingThread();
if (DEBUG) {
Log.d(TAG, "removeProvider: " + providerInstance);
}
sGlobal.removeProvider(providerInstance);
}
/**
* Adds a remote control client to enable remote control of the volume
* of the selected route.
*
* The remote control client must have previously been registered with
* the audio manager using the {@link android.media.AudioManager#registerRemoteControlClient
* AudioManager.registerRemoteControlClient} method.
*
*
* @param remoteControlClient The {@link android.media.RemoteControlClient} to register.
*/
public void addRemoteControlClient(@NonNull Object remoteControlClient) {
if (remoteControlClient == null) {
throw new IllegalArgumentException("remoteControlClient must not be null");
}
checkCallingThread();
if (DEBUG) {
Log.d(TAG, "addRemoteControlClient: " + remoteControlClient);
}
sGlobal.addRemoteControlClient(remoteControlClient);
}
/**
* Removes a remote control client.
*
* @param remoteControlClient The {@link android.media.RemoteControlClient}
* to unregister.
*/
public void removeRemoteControlClient(@NonNull Object remoteControlClient) {
if (remoteControlClient == null) {
throw new IllegalArgumentException("remoteControlClient must not be null");
}
if (DEBUG) {
Log.d(TAG, "removeRemoteControlClient: " + remoteControlClient);
}
sGlobal.removeRemoteControlClient(remoteControlClient);
}
/**
* Sets the media session to enable remote control of the volume of the
* selected route. This should be used instead of
* {@link #addRemoteControlClient} when using media sessions. Set the
* session to null to clear it.
*
* @param mediaSession The {@link android.media.session.MediaSession} to
* use.
*/
public void setMediaSession(Object mediaSession) {
if (DEBUG) {
Log.d(TAG, "addMediaSession: " + mediaSession);
}
sGlobal.setMediaSession(mediaSession);
}
/**
* Sets a compat media session to enable remote control of the volume of the
* selected route. This should be used instead of
* {@link #addRemoteControlClient} when using {@link MediaSessionCompat}.
* Set the session to null to clear it.
*
* @param mediaSession
*/
public void setMediaSessionCompat(MediaSessionCompat mediaSession) {
if (DEBUG) {
Log.d(TAG, "addMediaSessionCompat: " + mediaSession);
}
sGlobal.setMediaSessionCompat(mediaSession);
}
public MediaSessionCompat.Token getMediaSessionToken() {
return sGlobal.getMediaSessionToken();
}
/**
* Ensures that calls into the media router are on the correct thread.
* It pays to be a little paranoid when global state invariants are at risk.
*/
static void checkCallingThread() {
if (Looper.myLooper() != Looper.getMainLooper()) {
throw new IllegalStateException("The media router service must only be "
+ "accessed on the application's main thread.");
}
}
static boolean equal(T a, T b) {
return a == b || (a != null && b != null && a.equals(b));
}
/**
* Provides information about a media route.
*
* Each media route has a list of {@link MediaControlIntent media control}
* {@link #getControlFilters intent filters} that describe the capabilities of the
* route and the manner in which it is used and controlled.
*
*/
public static class RouteInfo {
private final ProviderInfo mProvider;
private final String mDescriptorId;
private final String mUniqueId;
private String mName;
private String mDescription;
private Uri mIconUri;
private boolean mEnabled;
private boolean mConnecting;
private int mConnectionState;
private boolean mCanDisconnect;
private final ArrayList mControlFilters = new ArrayList<>();
private int mPlaybackType;
private int mPlaybackStream;
private int mDeviceType;
private int mVolumeHandling;
private int mVolume;
private int mVolumeMax;
private Display mPresentationDisplay;
private int mPresentationDisplayId = PRESENTATION_DISPLAY_ID_NONE;
private Bundle mExtras;
private IntentSender mSettingsIntent;
MediaRouteDescriptor mDescriptor;
/** @hide */
@IntDef({CONNECTION_STATE_DISCONNECTED, CONNECTION_STATE_CONNECTING,
CONNECTION_STATE_CONNECTED})
@Retention(RetentionPolicy.SOURCE)
private @interface ConnectionState {}
/**
* The default connection state indicating the route is disconnected.
*
* @see #getConnectionState
*/
public static final int CONNECTION_STATE_DISCONNECTED = 0;
/**
* A connection state indicating the route is in the process of connecting and is not yet
* ready for use.
*
* @see #getConnectionState
*/
public static final int CONNECTION_STATE_CONNECTING = 1;
/**
* A connection state indicating the route is connected.
*
* @see #getConnectionState
*/
public static final int CONNECTION_STATE_CONNECTED = 2;
/** @hide */
@IntDef({PLAYBACK_TYPE_LOCAL,PLAYBACK_TYPE_REMOTE})
@Retention(RetentionPolicy.SOURCE)
private @interface PlaybackType {}
/**
* The default playback type, "local", indicating the presentation of the media
* is happening on the same device (e.g. a phone, a tablet) as where it is
* controlled from.
*
* @see #getPlaybackType
*/
public static final int PLAYBACK_TYPE_LOCAL = 0;
/**
* A playback type indicating the presentation of the media is happening on
* a different device (i.e. the remote device) than where it is controlled from.
*
* @see #getPlaybackType
*/
public static final int PLAYBACK_TYPE_REMOTE = 1;
/** @hide */
@IntDef({DEVICE_TYPE_UNKNOWN, DEVICE_TYPE_TV, DEVICE_TYPE_SPEAKER, DEVICE_TYPE_BLUETOOTH})
@Retention(RetentionPolicy.SOURCE)
private @interface DeviceType {}
/**
* The default receiver device type of the route indicating the type is unknown.
*
* @see #getDeviceType
* @hide
*/
public static final int DEVICE_TYPE_UNKNOWN = 0;
/**
* A receiver device type of the route indicating the presentation of the media is happening
* on a TV.
*
* @see #getDeviceType
*/
public static final int DEVICE_TYPE_TV = 1;
/**
* A receiver device type of the route indicating the presentation of the media is happening
* on a speaker.
*
* @see #getDeviceType
*/
public static final int DEVICE_TYPE_SPEAKER = 2;
/**
* A receiver device type of the route indicating the presentation of the media is happening
* on a bluetooth device such as a bluetooth speaker.
*
* @see #getDeviceType
* @hide
*/
public static final int DEVICE_TYPE_BLUETOOTH = 3;
/** @hide */
@IntDef({PLAYBACK_VOLUME_FIXED,PLAYBACK_VOLUME_VARIABLE})
@Retention(RetentionPolicy.SOURCE)
private @interface PlaybackVolume {}
/**
* Playback information indicating the playback volume is fixed, i.e. it cannot be
* controlled from this object. An example of fixed playback volume is a remote player,
* playing over HDMI where the user prefers to control the volume on the HDMI sink, rather
* than attenuate at the source.
*
* @see #getVolumeHandling
*/
public static final int PLAYBACK_VOLUME_FIXED = 0;
/**
* Playback information indicating the playback volume is variable and can be controlled
* from this object.
*
* @see #getVolumeHandling
*/
public static final int PLAYBACK_VOLUME_VARIABLE = 1;
/**
* The default presentation display id indicating no presentation display is associated
* with the route.
* @hide
*/
public static final int PRESENTATION_DISPLAY_ID_NONE = -1;
static final int CHANGE_GENERAL = 1 << 0;
static final int CHANGE_VOLUME = 1 << 1;
static final int CHANGE_PRESENTATION_DISPLAY = 1 << 2;
// Should match to SystemMediaRouteProvider.PACKAGE_NAME.
static final String SYSTEM_MEDIA_ROUTE_PROVIDER_PACKAGE_NAME = "android";
RouteInfo(ProviderInfo provider, String descriptorId, String uniqueId) {
mProvider = provider;
mDescriptorId = descriptorId;
mUniqueId = uniqueId;
}
/**
* Gets information about the provider of this media route.
*/
public ProviderInfo getProvider() {
return mProvider;
}
/**
* Gets the unique id of the route.
*
* The route unique id functions as a stable identifier by which the route is known.
* For example, an application can use this id as a token to remember the
* selected route across restarts or to communicate its identity to a service.
*
*
* @return The unique id of the route, never null.
*/
@NonNull
public String getId() {
return mUniqueId;
}
/**
* Gets the user-visible name of the route.
*
* The route name identifies the destination represented by the route.
* It may be a user-supplied name, an alias, or device serial number.
*
*
* @return The user-visible name of a media route. This is the string presented
* to users who may select this as the active route.
*/
public String getName() {
return mName;
}
/**
* Gets the user-visible description of the route.
*
* The route description describes the kind of destination represented by the route.
* It may be a user-supplied string, a model number or brand of device.
*
*
* @return The description of the route, or null if none.
*/
@Nullable
public String getDescription() {
return mDescription;
}
/**
* Gets the URI of the icon representing this route.
*
* This icon will be used in picker UIs if available.
*
*
* @return The URI of the icon representing this route, or null if none.
*/
public Uri getIconUri() {
return mIconUri;
}
/**
* Returns true if this route is enabled and may be selected.
*
* @return True if this route is enabled.
*/
public boolean isEnabled() {
return mEnabled;
}
/**
* Returns true if the route is in the process of connecting and is not
* yet ready for use.
*
* @return True if this route is in the process of connecting.
*/
public boolean isConnecting() {
return mConnecting;
}
/**
* Gets the connection state of the route.
*
* @return The connection state of this route: {@link #CONNECTION_STATE_DISCONNECTED},
* {@link #CONNECTION_STATE_CONNECTING}, or {@link #CONNECTION_STATE_CONNECTED}.
*/
@ConnectionState
public int getConnectionState() {
return mConnectionState;
}
/**
* Returns true if this route is currently selected.
*
* @return True if this route is currently selected.
*
* @see MediaRouter#getSelectedRoute
*/
public boolean isSelected() {
checkCallingThread();
return sGlobal.getSelectedRoute() == this;
}
/**
* Returns true if this route is the default route.
*
* @return True if this route is the default route.
*
* @see MediaRouter#getDefaultRoute
*/
public boolean isDefault() {
checkCallingThread();
return sGlobal.getDefaultRoute() == this;
}
/**
* Gets a list of {@link MediaControlIntent media control intent} filters that
* describe the capabilities of this route and the media control actions that
* it supports.
*
* @return A list of intent filters that specifies the media control intents that
* this route supports.
*
* @see MediaControlIntent
* @see #supportsControlCategory
* @see #supportsControlRequest
*/
public List getControlFilters() {
return mControlFilters;
}
/**
* Returns true if the route supports at least one of the capabilities
* described by a media route selector.
*
* @param selector The selector that specifies the capabilities to check.
* @return True if the route supports at least one of the capabilities
* described in the media route selector.
*/
public boolean matchesSelector(@NonNull MediaRouteSelector selector) {
if (selector == null) {
throw new IllegalArgumentException("selector must not be null");
}
checkCallingThread();
return selector.matchesControlFilters(mControlFilters);
}
/**
* Returns true if the route supports the specified
* {@link MediaControlIntent media control} category.
*
* Media control categories describe the capabilities of this route
* such as whether it supports live audio streaming or remote playback.
*
*
* @param category A {@link MediaControlIntent media control} category
* such as {@link MediaControlIntent#CATEGORY_LIVE_AUDIO},
* {@link MediaControlIntent#CATEGORY_LIVE_VIDEO},
* {@link MediaControlIntent#CATEGORY_REMOTE_PLAYBACK}, or a provider-defined
* media control category.
* @return True if the route supports the specified intent category.
*
* @see MediaControlIntent
* @see #getControlFilters
*/
public boolean supportsControlCategory(@NonNull String category) {
if (category == null) {
throw new IllegalArgumentException("category must not be null");
}
checkCallingThread();
int count = mControlFilters.size();
for (int i = 0; i < count; i++) {
if (mControlFilters.get(i).hasCategory(category)) {
return true;
}
}
return false;
}
/**
* Returns true if the route supports the specified
* {@link MediaControlIntent media control} category and action.
*
* Media control actions describe specific requests that an application
* can ask a route to perform.
*
*
* @param category A {@link MediaControlIntent media control} category
* such as {@link MediaControlIntent#CATEGORY_LIVE_AUDIO},
* {@link MediaControlIntent#CATEGORY_LIVE_VIDEO},
* {@link MediaControlIntent#CATEGORY_REMOTE_PLAYBACK}, or a provider-defined
* media control category.
* @param action A {@link MediaControlIntent media control} action
* such as {@link MediaControlIntent#ACTION_PLAY}.
* @return True if the route supports the specified intent action.
*
* @see MediaControlIntent
* @see #getControlFilters
*/
public boolean supportsControlAction(@NonNull String category, @NonNull String action) {
if (category == null) {
throw new IllegalArgumentException("category must not be null");
}
if (action == null) {
throw new IllegalArgumentException("action must not be null");
}
checkCallingThread();
int count = mControlFilters.size();
for (int i = 0; i < count; i++) {
IntentFilter filter = mControlFilters.get(i);
if (filter.hasCategory(category) && filter.hasAction(action)) {
return true;
}
}
return false;
}
/**
* Returns true if the route supports the specified
* {@link MediaControlIntent media control} request.
*
* Media control requests are used to request the route to perform
* actions such as starting remote playback of a media item.
*
*
* @param intent A {@link MediaControlIntent media control intent}.
* @return True if the route can handle the specified intent.
*
* @see MediaControlIntent
* @see #getControlFilters
*/
public boolean supportsControlRequest(@NonNull Intent intent) {
if (intent == null) {
throw new IllegalArgumentException("intent must not be null");
}
checkCallingThread();
ContentResolver contentResolver = sGlobal.getContentResolver();
int count = mControlFilters.size();
for (int i = 0; i < count; i++) {
if (mControlFilters.get(i).match(contentResolver, intent, true, TAG) >= 0) {
return true;
}
}
return false;
}
/**
* Sends a {@link MediaControlIntent media control} request to be performed
* asynchronously by the route's destination.
*
* Media control requests are used to request the route to perform
* actions such as starting remote playback of a media item.
*
* This function may only be called on a selected route. Control requests
* sent to unselected routes will fail.
*
*
* @param intent A {@link MediaControlIntent media control intent}.
* @param callback A {@link ControlRequestCallback} to invoke with the result
* of the request, or null if no result is required.
*
* @see MediaControlIntent
*/
public void sendControlRequest(@NonNull Intent intent,
@Nullable ControlRequestCallback callback) {
if (intent == null) {
throw new IllegalArgumentException("intent must not be null");
}
checkCallingThread();
sGlobal.sendControlRequest(this, intent, callback);
}
/**
* Gets the type of playback associated with this route.
*
* @return The type of playback associated with this route: {@link #PLAYBACK_TYPE_LOCAL}
* or {@link #PLAYBACK_TYPE_REMOTE}.
*/
@PlaybackType
public int getPlaybackType() {
return mPlaybackType;
}
/**
* Gets the audio stream over which the playback associated with this route is performed.
*
* @return The stream over which the playback associated with this route is performed.
*/
public int getPlaybackStream() {
return mPlaybackStream;
}
/**
* Gets the type of the receiver device associated with this route.
*
* @return The type of the receiver device associated with this route:
* {@link #DEVICE_TYPE_TV} or {@link #DEVICE_TYPE_SPEAKER}.
*/
public int getDeviceType() {
return mDeviceType;
}
/**
* @hide
*/
public boolean isDefaultOrBluetooth() {
if (isDefault() || mDeviceType == DEVICE_TYPE_BLUETOOTH) {
return true;
}
// This is a workaround for platform version 23 or below where the system route
// provider doesn't specify device type for bluetooth media routes.
return isSystemMediaRouteProvider(this)
&& supportsControlCategory(MediaControlIntent.CATEGORY_LIVE_AUDIO)
&& !supportsControlCategory(MediaControlIntent.CATEGORY_LIVE_VIDEO);
}
private static boolean isSystemMediaRouteProvider(MediaRouter.RouteInfo route) {
return TextUtils.equals(route.getProviderInstance().getMetadata().getPackageName(),
SYSTEM_MEDIA_ROUTE_PROVIDER_PACKAGE_NAME);
}
/**
* Gets information about how volume is handled on the route.
*
* @return How volume is handled on the route: {@link #PLAYBACK_VOLUME_FIXED}
* or {@link #PLAYBACK_VOLUME_VARIABLE}.
*/
@PlaybackVolume
public int getVolumeHandling() {
return mVolumeHandling;
}
/**
* Gets the current volume for this route. Depending on the route, this may only
* be valid if the route is currently selected.
*
* @return The volume at which the playback associated with this route is performed.
*/
public int getVolume() {
return mVolume;
}
/**
* Gets the maximum volume at which the playback associated with this route is performed.
*
* @return The maximum volume at which the playback associated with
* this route is performed.
*/
public int getVolumeMax() {
return mVolumeMax;
}
/**
* Gets whether this route supports disconnecting without interrupting
* playback.
*
* @return True if this route can disconnect without stopping playback,
* false otherwise.
*/
public boolean canDisconnect() {
return mCanDisconnect;
}
/**
* Requests a volume change for this route asynchronously.
*
* This function may only be called on a selected route. It will have
* no effect if the route is currently unselected.
*
*
* @param volume The new volume value between 0 and {@link #getVolumeMax}.
*/
public void requestSetVolume(int volume) {
checkCallingThread();
sGlobal.requestSetVolume(this, Math.min(mVolumeMax, Math.max(0, volume)));
}
/**
* Requests an incremental volume update for this route asynchronously.
*
* This function may only be called on a selected route. It will have
* no effect if the route is currently unselected.
*
*
* @param delta The delta to add to the current volume.
*/
public void requestUpdateVolume(int delta) {
checkCallingThread();
if (delta != 0) {
sGlobal.requestUpdateVolume(this, delta);
}
}
/**
* Gets the {@link Display} that should be used by the application to show
* a {@link android.app.Presentation} on an external display when this route is selected.
* Depending on the route, this may only be valid if the route is currently
* selected.
*
* The preferred presentation display may change independently of the route
* being selected or unselected. For example, the presentation display
* of the default system route may change when an external HDMI display is connected
* or disconnected even though the route itself has not changed.
*
* This method may return null if there is no external display associated with
* the route or if the display is not ready to show UI yet.
*
* The application should listen for changes to the presentation display
* using the {@link Callback#onRoutePresentationDisplayChanged} callback and
* show or dismiss its {@link android.app.Presentation} accordingly when the display
* becomes available or is removed.
*
* This method only makes sense for
* {@link MediaControlIntent#CATEGORY_LIVE_VIDEO live video} routes.
*
*
* @return The preferred presentation display to use when this route is
* selected or null if none.
*
* @see MediaControlIntent#CATEGORY_LIVE_VIDEO
* @see android.app.Presentation
*/
@Nullable
public Display getPresentationDisplay() {
checkCallingThread();
if (mPresentationDisplayId >= 0 && mPresentationDisplay == null) {
mPresentationDisplay = sGlobal.getDisplay(mPresentationDisplayId);
}
return mPresentationDisplay;
}
/**
* Gets the route's presentation display id, or -1 if none.
* @hide
*/
public int getPresentationDisplayId() {
return mPresentationDisplayId;
}
/**
* Gets a collection of extra properties about this route that were supplied
* by its media route provider, or null if none.
*/
@Nullable
public Bundle getExtras() {
return mExtras;
}
/**
* Gets an intent sender for launching a settings activity for this
* route.
*/
@Nullable
public IntentSender getSettingsIntent() {
return mSettingsIntent;
}
/**
* Selects this media route.
*/
public void select() {
checkCallingThread();
sGlobal.selectRoute(this);
}
@Override
public String toString() {
return "MediaRouter.RouteInfo{ uniqueId=" + mUniqueId
+ ", name=" + mName
+ ", description=" + mDescription
+ ", iconUri=" + mIconUri
+ ", enabled=" + mEnabled
+ ", connecting=" + mConnecting
+ ", connectionState=" + mConnectionState
+ ", canDisconnect=" + mCanDisconnect
+ ", playbackType=" + mPlaybackType
+ ", playbackStream=" + mPlaybackStream
+ ", deviceType=" + mDeviceType
+ ", volumeHandling=" + mVolumeHandling
+ ", volume=" + mVolume
+ ", volumeMax=" + mVolumeMax
+ ", presentationDisplayId=" + mPresentationDisplayId
+ ", extras=" + mExtras
+ ", settingsIntent=" + mSettingsIntent
+ ", providerPackageName=" + mProvider.getPackageName()
+ " }";
}
int maybeUpdateDescriptor(MediaRouteDescriptor descriptor) {
int changes = 0;
if (mDescriptor != descriptor) {
changes = updateDescriptor(descriptor);
}
return changes;
}
int updateDescriptor(MediaRouteDescriptor descriptor) {
int changes = 0;
mDescriptor = descriptor;
if (descriptor != null) {
if (!equal(mName, descriptor.getName())) {
mName = descriptor.getName();
changes |= CHANGE_GENERAL;
}
if (!equal(mDescription, descriptor.getDescription())) {
mDescription = descriptor.getDescription();
changes |= CHANGE_GENERAL;
}
if (!equal(mIconUri, descriptor.getIconUri())) {
mIconUri = descriptor.getIconUri();
changes |= CHANGE_GENERAL;
}
if (mEnabled != descriptor.isEnabled()) {
mEnabled = descriptor.isEnabled();
changes |= CHANGE_GENERAL;
}
if (mConnecting != descriptor.isConnecting()) {
mConnecting = descriptor.isConnecting();
changes |= CHANGE_GENERAL;
}
if (mConnectionState != descriptor.getConnectionState()) {
mConnectionState = descriptor.getConnectionState();
changes |= CHANGE_GENERAL;
}
if (!mControlFilters.equals(descriptor.getControlFilters())) {
mControlFilters.clear();
mControlFilters.addAll(descriptor.getControlFilters());
changes |= CHANGE_GENERAL;
}
if (mPlaybackType != descriptor.getPlaybackType()) {
mPlaybackType = descriptor.getPlaybackType();
changes |= CHANGE_GENERAL;
}
if (mPlaybackStream != descriptor.getPlaybackStream()) {
mPlaybackStream = descriptor.getPlaybackStream();
changes |= CHANGE_GENERAL;
}
if (mDeviceType != descriptor.getDeviceType()) {
mDeviceType = descriptor.getDeviceType();
changes |= CHANGE_GENERAL;
}
if (mVolumeHandling != descriptor.getVolumeHandling()) {
mVolumeHandling = descriptor.getVolumeHandling();
changes |= CHANGE_GENERAL | CHANGE_VOLUME;
}
if (mVolume != descriptor.getVolume()) {
mVolume = descriptor.getVolume();
changes |= CHANGE_GENERAL | CHANGE_VOLUME;
}
if (mVolumeMax != descriptor.getVolumeMax()) {
mVolumeMax = descriptor.getVolumeMax();
changes |= CHANGE_GENERAL | CHANGE_VOLUME;
}
if (mPresentationDisplayId != descriptor.getPresentationDisplayId()) {
mPresentationDisplayId = descriptor.getPresentationDisplayId();
mPresentationDisplay = null;
changes |= CHANGE_GENERAL | CHANGE_PRESENTATION_DISPLAY;
}
if (!equal(mExtras, descriptor.getExtras())) {
mExtras = descriptor.getExtras();
changes |= CHANGE_GENERAL;
}
if (!equal(mSettingsIntent, descriptor.getSettingsActivity())) {
mSettingsIntent = descriptor.getSettingsActivity();
changes |= CHANGE_GENERAL;
}
if (mCanDisconnect != descriptor.canDisconnectAndKeepPlaying()) {
mCanDisconnect = descriptor.canDisconnectAndKeepPlaying();
changes |= CHANGE_GENERAL | CHANGE_PRESENTATION_DISPLAY;
}
}
return changes;
}
String getDescriptorId() {
return mDescriptorId;
}
/** @hide */
public MediaRouteProvider getProviderInstance() {
return mProvider.getProviderInstance();
}
}
/**
* Information about a route that consists of multiple other routes in a group.
* @hide
*/
public static class RouteGroup extends RouteInfo {
private List mRoutes = new ArrayList<>();
RouteGroup(ProviderInfo provider, String descriptorId, String uniqueId) {
super(provider, descriptorId, uniqueId);
}
/**
* @return The number of routes in this group
*/
public int getRouteCount() {
return mRoutes.size();
}
/**
* Returns the route in this group at the specified index
*
* @param index Index to fetch
* @return The route at index
*/
public RouteInfo getRouteAt(int index) {
return mRoutes.get(index);
}
/**
* Returns the routes in this group
*
* @return The list of the routes in this group
*/
public List getRoutes() {
return mRoutes;
}
@Override
public String toString() {
StringBuilder sb = new StringBuilder(super.toString());
sb.append('[');
final int count = mRoutes.size();
for (int i = 0; i < count; i++) {
if (i > 0) sb.append(", ");
sb.append(mRoutes.get(i));
}
sb.append(']');
return sb.toString();
}
@Override
int maybeUpdateDescriptor(MediaRouteDescriptor descriptor) {
boolean changed = false;
if (mDescriptor != descriptor) {
mDescriptor = descriptor;
if (descriptor != null) {
List groupMemberIds = descriptor.getGroupMemberIds();
List routes = new ArrayList<>();
changed = groupMemberIds.size() != mRoutes.size();
for (String groupMemberId : groupMemberIds) {
String uniqueId = sGlobal.getUniqueId(getProvider(), groupMemberId);
RouteInfo groupMember = sGlobal.getRoute(uniqueId);
if (groupMember != null) {
routes.add(groupMember);
if (!changed && !mRoutes.contains(groupMember)) {
changed = true;
}
}
}
if (changed) {
mRoutes = routes;
}
}
}
return (changed ? CHANGE_GENERAL : 0) | super.updateDescriptor(descriptor);
}
}
/**
* Provides information about a media route provider.
*
* This object may be used to determine which media route provider has
* published a particular route.
*
*/
public static final class ProviderInfo {
private final MediaRouteProvider mProviderInstance;
private final List mRoutes = new ArrayList<>();
private final ProviderMetadata mMetadata;
private MediaRouteProviderDescriptor mDescriptor;
private Resources mResources;
private boolean mResourcesNotAvailable;
ProviderInfo(MediaRouteProvider provider) {
mProviderInstance = provider;
mMetadata = provider.getMetadata();
}
/**
* Gets the provider's underlying {@link MediaRouteProvider} instance.
*/
public MediaRouteProvider getProviderInstance() {
checkCallingThread();
return mProviderInstance;
}
/**
* Gets the package name of the media route provider.
*/
public String getPackageName() {
return mMetadata.getPackageName();
}
/**
* Gets the component name of the media route provider.
*/
public ComponentName getComponentName() {
return mMetadata.getComponentName();
}
/**
* Gets the {@link MediaRouter.RouteInfo routes} published by this route provider.
*/
public List getRoutes() {
checkCallingThread();
return mRoutes;
}
Resources getResources() {
if (mResources == null && !mResourcesNotAvailable) {
String packageName = getPackageName();
Context context = sGlobal.getProviderContext(packageName);
if (context != null) {
mResources = context.getResources();
} else {
Log.w(TAG, "Unable to obtain resources for route provider package: "
+ packageName);
mResourcesNotAvailable = true;
}
}
return mResources;
}
boolean updateDescriptor(MediaRouteProviderDescriptor descriptor) {
if (mDescriptor != descriptor) {
mDescriptor = descriptor;
return true;
}
return false;
}
int findRouteByDescriptorId(String id) {
final int count = mRoutes.size();
for (int i = 0; i < count; i++) {
if (mRoutes.get(i).mDescriptorId.equals(id)) {
return i;
}
}
return -1;
}
@Override
public String toString() {
return "MediaRouter.RouteProviderInfo{ packageName=" + getPackageName()
+ " }";
}
}
/**
* Interface for receiving events about media routing changes.
* All methods of this interface will be called from the application's main thread.
*
* A Callback will only receive events relevant to routes that the callback
* was registered for unless the {@link MediaRouter#CALLBACK_FLAG_UNFILTERED_EVENTS}
* flag was specified in {@link MediaRouter#addCallback(MediaRouteSelector, Callback, int)}.
*
*
* @see MediaRouter#addCallback(MediaRouteSelector, Callback, int)
* @see MediaRouter#removeCallback(Callback)
*/
public static abstract class Callback {
/**
* Called when the supplied media route becomes selected as the active route.
*
* @param router The media router reporting the event.
* @param route The route that has been selected.
*/
public void onRouteSelected(MediaRouter router, RouteInfo route) {
}
/**
* Called when the supplied media route becomes unselected as the active route.
* For detailed reason, override {@link #onRouteUnselected(MediaRouter, RouteInfo, int)}
* instead.
*
* @param router The media router reporting the event.
* @param route The route that has been unselected.
*/
public void onRouteUnselected(MediaRouter router, RouteInfo route) {
}
/**
* Called when the supplied media route becomes unselected as the active route.
* The default implementation calls {@link #onRouteUnselected}.
*
* The reason provided will be one of the following:
*
* - {@link MediaRouter#UNSELECT_REASON_UNKNOWN}
* - {@link MediaRouter#UNSELECT_REASON_DISCONNECTED}
* - {@link MediaRouter#UNSELECT_REASON_STOPPED}
* - {@link MediaRouter#UNSELECT_REASON_ROUTE_CHANGED}
*
*
* @param router The media router reporting the event.
* @param route The route that has been unselected.
* @param reason The reason for unselecting the route.
*/
public void onRouteUnselected(MediaRouter router, RouteInfo route, int reason) {
onRouteUnselected(router, route);
}
/**
* Called when a media route has been added.
*
* @param router The media router reporting the event.
* @param route The route that has become available for use.
*/
public void onRouteAdded(MediaRouter router, RouteInfo route) {
}
/**
* Called when a media route has been removed.
*
* @param router The media router reporting the event.
* @param route The route that has been removed from availability.
*/
public void onRouteRemoved(MediaRouter router, RouteInfo route) {
}
/**
* Called when a property of the indicated media route has changed.
*
* @param router The media router reporting the event.
* @param route The route that was changed.
*/
public void onRouteChanged(MediaRouter router, RouteInfo route) {
}
/**
* Called when a media route's volume changes.
*
* @param router The media router reporting the event.
* @param route The route whose volume changed.
*/
public void onRouteVolumeChanged(MediaRouter router, RouteInfo route) {
}
/**
* Called when a media route's presentation display changes.
*
* This method is called whenever the route's presentation display becomes
* available, is removed or has changes to some of its properties (such as its size).
*
*
* @param router The media router reporting the event.
* @param route The route whose presentation display changed.
*
* @see RouteInfo#getPresentationDisplay()
*/
public void onRoutePresentationDisplayChanged(MediaRouter router, RouteInfo route) {
}
/**
* Called when a media route provider has been added.
*
* @param router The media router reporting the event.
* @param provider The provider that has become available for use.
*/
public void onProviderAdded(MediaRouter router, ProviderInfo provider) {
}
/**
* Called when a media route provider has been removed.
*
* @param router The media router reporting the event.
* @param provider The provider that has been removed from availability.
*/
public void onProviderRemoved(MediaRouter router, ProviderInfo provider) {
}
/**
* Called when a property of the indicated media route provider has changed.
*
* @param router The media router reporting the event.
* @param provider The provider that was changed.
*/
public void onProviderChanged(MediaRouter router, ProviderInfo provider) {
}
}
/**
* Callback which is invoked with the result of a media control request.
*
* @see RouteInfo#sendControlRequest
*/
public static abstract class ControlRequestCallback {
/**
* Called when a media control request succeeds.
*
* @param data Result data, or null if none.
* Contents depend on the {@link MediaControlIntent media control action}.
*/
public void onResult(Bundle data) {
}
/**
* Called when a media control request fails.
*
* @param error A localized error message which may be shown to the user, or null
* if the cause of the error is unclear.
* @param data Error data, or null if none.
* Contents depend on the {@link MediaControlIntent media control action}.
*/
public void onError(String error, Bundle data) {
}
}
private static final class CallbackRecord {
public final MediaRouter mRouter;
public final Callback mCallback;
public MediaRouteSelector mSelector;
public int mFlags;
public CallbackRecord(MediaRouter router, Callback callback) {
mRouter = router;
mCallback = callback;
mSelector = MediaRouteSelector.EMPTY;
}
public boolean filterRouteEvent(RouteInfo route) {
return (mFlags & CALLBACK_FLAG_UNFILTERED_EVENTS) != 0
|| route.matchesSelector(mSelector);
}
}
/**
* Global state for the media router.
*
* Media routes and media route providers are global to the process; their
* state and the bulk of the media router implementation lives here.
*
*/
private static final class GlobalMediaRouter
implements SystemMediaRouteProvider.SyncCallback,
RegisteredMediaRouteProviderWatcher.Callback {
private final Context mApplicationContext;
private final ArrayList> mRouters = new ArrayList<>();
private final ArrayList mRoutes = new ArrayList<>();
private final Map, String> mUniqueIdMap = new HashMap<>();
private final ArrayList mProviders = new ArrayList<>();
private final ArrayList mRemoteControlClients =
new ArrayList<>();
private final RemoteControlClientCompat.PlaybackInfo mPlaybackInfo =
new RemoteControlClientCompat.PlaybackInfo();
private final ProviderCallback mProviderCallback = new ProviderCallback();
private final CallbackHandler mCallbackHandler = new CallbackHandler();
private final DisplayManagerCompat mDisplayManager;
private final SystemMediaRouteProvider mSystemProvider;
private final boolean mLowRam;
private RegisteredMediaRouteProviderWatcher mRegisteredProviderWatcher;
private RouteInfo mDefaultRoute;
private RouteInfo mSelectedRoute;
private RouteController mSelectedRouteController;
// A map from route descriptor ID to RouteController for the member routes in the currently
// selected route group.
private final Map mRouteControllerMap = new HashMap<>();
private MediaRouteDiscoveryRequest mDiscoveryRequest;
private MediaSessionRecord mMediaSession;
private MediaSessionCompat mRccMediaSession;
private MediaSessionCompat mCompatSession;
private MediaSessionCompat.OnActiveChangeListener mSessionActiveListener =
new MediaSessionCompat.OnActiveChangeListener() {
@Override
public void onActiveChanged() {
if(mRccMediaSession != null) {
if (mRccMediaSession.isActive()) {
addRemoteControlClient(mRccMediaSession.getRemoteControlClient());
} else {
removeRemoteControlClient(mRccMediaSession.getRemoteControlClient());
}
}
}
};
GlobalMediaRouter(Context applicationContext) {
mApplicationContext = applicationContext;
mDisplayManager = DisplayManagerCompat.getInstance(applicationContext);
mLowRam = ActivityManagerCompat.isLowRamDevice(
(ActivityManager)applicationContext.getSystemService(
Context.ACTIVITY_SERVICE));
// Add the system media route provider for interoperating with
// the framework media router. This one is special and receives
// synchronization messages from the media router.
mSystemProvider = SystemMediaRouteProvider.obtain(applicationContext, this);
addProvider(mSystemProvider);
}
public void start() {
// Start watching for routes published by registered media route
// provider services.
mRegisteredProviderWatcher = new RegisteredMediaRouteProviderWatcher(
mApplicationContext, this);
mRegisteredProviderWatcher.start();
}
public MediaRouter getRouter(Context context) {
MediaRouter router;
for (int i = mRouters.size(); --i >= 0; ) {
router = mRouters.get(i).get();
if (router == null) {
mRouters.remove(i);
} else if (router.mContext == context) {
return router;
}
}
router = new MediaRouter(context);
mRouters.add(new WeakReference(router));
return router;
}
public ContentResolver getContentResolver() {
return mApplicationContext.getContentResolver();
}
public Context getProviderContext(String packageName) {
if (packageName.equals(SystemMediaRouteProvider.PACKAGE_NAME)) {
return mApplicationContext;
}
try {
return mApplicationContext.createPackageContext(
packageName, Context.CONTEXT_RESTRICTED);
} catch (NameNotFoundException ex) {
return null;
}
}
public Display getDisplay(int displayId) {
return mDisplayManager.getDisplay(displayId);
}
public void sendControlRequest(RouteInfo route,
Intent intent, ControlRequestCallback callback) {
if (route == mSelectedRoute && mSelectedRouteController != null) {
if (mSelectedRouteController.onControlRequest(intent, callback)) {
return;
}
}
if (callback != null) {
callback.onError(null, null);
}
}
public void requestSetVolume(RouteInfo route, int volume) {
if (route == mSelectedRoute && mSelectedRouteController != null) {
mSelectedRouteController.onSetVolume(volume);
} else if (!mRouteControllerMap.isEmpty()) {
RouteController controller = mRouteControllerMap.get(route.mDescriptorId);
if (controller != null) {
controller.onSetVolume(volume);
}
}
}
public void requestUpdateVolume(RouteInfo route, int delta) {
if (route == mSelectedRoute && mSelectedRouteController != null) {
mSelectedRouteController.onUpdateVolume(delta);
}
}
public RouteInfo getRoute(String uniqueId) {
for (RouteInfo info : mRoutes) {
if (info.mUniqueId.equals(uniqueId)) {
return info;
}
}
return null;
}
public List getRoutes() {
return mRoutes;
}
public List getProviders() {
return mProviders;
}
public RouteInfo getDefaultRoute() {
if (mDefaultRoute == null) {
// This should never happen once the media router has been fully
// initialized but it is good to check for the error in case there
// is a bug in provider initialization.
throw new IllegalStateException("There is no default route. "
+ "The media router has not yet been fully initialized.");
}
return mDefaultRoute;
}
public RouteInfo getSelectedRoute() {
if (mSelectedRoute == null) {
// This should never happen once the media router has been fully
// initialized but it is good to check for the error in case there
// is a bug in provider initialization.
throw new IllegalStateException("There is no currently selected route. "
+ "The media router has not yet been fully initialized.");
}
return mSelectedRoute;
}
public void selectRoute(RouteInfo route) {
selectRoute(route, MediaRouter.UNSELECT_REASON_ROUTE_CHANGED);
}
public void selectRoute(RouteInfo route, int unselectReason) {
if (!mRoutes.contains(route)) {
Log.w(TAG, "Ignoring attempt to select removed route: " + route);
return;
}
if (!route.mEnabled) {
Log.w(TAG, "Ignoring attempt to select disabled route: " + route);
return;
}
setSelectedRouteInternal(route, unselectReason);
}
public boolean isRouteAvailable(MediaRouteSelector selector, int flags) {
if (selector.isEmpty()) {
return false;
}
// On low-RAM devices, do not rely on actual discovery results unless asked to.
if ((flags & AVAILABILITY_FLAG_REQUIRE_MATCH) == 0 && mLowRam) {
return true;
}
// Check whether any existing routes match the selector.
final int routeCount = mRoutes.size();
for (int i = 0; i < routeCount; i++) {
RouteInfo route = mRoutes.get(i);
if ((flags & AVAILABILITY_FLAG_IGNORE_DEFAULT_ROUTE) != 0
&& route.isDefaultOrBluetooth()) {
continue;
}
if (route.matchesSelector(selector)) {
return true;
}
}
// It doesn't look like we can find a matching route right now.
return false;
}
public void updateDiscoveryRequest() {
// Combine all of the callback selectors and active scan flags.
boolean discover = false;
boolean activeScan = false;
MediaRouteSelector.Builder builder = new MediaRouteSelector.Builder();
for (int i = mRouters.size(); --i >= 0; ) {
MediaRouter router = mRouters.get(i).get();
if (router == null) {
mRouters.remove(i);
} else {
final int count = router.mCallbackRecords.size();
for (int j = 0; j < count; j++) {
CallbackRecord callback = router.mCallbackRecords.get(j);
builder.addSelector(callback.mSelector);
if ((callback.mFlags & CALLBACK_FLAG_PERFORM_ACTIVE_SCAN) != 0) {
activeScan = true;
discover = true; // perform active scan implies request discovery
}
if ((callback.mFlags & CALLBACK_FLAG_REQUEST_DISCOVERY) != 0) {
if (!mLowRam) {
discover = true;
}
}
if ((callback.mFlags & CALLBACK_FLAG_FORCE_DISCOVERY) != 0) {
discover = true;
}
}
}
}
MediaRouteSelector selector = discover ? builder.build() : MediaRouteSelector.EMPTY;
// Create a new discovery request.
if (mDiscoveryRequest != null
&& mDiscoveryRequest.getSelector().equals(selector)
&& mDiscoveryRequest.isActiveScan() == activeScan) {
return; // no change
}
if (selector.isEmpty() && !activeScan) {
// Discovery is not needed.
if (mDiscoveryRequest == null) {
return; // no change
}
mDiscoveryRequest = null;
} else {
// Discovery is needed.
mDiscoveryRequest = new MediaRouteDiscoveryRequest(selector, activeScan);
}
if (DEBUG) {
Log.d(TAG, "Updated discovery request: " + mDiscoveryRequest);
}
if (discover && !activeScan && mLowRam) {
Log.i(TAG, "Forcing passive route discovery on a low-RAM device, "
+ "system performance may be affected. Please consider using "
+ "CALLBACK_FLAG_REQUEST_DISCOVERY instead of "
+ "CALLBACK_FLAG_FORCE_DISCOVERY.");
}
// Notify providers.
final int providerCount = mProviders.size();
for (int i = 0; i < providerCount; i++) {
mProviders.get(i).mProviderInstance.setDiscoveryRequest(mDiscoveryRequest);
}
}
@Override
public void addProvider(MediaRouteProvider providerInstance) {
int index = findProviderInfo(providerInstance);
if (index < 0) {
// 1. Add the provider to the list.
ProviderInfo provider = new ProviderInfo(providerInstance);
mProviders.add(provider);
if (DEBUG) {
Log.d(TAG, "Provider added: " + provider);
}
mCallbackHandler.post(CallbackHandler.MSG_PROVIDER_ADDED, provider);
// 2. Create the provider's contents.
updateProviderContents(provider, providerInstance.getDescriptor());
// 3. Register the provider callback.
providerInstance.setCallback(mProviderCallback);
// 4. Set the discovery request.
providerInstance.setDiscoveryRequest(mDiscoveryRequest);
}
}
@Override
public void removeProvider(MediaRouteProvider providerInstance) {
int index = findProviderInfo(providerInstance);
if (index >= 0) {
// 1. Unregister the provider callback.
providerInstance.setCallback(null);
// 2. Clear the discovery request.
providerInstance.setDiscoveryRequest(null);
// 3. Delete the provider's contents.
ProviderInfo provider = mProviders.get(index);
updateProviderContents(provider, null);
// 4. Remove the provider from the list.
if (DEBUG) {
Log.d(TAG, "Provider removed: " + provider);
}
mCallbackHandler.post(CallbackHandler.MSG_PROVIDER_REMOVED, provider);
mProviders.remove(index);
}
}
private void updateProviderDescriptor(MediaRouteProvider providerInstance,
MediaRouteProviderDescriptor descriptor) {
int index = findProviderInfo(providerInstance);
if (index >= 0) {
// Update the provider's contents.
ProviderInfo provider = mProviders.get(index);
updateProviderContents(provider, descriptor);
}
}
private int findProviderInfo(MediaRouteProvider providerInstance) {
final int count = mProviders.size();
for (int i = 0; i < count; i++) {
if (mProviders.get(i).mProviderInstance == providerInstance) {
return i;
}
}
return -1;
}
private void updateProviderContents(ProviderInfo provider,
MediaRouteProviderDescriptor providerDescriptor) {
if (provider.updateDescriptor(providerDescriptor)) {
// Update all existing routes and reorder them to match
// the order of their descriptors.
int targetIndex = 0;
boolean selectedRouteDescriptorChanged = false;
if (providerDescriptor != null) {
if (providerDescriptor.isValid()) {
final List routeDescriptors =
providerDescriptor.getRoutes();
final int routeCount = routeDescriptors.size();
// Updating route group's contents requires all member routes' information.
// Add the groups to the lists and update them later.
List> addedGroups = new ArrayList<>();
List> updatedGroups =
new ArrayList<>();
for (int i = 0; i < routeCount; i++) {
final MediaRouteDescriptor routeDescriptor = routeDescriptors.get(i);
final String id = routeDescriptor.getId();
final int sourceIndex = provider.findRouteByDescriptorId(id);
if (sourceIndex < 0) {
// 1. Add the route to the list.
String uniqueId = assignRouteUniqueId(provider, id);
boolean isGroup = routeDescriptor.getGroupMemberIds() != null;
RouteInfo route = isGroup ? new RouteGroup(provider, id, uniqueId) :
new RouteInfo(provider, id, uniqueId);
provider.mRoutes.add(targetIndex++, route);
mRoutes.add(route);
// 2. Create the route's contents.
if (isGroup) {
addedGroups.add(new Pair(route, routeDescriptor));
} else {
route.maybeUpdateDescriptor(routeDescriptor);
// 3. Notify clients about addition.
if (DEBUG) {
Log.d(TAG, "Route added: " + route);
}
mCallbackHandler.post(CallbackHandler.MSG_ROUTE_ADDED, route);
}
} else if (sourceIndex < targetIndex) {
Log.w(TAG, "Ignoring route descriptor with duplicate id: "
+ routeDescriptor);
} else {
// 1. Reorder the route within the list.
RouteInfo route = provider.mRoutes.get(sourceIndex);
Collections.swap(provider.mRoutes,
sourceIndex, targetIndex++);
// 2. Update the route's contents.
if (route instanceof RouteGroup) {
updatedGroups.add(new Pair(route, routeDescriptor));
} else {
// 3. Notify clients about changes.
if (updateRouteDescriptorAndNotify(route, routeDescriptor)
!= 0) {
if (route == mSelectedRoute) {
selectedRouteDescriptorChanged = true;
}
}
}
}
}
// Update the new and/or existing groups.
for (Pair pair : addedGroups) {
RouteInfo route = pair.first;
route.maybeUpdateDescriptor(pair.second);
if (DEBUG) {
Log.d(TAG, "Route added: " + route);
}
mCallbackHandler.post(CallbackHandler.MSG_ROUTE_ADDED, route);
}
for (Pair pair : updatedGroups) {
RouteInfo route = pair.first;
if (updateRouteDescriptorAndNotify(route, pair.second) != 0) {
if (route == mSelectedRoute) {
selectedRouteDescriptorChanged = true;
}
}
}
} else {
Log.w(TAG, "Ignoring invalid provider descriptor: " + providerDescriptor);
}
}
// Dispose all remaining routes that do not have matching descriptors.
for (int i = provider.mRoutes.size() - 1; i >= targetIndex; i--) {
// 1. Delete the route's contents.
RouteInfo route = provider.mRoutes.get(i);
route.maybeUpdateDescriptor(null);
// 2. Remove the route from the list.
mRoutes.remove(route);
}
// Update the selected route if needed.
updateSelectedRouteIfNeeded(selectedRouteDescriptorChanged);
// Now notify clients about routes that were removed.
// We do this after updating the selected route to ensure
// that the framework media router observes the new route
// selection before the removal since removing the currently
// selected route may have side-effects.
for (int i = provider.mRoutes.size() - 1; i >= targetIndex; i--) {
RouteInfo route = provider.mRoutes.remove(i);
if (DEBUG) {
Log.d(TAG, "Route removed: " + route);
}
mCallbackHandler.post(CallbackHandler.MSG_ROUTE_REMOVED, route);
}
// Notify provider changed.
if (DEBUG) {
Log.d(TAG, "Provider changed: " + provider);
}
mCallbackHandler.post(CallbackHandler.MSG_PROVIDER_CHANGED, provider);
}
}
private int updateRouteDescriptorAndNotify(RouteInfo route,
MediaRouteDescriptor routeDescriptor) {
int changes = route.maybeUpdateDescriptor(routeDescriptor);
if (changes != 0) {
if ((changes & RouteInfo.CHANGE_GENERAL) != 0) {
if (DEBUG) {
Log.d(TAG, "Route changed: " + route);
}
mCallbackHandler.post(
CallbackHandler.MSG_ROUTE_CHANGED, route);
}
if ((changes & RouteInfo.CHANGE_VOLUME) != 0) {
if (DEBUG) {
Log.d(TAG, "Route volume changed: " + route);
}
mCallbackHandler.post(
CallbackHandler.MSG_ROUTE_VOLUME_CHANGED, route);
}
if ((changes & RouteInfo.CHANGE_PRESENTATION_DISPLAY) != 0) {
if (DEBUG) {
Log.d(TAG, "Route presentation display changed: "
+ route);
}
mCallbackHandler.post(CallbackHandler.
MSG_ROUTE_PRESENTATION_DISPLAY_CHANGED, route);
}
}
return changes;
}
private String assignRouteUniqueId(ProviderInfo provider, String routeDescriptorId) {
// Although route descriptor ids are unique within a provider, it's
// possible for there to be two providers with the same package name.
// Therefore we must dedupe the composite id.
String componentName = provider.getComponentName().flattenToShortString();
String uniqueId = componentName + ":" + routeDescriptorId;
if (findRouteByUniqueId(uniqueId) < 0) {
mUniqueIdMap.put(new Pair(componentName, routeDescriptorId), uniqueId);
return uniqueId;
}
Log.w(TAG, "Either " + routeDescriptorId + " isn't unique in " + componentName
+ " or we're trying to assign a unique ID for an already added route");
for (int i = 2; ; i++) {
String newUniqueId = String.format(Locale.US, "%s_%d", uniqueId, i);
if (findRouteByUniqueId(newUniqueId) < 0) {
mUniqueIdMap.put(new Pair(componentName, routeDescriptorId), newUniqueId);
return newUniqueId;
}
}
}
private int findRouteByUniqueId(String uniqueId) {
final int count = mRoutes.size();
for (int i = 0; i < count; i++) {
if (mRoutes.get(i).mUniqueId.equals(uniqueId)) {
return i;
}
}
return -1;
}
private String getUniqueId(ProviderInfo provider, String routeDescriptorId) {
String componentName = provider.getComponentName().flattenToShortString();
return mUniqueIdMap.get(new Pair(componentName, routeDescriptorId));
}
private void updateSelectedRouteIfNeeded(boolean selectedRouteDescriptorChanged) {
// Update default route.
if (mDefaultRoute != null && !isRouteSelectable(mDefaultRoute)) {
Log.i(TAG, "Clearing the default route because it "
+ "is no longer selectable: " + mDefaultRoute);
mDefaultRoute = null;
}
if (mDefaultRoute == null && !mRoutes.isEmpty()) {
for (RouteInfo route : mRoutes) {
if (isSystemDefaultRoute(route) && isRouteSelectable(route)) {
mDefaultRoute = route;
Log.i(TAG, "Found default route: " + mDefaultRoute);
break;
}
}
}
// Update selected route.
if (mSelectedRoute != null && !isRouteSelectable(mSelectedRoute)) {
Log.i(TAG, "Unselecting the current route because it "
+ "is no longer selectable: " + mSelectedRoute);
setSelectedRouteInternal(null,
MediaRouter.UNSELECT_REASON_UNKNOWN);
}
if (mSelectedRoute == null) {
// Choose a new route.
// This will have the side-effect of updating the playback info when
// the new route is selected.
setSelectedRouteInternal(chooseFallbackRoute(),
MediaRouter.UNSELECT_REASON_UNKNOWN);
} else if (selectedRouteDescriptorChanged) {
// In case the selected route is a route group, select/unselect route controllers
// for the added/removed route members.
if (mSelectedRoute instanceof RouteGroup) {
List routes = ((RouteGroup) mSelectedRoute).getRoutes();
// Build a set of descriptor IDs for the new route group.
Set idSet = new HashSet();
for (RouteInfo route : routes) {
idSet.add(route.mDescriptorId);
}
// Unselect route controllers for the removed routes.
Iterator> iter =
mRouteControllerMap.entrySet().iterator();
while (iter.hasNext()) {
Map.Entry entry = iter.next();
if (!idSet.contains(entry.getKey())) {
RouteController controller = entry.getValue();
controller.onUnselect();
controller.onRelease();
iter.remove();
}
}
// Select route controllers for the added routes.
for (RouteInfo route : routes) {
if (!mRouteControllerMap.containsKey(route.mDescriptorId)) {
RouteController controller = route.getProviderInstance()
.onCreateRouteController(route.mDescriptorId);
controller.onSelect();
mRouteControllerMap.put(route.mDescriptorId, controller);
}
}
}
// Update the playback info because the properties of the route have changed.
updatePlaybackInfoFromSelectedRoute();
}
}
RouteInfo chooseFallbackRoute() {
// When the current route is removed or no longer selectable,
// we want to revert to a live audio route if there is
// one (usually Bluetooth A2DP). Failing that, use
// the default route.
for (RouteInfo route : mRoutes) {
if (route != mDefaultRoute
&& isSystemLiveAudioOnlyRoute(route)
&& isRouteSelectable(route)) {
return route;
}
}
return mDefaultRoute;
}
private boolean isSystemLiveAudioOnlyRoute(RouteInfo route) {
return route.getProviderInstance() == mSystemProvider
&& route.supportsControlCategory(MediaControlIntent.CATEGORY_LIVE_AUDIO)
&& !route.supportsControlCategory(MediaControlIntent.CATEGORY_LIVE_VIDEO);
}
private boolean isRouteSelectable(RouteInfo route) {
// This tests whether the route is still valid and enabled.
// The route descriptor field is set to null when the route is removed.
return route.mDescriptor != null && route.mEnabled;
}
private boolean isSystemDefaultRoute(RouteInfo route) {
return route.getProviderInstance() == mSystemProvider
&& route.mDescriptorId.equals(
SystemMediaRouteProvider.DEFAULT_ROUTE_ID);
}
private void setSelectedRouteInternal(RouteInfo route, int unselectReason) {
if (mSelectedRoute != route) {
if (mSelectedRoute != null) {
if (DEBUG) {
Log.d(TAG, "Route unselected: " + mSelectedRoute + " reason: "
+ unselectReason);
}
mCallbackHandler.post(CallbackHandler.MSG_ROUTE_UNSELECTED, mSelectedRoute,
unselectReason);
if (mSelectedRouteController != null) {
mSelectedRouteController.onUnselect(unselectReason);
mSelectedRouteController.onRelease();
mSelectedRouteController = null;
}
if (!mRouteControllerMap.isEmpty()) {
for (RouteController controller : mRouteControllerMap.values()) {
controller.onUnselect(unselectReason);
controller.onRelease();
}
mRouteControllerMap.clear();
}
}
mSelectedRoute = route;
if (mSelectedRoute != null) {
mSelectedRouteController = route.getProviderInstance().onCreateRouteController(
route.mDescriptorId);
if (mSelectedRouteController != null) {
mSelectedRouteController.onSelect();
}
if (DEBUG) {
Log.d(TAG, "Route selected: " + mSelectedRoute);
}
mCallbackHandler.post(CallbackHandler.MSG_ROUTE_SELECTED, mSelectedRoute);
if (mSelectedRoute instanceof RouteGroup) {
List routes = ((RouteGroup) mSelectedRoute).getRoutes();
mRouteControllerMap.clear();
for (RouteInfo r : routes) {
RouteController controller = r.getProviderInstance()
.onCreateRouteController(r.mDescriptorId);
controller.onSelect();
mRouteControllerMap.put(r.mDescriptorId, controller);
}
}
}
updatePlaybackInfoFromSelectedRoute();
}
}
@Override
public RouteInfo getSystemRouteByDescriptorId(String id) {
int providerIndex = findProviderInfo(mSystemProvider);
if (providerIndex >= 0) {
ProviderInfo provider = mProviders.get(providerIndex);
int routeIndex = provider.findRouteByDescriptorId(id);
if (routeIndex >= 0) {
return provider.mRoutes.get(routeIndex);
}
}
return null;
}
public void addRemoteControlClient(Object rcc) {
int index = findRemoteControlClientRecord(rcc);
if (index < 0) {
RemoteControlClientRecord record = new RemoteControlClientRecord(rcc);
mRemoteControlClients.add(record);
}
}
public void removeRemoteControlClient(Object rcc) {
int index = findRemoteControlClientRecord(rcc);
if (index >= 0) {
RemoteControlClientRecord record = mRemoteControlClients.remove(index);
record.disconnect();
}
}
public void setMediaSession(Object session) {
if (mMediaSession != null) {
mMediaSession.clearVolumeHandling();
}
if (session == null) {
mMediaSession = null;
} else {
mMediaSession = new MediaSessionRecord(session);
updatePlaybackInfoFromSelectedRoute();
}
}
public void setMediaSessionCompat(final MediaSessionCompat session) {
mCompatSession = session;
if (android.os.Build.VERSION.SDK_INT >= 21) {
setMediaSession(session != null ? session.getMediaSession() : null);
} else if (android.os.Build.VERSION.SDK_INT >= 14) {
if (mRccMediaSession != null) {
removeRemoteControlClient(mRccMediaSession.getRemoteControlClient());
mRccMediaSession.removeOnActiveChangeListener(mSessionActiveListener);
}
mRccMediaSession = session;
if (session != null) {
session.addOnActiveChangeListener(mSessionActiveListener);
if (session.isActive()) {
addRemoteControlClient(session.getRemoteControlClient());
}
}
}
}
public MediaSessionCompat.Token getMediaSessionToken() {
if (mMediaSession != null) {
return mMediaSession.getToken();
} else if (mCompatSession != null) {
return mCompatSession.getSessionToken();
}
return null;
}
private int findRemoteControlClientRecord(Object rcc) {
final int count = mRemoteControlClients.size();
for (int i = 0; i < count; i++) {
RemoteControlClientRecord record = mRemoteControlClients.get(i);
if (record.getRemoteControlClient() == rcc) {
return i;
}
}
return -1;
}
private void updatePlaybackInfoFromSelectedRoute() {
if (mSelectedRoute != null) {
mPlaybackInfo.volume = mSelectedRoute.getVolume();
mPlaybackInfo.volumeMax = mSelectedRoute.getVolumeMax();
mPlaybackInfo.volumeHandling = mSelectedRoute.getVolumeHandling();
mPlaybackInfo.playbackStream = mSelectedRoute.getPlaybackStream();
mPlaybackInfo.playbackType = mSelectedRoute.getPlaybackType();
final int count = mRemoteControlClients.size();
for (int i = 0; i < count; i++) {
RemoteControlClientRecord record = mRemoteControlClients.get(i);
record.updatePlaybackInfo();
}
if (mMediaSession != null) {
if (mSelectedRoute == getDefaultRoute()) {
// Local route
mMediaSession.clearVolumeHandling();
} else {
@VolumeProviderCompat.ControlType int controlType =
VolumeProviderCompat.VOLUME_CONTROL_FIXED;
if (mPlaybackInfo.volumeHandling
== MediaRouter.RouteInfo.PLAYBACK_VOLUME_VARIABLE) {
controlType = VolumeProviderCompat.VOLUME_CONTROL_ABSOLUTE;
}
mMediaSession.configureVolume(controlType, mPlaybackInfo.volumeMax,
mPlaybackInfo.volume);
}
}
} else {
if (mMediaSession != null) {
mMediaSession.clearVolumeHandling();
}
}
}
private final class ProviderCallback extends MediaRouteProvider.Callback {
@Override
public void onDescriptorChanged(MediaRouteProvider provider,
MediaRouteProviderDescriptor descriptor) {
updateProviderDescriptor(provider, descriptor);
}
}
private final class MediaSessionRecord {
private final MediaSessionCompat mMsCompat;
private @VolumeProviderCompat.ControlType int mControlType;
private int mMaxVolume;
private VolumeProviderCompat mVpCompat;
public MediaSessionRecord(Object mediaSession) {
mMsCompat = MediaSessionCompat.obtain(mApplicationContext, mediaSession);
}
public void configureVolume(@VolumeProviderCompat.ControlType int controlType,
int max, int current) {
if (mVpCompat != null && controlType == mControlType && max == mMaxVolume) {
// If we haven't changed control type or max just set the
// new current volume
mVpCompat.setCurrentVolume(current);
} else {
// Otherwise create a new provider and update
mVpCompat = new VolumeProviderCompat(controlType, max, current) {
@Override
public void onSetVolumeTo(final int volume) {
mCallbackHandler.post(new Runnable() {
@Override
public void run() {
if (mSelectedRoute != null) {
mSelectedRoute.requestSetVolume(volume);
}
}
});
}
@Override
public void onAdjustVolume(final int direction) {
mCallbackHandler.post(new Runnable() {
@Override
public void run() {
if (mSelectedRoute != null) {
mSelectedRoute.requestUpdateVolume(direction);
}
}
});
}
};
mMsCompat.setPlaybackToRemote(mVpCompat);
}
}
public void clearVolumeHandling() {
mMsCompat.setPlaybackToLocal(mPlaybackInfo.playbackStream);
mVpCompat = null;
}
public MediaSessionCompat.Token getToken() {
return mMsCompat.getSessionToken();
}
}
private final class RemoteControlClientRecord
implements RemoteControlClientCompat.VolumeCallback {
private final RemoteControlClientCompat mRccCompat;
private boolean mDisconnected;
public RemoteControlClientRecord(Object rcc) {
mRccCompat = RemoteControlClientCompat.obtain(mApplicationContext, rcc);
mRccCompat.setVolumeCallback(this);
updatePlaybackInfo();
}
public Object getRemoteControlClient() {
return mRccCompat.getRemoteControlClient();
}
public void disconnect() {
mDisconnected = true;
mRccCompat.setVolumeCallback(null);
}
public void updatePlaybackInfo() {
mRccCompat.setPlaybackInfo(mPlaybackInfo);
}
@Override
public void onVolumeSetRequest(int volume) {
if (!mDisconnected && mSelectedRoute != null) {
mSelectedRoute.requestSetVolume(volume);
}
}
@Override
public void onVolumeUpdateRequest(int direction) {
if (!mDisconnected && mSelectedRoute != null) {
mSelectedRoute.requestUpdateVolume(direction);
}
}
}
private final class CallbackHandler extends Handler {
private final ArrayList mTempCallbackRecords =
new ArrayList();
private static final int MSG_TYPE_MASK = 0xff00;
private static final int MSG_TYPE_ROUTE = 0x0100;
private static final int MSG_TYPE_PROVIDER = 0x0200;
public static final int MSG_ROUTE_ADDED = MSG_TYPE_ROUTE | 1;
public static final int MSG_ROUTE_REMOVED = MSG_TYPE_ROUTE | 2;
public static final int MSG_ROUTE_CHANGED = MSG_TYPE_ROUTE | 3;
public static final int MSG_ROUTE_VOLUME_CHANGED = MSG_TYPE_ROUTE | 4;
public static final int MSG_ROUTE_PRESENTATION_DISPLAY_CHANGED = MSG_TYPE_ROUTE | 5;
public static final int MSG_ROUTE_SELECTED = MSG_TYPE_ROUTE | 6;
public static final int MSG_ROUTE_UNSELECTED = MSG_TYPE_ROUTE | 7;
public static final int MSG_PROVIDER_ADDED = MSG_TYPE_PROVIDER | 1;
public static final int MSG_PROVIDER_REMOVED = MSG_TYPE_PROVIDER | 2;
public static final int MSG_PROVIDER_CHANGED = MSG_TYPE_PROVIDER | 3;
public void post(int msg, Object obj) {
obtainMessage(msg, obj).sendToTarget();
}
public void post(int msg, Object obj, int arg) {
Message message = obtainMessage(msg, obj);
message.arg1 = arg;
message.sendToTarget();
}
@Override
public void handleMessage(Message msg) {
final int what = msg.what;
final Object obj = msg.obj;
final int arg = msg.arg1;
// Synchronize state with the system media router.
syncWithSystemProvider(what, obj);
// Invoke all registered callbacks.
// Build a list of callbacks before invoking them in case callbacks
// are added or removed during dispatch.
try {
for (int i = mRouters.size(); --i >= 0; ) {
MediaRouter router = mRouters.get(i).get();
if (router == null) {
mRouters.remove(i);
} else {
mTempCallbackRecords.addAll(router.mCallbackRecords);
}
}
final int callbackCount = mTempCallbackRecords.size();
for (int i = 0; i < callbackCount; i++) {
invokeCallback(mTempCallbackRecords.get(i), what, obj, arg);
}
} finally {
mTempCallbackRecords.clear();
}
}
private void syncWithSystemProvider(int what, Object obj) {
switch (what) {
case MSG_ROUTE_ADDED:
mSystemProvider.onSyncRouteAdded((RouteInfo)obj);
break;
case MSG_ROUTE_REMOVED:
mSystemProvider.onSyncRouteRemoved((RouteInfo)obj);
break;
case MSG_ROUTE_CHANGED:
mSystemProvider.onSyncRouteChanged((RouteInfo)obj);
break;
case MSG_ROUTE_SELECTED:
mSystemProvider.onSyncRouteSelected((RouteInfo)obj);
break;
}
}
private void invokeCallback(CallbackRecord record, int what, Object obj, int arg) {
final MediaRouter router = record.mRouter;
final MediaRouter.Callback callback = record.mCallback;
switch (what & MSG_TYPE_MASK) {
case MSG_TYPE_ROUTE: {
final RouteInfo route = (RouteInfo)obj;
if (!record.filterRouteEvent(route)) {
break;
}
switch (what) {
case MSG_ROUTE_ADDED:
callback.onRouteAdded(router, route);
break;
case MSG_ROUTE_REMOVED:
callback.onRouteRemoved(router, route);
break;
case MSG_ROUTE_CHANGED:
callback.onRouteChanged(router, route);
break;
case MSG_ROUTE_VOLUME_CHANGED:
callback.onRouteVolumeChanged(router, route);
break;
case MSG_ROUTE_PRESENTATION_DISPLAY_CHANGED:
callback.onRoutePresentationDisplayChanged(router, route);
break;
case MSG_ROUTE_SELECTED:
callback.onRouteSelected(router, route);
break;
case MSG_ROUTE_UNSELECTED:
callback.onRouteUnselected(router, route, arg);
break;
}
break;
}
case MSG_TYPE_PROVIDER: {
final ProviderInfo provider = (ProviderInfo)obj;
switch (what) {
case MSG_PROVIDER_ADDED:
callback.onProviderAdded(router, provider);
break;
case MSG_PROVIDER_REMOVED:
callback.onProviderRemoved(router, provider);
break;
case MSG_PROVIDER_CHANGED:
callback.onProviderChanged(router, provider);
break;
}
}
}
}
}
}
}