Conectar a um app de música

Um controlador de mídia interage com uma sessão de mídia para consultar e controlar a reprodução de um app de mídia. Na Media3, a API MediaController implementa a interface Player. Exemplos de apps clientes que usam um controlador de mídia incluem:

• Controles de mídia do sistema Android
• App complementar do Android Wear OS
• Android Auto e Automotive OS
• Assistentes por voz, como o Google Assistente
• O app de teste dos controles de mídia

Um controlador de mídia também pode ser útil em um app de música, por exemplo, se o player e a sessão de mídia estiverem em um Service separado de Activity ou Fragment com a interface.

Criar um MediaController.

Para criar um MediaController, comece criando um SessionToken para a MediaSession correspondente. O método onStart() do seu Activity ou Fragment pode ser um bom lugar para isso.

Kotlin

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

Java

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

Usar esse SessionToken para criar um MediaController conecta o controlador à sessão especificada. Isso ocorre de forma assíncrona. Por isso, você precisa detectar o resultado e usá-lo quando disponível.

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());

Observação: use ContextCompat.getMainExecutor() em vez de MoreExecutors.directExecutor() caso o serviço seja executado em outro processo que não seja a interface.

Observação: os apps destinados ao nível 30 ou mais recente do SDK precisam incluir um elemento <queries> no manifesto para se conectar ao MediaSessionService de outro app (ou a um componente semelhante). Consulte o guia de visibilidade do pacote para mais detalhes.

Usar um MediaController

O MediaController implementa a interface Player. Assim, você pode usar os comandos definidos na interface para controlar a reprodução do MediaSession conectado. Ou seja, chamar play() em um MediaController enviará o comando para a MediaSession conectada, que, posteriormente, delegará o comando ao Player subjacente.

Dica: um controlador de mídia implementa a interface Player e, assim, você pode atribuí-la ao player na sua interface.

Da mesma forma, você pode adicionar um Player.Listener ao controlador para detectar mudanças no estado Player. Consulte o guia Eventos do jogador para saber mais sobre como usar um Player.Listener. A interface MediaController.Listener define callbacks extras para eventos e comandos recebidos do MediaSession conectado, como onAvailableSessionCommandsChanged() para quando a sessão de mídia muda os comandos de sessão disponíveis e onDisconnected() para quando o controlador é desconectado da sessão.

Assim como acontece com outros componentes, libere a MediaController quando ela não for mais necessária, como no método onStop() de uma Activity ou Fragment.

Kotlin

MediaController.releaseFuture(controllerFuture)

Java

MediaController.releaseFuture(controllerFuture);

Liberar o controlador ainda entregará todos os comandos pendentes enviados à sessão e somente será desvinculado do serviço da sessão depois que esses comandos forem processados ou após um tempo limite, o que ocorrer primeiro.

Criar e usar um MediaBrowser

Um MediaBrowser é criado com base nos recursos oferecidos por uma MediaController para ativar a navegação na biblioteca de mídia oferecida pelo MediaLibraryService de um app de mídia.

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 começar a navegar pela biblioteca de conteúdo do app de música, primeiro recupere o nó raiz com 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());

Você pode navegar pela biblioteca de mídia recuperando os filhos de um MediaItem na biblioteca com getChildren(). Por exemplo, para recuperar os filhos do nó raiz MediaItem:

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());