Как предоставлять контент с помощью MediaLibraryService

Медиаприложения часто содержат коллекции медиаконтента, организованные в иерархию. Например, песни в альбоме или серии телешоу в плейлисте. Такая иерархия медиаконтента называется медиатекой.

Примеры медиаконтента, упорядоченного по иерархии
Рисунок 1. Примеры иерархий медиаобъектов, образующих медиабиблиотеку.

MediaLibraryService предоставляет стандартизированный API для показа и доступа к вашей медиатеке. Это может быть полезно, например, при добавлении поддержки Android Auto в мультимедийное приложение, которое предоставляет собственный безопасный для водителя интерфейс для медиатеки.

Построй объект "MediaLibraryService"

Реализация MediaLibraryService похожа на реализацию MediaSessionService, но в методе onGetSession() нужно возвращать MediaLibrarySession, а не MediaSession.

Kotlin

class PlaybackService : MediaLibraryService() {
  private var mediaLibrarySession: MediaLibrarySession? = null
  private val callback: MediaLibrarySession.Callback =
    object : MediaLibrarySession.Callback {
      /* ... */
    }

  override fun onGetSession(controllerInfo: MediaSession.ControllerInfo): MediaLibrarySession? {
    // If desired, validate the controller before returning the media library session
    return mediaLibrarySession
  }

  // Create your player and media library session in the onCreate lifecycle event
  override fun onCreate() {
    super.onCreate()
    val player = ExoPlayer.Builder(this).build()
    mediaLibrarySession = MediaLibrarySession.Builder(this, player, callback).build()
  }

  // Remember to release the player and media library session in onDestroy
  override fun onDestroy() {
    mediaLibrarySession?.run {
      player.release()
      release()
      mediaLibrarySession = null
    }
    super.onDestroy()
  }
}

Java

class PlaybackService extends MediaLibraryService {
  MediaLibrarySession mediaLibrarySession = null;
  MediaLibrarySession.Callback callback = new MediaLibrarySession.Callback() {
        /* ... */
      };

  @Override
  public MediaLibrarySession onGetSession(MediaSession.ControllerInfo controllerInfo) {
    // If desired, validate the controller before returning the media library session
    return mediaLibrarySession;
  }

  // Create your player and media library session in the onCreate lifecycle event
  @Override
  public void onCreate() {
    super.onCreate();
    ExoPlayer player = new ExoPlayer.Builder(this).build();
    mediaLibrarySession = new MediaLibrarySession.Builder(this, player, callback).build();
  }

  // Remember to release the player and media library session in onDestroy
  @Override
  public void onDestroy() {
    if (mediaLibrarySession != null) {
      mediaLibrarySession.getPlayer().release();
      mediaLibrarySession.release();
      mediaLibrarySession = null;
    }
    super.onDestroy();
  }
}
Не забудьте также объявить Service и необходимые разрешения в файле манифеста:

<service
    android:name=".PlaybackService"
    android:foregroundServiceType="mediaPlayback"
    android:exported="true">
    <intent-filter>
        <action android:name="androidx.media3.session.MediaLibraryService"/>
        <action android:name="android.media.browse.MediaBrowserService"/>
    </intent-filter>
</service>

<uses-permission android:name="android.permission.FOREGROUND_SERVICE" />
<uses-permission android:name="android.permission.FOREGROUND_SERVICE_MEDIA_PLAYBACK" />

Рекомендуем зарегистрировать сервис как платформу и как интерфейс сервиса Media3:

  • Чтобы обеспечить совместимость с клиентами, использующими API медиасеансов платформы, рекомендуется включить <action android:name="android.media.browse.MediaBrowserService"/> в элемент intent-filter. Media3 автоматически обеспечивает обратную совместимость с этим интерфейсом сервиса.

  • Чтобы обеспечить совместимость с будущими версиями и гарантировать, что приложения, использующие Media3, смогут взаимодействовать с вашим сервисом через Media3 API, вместе с вариантом платформы следует указать <action android:name="androidx.media3.session.MediaLibraryService"/>.

Это позволяет приложениям находить ваш сервис через PackageManager и подключаться к MediaBrowser через любой из этих интерфейсов.

Используйте MediaLibrarySession

API MediaLibraryService ожидает, что ваша медиатека будет структурирована в виде дерева с одним корневым узлом и дочерними узлами, которые могут быть воспроизводимыми или доступными для просмотра.

MediaLibrarySession расширяет возможности API MediaSession, добавляя API для просмотра контента. По сравнению с обратным вызовом MediaSession, обратный вызов MediaLibrarySession добавляет такие методы, как:

  • onGetLibraryRoot(), если клиент запрашивает корневой элемент MediaItem дерева контента.
  • onGetChildren(), если клиент запрашивает дочерние элементы MediaItem в дереве контента.
  • onGetSearchResult(), когда клиент запрашивает результаты поиска по дереву контента для определенного запроса.

В соответствующие методы обратного вызова будет включен объект LibraryParams с дополнительными сигналами о типе дерева контента, который интересует клиентское приложение.

Кнопки команд для мультимедийных объектов

Приложение для сеанса может объявлять кнопки команд, поддерживаемые MediaItem в MediaMetadata. Это позволяет назначить медиаобъекту одну или несколько записей CommandButton, которые контроллер может отображать и использовать для удобной отправки в сеанс специальной команды для объекта.

Как настроить кнопки команд на стороне сеанса

При создании сеанса приложение сеанса объявляет набор кнопок команд, которые сеанс может обрабатывать как специальные команды:

Kotlin

val allCommandButtons =
  listOf(
    CommandButton.Builder(CommandButton.ICON_PLAYLIST_ADD)
      .setDisplayName(context.getString(R.string.add_to_playlist))
      .setSessionCommand(SessionCommand(COMMAND_PLAYLIST_ADD, Bundle.EMPTY))
      .setExtras(playlistAddExtras)
      .build(),
    CommandButton.Builder(CommandButton.ICON_RADIO)
      .setDisplayName(context.getString(R.string.radio_station))
      .setSessionCommand(SessionCommand(COMMAND_RADIO, Bundle.EMPTY))
      .setExtras(radioExtras)
      .build(),
  )
// Add all command buttons for media items supported by the session.
val session =
  MediaSession.Builder(context, player)
    .setCommandButtonsForMediaItems(allCommandButtons)
    .build()

Java

ImmutableList<CommandButton> allCommandButtons =
    ImmutableList.of(
        new CommandButton.Builder(CommandButton.ICON_PLAYLIST_ADD)
            .setDisplayName(context.getString(R.string.add_to_playlist))
            .setSessionCommand(new SessionCommand(COMMAND_PLAYLIST_ADD, Bundle.EMPTY))
            .setExtras(playlistAddExtras)
            .build(),
        new CommandButton.Builder(CommandButton.ICON_RADIO)
            .setDisplayName(context.getString(R.string.radio_station))
            .setSessionCommand(new SessionCommand(COMMAND_RADIO, Bundle.EMPTY))
            .setExtras(radioExtras)
            .build());
// Add all command buttons for media items supported by the session.
MediaSession session =
    new MediaSession.Builder(context, player)
        .setCommandButtonsForMediaItems(allCommandButtons)
        .build();

При создании медиаконтента приложение сеанса может добавить набор поддерживаемых идентификаторов команд, которые ссылаются на команды сеанса кнопок команд, настроенных при создании сеанса:

Kotlin

val mediaItem =
  MediaItem.Builder()
    .setMediaMetadata(
      MediaMetadata.Builder()
        .setSupportedCommands(listOf(COMMAND_PLAYLIST_ADD, COMMAND_RADIO))
        .build()
    )
    .build()

Java

MediaItem mediaItem =
    new MediaItem.Builder()
        .setMediaMetadata(
            new MediaMetadata.Builder()
                .setSupportedCommands(ImmutableList.of(COMMAND_PLAYLIST_ADD, COMMAND_RADIO))
                .build())
        .build();

Когда контроллер или браузер подключается или вызывает другой метод сеансаCallback, приложение сеанса может проверить ControllerInfo, переданный в обратный вызов, чтобы узнать максимальное количество кнопок команд, которые может отображать контроллер или браузер. Объект ControllerInfo, переданный в метод обратного вызова, предоставляет геттер для удобного доступа к этому значению. По умолчанию задано значение 0, которое означает, что браузер или контроллер не поддерживают эту функцию:

Kotlin

override fun onGetItem(
  session: MediaLibrarySession,
  browser: MediaSession.ControllerInfo,
  mediaId: String,
): ListenableFuture<LibraryResult<MediaItem>> {
  val settableFuture = SettableFuture.create<LibraryResult<MediaItem>>()

  val maxCommandsForMediaItems = browser.maxCommandsForMediaItems
  loadMediaItemAsync(settableFuture, mediaId, maxCommandsForMediaItems)

  return settableFuture
}

Java

@Override
public ListenableFuture<LibraryResult<MediaItem>> onGetItem(
    MediaLibraryService.MediaLibrarySession session,
    ControllerInfo browser,
    String mediaId) {
  SettableFuture<LibraryResult<MediaItem>> settableFuture = SettableFuture.create();

  int maxCommandsForMediaItems = browser.getMaxCommandsForMediaItems();
  loadMediaItemAsync(settableFuture, mediaId, maxCommandsForMediaItems);

  return settableFuture;
}

При обработке специального действия, отправленного для медиаконтента, приложение сеанса может получить идентификатор медиаконтента из аргументов Bundle, переданных в onCustomCommand:

Kotlin

override fun onCustomCommand(
  session: MediaSession,
  controller: MediaSession.ControllerInfo,
  customCommand: SessionCommand,
  args: Bundle,
): ListenableFuture<SessionResult> {
  val mediaItemId = args.getString(MediaConstants.EXTRA_KEY_MEDIA_ID)
  return if (mediaItemId != null)
    handleCustomCommandForMediaItem(controller, customCommand, mediaItemId, args)
  else handleCustomCommand(controller, customCommand, args)
}

Java

@Override
public ListenableFuture<SessionResult> onCustomCommand(
    MediaSession session,
    ControllerInfo controller,
    SessionCommand customCommand,
    Bundle args) {
  String mediaItemId = args.getString(MediaConstants.EXTRA_KEY_MEDIA_ID);
  return mediaItemId != null
      ? handleCustomCommandForMediaItem(controller, customCommand, mediaItemId, args)
      : handleCustomCommand(controller, customCommand, args);
}

Как использовать кнопки управления в качестве браузера или контроллера

На стороне MediaController приложение может указать максимальное количество кнопок управления, которые оно поддерживает для медиаконтента, при создании MediaController или MediaBrowser:

Kotlin

val browserFuture =
  MediaBrowser.Builder(context, sessionToken).setMaxCommandsForMediaItems(3).buildAsync()

Java

ListenableFuture<MediaBrowser> browserFuture =
    new MediaBrowser.Builder(context, sessionToken).setMaxCommandsForMediaItems(3).buildAsync();

При подключении к сеансу приложение контроллера может получать команды кнопок, поддерживаемые медиаконтентом и для которых контроллер имеет доступную команду, предоставленную приложением сеанса:

Kotlin

val commandButtonsForMediaItem = controller.getCommandButtonsForMediaItem(mediaItem)

Java

ImmutableList<CommandButton> commandButtonsForMediaItem =
    controller.getCommandButtonsForMediaItem(mediaItem);

Kotlin

val future =
  controller.sendCustomCommand(
    requireNotNull(addToPlaylistButton.sessionCommand),
    mediaItem,
    Bundle.EMPTY,
  )

Java

ListenableFuture<SessionResult> future =
    controller.sendCustomCommand(
        checkNotNull(addToPlaylistButton.sessionCommand), mediaItem, Bundle.EMPTY);