belongs to Maven artifact com.android.support:mediarouter-v7:28.0.0-alpha1
MediaRouter
public
final
class
MediaRouter
extends Object
| java.lang.Object | |
| ↳ | android.support.v7.media.MediaRouter |
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 getInstance(Context). 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 send control requests to the route
to ask the route's destination to perform certain remote control functions
such as playing media.
See also 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.
Summary
Nested classes | |
|---|---|
class |
MediaRouter.Callback
Interface for receiving events about media routing changes. |
class |
MediaRouter.ControlRequestCallback
Callback which is invoked with the result of a media control request. |
class |
MediaRouter.ProviderInfo
Provides information about a media route provider. |
class |
MediaRouter.RouteInfo
Provides information about a media route. |
Public methods | |
|---|---|
void
|
addCallback(MediaRouteSelector selector, MediaRouter.Callback callback, int flags)
Registers a callback to discover routes that match the selector and to receive events when they change. |
void
|
addCallback(MediaRouteSelector selector, MediaRouter.Callback callback)
Registers a callback to discover routes that match the selector and to receive events when they change. |
void
|
addProvider(MediaRouteProvider providerInstance)
Registers a media route provider within this application process. |
void
|
addRemoteControlClient(Object remoteControlClient)
Adds a remote control client to enable remote control of the volume of the selected route. |
MediaRouter.RouteInfo
|
getBluetoothRoute()
Gets a bluetooth route for playing media content on the system. |
MediaRouter.RouteInfo
|
getDefaultRoute()
Gets the default route for playing media content on the system. |
static
MediaRouter
|
getInstance(Context context)
Gets an instance of the media router service associated with the context. |
MediaSessionCompat.Token
|
getMediaSessionToken()
|
List<MediaRouter.ProviderInfo>
|
getProviders()
Gets information about the |
List<MediaRouter.RouteInfo>
|
getRoutes()
Gets information about the |
MediaRouter.RouteInfo
|
getSelectedRoute()
Gets the currently selected route. |
boolean
|
isRouteAvailable(MediaRouteSelector selector, int flags)
Returns true if there is a route that matches the specified selector. |
void
|
removeCallback(MediaRouter.Callback callback)
Removes the specified callback. |
void
|
removeProvider(MediaRouteProvider providerInstance)
Unregisters a media route provider within this application process. |
void
|
removeRemoteControlClient(Object remoteControlClient)
Removes a remote control client. |
void
|
selectRoute(MediaRouter.RouteInfo route)
Selects the specified route. |
void
|
setMediaSession(Object mediaSession)
Sets the media session to enable remote control of the volume of the selected route. |
void
|
setMediaSessionCompat(MediaSessionCompat mediaSession)
Sets a compat media session to enable remote control of the volume of the selected route. |
void
|
unselect(int reason)
Unselects the current round and selects the default route instead. |
MediaRouter.RouteInfo
|
updateSelectedRoute(MediaRouteSelector selector)
Returns the selected route if it matches the specified selector, otherwise selects the default route and returns it. |
Inherited methods | |
|---|---|
From
class
java.lang.Object
| |
Constants
AVAILABILITY_FLAG_IGNORE_DEFAULT_ROUTE
int AVAILABILITY_FLAG_IGNORE_DEFAULT_ROUTE
Flag for isRouteAvailable(MediaRouteSelector, int): 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.
Constant Value: 1 (0x00000001)
AVAILABILITY_FLAG_REQUIRE_MATCH
int AVAILABILITY_FLAG_REQUIRE_MATCH
Flag for isRouteAvailable(MediaRouteSelector, int): Require an actual route to be matched.
If this flag is not set, then isRouteAvailable(MediaRouteSelector, int) 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
low-RAM devices.
If this flag is set, then isRouteAvailable(MediaRouteSelector, int) will only return true if
a matching route has actually been discovered.
Constant Value: 2 (0x00000002)
CALLBACK_FLAG_FORCE_DISCOVERY
int CALLBACK_FLAG_FORCE_DISCOVERY
Flag for addCallback(MediaRouteSelector, MediaRouter.Callback): Request passive route discovery while this
callback is registered, 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 CALLBACK_FLAG_REQUEST_DISCOVERY instead to avoid
performing passive discovery on these devices altogether. Refer to
addCallback for details.
See also:
Constant Value: 8 (0x00000008)
CALLBACK_FLAG_PERFORM_ACTIVE_SCAN
int CALLBACK_FLAG_PERFORM_ACTIVE_SCAN
Flag for addCallback(MediaRouteSelector, MediaRouter.Callback): 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 CALLBACK_FLAG_REQUEST_DISCOVERY but performing
active scans is much more expensive than a normal discovery request.
See also:
Constant Value: 1 (0x00000001)
CALLBACK_FLAG_REQUEST_DISCOVERY
int CALLBACK_FLAG_REQUEST_DISCOVERY
Flag for addCallback(MediaRouteSelector, MediaRouter.Callback): Request passive route discovery while this
callback is registered, except on 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 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
activity's onStart
method and remove it in the onStop method.
The MediaRouteDiscoveryFragment fragment may
also be used for this purpose.
On low-RAM devices this flag
will be ignored. Refer to
addCallback for details.
See also:
Constant Value: 4 (0x00000004)
CALLBACK_FLAG_UNFILTERED_EVENTS
int CALLBACK_FLAG_UNFILTERED_EVENTS
Flag for addCallback(MediaRouteSelector, MediaRouter.Callback): 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.
Constant Value: 2 (0x00000002)