Обслуживание контента с помощью MediaLibraryService

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

Рисунок 1 : Примеры иерархий медиафайлов, формирующих медиатеку.

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

Создайте службу MediaLibraryService

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

Котлин

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

  // If desired, validate the controller before returning the media library session
  override fun onGetSession(controllerInfo: MediaSession.ControllerInfo): MediaLibrarySession? =
    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.MediaSessionService"/>
        <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" />

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

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

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

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

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

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

Кнопки управления для медиафайлов

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

Настройте кнопки управления на стороне сессии.

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

Котлин

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(),
    // possibly more here
  )

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

Примечание: элементы управления воспроизведением Android , доступные через уведомления о воспроизведении, не используют кнопки управления для медиафайлов. Используйте настройки кнопок управления воспроизведением , чтобы задать параметры для этих элементов управления.

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

Котлин

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, что указывает на то, что браузер или контроллер не поддерживают эту функцию:

Котлин

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

  val settableFuture = SettableFuture.create<LibraryResult<MediaItem>>()

  val maxCommandsForMediaItems = browser.maxCommandsForMediaItems
  scope.launch {
    loadMediaItem(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 :

Котлин

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 :

Котлин

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

Java

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

Примечание: По умолчанию количество команд установлено на 0 (ноль), что указывает приложению сессии не объявлять кнопки команд для данного браузера или контроллера.

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

Котлин

val commandButtonsForMediaItem: List<CommandButton> =
  controller.getCommandButtonsForMediaItem(mediaItem)

Java

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

Примечание: Возвращаемые кнопки управления представляют собой пересечение всех кнопок, настроенных в рамках сессии, поддерживаемых команд, заданных для медиафайла, и доступных команд контроллера.

Для удобства MediaController может отправлять пользовательские команды, специфичные для медиафайлов, с помощью MediaController.sendCustomCommand(SessionCommand, MediaItem, Bundle) :

Котлин

controller.sendCustomCommand(addToPlaylistButton.sessionCommand!!, mediaItem, Bundle.EMPTY)

Java

controller.sendCustomCommand(
    checkNotNull(addToPlaylistButton.sessionCommand), mediaItem, Bundle.EMPTY);