MediaRouteDescriptor.Builder

Builder(descriptor: MediaRouteDescriptor)

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

Builder(id: String, name: String)

Creates a media route descriptor builder.

fun addControlFilter(filter: IntentFilter): MediaRouteDescriptor.Builder

Adds a media control intent filter for the route.

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

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

fun build(): MediaRouteDescriptor

Builds the media route descriptor.

fun clearControlFilters(): MediaRouteDescriptor.Builder

Clears media control intent filters for the route.

fun setCanDisconnect(canDisconnect: Boolean): MediaRouteDescriptor.Builder

Sets whether the route can be disconnected without stopping playback.

fun setConnecting(connecting: Boolean): MediaRouteDescriptor.Builder

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

fun setConnectionState(connectionState: Int): MediaRouteDescriptor.Builder

Sets the route's connection state.

fun setDeduplicationIds(deduplicationIds: (Mutable)Set<String!>): MediaRouteDescriptor.Builder

Sets the route's deduplication ids.

Two routes are considered to come from the same receiver device if any of their respective deduplication ids match.

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.

fun setDeviceType(deviceType: Int): MediaRouteDescriptor.Builder

Sets the route's receiver device type.

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.

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.

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 (SCHEME_CONTENT)
• android.resource (SCHEME_ANDROID_RESOURCE)
• file (SCHEME_FILE)

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.

fun setIsDynamicGroupRoute(isDynamicGroupRoute: Boolean): MediaRouteDescriptor.Builder

Sets whether the route is a dynamic group route.

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.

fun setPlaybackStream(playbackStream: Int): MediaRouteDescriptor.Builder

Sets the route's playback stream.

fun setPlaybackType(playbackType: Int): MediaRouteDescriptor.Builder

Sets the route's playback type.

fun setPresentationDisplayId(presentationDisplayId: Int): MediaRouteDescriptor.Builder

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

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

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

fun setVisibilityPublic(): MediaRouteDescriptor.Builder

Sets the visibility of this route to public.

By default, unless you call setVisibilityRestricted, the new route will be public.

Public routes are visible to any application with a matching feature.

Calls to this method override previous calls to setVisibilityPublic and setVisibilityRestricted.

fun setVisibilityRestricted(allowedPackages: (Mutable)Set<String!>): MediaRouteDescriptor.Builder

Sets the visibility of this route to restricted.

Routes with restricted visibility are only visible to its publisher application and applications whose package name is included in the provided allowedPackages set with a matching feature.

Calls to this method override previous calls to setVisibilityPublic and setVisibilityRestricted.

fun setVolume(volume: Int): MediaRouteDescriptor.Builder

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

fun setVolumeHandling(volumeHandling: Int): MediaRouteDescriptor.Builder

Sets the route's volume handling.

fun setVolumeMax(volumeMax: Int): MediaRouteDescriptor.Builder

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