Panduan migrasi AndroidX Media3

Aplikasi yang saat ini menggunakan library com.google.android.exoplayer2 mandiri dan androidx.media harus dimigrasikan ke androidx.media3. Gunakan skrip migrasi untuk memigrasikan file build gradle, file sumber Java dan Kotlin, serta file tata letak XML dari ExoPlayer 2.19.1 ke AndroidX Media3 1.1.1.

Ringkasan

Sebelum bermigrasi, tinjau bagian berikut untuk mempelajari lebih lanjut manfaat API baru, API yang akan dimigrasikan, dan prasyarat yang harus dipenuhi project aplikasi Anda.

Alasan bermigrasi ke Jetpack Media3

• Ini adalah rumah baru ExoPlayer, sedangkan com.google.android.exoplayer2 dihentikan.
• Akses Player API di seluruh komponen/proses dengan MediaBrowser/MediaController.
• Gunakan kemampuan yang diperluas dari API MediaSession dan MediaController.
• Iklankan kemampuan pemutaran dengan kontrol akses terperinci.
• Sederhanakan aplikasi Anda dengan menghapus MediaSessionConnector dan PlayerNotificationManager.
• Kompatibel dengan versi sebelumnya dengan API klien media-compat (MediaBrowserCompat/MediaControllerCompat/MediaMetadataCompat)

Media API untuk dimigrasikan ke AndroidX Media3

• ExoPlayer dan ekstensi-ekstensinya
  Ini mencakup semua modul project ExoPlayer lama kecuali modul mediasession yang dihentikan. Aplikasi atau modul yang bergantung pada paket di com.google.android.exoplayer2 dapat dimigrasikan dengan skrip migrasi.
• MediaSessionConnector (bergantung pada paket androidx.media.* dari androidx.media:media:1.4.3+)
  Hapus MediaSessionConnector dan gunakan androidx.media3.session.MediaSession sebagai gantinya.
• MediaBrowserServiceCompat (bergantung pada paket androidx.media.* dari androidx.media:media:1.4.3+)
  Memigrasikan subclass androidx.media.MediaBrowserServiceCompat ke androidx.media3.session.MediaLibraryService dan kode menggunakan MediaBrowserCompat.MediaItem ke androidx.media3.common.MediaItem.
• MediaBrowserCompat (bergantung pada paket android.support.v4.media.* dari androidx.media:media:1.4.3+)
  Memigrasikan kode klien menggunakan MediaBrowserCompat atau MediaControllerCompat untuk menggunakan androidx.media3.session.MediaBrowser dengan androidx.media3.common.MediaItem.

Prasyarat

1. Memastikan project Anda berada dalam kontrol sumber

   Pastikan Anda dapat dengan mudah mengembalikan perubahan yang diterapkan oleh alat migrasi dengan skrip. Jika Anda belum memiliki project dalam kontrol sumber, sekarang adalah waktu yang tepat untuk memulainya. Jika karena alasan tertentu Anda tidak ingin melakukannya, buat salinan cadangan project sebelum memulai migrasi.

2. Mengupdate aplikasi

   • Sebaiknya update project Anda untuk menggunakan library ExoPlayer versi terbaru dan hapus panggilan ke metode yang tidak digunakan lagi. Jika ingin menggunakan skrip untuk migrasi, Anda harus mencocokkan versi yang diupdate dengan versi yang ditangani oleh skrip.

   • Tingkatkan compileSdkVersion aplikasi Anda minimal ke 32.

   • Upgrade Gradle dan plugin Gradle Android Studio ke versi terbaru yang berfungsi dengan dependensi yang diupdate dari atas. Misalnya:

     • Versi Plugin Android Gradle: 7.1.0
     • Versi Gradle: 7.4

   • Ganti semua pernyataan impor karakter pengganti yang menggunakan tanda bintang (*) dan gunakan pernyataan impor yang sepenuhnya memenuhi syarat: Hapus pernyataan impor karakter pengganti dan gunakan Android Studio untuk mengimpor pernyataan yang sepenuhnya memenuhi syarat (F2 - Alt/Enter, F2 - Alt/Enter, ...).

   • Melakukan migrasi dari com.google.android.exoplayer2.PlayerView ke com.google.android.exoplayer2.StyledPlayerView. Hal ini diperlukan karena tidak ada yang setara dengan com.google.android.exoplayer2.PlayerView di AndroidX Media3.

Memigrasikan ExoPlayer dengan dukungan skrip

Skrip ini memfasilitasi perpindahan dari com.google.android.exoplayer2 ke struktur paket dan modul baru di bagian androidx.media3. Skrip ini menerapkan beberapa pemeriksaan validasi pada project Anda dan mencetak peringatan jika validasi gagal. Jika tidak, plugin ini akan menerapkan pemetaan class dan paket yang diganti namanya dalam resource project gradle Android yang ditulis dalam Java atau Kotlin.

usage: ./media3-migration.sh [-p|-c|-d|-v]|[-m|-l [-x <path>] [-f] PROJECT_ROOT]
 PROJECT_ROOT: path to your project root (location of 'gradlew')
 -p: list package mappings and then exit
 -c: list class mappings (precedence over package mappings) and then exit
 -d: list dependency mappings and then exit
 -l: list files that will be considered for rewrite and then exit
 -x: exclude the path from the list of file to be changed: 'app/src/test'
 -m: migrate packages, classes and dependencies to AndroidX Media3
 -f: force the action even when validation fails
 -v: print the exoplayer2/media3 version strings of this script
 -h, --help: show this help text

Menggunakan skrip migrasi

1. Download skrip migrasi dari tag project ExoPlayer di GitHub yang sesuai dengan versi yang telah Anda update untuk aplikasi:

   curl -o media3-migration.sh \
     "https://raw.githubusercontent.com/google/ExoPlayer/r2.19.1/media3-migration.sh"
   

2. Setel agar skrip dapat dieksekusi:

   chmod 744 media3-migration.sh
   

3. Jalankan skrip dengan --help untuk mempelajari opsi.

4. Jalankan skrip dengan -l untuk mencantumkan kumpulan file yang dipilih untuk migrasi (gunakan -f untuk memaksa listingan tanpa peringatan):

   ./media3-migration.sh -l -f /path/to/gradle/project/root
   

5. Jalankan skrip dengan -m untuk memetakan paket, class, dan modul ke Media3. Menjalankan skrip dengan opsi -m akan menerapkan perubahan pada file yang dipilih.

   • Berhenti pada error validasi tanpa membuat perubahan

   ./media3-migration.sh -m /path/to/gradle/project/root
   

   • Eksekusi paksa

   Jika skrip menemukan pelanggaran prasyarat, migrasi dapat dipaksakan dengan tanda -f:

   ./media3-migration.sh -m -f /path/to/gradle/project/root
   

 # list files selected for migration when excluding paths
 ./media3-migration.sh -l -x "app/src/test/" -x "service/" /path/to/project/root
 # migrate the selected files
 ./media3-migration.sh -m -x "app/src/test/" -x "service/" /path/to/project/root

Selesaikan langkah-langkah manual berikut setelah menjalankan skrip dengan opsi -m:

1. Periksa bagaimana skrip mengubah kode Anda: Gunakan alat diff dan perbaiki masalah potensial (pertimbangkan untuk melaporkan bug jika Anda merasa skrip memiliki masalah umum yang diperkenalkan tanpa meneruskan opsi -f).
2. Mem-build project: Gunakan ./gradlew clean build atau di Android Studio, pilih File > Sync Project with Gradle Files, lalu Build > Clean project, lalu Build > Rebuild project (monitor build Anda di tab'Build - Build Output' di Android Studio.

Langkah-langkah tindak lanjut yang direkomendasikan:

1. Selesaikan keikutsertaan untuk error terkait penggunaan API yang tidak stabil.
2. Mengganti panggilan API yang tidak digunakan lagi: Gunakan API penggantian yang disarankan. Tahan pointer di atas peringatan di Android Studio, dan lihat JavaDoc simbol yang tidak digunakan lagi untuk mengetahui apa yang akan digunakan, bukan panggilan tertentu.
3. Urutkan pernyataan impor: Buka project di Android Studio, lalu klik kanan node folder paket di penampil project dan pilih Optimalkan impor pada paket yang berisi file sumber yang diubah.

Ganti MediaSessionConnector dengan androidx.media3.session.MediaSession

Di dunia MediaSessionCompat lama, MediaSessionConnector bertanggung jawab untuk menyinkronkan status pemutar dengan status sesi dan menerima perintah dari pengontrol yang memerlukan delegasi ke metode pemutar yang sesuai. Dengan AndroidX Media3, hal ini dilakukan oleh MediaSession secara langsung tanpa memerlukan konektor.

1. Hapus semua referensi dan penggunaan MediaSessionConnector: Jika Anda menggunakan skrip otomatis untuk memigrasikan class dan paket ExoPlayer, skrip tersebut mungkin telah membuat kode Anda dalam status yang tidak dapat dikompilasi terkait MediaSessionConnector yang tidak dapat di-resolve. Android Studio akan menampilkan kode yang rusak saat Anda mencoba mem-build atau memulai aplikasi.

2. Dalam file build.gradle tempat Anda mengelola dependensi, tambahkan dependensi implementasi ke modul sesi AndroidX Media3 dan hapus dependensi lama:

   implementation "androidx.media3:media3-session:1.5.0"
   

3. Ganti MediaSessionCompat dengan androidx.media3.session.MediaSession.

4. Di situs kode tempat Anda membuat MediaSessionCompat lama, gunakan androidx.media3.session.MediaSession.Builder untuk mem-build MediaSession. Teruskan pemutar untuk membuat builder sesi.

   val player = ExoPlayer.Builder(context).build()
   mediaSession = MediaSession.Builder(context, player)
       .setSessionCallback(MySessionCallback())
       .build()
   

5. Terapkan MySessionCallback seperti yang diperlukan oleh aplikasi Anda. Tindakan ini bersifat opsional. Jika Anda ingin mengizinkan pengontrol menambahkan item media ke pemutar, terapkan MediaSession.Callback.onAddMediaItems(). API ini menyediakan berbagai metode API saat ini dan lama yang menambahkan item media ke pemutar untuk diputar dengan cara yang kompatibel dengan versi sebelumnya. Hal ini mencakup metode MediaController.set/addMediaItems() pengontrol Media3, serta metode TransportControls.prepareFrom*/playFrom* dari API lama. Contoh implementasi onAddMediaItems dapat ditemukan di PlaybackService aplikasi demo sesi.

6. Rilis sesi media di situs kode tempat Anda menghancurkan sesi sebelum migrasi:

   mediaSession?.run {
     player.release()
     release()
     mediaSession = null
   }
   

Fungsi MediaSessionConnector di Media3

Tabel berikut menunjukkan Media3 API yang menangani fungsi yang sebelumnya diimplementasikan di MediaSessionConnector.

Memigrasikan MediaBrowserService ke MediaLibraryService

AndroidX Media3 memperkenalkan MediaLibraryService yang menggantikan MediaBrowserServiceCompat. JavaDoc MediaLibraryService dan super class-nya, MediaSessionService, memberikan pengantar yang baik tentang API dan model pemrograman asinkron layanan.

MediaLibraryService kompatibel dengan versi sebelumnya MediaBrowserService. Aplikasi klien yang menggunakan MediaBrowserCompat atau MediaControllerCompat, akan terus berfungsi tanpa perubahan kode saat terhubung ke MediaLibraryService. Untuk klien, transparan apakah aplikasi Anda menggunakan MediaLibraryService atau MediaBrowserServiceCompat lama.

1. Agar kompatibilitas mundur berfungsi, Anda harus mendaftarkan kedua antarmuka layanan dengan layanan Anda di AndroidManifest.xml. Dengan cara ini, klien akan menemukan layanan Anda berdasarkan antarmuka layanan yang diperlukan:

   <service android:name=".MusicService" android:exported="true">
       <intent-filter>
           <action android:name="androidx.media3.session.MediaLibraryService"/>
           <action android:name="android.media.browse.MediaBrowserService" />
       </intent-filter>
   </service>
   

2. Dalam file build.gradle tempat Anda mengelola dependensi, tambahkan dependensi implementasi ke modul sesi AndroidX Media3 dan hapus dependensi lama:

   implementation "androidx.media3:media3-session:1.5.0"
   

3. Ubah layanan Anda untuk mewarisi dari MediaLibraryService, bukan MediaBrowserService Seperti yang telah disebutkan sebelumnya, MediaLibraryService kompatibel dengan MediaBrowserService lama. Oleh karena itu, API yang lebih luas yang ditawarkan layanan kepada klien masih sama. Jadi, kemungkinan aplikasi dapat mempertahankan sebagian besar logika yang diperlukan untuk menerapkan MediaBrowserService dan menyesuaikannya untuk MediaLibraryService baru.

   Perbedaan utamanya dibandingkan dengan MediaBrowserServiceCompat lama adalah sebagai berikut:

   • Terapkan metode siklus proses layanan: Metode yang perlu diganti pada layanan itu sendiri adalah onCreate/onDestroy, tempat aplikasi mengalokasikan/merilis sesi library, pemutar, dan resource lainnya. Selain metode siklus proses layanan standar, aplikasi harus mengganti onGetSession(MediaSession.ControllerInfo) untuk menampilkan MediaLibrarySession yang dibuat di onCreate.

   • Implementasikan MediaLibraryService.MediaLibrarySessionCallback: Membuat sesi memerlukan MediaLibraryService.MediaLibrarySessionCallback yang mengimplementasikan metode API domain yang sebenarnya. Jadi, alih-alih mengganti metode API layanan lama, Anda akan mengganti metode MediaLibrarySession.Callback.

     Callback kemudian digunakan untuk mem-build MediaLibrarySession:

     mediaLibrarySession =
           MediaLibrarySession.Builder(this, player, MySessionCallback())
              .build()
     

     Temukan API lengkap MediaLibrarySessionCallback dalam dokumentasi API.

   • Terapkan MediaSession.Callback.onAddMediaItems(): Callback onAddMediaItems(MediaSession, ControllerInfo, List<MediaItem>) menayangkan berbagai metode API saat ini dan lama yang menambahkan item media ke pemutar untuk pemutaran dengan cara yang kompatibel dengan versi lama. Hal ini mencakup metode MediaController.set/addMediaItems() pengontrol Media3, serta metode TransportControls.prepareFrom*/playFrom* dari API lama. Contoh implementasi callback dapat ditemukan di PlaybackService aplikasi demo sesi.

   • AndroidX Media3 menggunakan androidx.media3.common.MediaItem, bukan MediaBrowserCompat.MediaItem dan MediaMetadataCompat. Bagian kode Anda yang terikat dengan class lama harus diubah sesuai kebutuhan atau dipetakan ke MediaItem Media3.

   • Model pemrograman asinkron umum diubah menjadi Futures, yang berbeda dengan pendekatan Result yang dapat dilepas dari MediaBrowserServiceCompat. Implementasi layanan Anda dapat menampilkan ListenableFuture asinkron, bukan melepaskan hasil atau menampilkan Future langsung untuk langsung menampilkan nilai.

Menghapus PlayerNotificationManager

MediaLibraryService mendukung notifikasi media secara otomatis dan PlayerNotificationManager dapat dihapus saat menggunakan MediaLibraryService atau MediaSessionService.

Aplikasi dapat menyesuaikan notifikasi dengan menetapkan MediaNotification.Provider kustom di onCreate() yang menggantikan DefaultMediaNotificationProvider. MediaLibraryService kemudian akan menangani memulai layanan di latar depan sesuai kebutuhan.

Dengan mengganti MediaLibraryService.updateNotification(), aplikasi dapat mengambil kepemilikan penuh untuk memposting notifikasi dan memulai/menghentikan layanan di latar depan sesuai kebutuhan.

Memigrasikan kode klien menggunakan MediaBrowser

Dengan AndroidX Media3, MediaBrowser mengimplementasikan antarmuka MediaController/Player dan dapat digunakan untuk mengontrol pemutaran media selain menjelajahi library media. Jika Anda harus membuat MediaBrowserCompat dan MediaControllerCompat di dunia lama, Anda dapat melakukan hal yang sama hanya dengan menggunakan MediaBrowser di Media3.

MediaBrowser dapat dibuat dan menunggu koneksi ke layanan yang dibuat:

scope.launch {
    val sessionToken =
        SessionToken(context, ComponentName(context, MusicService::class.java)
    browser =
        MediaBrowser.Builder(context, sessionToken))
            .setListener(BrowserListener())
            .buildAsync()
            .await()
    // Get the library root to start browsing the library.
    root = browser.getLibraryRoot(/* params= */ null).await();
    // Add a MediaController.Listener to listen to player state events.
    browser.addListener(playerListener)
    playerView.setPlayer(browser)
}

Lihat Mengontrol pemutaran dalam sesi media untuk mempelajari cara membuat MediaController guna mengontrol pemutaran di latar belakang.

Langkah-langkah selanjutnya dan pembersihan

Error API yang tidak stabil

Setelah bermigrasi ke Media3, Anda mungkin melihat error lint tentang penggunaan API yang tidak stabil. API ini aman digunakan dan error lint adalah produk sampingan dari jaminan kompatibilitas biner baru kami. Jika Anda tidak memerlukan kompatibilitas biner ketat, error ini dapat disembunyikan dengan aman menggunakan anotasi @OptIn.

Latar belakang

ExoPlayer v1 atau v2 tidak memberikan jaminan ketat tentang kompatibilitas biner library antara versi berikutnya. Platform ExoPlayer API sangat besar secara desain, agar aplikasi dapat menyesuaikan hampir setiap aspek pemutaran. Versi ExoPlayer berikutnya terkadang akan memperkenalkan penggantian nama simbol atau perubahan yang menyebabkan error lainnya (misalnya, metode baru yang diperlukan di antarmuka). Dalam sebagian besar kasus, kerusakan ini dimitigasi dengan memperkenalkan simbol baru bersama dengan penghentian simbol lama untuk beberapa versi, agar developer memiliki waktu untuk memigrasikan penggunaannya, tetapi hal ini tidak selalu memungkinkan.

Perubahan yang menyebabkan gangguan ini mengakibatkan dua masalah bagi pengguna library ExoPlayer v1 dan v2:

1. Upgrade dari ke versi ExoPlayer dapat menyebabkan kode berhenti dikompilasi.
2. Aplikasi yang bergantung pada ExoPlayer secara langsung dan melalui library perantara harus memastikan bahwa kedua dependensi tersebut memiliki versi yang sama, jika tidak, inkompatibilitas biner dapat menyebabkan error runtime.

Peningkatan di Media3

Media3 menjamin kompatibilitas biner untuk sebagian platform API. Bagian yang tidak menjamin kompatibilitas biner ditandai dengan @UnstableApi. Untuk memperjelas perbedaan ini, penggunaan simbol API yang tidak stabil akan menghasilkan error lint kecuali jika dianotasikan dengan @OptIn.

Setelah bermigrasi dari ExoPlayer v2 ke Media3, Anda mungkin melihat banyak error lint API yang tidak stabil. Hal ini mungkin membuat Media3 tampak 'kurang stabil' daripada ExoPlayer v2. Bukan itu masalahnya. Bagian 'tidak stabil' dari Media3 API memiliki tingkat stabilitas yang sama dengan keseluruhan platform API ExoPlayer v2, dan jaminan platform Media3 API yang stabil tidak tersedia di ExoPlayer v2 sama sekali. Perbedaannya adalah error lint kini memberi tahu Anda tentang berbagai tingkat stabilitas.

Menangani error lint API yang tidak stabil

Lihat bagian pemecahan masalah pada error lint ini untuk mengetahui detail tentang cara menambahkan anotasi pada penggunaan Java dan Kotlin untuk API yang tidak stabil dengan @OptIn.

API yang Tidak Digunakan Lagi

Anda mungkin melihat bahwa panggilan ke API yang tidak digunakan lagi dicoret di Android Studio. Sebaiknya ganti panggilan tersebut dengan alternatif yang sesuai. Arahkan kursor ke simbol untuk melihat JavaDoc yang memberi tahu API mana yang akan digunakan.

Contoh kode dan aplikasi demo

• Aplikasi demo sesi AndroidX Media3 (seluler dan WearOS)
  • Tindakan kustom
  • Notifikasi UI sistem, MediaButton/BT
  • Kontrol pemutaran Asisten Google
• UAMP: Android Media Player (cabang media3) (seluler, AutomotiveOS)
  • Notifikasi UI sistem, MediaButton/BT, Lanjutkan pemutaran
  • Kontrol pemutaran Asisten Google/WearOS
  • AutomotiveOS: perintah dan login kustom