Summary: Nested Classes | Ctors | Methods | Inherited Methods

MediaRouteProvider.DynamicGroupRouteController

Kotlin |Java

public static abstract class MediaRouteProvider.DynamicGroupRouteController
extends MediaRouteProvider.RouteController

java.lang.Object
↳	androidx.mediarouter.media.MediaRouteProvider.RouteController
	↳	androidx.mediarouter.media.MediaRouteProvider.DynamicGroupRouteController

Provides control over a dynamic group route. A dynamic group route is a group of routes such that a route can be added or removed from the group by the user dynamically.

Summary

Nested classes
`class`	`MediaRouteProvider.DynamicGroupRouteController.DynamicRouteDescriptor` Contains a route, its selection state and its capabilities.

Public constructors
`DynamicGroupRouteController()`

Public methods
`String`	`getGroupableSelectionTitle()` Gets the title of the groupable routes section which will be shown to the user.
`String`	`getTransferableSectionTitle()` Gets the title of the transferable routes section which will be shown to the user.
`final void`	`notifyDynamicRoutesChanged(MediaRouteDescriptor groupRoute, Collection<MediaRouteProvider.DynamicGroupRouteController.DynamicRouteDescriptor> dynamicRoutes)` Sets the group route descriptor and the dynamic route descriptors for the dynamic group.
`final void`	`notifyDynamicRoutesChanged(Collection<MediaRouteProvider.DynamicGroupRouteController.DynamicRouteDescriptor> routes)` This method is deprecated. Use `notifyDynamicRoutesChanged(MediaRouteDescriptor, Collection)` instead to notify information of the group.
`abstract void`	`onAddMemberRoute(String routeId)` Called when a user adds a route into the casting session.
`abstract void`	`onRemoveMemberRoute(String routeId)` Called when a user removes a route from casting session.
`abstract void`	`onUpdateMemberRoutes(List<String> routeIds)` Called when a user selects a new set of routes s/he wants the session to be played.

Inherited methods

From class


        
          androidx.mediarouter.media.MediaRouteProvider.RouteController

`boolean`	`onControlRequest(Intent intent, MediaRouter.ControlRequestCallback callback)` Performs a `media control` request asynchronously on behalf of the route.
`void`	`onRelease()` Releases the route controller, allowing it to free its resources.
`void`	`onSelect()` Selects the route.
`void`	`onSetVolume(int volume)` Requests to set the volume of the route.
`void`	`onUnselect()` This method is deprecated. Use `onUnselect(int)` instead.
`void`	`onUnselect(int reason)` Unselects the route and provides a reason.
`void`	`onUpdateVolume(int delta)` Requests an incremental volume update for the route.

From class


        
          java.lang.Object

`Object`	`clone()`
`boolean`	`equals(Object arg0)`
`void`	`finalize()`
`final Class<?>`	`getClass()`
`int`	`hashCode()`
`final void`	`notify()`
`final void`	`notifyAll()`
`String`	`toString()`
`final void`	`wait(long arg0, int arg1)`
`final void`	`wait(long arg0)`
`final void`	`wait()`

Public constructors

DynamicGroupRouteController

public DynamicGroupRouteController ()

Public methods

getGroupableSelectionTitle

public String getGroupableSelectionTitle ()

Gets the title of the groupable routes section which will be shown to the user. It is provided by MediaRouteProvider. e.g. "Add a device."

Returns
`String`

getTransferableSectionTitle

public String getTransferableSectionTitle ()

Gets the title of the transferable routes section which will be shown to the user. It is provided by MediaRouteProvider. MediaRouteProvider. e.g. "Play on group."

Returns
`String`

notifyDynamicRoutesChanged

public final void notifyDynamicRoutesChanged (MediaRouteDescriptor groupRoute, 
                Collection<MediaRouteProvider.DynamicGroupRouteController.DynamicRouteDescriptor> dynamicRoutes)

Sets the group route descriptor and the dynamic route descriptors for the dynamic group.

The dynamic group controller should call this method to notify the current dynamic group state.

Parameters
`groupRoute`	`MediaRouteDescriptor`: The media route descriptor describing the dynamic group. The `selected route` of the media router will contain this information. If it is `disabled`, the media router will unselect the dynamic group and release the route controller.
`dynamicRoutes`	`Collection`: The dynamic route descriptors for published routes. At least a selected or selecting route should be included.

notifyDynamicRoutesChanged

public final void notifyDynamicRoutesChanged (Collection<MediaRouteProvider.DynamicGroupRouteController.DynamicRouteDescriptor> routes)

This method is deprecated.
Use notifyDynamicRoutesChanged(MediaRouteDescriptor, Collection) instead to notify information of the group.

Sets the dynamic route descriptors for the dynamic group.

The dynamic group controller should call this method to notify the current dynamic group state.

Parameters
`routes`	`Collection`: The dynamic route descriptors for published routes. At least a selected or selecting route must be included.

onAddMemberRoute

public abstract void onAddMemberRoute (String routeId)

Called when a user adds a route into the casting session.

Parameters
`routeId`	`String`

onRemoveMemberRoute

public abstract void onRemoveMemberRoute (String routeId)

Called when a user removes a route from casting session.

Parameters
`routeId`	`String`

onUpdateMemberRoutes

public abstract void onUpdateMemberRoutes (List<String> routeIds)

Called when a user selects a new set of routes s/he wants the session to be played.

Parameters
`routeIds`	`List`

MediaRouteProvider.DynamicGroupRouteController

Summary

Nested classes

Public constructors

Public methods

Inherited methods

Public constructors

DynamicGroupRouteController

Public methods

getGroupableSelectionTitle

getTransferableSectionTitle

notifyDynamicRoutesChanged

notifyDynamicRoutesChanged

onAddMemberRoute

onRemoveMemberRoute

onUpdateMemberRoutes