Added in API level 16

Summary: Inherited Constants | Methods | Inherited Methods

MediaRouter.UserRouteInfo

---

Kotlin |Java

public static class MediaRouter.UserRouteInfo
extends MediaRouter.RouteInfo

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

---

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

See also:

• MediaRouter.RouteInfo

Summary

Inherited constants

From class android.media.MediaRouter.RouteInfo int DEVICE_TYPE_BLUETOOTH A receiver device type of the route indicating the presentation of the media is happening on a bluetooth device such as a bluetooth speaker. int DEVICE_TYPE_SPEAKER A receiver device type of the route indicating the presentation of the media is happening on a speaker. int DEVICE_TYPE_TV A receiver device type of the route indicating the presentation of the media is happening on a TV. int DEVICE_TYPE_UNKNOWN The default receiver device type of the route indicating the type is unknown. int PLAYBACK_TYPE_LOCAL 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. int PLAYBACK_TYPE_REMOTE 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. int PLAYBACK_VOLUME_FIXED Playback information indicating the playback volume is fixed, i.e. it cannot be controlled from this object. int PLAYBACK_VOLUME_VARIABLE Playback information indicating the playback volume is variable and can be controlled from this object.

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(CharSequence name) Set the user-visible name of this route.
void	setName(int resId) 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" (RouteInfo.PLAYBACK_TYPE_LOCAL) or "remote" (RouteInfo.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 (RouteInfo.PLAYBACK_VOLUME_FIXED) or can modified (RouteInfo.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).

Inherited methods
From class android.media.MediaRouter.RouteInfo MediaRouter.RouteCategory getCategory() CharSequence getDescription() Gets the user-visible description of the route. int getDeviceType() Gets the type of the receiver device associated with this route. MediaRouter.RouteGroup getGroup() Drawable getIconDrawable() Get the icon representing this route. CharSequence getName(Context context) Return the properly localized/resource user-visible name of this route. CharSequence getName() Gets the user-visible name of the route. int getPlaybackStream() int getPlaybackType() Display getPresentationDisplay() Gets the Display that should be used by the application to show a Presentation on an external display when this route is selected. CharSequence getStatus() int getSupportedTypes() Object getTag() int getVolume() Return the current volume for this route. int getVolumeHandling() int getVolumeMax() boolean isConnecting() Returns true if the route is in the process of connecting and is not yet ready for use. boolean isEnabled() Returns true if this route is enabled and may be selected. void requestSetVolume(int volume) Request a volume change for this route. void requestUpdateVolume(int direction) Request an incremental volume update for this route. void setTag(Object tag) Set an application-specific tag object for this route. String toString() Returns a string representation of the object.
From class java.lang.Object Object clone() Creates and returns a copy of this object. boolean equals(Object obj) Indicates whether some other object is "equal to" this one. void finalize() Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. final Class<?> getClass() Returns the runtime class of this Object. int hashCode() Returns a hash code value for the object. final void notify() Wakes up a single thread that is waiting on this object's monitor. final void notifyAll() Wakes up all threads that are waiting on this object's monitor. String toString() Returns a string representation of the object. final void wait(long timeoutMillis, int nanos) Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed. final void wait(long timeoutMillis) Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed. final void wait() Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

Public methods

getRemoteControlClient

Added in API level 16

public RemoteControlClient getRemoteControlClient ()

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

Returns
RemoteControlClient	the RemoteControlClient associated with this route

See also:

• setRemoteControlClient(RemoteControlClient)

requestSetVolume

Added in API level 16

public void requestSetVolume (int volume)

Request a volume change for this route.

Parameters
volume	int: value between 0 and getVolumeMax

requestUpdateVolume

Added in API level 16

public void requestUpdateVolume (int direction)

Request an incremental volume update for this route.

Parameters
direction	int: Delta to apply to the current volume

setDescription

Added in API level 18

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	CharSequence: The description of the route, or null if none.

setIconDrawable

Added in API level 16

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	Drawable: icon drawable to use to represent this route

setIconResource

Added in API level 16

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	int: Resource ID of an icon drawable to use to represent this route

setName

Added in API level 16

public void setName (CharSequence name)

Set the user-visible name of this route.

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

setName

Added in API level 16

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	int: Resource ID of the name to display to the user to describe this route

setPlaybackStream

Added in API level 16

public void setPlaybackStream (int stream)

Defines over what stream type the media is presented.

setPlaybackType

Added in API level 16

public void setPlaybackType (int type)

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

Parameters
type	int: Value is MediaRouter.RouteInfo.PLAYBACK_TYPE_LOCAL, or MediaRouter.RouteInfo.PLAYBACK_TYPE_REMOTE

setRemoteControlClient

Added in API level 16

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 AudioManager.registerRemoteControlClient(RemoteControlClient).

Parameters
rcc	RemoteControlClient: RemoteControlClient associated with this route

setStatus

Added in API level 16

public void setStatus (CharSequence status)

Set the current user-visible status for this route.

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

setVolume

Added in API level 16

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.

setVolumeCallback

Added in API level 16

public void setVolumeCallback (MediaRouter.VolumeCallback vcb)

Set a callback to be notified of volume update requests

setVolumeHandling

Added in API level 16

public void setVolumeHandling (int volumeHandling)

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

Parameters
volumeHandling	int: Value is MediaRouter.RouteInfo.PLAYBACK_VOLUME_FIXED, or MediaRouter.RouteInfo.PLAYBACK_VOLUME_VARIABLE

setVolumeMax

Added in API level 16

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.