MediaRouteDescriptor.Builder

public Builder(@NonNull MediaRouteDescriptor descriptor)

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

public Builder(@NonNull String id, @NonNull String name)

Creates a media route descriptor builder.

public @NonNull MediaRouteDescriptor.Builder addControlFilter(@NonNull IntentFilter filter)

Adds a media control intent filter for the route.

public @NonNull MediaRouteDescriptor.Builder addControlFilters(@NonNull Collection<IntentFilter> filters)

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

public @NonNull MediaRouteDescriptor build()

Builds the media route descriptor.

public @NonNull MediaRouteDescriptor.Builder clearControlFilters()

Clears media control intent filters for the route.

public @NonNull MediaRouteDescriptor.Builder setCanDisconnect(boolean canDisconnect)

Sets whether the route can be disconnected without stopping playback.

public @NonNull MediaRouteDescriptor.Builder setConnecting(boolean connecting)

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

public @NonNull MediaRouteDescriptor.Builder setConnectionState(int connectionState)

Sets the route's connection state.

public @NonNull MediaRouteDescriptor.Builder setDeduplicationIds(@NonNull Set<String> deduplicationIds)

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.

public @NonNull MediaRouteDescriptor.Builder setDescription(@Nullable 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.

public @NonNull MediaRouteDescriptor.Builder setDeviceType(int deviceType)

Sets the route's receiver device type.

public @NonNull 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.

public @NonNull MediaRouteDescriptor.Builder setExtras(@Nullable 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.

public @NonNull MediaRouteDescriptor.Builder setIconUri(@NonNull 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:

• content (SCHEME_CONTENT)
• android.resource (SCHEME_ANDROID_RESOURCE)
• file (SCHEME_FILE)

public @NonNull MediaRouteDescriptor.Builder setId(@NonNull 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.

public @NonNull MediaRouteDescriptor.Builder setIsDynamicGroupRoute(boolean isDynamicGroupRoute)

Sets whether the route is a dynamic group route.

public @NonNull MediaRouteDescriptor.Builder setName(@NonNull 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.

public @NonNull MediaRouteDescriptor.Builder setPlaybackStream(int playbackStream)

Sets the route's playback stream.

public @NonNull MediaRouteDescriptor.Builder setPlaybackType(int playbackType)

Sets the route's playback type.

public @NonNull MediaRouteDescriptor.Builder setPresentationDisplayId(int presentationDisplayId)

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

public @NonNull MediaRouteDescriptor.Builder setSettingsActivity(@Nullable IntentSender is)

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

public @NonNull MediaRouteDescriptor.Builder setVisibilityPublic()

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.

public @NonNull MediaRouteDescriptor.Builder setVisibilityRestricted(@NonNull Set<String> allowedPackages)

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.

public @NonNull MediaRouteDescriptor.Builder setVolume(int volume)

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

public @NonNull MediaRouteDescriptor.Builder setVolumeHandling(int volumeHandling)

Sets the route's volume handling.

public @NonNull MediaRouteDescriptor.Builder setVolumeMax(int volumeMax)

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