DynamicGroupRouteController
abstract class DynamicGroupRouteController : MediaRouteProvider.RouteController
kotlin.Any | ||
↳ | 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 | |
---|---|
Contains a route, its selection state and its capabilities. |
Public constructors | |
---|---|
<init>() Provides control over a dynamic group route. |
Public methods | |
---|---|
open String? |
Gets the title of the groupable routes section which will be shown to the user. |
open String? |
Gets the title of the transferable routes section which will be shown to the user. |
Unit |
notifyDynamicRoutesChanged(routes: MutableCollection<MediaRouteProvider.DynamicGroupRouteController.DynamicRouteDescriptor!>!) Sets the dynamic route descriptors for the dynamic group. |
Unit |
notifyDynamicRoutesChanged(@NonNull groupRoute: MediaRouteDescriptor, @NonNull dynamicRoutes: MutableCollection<MediaRouteProvider.DynamicGroupRouteController.DynamicRouteDescriptor!>) Sets the group route descriptor and the dynamic route descriptors for the dynamic group. |
abstract Unit |
onAddMemberRoute(@NonNull routeId: String) Called when a user adds a route into the casting session. |
abstract Unit |
onRemoveMemberRoute(routeId: String!) Called when a user removes a route from casting session. |
abstract Unit |
onUpdateMemberRoutes(@Nullable routeIds: MutableList<String!>?) Called when a user selects a new set of routes s/he wants the session to be played. |
Inherited functions | |
---|---|
Public constructors
<init>
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.
Public methods
getGroupableSelectionTitle
@Nullable open fun getGroupableSelectionTitle(): String?
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."
getTransferableSectionTitle
@Nullable open fun getTransferableSectionTitle(): String?
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."
notifyDynamicRoutesChanged
funnotifyDynamicRoutesChanged(routes: MutableCollection<MediaRouteProvider.DynamicGroupRouteController.DynamicRouteDescriptor!>!): Unit
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 |
MutableCollection<MediaRouteProvider.DynamicGroupRouteController.DynamicRouteDescriptor!>!: The dynamic route descriptors for published routes. At least a selected or selecting route must be included. |
notifyDynamicRoutesChanged
fun notifyDynamicRoutesChanged(
@NonNull groupRoute: MediaRouteDescriptor,
@NonNull dynamicRoutes: MutableCollection<MediaRouteProvider.DynamicGroupRouteController.DynamicRouteDescriptor!>
): Unit
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 |
MutableCollection<MediaRouteProvider.DynamicGroupRouteController.DynamicRouteDescriptor!>: The dynamic route descriptors for published routes. At least a selected or selecting route should be included. |
onAddMemberRoute
abstract fun onAddMemberRoute(@NonNull routeId: String): Unit
Called when a user adds a route into the casting session.
onRemoveMemberRoute
abstract fun onRemoveMemberRoute(routeId: String!): Unit
Called when a user removes a route from casting session.
onUpdateMemberRoutes
abstract fun onUpdateMemberRoutes(@Nullable routeIds: MutableList<String!>?): Unit
Called when a user selects a new set of routes s/he wants the session to be played.