Please note that the contents of this offline web site may be out of date. To access the most recent documentation visit the online version .
Note that links that point to online resources are green in color and will open in a new window.
We would love it if you could give us feedback about this material by filling this form (You have to be online to fill it)
Android APIs
public static class

MediaRouter.UserRouteInfo

extends MediaRouter.RouteInfo
java.lang.Object
   ↳ android.media.MediaRouter.RouteInfo
     ↳ android.media.MediaRouter.UserRouteInfo

Class Overview

Information about a route that the application may define and modify. A user route defaults to PLAYBACK_TYPE_REMOTE and PLAYBACK_VOLUME_FIXED .

See Also

Summary

[Expand]
Inherited Constants
From class android.media.MediaRouter.RouteInfo
Public Methods
RemoteControlClient getRemoteControlClient ()
Retrieve the RemoteControlClient associated with this route, if one has been set.
void requestSetVolume (int volume)
Request a volume change for this route.
void requestUpdateVolume (int direction)
Request an incremental volume update for this route.
void setDescription ( CharSequence description)
Set the user-visible description of this route.
void setIconDrawable ( Drawable icon)
Set an icon that will be used to represent this route.
void setIconResource (int resId)
Set an icon that will be used to represent this route.
void setName (int resId)
Set the user-visible name of this route.
void setName ( CharSequence name)
Set the user-visible name of this route.
void setPlaybackStream (int stream)
Defines over what stream type the media is presented.
void setPlaybackType (int type)
Defines whether playback associated with this route is "local" ( PLAYBACK_TYPE_LOCAL ) or "remote" ( PLAYBACK_TYPE_REMOTE ).
void setRemoteControlClient ( RemoteControlClient rcc)
Set the RemoteControlClient responsible for reporting playback info for this user route.
void setStatus ( CharSequence status)
Set the current user-visible status for this route.
void setVolume (int volume)
Defines at what volume the playback associated with this route is performed (for user feedback purposes).
void setVolumeCallback ( MediaRouter.VolumeCallback vcb)
Set a callback to be notified of volume update requests
void setVolumeHandling (int volumeHandling)
Defines whether volume for the playback associated with this route is fixed ( PLAYBACK_VOLUME_FIXED ) or can modified ( PLAYBACK_VOLUME_VARIABLE ).
void setVolumeMax (int volumeMax)
Defines the maximum volume at which the playback associated with this route is performed (for user feedback purposes).
[Expand]
Inherited Methods
From class android.media.MediaRouter.RouteInfo
From class java.lang.Object

Public Methods

public RemoteControlClient getRemoteControlClient ()

Retrieve the RemoteControlClient associated with this route, if one has been set.

Returns
  • the RemoteControlClient associated with this route
See Also

public void requestSetVolume (int volume)

Request a volume change for this route.

Parameters
volume value between 0 and getVolumeMax

public void requestUpdateVolume (int direction)

Request an incremental volume update for this route.

Parameters
direction Delta to apply to the current volume

public void setDescription ( CharSequence description)

Set the user-visible description of this 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.

Parameters
description The description of the route, or null if none.

public void setIconDrawable ( Drawable icon)

Set an icon that will be used to represent this route. The system may use this icon in picker UIs or similar.

Parameters
icon icon drawable to use to represent this route

public void setIconResource (int resId)

Set an icon that will be used to represent this route. The system may use this icon in picker UIs or similar.

Parameters
resId Resource ID of an icon drawable to use to represent this route

public void setName (int resId)

Set the user-visible name of this route.

The route name identifies the destination represented by the route. It may be a user-supplied name, an alias, or device serial number.

Parameters
resId Resource ID of the name to display to the user to describe this route

public void setName ( CharSequence name)

Set the user-visible name of this route.

Parameters
name Name to display to the user to describe this route

public void setPlaybackStream (int stream)

Defines over what stream type the media is presented.

public void setPlaybackType (int type)

Defines whether playback associated with this route is "local" ( PLAYBACK_TYPE_LOCAL ) or "remote" ( PLAYBACK_TYPE_REMOTE ).

public void setRemoteControlClient ( RemoteControlClient rcc)

Set the RemoteControlClient responsible for reporting playback info for this user route.

If this route manages remote playback, the data exposed by this RemoteControlClient will be used to reflect and update information such as route volume info in related UIs.

The RemoteControlClient must have been previously registered with registerRemoteControlClient(RemoteControlClient) .

Parameters
rcc RemoteControlClient associated with this route

public void setStatus ( CharSequence status)

Set the current user-visible status for this route.

Parameters
status Status to display to the user to describe what the endpoint of this route is currently doing

public void setVolume (int volume)

Defines at what volume the playback associated with this route is performed (for user feedback purposes). This information is only used when the playback is not local.

public void setVolumeCallback ( MediaRouter.VolumeCallback vcb)

Set a callback to be notified of volume update requests

public void setVolumeHandling (int volumeHandling)

Defines whether volume for the playback associated with this route is fixed ( PLAYBACK_VOLUME_FIXED ) or can modified ( PLAYBACK_VOLUME_VARIABLE ).

public void setVolumeMax (int volumeMax)

Defines the maximum volume at which the playback associated with this route is performed (for user feedback purposes). This information is only used when the playback is not local.