Builder

class Builder

kotlin.Any
↳	androidx.mediarouter.media.MediaRouteDescriptor.Builder

Builder for media route descriptors.

Summary

Public constructors
`<init>(id: String!, name: String!)` Creates a media route descriptor builder.
`<init>(descriptor: MediaRouteDescriptor!)` Creates a media route descriptor builder whose initial contents are copied from an existing descriptor.

Public methods
MediaRouteDescriptor.Builder!	`setId(id: String!)` Sets the unique id of the route.
MediaRouteDescriptor.Builder!	`setConnecting(connecting: Boolean)` Sets whether the route is in the process of connecting and is not yet ready for use.
MediaRouteDescriptor.Builder!	`setPlaybackStream(playbackStream: Int)` Sets the route's playback stream.
MediaRouteDescriptor.Builder!	`setExtras(extras: Bundle!)` Sets a bundle of extras for this route descriptor.
MediaRouteDescriptor.Builder!	`setVolumeMax(volumeMax: Int)` Sets the route's maximum volume, or 0 if unknown.
MediaRouteDescriptor!	`build()` Builds the `media route descriptor`.
MediaRouteDescriptor.Builder!	`setConnectionState(connectionState: Int)` Sets the route's connection state.
MediaRouteDescriptor.Builder!	`setVolume(volume: Int)` Sets the route's current volume, or 0 if unknown.
MediaRouteDescriptor.Builder!	`setEnabled(enabled: Boolean)` Sets whether the route is enabled.
MediaRouteDescriptor.Builder!	`setDeviceType(deviceType: Int)` Sets the route's receiver device type.
MediaRouteDescriptor.Builder!	`setVolumeHandling(volumeHandling: Int)` Sets the route's volume handling.
MediaRouteDescriptor.Builder!	`setSettingsActivity(is: IntentSender!)` Sets an intent sender for launching the settings activity for this route.
MediaRouteDescriptor.Builder!	`addControlFilters(filters: MutableCollection<IntentFilter!>!)` Adds a list of `media control intent` filters for the route.
MediaRouteDescriptor.Builder!	`addControlFilter(filter: IntentFilter!)` Adds a `media control intent` filter for the route.
MediaRouteDescriptor.Builder!	`setPresentationDisplayId(presentationDisplayId: Int)` Sets the route's presentation display id, or -1 if none.
MediaRouteDescriptor.Builder!	`setDescription(description: String!)` Sets the user-visible description of the route.
MediaRouteDescriptor.Builder!	`setCanDisconnect(canDisconnect: Boolean)` Sets whether the route can be disconnected without stopping playback.
MediaRouteDescriptor.Builder!	`setName(name: String!)` Sets the user-visible name of the route.
MediaRouteDescriptor.Builder!	`setIsDynamicGroupRoute(isDynamicGroupRoute: Boolean)` Sets whether the route is a dynamic group route.
MediaRouteDescriptor.Builder!	`setIconUri(iconUri: Uri!)` Sets the URI of the icon representing this route.
MediaRouteDescriptor.Builder!	`setPlaybackType(playbackType: Int)` Sets the route's playback type.

Public constructors

<init>

Builder(id: String!, name: String!)

Creates a media route descriptor builder.

Parameters
`id`	String!: The unique id of the route.
`name`	String!: The user-visible name of the route.

<init>

Builder(descriptor: MediaRouteDescriptor!)

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

Public methods

setId

fun setId(id: String!): MediaRouteDescriptor.Builder!

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.

setConnecting

fun setConnecting(connecting: Boolean): MediaRouteDescriptor.Builder!

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

setPlaybackStream

fun setPlaybackStream(playbackStream: Int): MediaRouteDescriptor.Builder!

Sets the route's playback stream.

setExtras

fun setExtras(extras: Bundle!): MediaRouteDescriptor.Builder!

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.

setVolumeMax

fun setVolumeMax(volumeMax: Int): MediaRouteDescriptor.Builder!

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

build

fun build(): MediaRouteDescriptor!

Builds the media route descriptor.

setConnectionState

fun setConnectionState(connectionState: Int): MediaRouteDescriptor.Builder!

Sets the route's connection state.

Parameters
`connectionState`	Int: The connection state of the route: `MediaRouter.RouteInfo#CONNECTION_STATE_DISCONNECTED`, `MediaRouter.RouteInfo#CONNECTION_STATE_CONNECTING`, or `MediaRouter.RouteInfo#CONNECTION_STATE_CONNECTED`.

setVolume

fun setVolume(volume: Int): MediaRouteDescriptor.Builder!

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

setEnabled

fun setEnabled(enabled: Boolean): MediaRouteDescriptor.Builder!

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.

setDeviceType

fun setDeviceType(deviceType: Int): MediaRouteDescriptor.Builder!

Sets the route's receiver device type.

Parameters
`deviceType`	Int: The receive device type of the route: `MediaRouter.RouteInfo#DEVICE_TYPE_TV` or `MediaRouter.RouteInfo#DEVICE_TYPE_SPEAKER`.

setVolumeHandling

fun setVolumeHandling(volumeHandling: Int): MediaRouteDescriptor.Builder!

Sets the route's volume handling.

Parameters
`volumeHandling`	Int: how volume is handled on the route: `MediaRouter.RouteInfo#PLAYBACK_VOLUME_FIXED` or `MediaRouter.RouteInfo#PLAYBACK_VOLUME_VARIABLE`.

setSettingsActivity

fun setSettingsActivity(is: IntentSender!): MediaRouteDescriptor.Builder!

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

addControlFilters

fun addControlFilters(filters: MutableCollection<IntentFilter!>!): MediaRouteDescriptor.Builder!

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

addControlFilter

fun addControlFilter(filter: IntentFilter!): MediaRouteDescriptor.Builder!

Adds a media control intent filter for the route.

setPresentationDisplayId

fun setPresentationDisplayId(presentationDisplayId: Int): MediaRouteDescriptor.Builder!

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

setDescription

fun setDescription(description: String!): MediaRouteDescriptor.Builder!

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.

setCanDisconnect

fun setCanDisconnect(canDisconnect: Boolean): MediaRouteDescriptor.Builder!

Sets whether the route can be disconnected without stopping playback.

setName

fun setName(name: String!): MediaRouteDescriptor.Builder!

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.

setIsDynamicGroupRoute

fun setIsDynamicGroupRoute(isDynamicGroupRoute: Boolean): MediaRouteDescriptor.Builder!

Sets whether the route is a dynamic group route.

See Also

#isDynamicGroupRoute()

setIconUri

fun setIconUri(iconUri: Uri!): MediaRouteDescriptor.Builder!

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:

content (android.content.ContentResolver#SCHEME_CONTENT)
android.resource (android.content.ContentResolver#SCHEME_ANDROID_RESOURCE)
file (android.content.ContentResolver#SCHEME_FILE)

setPlaybackType

fun setPlaybackType(playbackType: Int): MediaRouteDescriptor.Builder!

Sets the route's playback type.

Parameters
`playbackType`	Int: The playback type of the route: `MediaRouter.RouteInfo#PLAYBACK_TYPE_LOCAL` or `MediaRouter.RouteInfo#PLAYBACK_TYPE_REMOTE`.