# Print output for @column tags ?> MediaRoute2Info.Builder - Android SDK | Android Developers

Most visited

Recently visited

MediaRoute2Info.Builder

public static final class MediaRoute2Info.Builder
extends Object

java.lang.Object
   ↳ android.media.MediaRoute2Info.Builder


Builder for media route info.

Summary

Public constructors

Builder(String id, CharSequence name)

Constructor for builder to create MediaRoute2Info.

Builder(MediaRoute2Info routeInfo)

Constructor for builder to create MediaRoute2Info with existing MediaRoute2Info instance.

Public methods

MediaRoute2Info.Builder addFeature(String feature)

Adds a feature for the route.

MediaRoute2Info.Builder addFeatures(Collection<String> features)

Adds features for the route.

MediaRoute2Info build()

Builds the media route info.

MediaRoute2Info.Builder clearFeatures()

Clears the features of the route.

MediaRoute2Info.Builder setClientPackageName(String packageName)

Sets the package name of the app using the route.

MediaRoute2Info.Builder setConnectionState(int connectionState)

Sets the route's connection state.

MediaRoute2Info.Builder setDescription(CharSequence description)

Sets the user-visible description of the route.

MediaRoute2Info.Builder setExtras(Bundle extras)

Sets a bundle of extras for the route.

MediaRoute2Info.Builder setIconUri(Uri iconUri)

Sets the URI of the icon representing this route.

MediaRoute2Info.Builder setVolume(int volume)

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

MediaRoute2Info.Builder setVolumeHandling(int volumeHandling)

Sets the route's volume handling.

MediaRoute2Info.Builder setVolumeMax(int volumeMax)

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

Inherited methods

Public constructors

Builder

public Builder (String id, 
                CharSequence name)

Constructor for builder to create MediaRoute2Info.

In order to ensure ID uniqueness, the ID of a route info obtained from MediaRouter2 can be different from what was set in MediaRoute2ProviderService.

Parameters
id String: The ID of the route. Must not be empty. This value cannot be null.

name CharSequence: The user-visible name of the route. This value cannot be null.

Builder

public Builder (MediaRoute2Info routeInfo)

Constructor for builder to create MediaRoute2Info with existing MediaRoute2Info instance.

Parameters
routeInfo MediaRoute2Info: the existing instance to copy data from. This value cannot be null.

Public methods

addFeature

public MediaRoute2Info.Builder addFeature (String feature)

Adds a feature for the route.

Parameters
feature String: a feature that the route has. May be one of predefined features such as MediaRoute2Info.FEATURE_LIVE_AUDIO, MediaRoute2Info.FEATURE_LIVE_VIDEO or MediaRoute2Info.FEATURE_REMOTE_PLAYBACK or a custom feature defined by a provider. This value cannot be null.

Returns
MediaRoute2Info.Builder This value cannot be null.

See also:

addFeatures

public MediaRoute2Info.Builder addFeatures (Collection<String> features)

Adds features for the route. A route must support at least one route type.

Parameters
features Collection: features that the route has. May include predefined features such as MediaRoute2Info.FEATURE_LIVE_AUDIO, MediaRoute2Info.FEATURE_LIVE_VIDEO or MediaRoute2Info.FEATURE_REMOTE_PLAYBACK or custom features defined by a provider. This value cannot be null.

Returns
MediaRoute2Info.Builder This value cannot be null.

See also:

build

public MediaRoute2Info build ()

Builds the media route info.

Returns
MediaRoute2Info This value cannot be null.

Throws
IllegalArgumentException if no features are added.

clearFeatures

public MediaRoute2Info.Builder clearFeatures ()

Clears the features of the route. A route must support at least one route type.

Returns
MediaRoute2Info.Builder This value cannot be null.

setClientPackageName

public MediaRoute2Info.Builder setClientPackageName (String packageName)

Sets the package name of the app using the route.

Parameters
packageName String: This value may be null.

Returns
MediaRoute2Info.Builder This value cannot be null.

setConnectionState

public MediaRoute2Info.Builder setConnectionState (int connectionState)

Sets the route's connection state. MediaRoute2Info.CONNECTION_STATE_DISCONNECTED, MediaRoute2Info.CONNECTION_STATE_CONNECTING, or MediaRoute2Info.CONNECTION_STATE_CONNECTED.

Parameters
connectionState int: Value is MediaRoute2Info.CONNECTION_STATE_DISCONNECTED, MediaRoute2Info.CONNECTION_STATE_CONNECTING, or MediaRoute2Info.CONNECTION_STATE_CONNECTED

Returns
MediaRoute2Info.Builder This value cannot be null.

setDescription

public MediaRoute2Info.Builder setDescription (CharSequence description)

Sets the user-visible description of the route.

Parameters
description CharSequence: This value may be null.

Returns
MediaRoute2Info.Builder This value cannot be null.

setExtras

public MediaRoute2Info.Builder setExtras (Bundle extras)

Sets a bundle of extras for the route.

Note: The extras will not affect the result of MediaRoute2Info#equals(Object).

Parameters
extras Bundle: This value may be null.

Returns
MediaRoute2Info.Builder This value cannot be null.

setIconUri

public MediaRoute2Info.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: This value may be null.

Returns
MediaRoute2Info.Builder This value cannot be null.

setVolume

public MediaRoute2Info.Builder setVolume (int volume)

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

Parameters
volume int

Returns
MediaRoute2Info.Builder This value cannot be null.

setVolumeHandling

public MediaRoute2Info.Builder setVolumeHandling (int volumeHandling)

Sets the route's volume handling.

Parameters
volumeHandling int: Value is MediaRoute2Info.PLAYBACK_VOLUME_FIXED, or MediaRoute2Info.PLAYBACK_VOLUME_VARIABLE

Returns
MediaRoute2Info.Builder This value cannot be null.

setVolumeMax

public MediaRoute2Info.Builder setVolumeMax (int volumeMax)

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

Parameters
volumeMax int

Returns
MediaRoute2Info.Builder This value cannot be null.