カスタマイズ

ExoPlayer ライブラリの中核は Player インターフェースです。Player は、メディアのバッファリング、再生、一時停止、シークなどの従来の高レベルのメディア プレーヤー機能を公開します。デフォルトの実装 ExoPlayer は、再生されるメディアのタイプ、保存方法と保存場所、レンダリング方法について、ほとんど想定しない(したがって、ほとんど制限を課さない)ように設計されています。ExoPlayer 実装では、メディアの読み込みとレンダリングを直接実装するのではなく、プレーヤーの作成時または新しいメディアソースがプレーヤーに渡されたときに挿入されるコンポーネントにこの作業を委任します。すべての ExoPlayer 実装に共通するコンポーネントは次のとおりです。

  • 再生するメディアを定義し、メディアを読み込み、読み込んだメディアを読み取ることができる MediaSource インスタンス。MediaSource インスタンスは、プレーヤー内の MediaSource.Factory によって MediaItem から作成されます。メディアソース ベースのプレイリスト API を使用して、プレーヤーに直接渡すこともできます。
  • MediaItemMediaSource に変換する MediaSource.Factory インスタンス。MediaSource.Factory は、プレーヤーの作成時に挿入されます。
  • メディアの個々のコンポーネントをレンダリングする Renderer インスタンス。これらは、プレーヤーの作成時に挿入されます。
  • 利用可能な各 Renderer で使用される MediaSource によって提供されるトラックを選択する TrackSelector。プレーヤーの作成時に TrackSelector が挿入されます。
  • MediaSource がメディアをバッファリングするタイミングと、バッファリングするメディアの量を制御する LoadControl。プレーヤーの作成時に LoadControl が挿入されます。
  • ライブ再生中の再生速度を制御する LivePlaybackSpeedControl。プレーヤーが設定されたライブ オフセットに近い状態を維持できるようにします。プレーヤーの作成時に LivePlaybackSpeedControl が挿入されます。

プレーヤーの機能の一部を実装するコンポーネントを挿入するというコンセプトは、ライブラリ全体に存在します。一部のコンポーネントのデフォルト実装では、さらに挿入されたコンポーネントに作業を委任します。これにより、多くのサブコンポーネントを、カスタム構成された実装に個別に置き換えることができます。

プレーヤーのカスタマイズ

コンポーネントを挿入してプレーヤーをカスタマイズする一般的な例を以下に示します。

ネットワーク スタックの構成

ExoPlayer で使用されるネットワーク スタックのカスタマイズに関するページをご覧ください。

ネットワークから読み込まれたデータのキャッシュ保存

一時的なオンザフライ キャッシュ保存メディアのダウンロードに関するガイドをご覧ください。

サーバーとのやり取りをカスタマイズする

一部のアプリでは、HTTP リクエストとレスポンスをインターセプトすることがあります。カスタム リクエスト ヘッダーの挿入、サーバーのレスポンス ヘッダーの読み取り、リクエストの URI の変更などを行うことができます。たとえば、メディア セグメントをリクエストする際に、トークンをヘッダーとして挿入することで、アプリが認証を行うことができます。

次の例は、カスタム DataSource.FactoryDefaultMediaSourceFactory に挿入して、これらの動作を実装する方法を示しています。

Kotlin

val dataSourceFactory =
  DataSource.Factory {
    val dataSource = httpDataSourceFactory.createDataSource()
    // Set a custom authentication request header.
    dataSource.setRequestProperty("Header", "Value")
    dataSource
  }
val player =
  ExoPlayer.Builder(context)
    .setMediaSourceFactory(
      DefaultMediaSourceFactory(context).setDataSourceFactory(dataSourceFactory)
    )
    .build()

Java

DataSource.Factory dataSourceFactory =
    () -> {
      HttpDataSource dataSource = httpDataSourceFactory.createDataSource();
      // Set a custom authentication request header.
      dataSource.setRequestProperty("Header", "Value");
      return dataSource;
    };

ExoPlayer player =
    new ExoPlayer.Builder(context)
        .setMediaSourceFactory(
            new DefaultMediaSourceFactory(context).setDataSourceFactory(dataSourceFactory))
        .build();

上記のコード スニペットでは、挿入された HttpDataSource には、すべての HTTP リクエストに "Header: Value" ヘッダーが含まれています。この動作は、HTTP ソースとのすべてのインタラクションで修正されています。

よりきめ細かいアプローチとして、ResolvingDataSource を使用してジャストインタイム動作を挿入できます。次のコード スニペットは、HTTP ソースとやり取りする直前にリクエスト ヘッダーを挿入する方法を示しています。

Kotlin

val dataSourceFactory: DataSource.Factory =
  ResolvingDataSource.Factory(httpDataSourceFactory) { dataSpec: DataSpec ->
    // Provide just-in-time request headers.
    dataSpec.withRequestHeaders(getCustomHeaders(dataSpec.uri))
  }

Java

    DataSource.Factory dataSourceFactory =
        new ResolvingDataSource.Factory(
            httpDataSourceFactory,
            // Provide just-in-time request headers.
            dataSpec -> dataSpec.withRequestHeaders(getCustomHeaders(dataSpec.uri)));

次のスニペットに示すように、ResolvingDataSource を使用して URI のジャストインタイム変更を行うこともできます。

Kotlin

val dataSourceFactory: DataSource.Factory =
  ResolvingDataSource.Factory(httpDataSourceFactory) { dataSpec: DataSpec ->
    // Provide just-in-time URI resolution logic.
    dataSpec.withUri(resolveUri(dataSpec.uri))
  }

Java

DataSource.Factory dataSourceFactory =
    new ResolvingDataSource.Factory(
        httpDataSourceFactory,
        // Provide just-in-time URI resolution logic.
        dataSpec -> dataSpec.withUri(resolveUri(dataSpec.uri)));

エラー処理のカスタマイズ

カスタム LoadErrorHandlingPolicy を実装すると、アプリは ExoPlayer が読み込みエラーに反応する方法をカスタマイズできます。たとえば、アプリは何度も再試行するのではなく、すぐに失敗させたい場合や、各再試行の間にプレーヤーが待機する時間を制御するバックオフ ロジックをカスタマイズしたい場合があります。次のスニペットは、カスタム バックオフ ロジックの実装方法を示しています。

Kotlin

val loadErrorHandlingPolicy: LoadErrorHandlingPolicy =
  object : DefaultLoadErrorHandlingPolicy() {
    override fun getRetryDelayMsFor(loadErrorInfo: LoadErrorInfo): Long {
      // Implement custom back-off logic here.
      return 0
    }
  }
val player =
  ExoPlayer.Builder(context)
    .setMediaSourceFactory(
      DefaultMediaSourceFactory(context).setLoadErrorHandlingPolicy(loadErrorHandlingPolicy)
    )
    .build()

Java

LoadErrorHandlingPolicy loadErrorHandlingPolicy =
    new DefaultLoadErrorHandlingPolicy() {
      @Override
      public long getRetryDelayMsFor(LoadErrorInfo loadErrorInfo) {
        // Implement custom back-off logic here.
        return 0;
      }
    };

ExoPlayer player =
    new ExoPlayer.Builder(context)
        .setMediaSourceFactory(
            new DefaultMediaSourceFactory(context)
                .setLoadErrorHandlingPolicy(loadErrorHandlingPolicy))
        .build();

LoadErrorInfo 引数には、読み込みの失敗に関する詳細情報が含まれており、エラータイプや失敗したリクエストに基づいてロジックをカスタマイズできます。

エクストラクタ フラグのカスタマイズ

エクストラクタ フラグを使用して、プログレッシブ メディアから個々の形式を抽出する方法をカスタマイズできます。これらは、DefaultMediaSourceFactory に提供される DefaultExtractorsFactory で設定できます。次の例では、MP3 ストリームのインデックス ベースのシークを有効にするフラグを渡します。

Kotlin

val extractorsFactory =
  DefaultExtractorsFactory().setMp3ExtractorFlags(Mp3Extractor.FLAG_ENABLE_INDEX_SEEKING)
val player =
  ExoPlayer.Builder(context)
    .setMediaSourceFactory(DefaultMediaSourceFactory(context, extractorsFactory))
    .build()

Java

DefaultExtractorsFactory extractorsFactory =
    new DefaultExtractorsFactory().setMp3ExtractorFlags(Mp3Extractor.FLAG_ENABLE_INDEX_SEEKING);

ExoPlayer player =
    new ExoPlayer.Builder(context)
        .setMediaSourceFactory(new DefaultMediaSourceFactory(context, extractorsFactory))
        .build();

定数ビットレート シークを有効にする

MP3、ADTS、AMR ストリームの場合、FLAG_ENABLE_CONSTANT_BITRATE_SEEKING フラグで一定のビットレートを仮定して、おおよそのシークを有効にできます。これらのフラグは、上記のように個々の DefaultExtractorsFactory.setXyzExtractorFlags メソッドを使用して、個々の抽出ツールに設定できます。定ビットレート シークをサポートするすべてのエクストラクタで有効にするには、DefaultExtractorsFactory.setConstantBitrateSeekingEnabled を使用します。

Kotlin

val extractorsFactory = DefaultExtractorsFactory().setConstantBitrateSeekingEnabled(true)

Java

DefaultExtractorsFactory extractorsFactory =
    new DefaultExtractorsFactory().setConstantBitrateSeekingEnabled(true);

ExtractorsFactory は、上記で説明した抽出ツールのフラグのカスタマイズと同様に、DefaultMediaSourceFactory を介して挿入できます。

非同期バッファ キューイングを有効にする

非同期バッファ キューイングは、ExoPlayer のレンダリング パイプラインの拡張機能です。MediaCodec インスタンスを非同期モードで動作させ、追加のスレッドを使用してデータのデコードとレンダリングをスケジュールします。有効にすると、フレーム落ちやオーディオ アンダーランを減らすことができます。

非同期バッファ キューイングは、Android 12(API レベル 31)以上を搭載しているデバイスではデフォルトで有効になっています。Android 6.0(API レベル 23)以降では、手動で有効にできます。特に DRM で保護されたコンテンツや高フレームレートのコンテンツを再生しているときに、フレーム落ちや音声アンダーランが発生する特定のデバイスで、この機能を有効にすることを検討してください。

最も単純なケースでは、次のように DefaultRenderersFactory をプレーヤーに挿入する必要があります。

Kotlin

val renderersFactory = 
  DefaultRenderersFactory(context).forceEnableMediaCodecAsynchronousQueueing()
val exoPlayer = ExoPlayer.Builder(context, renderersFactory).build()

Java

DefaultRenderersFactory renderersFactory =
    new DefaultRenderersFactory(context).forceEnableMediaCodecAsynchronousQueueing();
ExoPlayer exoPlayer = new ExoPlayer.Builder(context, renderersFactory).build();

レンダラを直接インスタンス化する場合は、new DefaultMediaCodecAdapter.Factory(context).forceEnableAsynchronous()MediaCodecVideoRenderer コンストラクタと MediaCodecAudioRenderer コンストラクタに渡します。

ForwardingSimpleBasePlayer を使用したオペレーションのカスタマイズ

Player インスタンスの動作の一部は、ForwardingSimpleBasePlayer のサブクラスでラップすることでカスタマイズできます。このクラスを使用すると、Player メソッドを直接実装するのではなく、特定の「オペレーション」をインターセプトできます。これにより、play()pause()setPlayWhenReady(boolean) などの動作の一貫性が確保されます。また、すべての状態変更が登録済みの Player.Listener インスタンスに正しく伝播されるようにします。ほとんどのカスタマイズのユースケースでは、整合性の保証があるため、エラーが発生しやすい ForwardingPlayer よりも ForwardingSimpleBasePlayer を優先する必要があります。

たとえば、再生の開始時または停止時にカスタム ロジックを追加するには:

Kotlin

class PlayerWithCustomPlay(player: Player) : ForwardingSimpleBasePlayer(player) {
  override fun handleSetPlayWhenReady(playWhenReady: Boolean): ListenableFuture<*> {
    // Add custom logic
    return super.handleSetPlayWhenReady(playWhenReady)
  }
}

Java

class PlayerWithCustomPlay extends ForwardingSimpleBasePlayer {

  public PlayerWithCustomPlay(Player player) {
    super(player);
  }

  @Override
  protected ListenableFuture<?> handleSetPlayWhenReady(boolean playWhenReady) {
    // Add custom logic
    return super.handleSetPlayWhenReady(playWhenReady);
  }
}

または、SEEK_TO_NEXT コマンドを禁止する(Player.seekToNext が no-op であることを確認する)には:

Kotlin

class PlayerWithoutSeekToNext(player: Player) : ForwardingSimpleBasePlayer(player) {
  override fun getState(): State {
    val state = super.getState()
    return state
      .buildUpon()
      .setAvailableCommands(
        state.availableCommands.buildUpon().remove(COMMAND_SEEK_TO_NEXT).build()
      )
      .build()
  }

  // We don't need to override handleSeek, because it is guaranteed not to be called for
  // COMMAND_SEEK_TO_NEXT since we've marked that command unavailable.
}

Java

class PlayerWithoutSeekToNext extends ForwardingSimpleBasePlayer {

  public PlayerWithoutSeekToNext(Player player) {
    super(player);
  }

  @Override
  protected State getState() {
    State state = super.getState();
    return state
        .buildUpon()
        .setAvailableCommands(
            state.availableCommands.buildUpon().remove(COMMAND_SEEK_TO_NEXT).build())
        .build();
  }

  // We don't need to override handleSeek, because it is guaranteed not to be called for
  // COMMAND_SEEK_TO_NEXT since we've marked that command unavailable.
}

MediaSource のカスタマイズ

上記の例では、プレーヤーに渡されたすべての MediaItem オブジェクトの再生中に使用するカスタマイズされたコンポーネントを挿入しています。きめ細かいカスタマイズが必要な場合は、カスタマイズされたコンポーネントを個々の MediaSource インスタンスに挿入して、プレーヤーに直接渡すこともできます。次の例は、カスタムの DataSource.FactoryExtractorsFactoryLoadErrorHandlingPolicy を使用するように ProgressiveMediaSource をカスタマイズする方法を示しています。

Kotlin

val mediaSource =
  ProgressiveMediaSource.Factory(customDataSourceFactory, customExtractorsFactory)
    .setLoadErrorHandlingPolicy(customLoadErrorHandlingPolicy)
    .createMediaSource(MediaItem.fromUri(streamUri))

Java

ProgressiveMediaSource mediaSource =
    new ProgressiveMediaSource.Factory(customDataSourceFactory, customExtractorsFactory)
        .setLoadErrorHandlingPolicy(customLoadErrorHandlingPolicy)
        .createMediaSource(MediaItem.fromUri(streamUri));

カスタム コンポーネントの作成

このライブラリには、このページの上部に記載されているコンポーネントのデフォルト実装が、一般的なユースケース向けに用意されています。ExoPlayer はこれらのコンポーネントを使用できますが、標準外の動作が必要な場合は、カスタム実装を使用するように構築することもできます。カスタム実装のユースケースは次のとおりです。

  • Renderer - ライブラリが提供するデフォルト実装でサポートされていないメディアタイプを処理するために、カスタム Renderer を実装することがあります。
  • TrackSelector - カスタム TrackSelector を実装すると、アプリ デベロッパーは、利用可能な各 Renderer が消費する MediaSource によって公開されるトラックの選択方法を変更できます。
  • LoadControl - カスタム LoadControl を実装すると、アプリ デベロッパーはプレーヤーのバッファリング ポリシーを変更できます。
  • Extractor - ライブラリで現在サポートされていないコンテナ形式をサポートする必要がある場合は、カスタム Extractor クラスの実装を検討してください。
  • MediaSource - カスタム MediaSource クラスの実装は、レンダラに供給するメディア サンプルをカスタム方法で取得する場合や、カスタム MediaSource 合成動作を実装する場合に適しています。
  • MediaSource.Factory - カスタム MediaSource.Factory を実装すると、アプリは MediaItem から MediaSource を作成する方法をカスタマイズできます。
  • DataSource - ExoPlayer のアップストリーム パッケージには、さまざまなユースケースに対応する DataSource 実装がすでに多数含まれています。カスタム プロトコル経由、カスタム HTTP スタックの使用、カスタム永続キャッシュからの読み込みなど、別の方法でデータを読み込むために、独自の DataSource クラスを実装することがあります。

カスタム コンポーネントを構築する場合は、次のことをおすすめします。

  • カスタム コンポーネントがアプリにイベントをレポートする必要がある場合は、既存の ExoPlayer コンポーネントと同じモデルを使用することをおすすめします。たとえば、EventDispatcher クラスを使用したり、Handler とリスナーをコンポーネントのコンストラクタに渡したりします。
  • カスタム コンポーネントでは、既存の ExoPlayer コンポーネントと同じモデルを使用して、再生中にアプリによる再構成を可能にすることをおすすめします。そのため、カスタム コンポーネントは PlayerMessage.Target を実装し、handleMessage メソッドで構成の変更を受け取る必要があります。アプリケーション コードは、ExoPlayer の createMessage メソッドを呼び出し、メッセージを構成して、PlayerMessage.send を使用してコンポーネントに送信することで、構成の変更を渡す必要があります。再生スレッドで配信されるメッセージを送信すると、プレーヤーで実行される他のオペレーションと順番に実行されます。