Cómo conectarse a una app de música

Un controlador multimedia interactúa con una sesión multimedia para consultar y controlar la reproducción de una app de música. En Media3, la API de MediaController implementa la interfaz Player. Estos son algunos ejemplos de apps cliente que usan un controlador de contenido multimedia:

• Controles multimedia del sistema Android
• App complementaria de Android Wear OS
• Android Auto y el SO Automotive
• Asistentes de voz, como Asistente de Google
• La app de prueba del controlador multimedia

Un controlador multimedia también puede ser útil dentro de una app de música, por ejemplo, si el reproductor y la sesión multimedia se encuentran en un Service separado del Activity o Fragment con la IU.

Cómo crear un MediaController

Para crear una MediaController, primero crea un SessionToken para la MediaSession correspondiente. El método onStart() de tu Activity o Fragment puede ser un buen lugar para esto.

Kotlin

val sessionToken = 
  SessionToken(context, ComponentName(context, PlaybackService::class.java))

Java

SessionToken sessionToken = 
  new SessionToken(context, new ComponentName(context, PlaybackService.class));

El uso de este SessionToken para compilar un MediaController conecta el controlador a la sesión determinada. Esto se realiza de forma asíncrona, por lo que debes detectar el resultado y usarlo cuando esté disponible.

Kotlin

val controllerFuture =
  MediaController.Builder(context, sessionToken).buildAsync()
controllerFuture.addListener({
  // MediaController is available here with controllerFuture.get()
}, MoreExecutors.directExecutor())

Java

ListenableFuture<MediaController> controllerFuture =
  new MediaController.Builder(context, sessionToken).buildAsync();
controllerFuture.addListener(() -> {
  // MediaController is available here with controllerFuture.get()
}, MoreExecutors.directExecutor());

Nota: Usa ContextCompat.getMainExecutor() en lugar de MoreExecutors.directExecutor() en caso de que ejecutes tu servicio en otro proceso que no sea la IU.

Nota: Las apps que se orientan al nivel de SDK 30 o versiones posteriores deben incluir un elemento <queries> en su manifiesto para conectarse a un MediaSessionService (o un componente similar) de otra app. Consulta la guía de visibilidad de paquetes para obtener más detalles.

Usa un MediaController

MediaController implementa la interfaz Player, por lo que puedes usar los comandos definidos en la interfaz para controlar la reproducción de MediaSession conectado. Es decir, llamar a play() en un MediaController enviará el comando al MediaSession conectado, que luego delegará el comando a su Player subyacente.

Sugerencia: Un controlador multimedia implementa la interfaz Player y, por lo tanto, puedes asignarla al reproductor dentro de la IU.

Del mismo modo, puedes agregar un Player.Listener al controlador para detectar cambios en el estado Player. Consulta la guía de Eventos del jugador para obtener más detalles sobre el uso de un Player.Listener. La interfaz de MediaController.Listener define devoluciones de llamada adicionales para eventos y comandos entrantes desde el MediaSession conectado, como onAvailableSessionCommandsChanged() para cuando la sesión multimedia cambia los comandos de sesión disponibles y onDisconnected() para cuando el controlador se desconecta de la sesión.

Al igual que con otros componentes, recuerda liberar el MediaController cuando ya no sea necesario, como en el método onStop() de un Activity o Fragment.

Kotlin

MediaController.releaseFuture(controllerFuture)

Java

MediaController.releaseFuture(controllerFuture);

Si liberas el controlador, se seguirán enviando todos los comandos pendientes a la sesión y solo se desvinculará del servicio de sesión una vez que se hayan controlado estos comandos o después de un período de tiempo de espera, lo que ocurra primero.

Crea y usa un MediaBrowser

Un MediaBrowser se basa en las capacidades que ofrece un MediaController para habilitar también la navegación por la biblioteca multimedia que ofrece el MediaLibraryService de una app multimedia.

Kotlin

val browserFuture = MediaBrowser.Builder(context, sessionToken).buildAsync()
browserFuture.addListener({
  // MediaBrowser is available here with browserFuture.get()
}, MoreExecutors.directExecutor())

Java

ListenableFuture<MediaBrowser> browserFuture =
  new MediaBrowser.Builder(context, sessionToken).buildAsync();
browserFuture.addListener(() -> {
  // MediaBrowser is available here with browserFuture.get()
}, MoreExecutors.directExecutor());

Para comenzar a explorar la biblioteca de contenido de la app de música, primero recupera el nodo raíz con getLibraryRoot():

Kotlin

// Get the library root to start browsing the library tree.
val rootFuture = mediaBrowser.getLibraryRoot(/* params= */ null)
rootFuture.addListener({
  // Root node MediaItem is available here with rootFuture.get().value
}, MoreExecutors.directExecutor())

Java

// Get the library root to start browsing the library tree.
ListenableFuture<LibraryResult<MediaItem>> rootFuture =
  mediaBrowser.getLibraryRoot(/* params= */ null);
rootFuture.addListener(() -> {
  // Root node MediaItem is available here with rootFuture.get().value
}, MoreExecutors.directExecutor());

Luego, puedes navegar por la biblioteca multimedia recuperando los elementos secundarios de un MediaItem en la biblioteca con getChildren(). Por ejemplo, para recuperar los elementos secundarios del nodo raíz MediaItem, haz lo siguiente:

Kotlin

// Get the library root to start browsing the library tree.
val childrenFuture = 
  mediaBrowser.getChildren(rootMediaItem.mediaId, 0, Int.MAX_VALUE, null)
childrenFuture.addListener({
  // List of children MediaItem nodes is available here with
  // childrenFuture.get().value
}, MoreExecutors.directExecutor())

Java

ListenableFuture<LibraryResult<ImmutableList<MediaItem>>> childrenFuture =
  mediaBrowser.getChildren(rootMediaItem.mediaId, 0, Integer.MAX_VALUE, null);
childrenFuture.addListener(() -> {
  // List of children MediaItem nodes is available here with
  // childrenFuture.get().value
}, MoreExecutors.directExecutor());