Skip to content

Most visited

Recently visited

navigation

MediaRouteDescriptor.Builder

public static final class MediaRouteDescriptor.Builder
extends Object

java.lang.Object
   ↳ android.support.v7.media.MediaRouteDescriptor.Builder


Builder for media route descriptors.

Summary

Public constructors

MediaRouteDescriptor.Builder(String id, String name)

Creates a media route descriptor builder.

MediaRouteDescriptor.Builder(MediaRouteDescriptor descriptor)

Creates a media route descriptor builder whose initial contents are copied from an existing descriptor.

Public methods

MediaRouteDescriptor.Builder addControlFilter(IntentFilter filter)

Adds a media control intent filter for the route.

MediaRouteDescriptor.Builder addControlFilters(Collection<IntentFilter> filters)

Adds a list of media control intent filters for the route.

MediaRouteDescriptor build()

Builds the media route descriptor.

MediaRouteDescriptor.Builder setCanDisconnect(boolean canDisconnect)

Sets whether the route can be disconnected without stopping playback.

MediaRouteDescriptor.Builder setConnecting(boolean connecting)

This method was deprecated in API level 23.1.0. Use setConnectionState(int) instead.

MediaRouteDescriptor.Builder setConnectionState(int connectionState)

Sets the route's connection state.

MediaRouteDescriptor.Builder setDescription(String description)

Sets the user-visible description of the route.

MediaRouteDescriptor.Builder setDeviceType(int deviceType)

Sets the route's receiver device type.

MediaRouteDescriptor.Builder setEnabled(boolean enabled)

Sets whether the route is enabled.

MediaRouteDescriptor.Builder setExtras(Bundle extras)

Sets a bundle of extras for this route descriptor.

MediaRouteDescriptor.Builder setIconUri(Uri iconUri)

Sets the URI of the icon representing this route.

MediaRouteDescriptor.Builder setId(String id)

Sets the unique id of the route.

MediaRouteDescriptor.Builder setName(String name)

Sets the user-visible name of the route.

MediaRouteDescriptor.Builder setPlaybackStream(int playbackStream)

Sets the route's playback stream.

MediaRouteDescriptor.Builder setPlaybackType(int playbackType)

Sets the route's playback type.

MediaRouteDescriptor.Builder setPresentationDisplayId(int presentationDisplayId)

Sets the route's presentation display id, or -1 if none.

MediaRouteDescriptor.Builder setSettingsActivity(IntentSender is)

Sets an intent sender for launching the settings activity for this route.

MediaRouteDescriptor.Builder setVolume(int volume)

Sets the route's current volume, or 0 if unknown.

MediaRouteDescriptor.Builder setVolumeHandling(int volumeHandling)

Sets the route's volume handling.

MediaRouteDescriptor.Builder setVolumeMax(int volumeMax)

Sets the route's maximum volume, or 0 if unknown.

Inherited methods

From class java.lang.Object

Public constructors

MediaRouteDescriptor.Builder

added in version 22.0.0
MediaRouteDescriptor.Builder (String id, 
                String name)

Creates a media route descriptor builder.

Parameters
id String: The unique id of the route.

name String: The user-visible name of the route.

MediaRouteDescriptor.Builder

added in version 22.0.0
MediaRouteDescriptor.Builder (MediaRouteDescriptor descriptor)

Creates a media route descriptor builder whose initial contents are copied from an existing descriptor.

Parameters
descriptor MediaRouteDescriptor

Public methods

addControlFilter

added in version 22.0.0
MediaRouteDescriptor.Builder addControlFilter (IntentFilter filter)

Adds a media control intent filter for the route.

Parameters
filter IntentFilter

Returns
MediaRouteDescriptor.Builder

addControlFilters

added in version 22.0.0
MediaRouteDescriptor.Builder addControlFilters (Collection<IntentFilter> filters)

Adds a list of media control intent filters for the route.

Parameters
filters Collection

Returns
MediaRouteDescriptor.Builder

setCanDisconnect

added in version 22.0.0
MediaRouteDescriptor.Builder setCanDisconnect (boolean canDisconnect)

Sets whether the route can be disconnected without stopping playback.

Parameters
canDisconnect boolean

Returns
MediaRouteDescriptor.Builder

setConnecting

added in version 22.0.0
MediaRouteDescriptor.Builder setConnecting (boolean connecting)

This method was deprecated in API level 23.1.0.
Use setConnectionState(int) instead.

Sets whether the route is in the process of connecting and is not yet ready for use.

Parameters
connecting boolean

Returns
MediaRouteDescriptor.Builder

setConnectionState

added in version 23.1.0
MediaRouteDescriptor.Builder setConnectionState (int connectionState)

Sets the route's connection state.

Parameters
connectionState int: The connection state of the route: CONNECTION_STATE_DISCONNECTED, CONNECTION_STATE_CONNECTING, or CONNECTION_STATE_CONNECTED.

Returns
MediaRouteDescriptor.Builder

setDescription

added in version 22.0.0
MediaRouteDescriptor.Builder setDescription (String description)

Sets 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.

Parameters
description String

Returns
MediaRouteDescriptor.Builder

setDeviceType

added in version 23.1.0
MediaRouteDescriptor.Builder setDeviceType (int deviceType)

Sets the route's receiver device type.

Parameters
deviceType int: The receive device type of the route: DEVICE_TYPE_TV or DEVICE_TYPE_SPEAKER.

Returns
MediaRouteDescriptor.Builder

setEnabled

added in version 22.0.0
MediaRouteDescriptor.Builder setEnabled (boolean enabled)

Sets whether the route is enabled.

Disabled routes represent routes that a route provider knows about, such as paired Wifi Display receivers, but that are not currently available for use.

Parameters
enabled boolean

Returns
MediaRouteDescriptor.Builder

setExtras

added in version 22.0.0
MediaRouteDescriptor.Builder setExtras (Bundle extras)

Sets a bundle of extras for this route descriptor. The extras will be ignored by the media router but they may be used by applications.

Parameters
extras Bundle

Returns
MediaRouteDescriptor.Builder

setIconUri

added in version 23.1.0
MediaRouteDescriptor.Builder setIconUri (Uri iconUri)

Sets the URI of the icon representing this route.

This icon will be used in picker UIs if available.

The URI must be one of the following formats:

Parameters
iconUri Uri

Returns
MediaRouteDescriptor.Builder

setId

added in version 22.0.0
MediaRouteDescriptor.Builder setId (String id)

Sets the unique id of the route.

The route id associated with a route descriptor functions as a stable identifier for the route and must be unique among all routes offered by the provider.

Parameters
id String

Returns
MediaRouteDescriptor.Builder

setName

added in version 22.0.0
MediaRouteDescriptor.Builder setName (String name)

Sets 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.

Parameters
name String

Returns
MediaRouteDescriptor.Builder

setPlaybackStream

added in version 22.0.0
MediaRouteDescriptor.Builder setPlaybackStream (int playbackStream)

Sets the route's playback stream.

Parameters
playbackStream int

Returns
MediaRouteDescriptor.Builder

setPlaybackType

added in version 22.0.0
MediaRouteDescriptor.Builder setPlaybackType (int playbackType)

Sets the route's playback type.

Parameters
playbackType int: The playback type of the route: PLAYBACK_TYPE_LOCAL or PLAYBACK_TYPE_REMOTE.

Returns
MediaRouteDescriptor.Builder

setPresentationDisplayId

added in version 22.0.0
MediaRouteDescriptor.Builder setPresentationDisplayId (int presentationDisplayId)

Sets the route's presentation display id, or -1 if none.

Parameters
presentationDisplayId int

Returns
MediaRouteDescriptor.Builder

setSettingsActivity

added in version 22.0.0
MediaRouteDescriptor.Builder setSettingsActivity (IntentSender is)

Sets an intent sender for launching the settings activity for this route.

Parameters
is IntentSender

Returns
MediaRouteDescriptor.Builder

setVolume

added in version 22.0.0
MediaRouteDescriptor.Builder setVolume (int volume)

Sets the route's current volume, or 0 if unknown.

Parameters
volume int

Returns
MediaRouteDescriptor.Builder

setVolumeHandling

added in version 22.0.0
MediaRouteDescriptor.Builder setVolumeHandling (int volumeHandling)

Sets the route's volume handling.

Parameters
volumeHandling int: how volume is handled on the route: PLAYBACK_VOLUME_FIXED or PLAYBACK_VOLUME_VARIABLE.

Returns
MediaRouteDescriptor.Builder

setVolumeMax

added in version 22.0.0
MediaRouteDescriptor.Builder setVolumeMax (int volumeMax)

Sets the route's maximum volume, or 0 if unknown.

Parameters
volumeMax int

Returns
MediaRouteDescriptor.Builder

This site uses cookies to store your preferences for site-specific language and display options.

Get the latest Android developer news and tips that will help you find success on Google Play.

* Required Fields

Hooray!

Browse this site in ?

You requested a page in , but your language preference for this site is .

Would you like to change your language preference and browse this site in ? If you want to change your language preference later, use the language menu at the bottom of each page.

This class requires API level or higher

This doc is hidden because your selected API level for the documentation is . You can change the documentation API level with the selector above the left navigation.

For more information about specifying the API level your app requires, read Supporting Different Platform Versions.

Take a one-minute survey?
Help us improve Android tools and documentation.