Google は AI 技術を使用して、コンテンツをご希望の言語に翻訳しています。AI 翻訳には誤りが含まれる場合があります。

MediaLibraryService を使用してコンテンツを提供する

メディアアプリには、階層構造に整理されたメディアアイテムのコレクションが含まれていることがよくあります。たとえば、アルバム内の曲やプレイリスト内のテレビ番組のエピソードなどです。このメディアアイテムの階層は、メディアライブラリと呼ばれます。

階層構造に配置されたメディアコンテンツの例 — **図 1**: メディアライブラリを形成するメディアアイテム階層の例。

MediaLibraryService は、メディアライブラリを提供してアクセスするための標準化された API を提供します。これは、たとえば、メディアアプリに Android Auto のサポートを追加する場合に役立ちます。Android Auto は、メディアライブラリに独自のドライバーセーフ UI を提供します。

`MediaLibraryService` をビルドする

MediaLibraryService の実装は、MediaSessionService の実装と似ていますが、onGetSession() メソッドで MediaSession ではなく MediaLibrarySession を返す必要があります。

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()
  }
}
ServeContent.kt

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();
  }
}
ServeContent.java

マニフェストファイルで 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 を使用するクライアントとの互換性を確保するため、intent-filter 要素に <action android:name="android.media.browse.MediaBrowserService"/> を含めることをおすすめします。Media3 は、このサービスインターフェースに下位互換性を自動的に提供します。
将来を見据えた設定として、また Media3 を使用するアプリが Media3 API を使用してサービスと通信できるように、プラットフォームオプションとともに <action android:name="androidx.media3.session.MediaLibraryService"/> を指定する必要があります。

これにより、アプリは PackageManager を介してサービスを検出し、これらのインターフェースのいずれかを介して MediaBrowser に接続できます。

`MediaLibrarySession` を使用する

MediaLibraryService API は、メディアライブラリがツリー形式で構造化されていることを想定しています。このツリー形式では、1 つのルートノードと、再生可能またはさらにブラウズ可能な子ノードが存在します。

MediaLibrarySession は、MediaSession API を拡張してコンテンツブラウジング API を追加します。MediaSession コールバックと比較して、MediaLibrarySession コールバックには次のようなメソッドが追加されています。

onGetLibraryRoot(): クライアントがコンテンツツリーのルート MediaItem をリクエストした場合
onGetChildren(): クライアントがコンテンツツリー内の MediaItem の子をリクエストした場合
onGetSearchResult(): クライアントが特定のクエリの検索結果をコンテンツツリーからリクエストする場合

関連するコールバックメソッドには、クライアントアプリが関心を持つコンテンツツリーのタイプに関する追加のシグナルを含む LibraryParams オブジェクトが含まれます。

メディアアイテムのコマンドボタン

セッションアプリは、MediaMetadata の MediaItem でサポートされているコマンドボタンを宣言できます。これにより、コントローラが表示できるメディアアイテムに 1 つ以上の 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()ServeContent.kt

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();ServeContent.java

メディアアイテムをビルドするときに、セッションアプリは、セッションのビルド時に設定されたコマンドボタンのセッションコマンドを参照する、サポートされているコマンド ID のセットを追加できます。

Kotlin

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

Java

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

コントローラまたはブラウザが接続するか、セッション 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
}ServeContent.kt

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;
}ServeContent.java

メディアアイテムに対して送信されたカスタムアクションを処理するときに、セッションアプリは onCustomCommand に渡された引数 Bundle からメディアアイテム ID を取得できます。

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)
}ServeContent.kt

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);
}ServeContent.java

コマンドボタンをブラウザまたはコントローラとして使用する

MediaController 側では、アプリは MediaController または MediaBrowser をビルドするときに、メディアアイテムでサポートするコマンドボタンの最大数を宣言できます。

Kotlin

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

Java

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

セッションに接続すると、コントローラアプリは、メディアアイテムでサポートされているコマンドボタンを受け取ることができます。このコマンドボタンには、コントローラがセッションアプリから付与された使用可能なコマンドが含まれています。

Kotlin

val commandButtonsForMediaItem = controller.getCommandButtonsForMediaItem(mediaItem)ServeContent.kt

Java

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

Kotlin

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

Java

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

MediaLibraryService を使用してコンテンツを提供する コレクションでコンテンツを整理 必要に応じて、コンテンツの保存と分類を行います。

MediaLibraryService をビルドする

Kotlin

Java

MediaLibrarySession を使用する

メディア アイテムのコマンドボタン

セッション側の設定コマンドボタン

Kotlin

Java

Kotlin

Java

Kotlin

Java

Kotlin

Java

コマンドボタンをブラウザまたはコントローラとして使用する

Kotlin

Java

Kotlin

Java

Kotlin

Java

MediaLibraryService を使用してコンテンツを提供する

`MediaLibraryService` をビルドする

`MediaLibrarySession` を使用する

メディアアイテムのコマンドボタン