スタート ガイド

Transformer の使用を開始する手順は次のとおりです。

  1. Media3 Transformer をプロジェクトの依存関係として追加します。
  2. 処理対象のメディアとそれに適用する編集を表す EditedMediaItem を作成します。
  3. Transformer を作成して、必要な出力と、完了イベントとエラーイベントのリスナーを記述します。
  4. エクスポート オペレーションを開始し、編集する EditedMediaItem と出力パスを渡します。エクスポート中に、現在の進行状況をクエリしたり、オペレーションをキャンセルしたりできます。
  5. エクスポートが終了したら、必要に応じて出力を処理します。たとえば、出力を別のアプリと共有したり、サーバーにアップロードしたりできます。

これらの手順の詳細については、以降で説明します。完全な例については、Transformer デモアプリの TransformerActivity をご覧ください。

Media3 Transformer を依存関係として追加する

Transformer の使用を開始する最も簡単な方法は、アプリ モジュールの build.gradle ファイル内のライブラリに Gradle 依存関係を追加することです。

Kotlin

implementation("androidx.media3:media3-transformer:1.3.1")
implementation("androidx.media3:media3-effect:1.3.1")
implementation("androidx.media3:media3-common:1.3.1")

Groovy

implementation "androidx.media3:media3-transformer:1.3.1"
implementation "androidx.media3:media3-effect:1.3.1"
implementation "androidx.media3:media3-common:1.3.1"

優先バージョンは 1.3.1 です。最新バージョンはリリースノートで確認できます。

利用可能なライブラリ モジュールの詳細については、Google Maven AndroidX Media3 のページをご覧ください。

Java 8 のサポートを有効にする

まだ有効になっていない場合は、android セクションに次の行を追加して、Transformer に依存するすべての build.gradle ファイルで Java 8 サポートを有効にする必要があります。

compileOptions {
  targetCompatibility JavaVersion.VERSION_1_8
}

変換を開始する

次の例では、EditedMediaItem を作成して入力ファイルの音声を削除し、Transformer インスタンスを作成して構成し、H.265/HEVC 動画をエクスポートして、結果を outputPath に出力しています。

Kotlin

val inputMediaItem = MediaItem.fromUri("path_to_input_file")
val editedMediaItem =
    EditedMediaItem.Builder(inputMediaItem).setRemoveAudio(true).build()
val transformer = Transformer.Builder(context)
    .setVideoMimeType(MimeTypes.VIDEO_H265)
    .addListener(transformerListener)
    .build()
transformer.start(editedMediaItem, outputPath)

Java

MediaItem inputMediaItem = MediaItem.fromUri("path_to_input_file");
EditedMediaItem editedMediaItem =
    new EditedMediaItem.Builder(inputMediaItem).setRemoveAudio(true).build();
Transformer transformer =
    new Transformer.Builder(context)
        .setVideoMimeType(MimeTypes.VIDEO_H265)
        .addListener(transformerListener)
        .build();
transformer.start(editedMediaItem, outputPath);

メディア アイテムの詳細については、ExoPlayer のメディア アイテムのページをご覧ください。入力はプログレッシブ ストリームまたはアダプティブ ストリームにできますが、出力は常にプログレッシブ ストリームです。アダプティブ入力では、変換に対して最高解像度のトラックが常に選択されます。入力は、ExoPlayer がサポートしている任意のコンテナ形式にできますが、出力は常に MP4 ファイルです。

同じ Transformer インスタンスに対して複数のエクスポート オペレーションを順次実行できます。ただし、同じインスタンスでの同時エクスポートはサポートされていません。

スレッドに関する注意事項

Transformer インスタンスには単一のアプリケーション スレッドからアクセスする必要があり、リスナー メソッドは同じスレッドで呼び出されます。ほとんどの場合、アプリスレッドはアプリのメインスレッドのみで構いません。内部的には、Transformer はバックグラウンドで処理を行い、その呼び出しをアプリスレッドのリスナー メソッドに送信します。

イベントをリッスンする

start メソッドは非同期です。すぐに返され、Transformer ビルダーに渡されたリスナーを介して、アプリにイベントが通知されます。

Kotlin

val transformerListener: Transformer.Listener =
    object : Transformer.Listener {
  override fun onCompleted(composition: Composition, result: ExportResult) {
    playOutput()
  }

  override fun onError(composition: Composition, result: ExportResult,
                       exception: ExportException) {
    displayError(exception)
  }
}

Java

Transformer.Listener transformerListener =
    new Transformer.Listener() {
      @Override
      public void onCompleted(Composition composition, ExportResult result) {
        playOutput();
      }

      @Override
      public void onError(Composition composition, ExportResult result,
          ExportException exception) {
        displayError(exception);
      }
    };

ExportResult には、必要に応じて音声と動画のファイルサイズや平均ビットレートなど、出力ファイルに関する情報が含まれます。

最新の進捗状況を確認する

Transformer.getProgress を呼び出して、変換の現在の進行状況をクエリします。戻り値は進行状況を示します。進行状況が PROGRESS_STATE_AVAILABLE の場合、指定された ProgressHolder は現在の進行状況の割合で更新されます。次の例は、変換の進行状況を定期的にクエリする方法を示しています。ここでは、進行状況バーを更新するために updateProgressInUi メソッドを実装できます。

Kotlin

transformer.start(inputMediaItem, outputPath)
val progressHolder = ProgressHolder()
mainHandler.post(
    object : Runnable {
      override fun run() {
        val progressState: @ProgressState Int = transformer.getProgress(progressHolder)
        updateProgressInUi(progressState, progressHolder)
        if (progressState != Transformer.PROGRESS_STATE_NOT_STARTED) {
          mainHandler.postDelayed(/* r= */this,  /* delayMillis= */500)
        }
      }
    }
)

Java

transformer.start(inputMediaItem, outputPath);
ProgressHolder progressHolder = new ProgressHolder();
mainHandler.post(
    new Runnable() {
      @Override
      public void run() {
        @Transformer.ProgressState int progressState = transformer.getProgress(progressHolder);
        updateProgressInUi(progressState, progressHolder);
        if (progressState != PROGRESS_STATE_NOT_STARTED) {
          mainHandler.postDelayed(/* r= */ this, /* delayMillis= */ 500);
        }
      }
    });

変換をキャンセルする

ユーザーがエクスポート フローの取り消しを選択した場合は、Transformer.cancel を使用してエクスポート オペレーションをキャンセルします。特にローエンド デバイスでは、ハードウェア動画コーデックなどのリソースは制限されるため、出力が必要ない場合はリソースを解放するためにこれを行うことが重要です。