MediaRouteDescriptor

public @NonNull Bundle asBundle()

Converts this object to a bundle for serialization.

public boolean canDisconnectAndKeepPlaying()

Gets whether the route can be disconnected without stopping playback.

The route can normally be disconnected without stopping playback when the destination device on the route is connected to two or more source devices. The route provider should update the route immediately when the number of connected devices changes.

To specify that the route should disconnect without stopping use unselect with UNSELECT_REASON_DISCONNECTED.

public static @Nullable MediaRouteDescriptor fromBundle(@Nullable Bundle bundle)

Creates an instance from a bundle.

public @NonNull Set<String> getAllowedPackages()

Gets the set of allowed packages which are able to see the route or an empty set if only the route provider's package is allowed to see this route. This applies only when isVisibilityPublic returns false.

public int getConnectionState()

Gets the connection state of the route.

public @NonNull List<IntentFilter> getControlFilters()

Gets the route's media control intent filters.

public @NonNull Set<String> getDeduplicationIds()

Gets 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 @Nullable String getDescription()

Gets 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 int getDeviceType()

Gets the type of the receiver device associated with this route.

public @Nullable Bundle getExtras()

Gets 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 @Nullable Uri getIconUri()

Gets the URI of the icon representing this route.

This icon will be used in picker UIs if available.

public @NonNull String getId()

Gets 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 String getName()

Gets 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 int getPlaybackStream()

Gets the route's playback stream.

public int getPlaybackType()

Gets the type of playback associated with this route.

public int getPresentationDisplayId()

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

public @Nullable IntentSender getSettingsActivity()

Gets an IntentSender for starting a settings activity for this route. The activity may have specific route settings or general settings for the connected device or route provider.

public int getVolume()

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

public int getVolumeHandling()

Gets information about how volume is handled on the route.

public int getVolumeMax()

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

public boolean isConnecting()

Gets whether the route is connecting.

public boolean isDynamicGroupRoute()

Returns if this route is a dynamic group route.

MediaRouteProvider creates a dynamic group route when onCreateDynamicGroupRouteController is called. It happens when a single route or a single static group is selected.

If a single device or a static group is selected, the associated dynamic group route should not be seen by any client app because there is already one for the device. After user added more devices into the session, it should be seen by the client app. The provider can treat this by not setting the media intent for the dynamic group route if it contains only one member.

public boolean isEnabled()

Gets whether the route is enabled.

public boolean isSystemRoute()

Returns true if this route is a system route.

System routes are routes controlled by the system, like the device's built-in speakers, wired headsets, and bluetooth devices.

To use system routes, your application should write media sample data to a media framework API, typically via Exoplayer.

public boolean isValid()

Returns true if the route descriptor has all of the required fields.

public boolean isVisibilityPublic()

Gets whether the route visibility is public or not.