Ringkasan MediaRouter

Tetap teratur dengan koleksi Simpan dan kategorikan konten berdasarkan preferensi Anda.

Untuk menggunakan framework MediaRouter dalam aplikasi, Anda harus mendapatkan instance objek MediaRouter dan melampirkan objek MediaRouter.Callback untuk memantau peristiwa perutean. Konten yang dikirim melalui rute media akan melewati MediaRouteProvider rute yang terkait (kecuali dalam beberapa situasi khusus, seperti perangkat output Bluetooth). Gambar 1 memberikan tampilan mendetail tentang class yang digunakan untuk merutekan konten antarperangkat.

Gambar 1. Ringkasan class router media utama yang digunakan oleh aplikasi.

Catatan: Jika ingin aplikasi Anda mendukung perangkat Google Cast, gunakan Cast SDK dan build aplikasi Anda sebagai pengirim Cast. Sebaiknya ikuti arahan dalam Dokumentasi Cast dan jangan gunakan framework MediaRouter secara langsung.

Tombol rute media

Aplikasi Android harus menggunakan tombol rute media untuk mengontrol perutean media. Framework MediaRouter menyediakan antarmuka standar untuk tombol ini, yang membantu pengguna mengenali dan menggunakan perutean saat tersedia. Tombol rute media biasanya terletak di sisi kanan panel tindakan aplikasi Anda, seperti dalam Gambar 2.

Gambar 2. Tombol rute media di panel tindakan.

Saat pengguna menekan tombol rute media, rute media yang tersedia akan muncul dalam daftar seperti pada gambar 3.

Gambar 3. Daftar rute media yang tersedia, yang ditampilkan setelah menekan tombol rute media.

Ikuti langkah-langkah berikut untuk membuat tombol rute media:

  1. Gunakan AppCompatActivity
  2. Tentukan item menu tombol rute media
  3. Buat MediaRouteSelector
  4. Tambahkan tombol rute media ke panel tindakan
  5. Buat dan kelola metode MediaRouter.Callback dalam siklus hidup aktivitas Anda

Bagian ini menjelaskan empat langkah pertama. Bagian berikutnya menjelaskan metode Callback.

Menggunakan AppCompatActivity

Jika menggunakan framework router media dalam aktivitas, Anda harus memperluas aktivitas dari AppCompatActivity dan mengimpor paket android.support.v7.media. Anda harus menambahkan support library v7-appcompat dan v7-mediarouter ke project pengembangan aplikasi Anda. Untuk informasi selengkapnya tentang menambahkan support library ke project, lihat Penyiapan Support Library.

Perhatian: Pastikan untuk menggunakan penerapan android.support.v7.media bagi framework router media. Jangan gunakan paket android.media yang lama.

Buat file xml yang menentukan item menu untuk tombol rute media. Tindakan item harus berupa class MediaRouteActionProvider. Berikut adalah file contohnya:

    // myMediaRouteButtonMenuItem.xml
    <?xml version="1.0" encoding="utf-8"?>
    <menu xmlns:android="http://schemas.android.com/apk/res/android"
          xmlns:app="http://schemas.android.com/apk/res-auto"
          >

        <item android:id="@+id/media_route_menu_item"
            android:title="@string/media_route_menu_title"
            app:actionProviderClass="android.support.v7.app.MediaRouteActionProvider"
            app:showAsAction="always"
        />
    </menu>

Membuat MediaRouteSelector

Rute yang muncul dalam menu tombol rute media ditentukan oleh MediaRouteSelector. Perluas aktivitas Anda dari AppCompatActivity dan build pemilih saat aktivitas dibuat dengan memanggil MediaRouteSelector.Builder dari metode onCreate() seperti dalam contoh kode berikut. Perlu diketahui bahwa pemilih disimpan dalam variabel class, dan jenis rute yang diizinkan ditentukan dengan menambahkan objek MediaControlIntent:

Kotlin

    class MediaRouterPlaybackActivity : AppCompatActivity() {

        private var mSelector: MediaRouteSelector? = null

        override fun onCreate(savedInstanceState: Bundle?) {
            super.onCreate(savedInstanceState)
            setContentView(R.layout.activity_main)

            // Create a route selector for the type of routes your app supports.
            mSelector = MediaRouteSelector.Builder()
                    // These are the framework-supported intents
                    .addControlCategory(MediaControlIntent.CATEGORY_REMOTE_PLAYBACK)
                    .build()
        }
    }

Java

    public class MediaRouterPlaybackActivity extends AppCompatActivity {
        private MediaRouteSelector mSelector;

        @Override
        protected void onCreate(Bundle savedInstanceState) {
            super.onCreate(savedInstanceState);
            setContentView(R.layout.activity_main);

            // Create a route selector for the type of routes your app supports.
            mSelector = new MediaRouteSelector.Builder()
                    // These are the framework-supported intents
                    .addControlCategory(MediaControlIntent.CATEGORY_REMOTE_PLAYBACK)
                    .build();
        }
    }

Untuk sebagian besar aplikasi, satu-satunya jenis rute yang dibutuhkan adalah CATEGORY_REMOTE_PLAYBACK. Jenis rute ini memperlakukan perangkat yang menjalankan aplikasi Anda sebagai remote kontrol. Perangkat penerima yang terhubung akan menangani semua pemutaran, dekode, dan pengambilan data konten. Berikut ini adalah cara kerja aplikasi yang mendukung Google Cast, seperti Chromecast.

Beberapa produsen mendukung opsi perutean khusus yang disebut "output sekunder". Dengan perutean ini, aplikasi media Anda akan mengambil, merender, dan melakukan streaming video atau musik secara langsung ke layar dan/atau speaker di perangkat penerima jarak jauh yang dipilih. Gunakan output sekunder untuk mengirim konten ke sistem musik atau layar video yang didukung fitur nirkabel. Untuk mengaktifkan penemuan dan pemilihan perangkat ini, Anda perlu menambahkan kategori kontrol CATEGORY_LIVE_AUDIO atau CATEGORY_LIVE_VIDEO ke MediaRouteSelector. Anda juga harus membuat dan menangani dialog Presentation Anda sendiri.

Menambahkan tombol rute media ke panel tindakan

Setelah menu rute media dan MediaRouteSelector ditentukan, Anda sekarang dapat menambahkan tombol rute media ke aktivitas. Ganti metode onCreateOptionsMenu() bagi setiap aktivitas Anda untuk menambahkan menu opsi.

Kotlin

    override fun onCreateOptionsMenu(menu: Menu): Boolean {
        super.onCreateOptionsMenu(menu)

        // Inflate the menu and configure the media router action provider.
        menuInflater.inflate(R.menu.sample_media_router_menu, menu)

        // Attach the MediaRouteSelector to the menu item
        val mediaRouteMenuItem = menu.findItem(R.id.media_route_menu_item)
        val mediaRouteActionProvider =
                MenuItemCompat.getActionProvider(mediaRouteMenuItem) as MediaRouteActionProvider

        // Attach the MediaRouteSelector that you built in onCreate()
        selector?.also(mediaRouteActionProvider::setRouteSelector)

        // Return true to show the menu.
        return true
    }

Java

    @Override
    public boolean onCreateOptionsMenu(Menu menu) {
        super.onCreateOptionsMenu(menu);

        // Inflate the menu and configure the media router action provider.
        getMenuInflater().inflate(R.menu.sample_media_router_menu, menu);

        // Attach the MediaRouteSelector to the menu item
        MenuItem mediaRouteMenuItem = menu.findItem(R.id.media_route_menu_item);
        MediaRouteActionProvider mediaRouteActionProvider =
                (MediaRouteActionProvider)MenuItemCompat.getActionProvider(
                mediaRouteMenuItem);
        // Attach the MediaRouteSelector that you built in onCreate()
        mediaRouteActionProvider.setRouteSelector(selector);

        // Return true to show the menu.
        return true;
    }

Untuk informasi selengkapnya tentang cara menerapkan panel tindakan dalam aplikasi Anda, lihat panduan developer tentang Panel Tindakan

Anda juga dapat menambahkan tombol rute media sebagai MediaRouteButton dalam tampilan apa pun. Anda harus melampirkan MediaRouteSelector ke tombol tersebut menggunakan metode setRouteSelector(). Lihat Checklist Desain Google Cast untuk melihat pedoman tentang cara menambahkan tombol rute media ke aplikasi Anda.

Callback MediaRouter

Semua aplikasi yang berjalan di perangkat yang sama menggunakan satu instance MediaRouter yang sama beserta rutenya (difilter per aplikasi oleh MediaRouteSelector aplikasi). Setiap aktivitas berkomunikasi dengan MediaRouter menggunakan penerapannya sendiri atas metode MediaRouter.Callback. MediaRouter akan memanggil metode callback setiap kali pengguna memilih, mengubah, atau memutuskan sambungan rute.

Ada beberapa metode dalam callback yang dapat Anda ganti untuk menerima informasi tentang peristiwa perutean. Minimal, penerapan Anda atas class MediaRouter.Callback harus menggantikan onRouteSelected() dan onRouteUnselected().

MediaRouter adalah resource bersama sehingga aplikasi Anda perlu mengelola callback MediaRouter-nya sebagai respons terhadap callback siklus aktivitas biasa:

  • Saat aktivitas dibuat (onCreate(Bundle)), arahkan penunjuk ke MediaRouter dan pertahankan selama masa pakai aplikasi.
  • Lampirkan callback ke MediaRouter saat aktivitas terlihat (onStart()), dan lepaskan ketika disembunyikan (onStop()).

Contoh kode berikut ini menunjukkan cara membuat dan menyimpan objek callback, cara mendapatkan instance MediaRouter, dan cara mengelola callback. Perhatikan penggunaan tanda CALLBACK_FLAG_REQUEST_DISCOVERY saat melampirkan callback dalam onStart(). Hal ini memungkinkan MediaRouteSelector memuat ulang daftar rute yang tersedia milik tombol rute media.

Kotlin

    class MediaRouterPlaybackActivity : AppCompatActivity() {

        private var mediaRouter: MediaRouter? = null
        private var mSelector: MediaRouteSelector? = null

        // Variables to hold the currently selected route and its playback client
        private var mRoute: MediaRouter.RouteInfo? = null
        private var remotePlaybackClient: RemotePlaybackClient? = null

        // Define the Callback object and its methods, save the object in a class variable
        private val mediaRouterCallback = object : MediaRouter.Callback() {

            override fun onRouteSelected(router: MediaRouter, route: MediaRouter.RouteInfo) {
                Log.d(TAG, "onRouteSelected: route=$route")
                if (route.supportsControlCategory(MediaControlIntent.CATEGORY_REMOTE_PLAYBACK)) {
                    // Stop local playback (if necessary)
                    // ...

                    // Save the new route
                    mRoute = route

                    // Attach a new playback client
                    remotePlaybackClient =
                        RemotePlaybackClient(this@MediaRouterPlaybackActivity, mRoute)

                    // Start remote playback (if necessary)
                    // ...
                }
            }

            override fun onRouteUnselected(
                    router: MediaRouter,
                    route: MediaRouter.RouteInfo,
                    reason: Int
            ) {
                Log.d(TAG, "onRouteUnselected: route=$route")
                if (route.supportsControlCategory(MediaControlIntent.CATEGORY_REMOTE_PLAYBACK)) {

                    // Changed route: tear down previous client
                    mRoute?.also {
                        remotePlaybackClient?.release()
                        remotePlaybackClient = null
                    }

                    // Save the new route
                    mRoute = route

                    when (reason) {
                        MediaRouter.UNSELECT_REASON_ROUTE_CHANGED -> {
                            // Resume local playback (if necessary)
                            // ...
                        }
                    }
                }
            }
        }

        // Retain a pointer to the MediaRouter
        override fun onCreate(savedInstanceState: Bundle?) {
            super.onCreate(savedInstanceState)
            setContentView(R.layout.activity_main)

            // Get the media router service.
            mediaRouter = MediaRouter.getInstance(this)
            ...
        }

        // Use this callback to run your MediaRouteSelector to generate the
        // list of available media routes
        override fun onStart() {
            mSelector?.also { selector ->
                mediaRouter?.addCallback(selector, mediaRouterCallback,
                        MediaRouter.CALLBACK_FLAG_REQUEST_DISCOVERY)
            }
            super.onStart()
        }

        // Remove the selector on stop to tell the media router that it no longer
        // needs to discover routes for your app.
        override fun onStop() {
            mediaRouter?.removeCallback(mediaRouterCallback)
            super.onStop()
        }
        ...
    }

Java

    public class MediaRouterPlaybackActivity extends AppCompatActivity {
        private MediaRouter mediaRouter;
        private MediaRouteSelector mSelector;

        // Variables to hold the currently selected route and its playback client
        private MediaRouter.RouteInfo mRoute;
        private RemotePlaybackClient remotePlaybackClient;

        // Define the Callback object and its methods, save the object in a class variable
        private final MediaRouter.Callback mediaRouterCallback =
                new MediaRouter.Callback() {

            @Override
            public void onRouteSelected(MediaRouter router, RouteInfo route) {
                Log.d(TAG, "onRouteSelected: route=" + route);

                if (route.supportsControlCategory(
                    MediaControlIntent.CATEGORY_REMOTE_PLAYBACK)){
                    // Stop local playback (if necessary)
                    // ...

                    // Save the new route
                    mRoute = route;

                    // Attach a new playback client
                    remotePlaybackClient = new RemotePlaybackClient(this, mRoute);

                    // Start remote playback (if necessary)
                    // ...
                }
            }

            @Override
            public void onRouteUnselected(MediaRouter router, RouteInfo route, int reason) {
                Log.d(TAG, "onRouteUnselected: route=" + route);

                if (route.supportsControlCategory(
                    MediaControlIntent.CATEGORY_REMOTE_PLAYBACK)){

                    // Changed route: tear down previous client
                    if (mRoute != null && remotePlaybackClient != null) {
                        remotePlaybackClient.release();
                        remotePlaybackClient = null;
                    }

                    // Save the new route
                    mRoute = route;

                    if (reason != MediaRouter.UNSELECT_REASON_ROUTE_CHANGED) {
                        // Resume local playback  (if necessary)
                        // ...
                    }
                }
            }
        }

        // Retain a pointer to the MediaRouter
        @Override
        protected void onCreate(Bundle savedInstanceState) {
            super.onCreate(savedInstanceState);
            setContentView(R.layout.activity_main);

            // Get the media router service.
            mediaRouter = MediaRouter.getInstance(this);
            ...
        }

        // Use this callback to run your MediaRouteSelector to generate the list of available media routes
        @Override
        public void onStart() {
            mediaRouter.addCallback(mSelector, mediaRouterCallback,
                    MediaRouter.CALLBACK_FLAG_REQUEST_DISCOVERY);
            super.onStart();
        }

        // Remove the selector on stop to tell the media router that it no longer
        // needs to discover routes for your app.
        @Override
        public void onStop() {
            mediaRouter.removeCallback(mediaRouterCallback);
            super.onStop();
        }
        ...
    }

Framework router media juga menyediakan class MediaRouteDiscoveryFragment, yang menangani penambahan dan penghapusan callback untuk suatu aktivitas.

Catatan: Jika Anda menulis aplikasi pemutaran musik dan ingin aplikasi tersebut memutar musik saat berada di latar belakang, Anda harus membuat file Service untuk pemutaran dan memanggil framework router media dari callback siklus Layanan.

Mengontrol rute pemutaran jarak jauh

Jika Anda memilih rute pemutaran jarak jauh, aplikasi Anda akan berfungsi sebagai remote kontrol. Perangkat di ujung lain rute akan menangani semua fungsi pemutaran, dekode, dan pengambilan data konten. Kontrol dalam UI aplikasi Anda berkomunikasi dengan perangkat penerima menggunakan objek RemotePlaybackClient.

Class RemotePlaybackClient menyediakan metode tambahan untuk mengelola pemutaran konten. Berikut adalah beberapa metode pemutaran utama dari class RemotePlaybackClient:

  • play() - Memutar file media tertentu, yang ditentukan oleh Uri.
  • pause() - Menjeda trek media yang sedang diputar.
  • resume() - Melanjutkan pemutaran lagu saat ini setelah perintah jeda.
  • seek() - Berpindah ke posisi tertentu dalam trek saat ini.
  • release() - Menghentikan koneksi dari aplikasi Anda ke perangkat pemutaran jarak jauh.

Anda dapat menggunakan metode ini untuk melampirkan tindakan ke kontrol pemutaran yang disediakan dalam aplikasi Anda. Sebagian besar metode ini juga memungkinkan Anda menyertakan objek callback sehingga dapat memantau progres tugas pemutaran atau permintaan kontrol.

Class RemotePlaybackClient juga mendukung antrean beberapa item media untuk pemutaran dan pengelolaan antrean media.

Kode contoh

Contoh BasicMediaRouter Android dan MediaRouter menunjukkan penggunaan API MediaRouter secara lebih mendetail.