播放器介面

播放器是應用程式的元件，可協助播放媒體項目。Media3 Player 介面會設定播放器通常處理的功能大綱。包括：

• 影響播放控制項，例如播放、暫停及搜尋
• 查詢目前播放媒體的屬性，例如播放位置
• 管理媒體項目的播放清單/佇列
• 設定播放屬性，例如隨機播放、重複播放、速度和音量
• 將影片算繪到螢幕上

Media3 也提供 Player 介面的實作，稱為 ExoPlayer。

元件之間的通用介面

Media3 中的多個元件會實作 Player 介面，例如：

雖然 MediaSession 不會實作 Player 介面，但建立時需要 Player。目的是要從其他程序或執行緒存取 Player。

Media3 播放架構

如果您可以存取 Player，請直接呼叫其方法來發出播放指令。您可以導入 MediaSession，宣傳播放內容並授予外部來源播放控制權。這些外部來源會實作 MediaController，方便連結至媒體工作階段並發出播放指令要求。

在背景播放媒體時，您需要在以前景服務執行的 MediaSessionService 或 MediaLibraryService 中，存放媒體工作階段和播放器。這樣一來，您就能將播放器與應用程式中含有播放控制項 UI 的 Activity 分開。這時可能需要使用媒體控制器。

播放器狀態

實作 Player 介面的媒體播放器狀態主要包含 4 類資訊：

1. 播放狀態
   • 使用 getPlaybackState() 擷取。
   • 介面定義的狀態值為 STATE_IDLE、STATE_BUFFERING、STATE_READY 和 STATE_ENDED。
2. 媒體項目播放清單
   • 用於播放的 MediaItem 執行個體序列。
   • 使用 getCurrentTimeline() 擷取
   • Player 執行個體可提供播放清單作業方法，例如新增或移除 MediaItem，以及 getCurrentMediaItem() 等便利方法。
3. 播放/暫停屬性，例如：
   • playWhenReady：指出使用者是否希望媒體在可能的情況下播放，或保持暫停狀態
   • 播放遭禁止的原因： 指出播放遭禁止的原因 (如適用)，即使 playWhenReady 為 true
   • isPlaying：表示播放器目前是否正在播放內容，只有在播放狀態為 STATE_READY、playWhenReady 為 true 且播放未遭禁止時，才會是 true
4. 播放位置，包括：
   • 目前媒體項目索引： 播放清單中目前 MediaItem 的索引。
   • isPlayingAd：表示插入的廣告是否正在播放。
   • 目前播放位置： 目前 MediaItem 或插入廣告中的播放位置。

此外，Player 介面可存取可用軌、媒體中繼資料、播放速度、音量，以及播放的其他輔助屬性。

監聽變更

使用 Player.Listener 監聽 Player 中的變更。如要瞭解如何建立及使用監聽器，請參閱 ExoPlayer 說明文件中的「播放器事件」。

請注意，監聽器介面不包含任何回呼，可追蹤正常播放進度。如要持續監控播放進度 (例如設定進度列 UI)，您應以適當間隔查詢目前位置。

fun checkPlaybackPosition(delayMs: Long): Boolean =
  handler.postDelayed(
    {
      val currentPosition = player.currentPosition
      // Update UI based on currentPosition
      checkPlaybackPosition(delayMs)
    },
    delayMs,
  )
Player.kt

boolean checkPlaybackPosition(long delayMs) {
  return handler.postDelayed(
      () -> {
        long currentPosition = player.getCurrentPosition();
        // Update UI based on currentPosition
        checkPlaybackPosition(delayMs);
      },
      delayMs);
}
Player.java

控制播放

Player 介面提供多種方法來操控狀態及控制播放：

• 基本播放控制項，例如 play()、pause()、prepare() 和 stop()。
• 播放清單作業，例如 addMediaItem() 或 removeMediaItem()。
• 搜尋可變更目前項目或位置。
• 設定重複播放模式和隨機播放模式。
• 更新曲目選取偏好設定。
• 設定播放速度。

自訂 Player 實作

如要建立自訂播放器，可以擴充 Media3 中包含的 SimpleBasePlayer。這個類別提供 Player 介面的基本實作項目，可將您需要實作的方法數量降至最低。

首先，覆寫 getState() 方法。呼叫這個方法時，應填入目前的播放器狀態，包括：

• 可用的指令集
• 播放屬性，例如播放狀態為 STATE_READY 時播放器是否應開始播放、目前播放的媒體項目索引，以及目前項目內的播放位置

class CustomPlayer(looper: Looper) : SimpleBasePlayer(looper) {
  override fun getState(): State {
    return State.Builder()
      .setAvailableCommands(Commands.EMPTY) // Set which playback commands the player can handle
      // Configure additional playback properties
      .setPlayWhenReady(true, PLAY_WHEN_READY_CHANGE_REASON_USER_REQUEST)
      .setCurrentMediaItemIndex(0)
      .setContentPositionMs(0)
      .build()
  }
}
Player.kt

private static final class CustomPlayer extends SimpleBasePlayer {
  public CustomPlayer(Looper looper) {
    super(looper);
  }

  @Override
  protected State getState() {
    return new State.Builder()
        .setAvailableCommands(Commands.EMPTY) // Set which playback commands the player can handle
        // Configure additional playback properties
        .setPlayWhenReady(true, PLAY_WHEN_READY_CHANGE_REASON_USER_REQUEST)
        .setCurrentMediaItemIndex(0)
        .setContentPositionMs(0)
        .build();
  }
}
Player.java

SimpleBasePlayer 會強制使用有效的狀態值組合建立 State。此外，也會處理監聽器，並通知監聽器狀態變更。如要手動觸發狀態更新，請呼叫 invalidateState()。

除了 getState() 方法之外，您只需要實作播放器宣告可用的指令所用的方法。找出與要實作功能相應的可覆寫處理常式方法。舉例來說，覆寫 handleSeek() 方法，即可支援 COMMAND_SEEK_IN_CURRENT_MEDIA_ITEM 和 COMMAND_SEEK_TO_NEXT_MEDIA_ITEM 等作業。

修改 Player 導入方式

您可以選擇不建立完全自訂的 Player，而是使用 ForwardingSimpleBasePlayer 修改現有 Player 的狀態和行為。詳情請參閱自訂頁面指南。