MediaRouter

CALLBACK_FLAG_PERFORM_ACTIVE_SCAN

public static final int CALLBACK_FLAG_PERFORM_ACTIVE_SCAN

Flag for addCallback(int, 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.

Constant Value: 1 (0x00000001)

CALLBACK_FLAG_UNFILTERED_EVENTS

public static final int CALLBACK_FLAG_UNFILTERED_EVENTS

Flag for addCallback(int, Callback): Do not filter route events.

When this flag is specified, the callback will be invoked for event that affect any route even if they do not match the callback's filter.

Constant Value: 2 (0x00000002)

ROUTE_TYPE_LIVE_AUDIO

public static final int ROUTE_TYPE_LIVE_AUDIO

Route type flag for live audio.

A device that supports live audio routing will allow the media audio stream to be routed to supported destinations. This can include internal speakers or audio jacks on the device itself, A2DP devices, and more.

Once initiated this routing is transparent to the application. All audio played on the media stream will be routed to the selected destination.

Constant Value: 1 (0x00000001)

ROUTE_TYPE_LIVE_VIDEO

public static final int ROUTE_TYPE_LIVE_VIDEO

Route type flag for live video.

A device that supports live video routing will allow a mirrored version of the device's primary display or a customized Presentation to be routed to supported destinations.

Once initiated, display mirroring is transparent to the application. While remote routing is active the application may use a Presentation to replace the mirrored view on the external display with different content.

Constant Value: 2 (0x00000002)

ROUTE_TYPE_USER

public static final int ROUTE_TYPE_USER

Route type flag for application-specific usage.

Unlike other media route types, user routes are managed by the application. The MediaRouter will manage and dispatch events for user routes, but the application is expected to interpret the meaning of these events and perform the requested routing tasks.

Constant Value: 8388608 (0x00800000)

addCallback

public void addCallback (int types, 
                MediaRouter.Callback cb, 
                int flags)

Add a callback to listen to events about specific kinds of media routes. If the specified callback is already registered, its registration will be updated for any additional route types specified.

By default, the callback will only be invoked for events that affect routes that match the specified selector. The filtering may be disabled by specifying the CALLBACK_FLAG_UNFILTERED_EVENTS flag.

addCallback

public void addCallback (int types, 
                MediaRouter.Callback cb)

Add a callback to listen to events about specific kinds of media routes. If the specified callback is already registered, its registration will be updated for any additional route types specified.

This is a convenience method that has the same effect as calling addCallback(int, android.media.MediaRouter.Callback, int) without flags.

addUserRoute

public void addUserRoute (MediaRouter.UserRouteInfo info)

Add an app-specified route for media to the MediaRouter. App-specified route definitions are created using createUserRoute(android.media.MediaRouter.RouteCategory)

clearUserRoutes

public void clearUserRoutes ()

Remove all app-specified routes from the MediaRouter.

createRouteCategory

public MediaRouter.RouteCategory createRouteCategory (int nameResId, 
                boolean isGroupable)

Create a new route category. Each route must belong to a category.

createRouteCategory

public MediaRouter.RouteCategory createRouteCategory (CharSequence name, 
                boolean isGroupable)

Create a new route category. Each route must belong to a category.

createUserRoute

public MediaRouter.UserRouteInfo createUserRoute (MediaRouter.RouteCategory category)

Create a new user route that may be modified and registered for use by the application.

getCategoryAt

public MediaRouter.RouteCategory getCategoryAt (int index)

Return the category at the given index. Valid indices are in the range [0-getCategoryCount).

getCategoryCount

public int getCategoryCount ()

Return the number of categories currently represented by routes known to this MediaRouter.

getDefaultRoute

public MediaRouter.RouteInfo getDefaultRoute ()

Gets the default route for playing media content on the system.

The system always provides a default route.

getRouteAt

public MediaRouter.RouteInfo getRouteAt (int index)

Return the route at the specified index.

getRouteCount

public int getRouteCount ()

Return the number of routes currently known to this MediaRouter.

getSelectedRoute

public MediaRouter.RouteInfo getSelectedRoute (int type)

Return the currently selected route for any of the given types

removeCallback

public void removeCallback (MediaRouter.Callback cb)

Remove the specified callback. It will no longer receive events about media routing.

removeUserRoute

public void removeUserRoute (MediaRouter.UserRouteInfo info)

Remove an app-specified route for media from the MediaRouter.

selectRoute

public void selectRoute (int types, 
                MediaRouter.RouteInfo route)

Select the specified route to use for output of the given media types.

As API version 18, this function may be used to select any route. In prior versions, this function could only be used to select user routes and would ignore any attempt to select a system route.