Mengintegrasikan Cast SDK ke dalam Aplikasi Pengirim Web Anda

Panduan developer ini menjelaskan cara menambahkan dukungan Google Cast ke aplikasi Pengirim Web menggunakan Cast SDK.

Catatan: Sebaiknya Anda mencoba hal berikut:

• Tutorial codelab Pengirim Web Transmisi - Pelajari langkah demi langkah cara mengubah aplikasi video web yang ada untuk memutar konten di perangkat Google Cast.
• Aplikasi contoh CastCast-chrome (GitHub) - Jalankan, navigasikan, dan lihat aplikasi contoh referensi ini yang mematuhi Panduan UX dan Checklist Desain.

Terminologi

Perangkat seluler atau browser adalah pengirim, yang mengontrol pemutaran; perangkat Google Cast adalah penerima, yang menampilkan konten di layar untuk pemutaran.

Web Sender SDK terdiri dari dua bagian: Framework API (cast.framework) dan Base API (chrome.cast) Secara umum, Anda melakukan panggilan di Framework API yang lebih sederhana dan levelnya lebih tinggi, yang kemudian diproses oleh Base API level yang lebih rendah.

Framework pengirim mengacu pada Framework API, modul, dan resource terkait yang menyediakan wrapper di sekitar fungsi tingkat rendah. Aplikasi pengirim atau aplikasi Chrome Google Cast merujuk pada aplikasi web (HTML/JavaScript) yang berjalan di dalam browser Chrome pada perangkat pengirim. Aplikasi Penerima Web mengacu pada aplikasi HTML/JavaScript yang berjalan di Chromecast atau perangkat Google Cast.

Framework pengirim menggunakan desain callback asinkron untuk memberi tahu aplikasi pengirim peristiwa dan untuk melakukan transisi antara berbagai status siklus proses aplikasi Cast.

Memuat library

Agar aplikasi Anda dapat mengimplementasikan fitur Google Cast, aplikasi perlu mengetahui lokasi Google Cast Web Sender SDK, seperti yang ditunjukkan di bawah ini. Tambahkan parameter kueri URL loadCastFramework untuk memuat Web Sender Framework API juga. Semua halaman aplikasi Anda harus merujuk ke library sebagai berikut:

<script src="https://www.gstatic.com/cv/js/sender/v1/cast_sender.js?loadCastFramework=1"></script>

Framework

Web Sender SDK menggunakan namespace cast.framework.*. Namespace ini mewakili hal berikut:

• Metode atau fungsi yang memanggil operasi pada API
• Pemroses peristiwa untuk fungsi pemroses dalam API

Framework ini terdiri dari komponen utama berikut:

• CastContext adalah objek singleton yang memberikan informasi tentang status Cast saat ini, dan memicu peristiwa untuk status Cast dan perubahan status sesi Cast.
• Objek CastSession mengelola sesi -- memberikan informasi status dan memicu peristiwa, seperti perubahan pada volume perangkat, status penonaktifan, dan metadata aplikasi.
• Elemen tombol Cast, yang merupakan elemen kustom HTML sederhana yang memperluas tombol HTML. Jika tombol Cast yang diberikan tidak memadai, Anda dapat menggunakan status Cast untuk menerapkan tombol Cast.
• RemotePlayerController menyediakan data binding untuk menyederhanakan implementasi pemutar jarak jauh.

Lihat Referensi API Pengirim Web Google Cast untuk mengetahui deskripsi lengkap namespace.

Tombol Cast

Komponen tombol Cast di aplikasi Anda ditangani sepenuhnya oleh framework. Hal ini mencakup pengelolaan visibilitas, serta penanganan peristiwa klik.

<google-cast-launcher></google-cast-launcher>

Atau, Anda dapat membuat tombol tersebut secara terprogram:

document.createElement("google-cast-launcher");

Anda bisa menerapkan penataan gaya tambahan, seperti ukuran atau positioning, ke elemen sesuai kebutuhan. Gunakan atribut --connected-color untuk memilih warna untuk status Web Receiver yang terhubung, dan --disconnected-color untuk status tidak terhubung.

Inisialisasi

Setelah memuat API framework, aplikasi akan memanggil pengendali window.__onGCastApiAvailable. Anda harus memastikan bahwa aplikasi menetapkan pengendali ini pada window sebelum memuat library pengirim.

Dalam pengendali ini, Anda akan menginisialisasi interaksi Cast dengan memanggil metode setOptions(options) CastContext.

Contoh:

<script>
window['__onGCastApiAvailable'] = function(isAvailable) {
  if (isAvailable) {
    initializeCastApi();
  }
};
</script>

Kemudian, Anda melakukan inisialisasi API sebagai berikut:

initializeCastApi = function() {
  cast.framework.CastContext.getInstance().setOptions({
    receiverApplicationId: applicationId,
    autoJoinPolicy: chrome.cast.AutoJoinPolicy.ORIGIN_SCOPED
  });
};

Pertama, aplikasi mengambil instance singleton dari objek CastContext yang disediakan oleh framework. Lalu, kode ini menggunakan setOptions(options) menggunakan objek CastOptions untuk menetapkan applicationID.

Jika menggunakan Penerima Media Default, yang tidak memerlukan pendaftaran, Anda harus menggunakan konstanta yang telah ditetapkan sebelumnya oleh Web Sender SDK, seperti yang ditunjukkan di bawah, bukan applicationID:

cast.framework.CastContext.getInstance().setOptions({
  receiverApplicationId: chrome.cast.media.DEFAULT_MEDIA_RECEIVER_APP_ID
});

Kontrol media

Setelah CastContext diinisialisasi, aplikasi dapat mengambil CastSession saat ini kapan saja menggunakan getCurrentSession().

var castSession = cast.framework.CastContext.getInstance().getCurrentSession();

CastSession dapat digunakan untuk memuat media ke perangkat Cast yang terhubung menggunakan loadMedia(loadRequest). Pertama, buat MediaInfo, menggunakan contentId dan contentType serta informasi lain terkait konten. Kemudian, buat LoadRequest dari sini, dengan menetapkan semua informasi yang relevan untuk permintaan. Terakhir, panggil loadMedia(loadRequest) di CastSession.

var mediaInfo = new chrome.cast.media.MediaInfo(currentMediaURL, contentType);
var request = new chrome.cast.media.LoadRequest(mediaInfo);
castSession.loadMedia(request).then(
  function() { console.log('Load succeed'); },
  function(errorCode) { console.log('Error code: ' + errorCode); });

Metode loadMedia akan menampilkan Promise yang dapat digunakan untuk melakukan operasi yang diperlukan agar berhasil. Jika Promise ditolak, argumen fungsi akan berupa chrome.cast.ErrorCode.

Anda dapat mengakses variabel status pemain di RemotePlayer. Semua interaksi dengan RemotePlayer, termasuk callback dan perintah peristiwa media, ditangani dengan RemotePlayerController.

var player = new cast.framework.RemotePlayer();
var playerController = new cast.framework.RemotePlayerController(player);

RemotePlayerController memberi aplikasi kontrol media penuh PLAY, PAUSE, STOP, dan SEEK untuk media yang dimuat.

• PUTAR/JEDA: playerController.playOrPause();
• HENTIKAN: playerController.stop();
• CARI: playerController.seek();

RemotePlayer dan RemotePlayerController dapat digunakan dengan framework data binding, seperti Polymer atau Angular, untuk menerapkan pemain jarak jauh.

Berikut ini cuplikan kode untuk Angular:

<button id="playPauseButton" class="playerButton"
  ng-disabled="!player.canPause"
  ng-click="controller.playOrPause()">
    {{player.isPaused ? 'Play' : 'Pause'}}
</button>
<script>
var player = new cast.framework.RemotePlayer();
var controller = new cast.framework.RemotePlayerController(player);
// Listen to any player update, and trigger angular data binding
update.controller.addEventListener(
  cast.framework.RemotePlayerEventType.ANY_CHANGE,
  function(event) {
    if (!$scope.$$phase) $scope.$apply();
  });
</script>

Status media

Selama pemutaran media, berbagai peristiwa terjadi yang dapat ditangkap dengan menetapkan pemroses untuk berbagai peristiwa cast.framework.RemotePlayerEventType pada objek RemotePlayerController.

Untuk mendapatkan informasi status media, gunakan peristiwa cast.framework.RemotePlayerEventType.MEDIA_INFO_CHANGED, yang terpicu saat pemutaran berubah dan saat CastSession.getMediaSession().media berubah.

playerController.addEventListener(
  cast.framework.RemotePlayerEventType.MEDIA_INFO_CHANGED, function() {
    // Use the current session to get an up to date media status.
    let session = cast.framework.CastContext.getInstance().getCurrentSession();

    if (!session) {
        return;
    }

    // Contains information about the playing media including currentTime.
    let mediaStatus = session.getMediaSession();
    if (!mediaStatus) {
        return;
    }

    // mediaStatus also contains the mediaInfo containing metadata and other
    // information about the in progress content.
    let mediaInfo = mediaStatus.media;
  });

Saat peristiwa seperti menjeda, memutar, melanjutkan, atau mencari terjadi, aplikasi harus menindaklanjutinya dan menyinkronkan antara dirinya sendiri dan aplikasi Penerima Web di perangkat Cast. Lihat Pembaruan status untuk informasi selengkapnya.

Cara kerja pengelolaan sesi

SDK Cast memperkenalkan konsep sesi Transmisi, dengan pembentukan yang menggabungkan langkah-langkah untuk menghubungkan ke perangkat, meluncurkan (atau menggabungkan) aplikasi Penerima Web, menghubungkan ke aplikasi tersebut, dan menginisialisasi saluran kontrol media. Lihat Panduan siklus proses aplikasi Penerima Web untuk informasi selengkapnya tentang sesi Transmisi dan siklus proses Penerima Web.

Sesi dikelola oleh class CastContext, yang dapat diambil aplikasi Anda melalui cast.framework.CastContext.getInstance(). Setiap sesi diwakili oleh subclass dari class Session. Misalnya, CastSession mewakili sesi dengan perangkat Cast. Aplikasi Anda dapat mengakses sesi Transmisi yang saat ini aktif melalui CastContext.getCurrentSession().

Untuk memantau status sesi, tambahkan pemroses ke CastContext untuk jenis peristiwa CastContextEventType.SESSION_STATE_CHANGED.

var context = cast.framework.CastContext.getInstance();
context.addEventListener(
  cast.framework.CastContextEventType.SESSION_STATE_CHANGED,
  function(event) {
    switch (event.sessionState) {
      case cast.framework.SessionState.SESSION_STARTED:
      case cast.framework.SessionState.SESSION_RESUMED:
        break;
      case cast.framework.SessionState.SESSION_ENDED:
        console.log('CastContext: CastSession disconnected');
        // Update locally as necessary
        break;
    }
  })

Untuk terputus, misalnya saat pengguna mengklik tombol "hentikan transmisi" dari dialog Cast, Anda dapat menambahkan pemroses untuk jenis peristiwa RemotePlayerEventType.IS_CONNECTED_CHANGED di pemroses Anda. Dalam pemroses Anda, periksa apakah RemotePlayer terputus. Jika ya, perbarui status pemutar lokal sesuai kebutuhan. Contoh:

playerController.addEventListener(
  cast.framework.RemotePlayerEventType.IS_CONNECTED_CHANGED, function() {
    if (!player.isConnected) {
      console.log('RemotePlayerController: Player disconnected');
      // Update local player to disconnected state
    }
  });

Meskipun pengguna dapat langsung mengontrol penghentian Cast melalui tombol Cast framework, pengirim itu sendiri dapat menghentikan transmisi menggunakan objek CastSession saat ini.

function stopCasting() {
  var castSession = cast.framework.CastContext.getInstance().getCurrentSession();
  // End the session and pass 'true' to indicate
  // that Web Receiver app should be stopped.
  castSession.endSession(true);
}

Transfer streaming

Mempertahankan status sesi adalah dasar transfer streaming, tempat pengguna dapat memindahkan streaming audio dan video yang ada di seluruh perangkat menggunakan perintah suara, Aplikasi Google Home, atau layar smart. Media berhenti diputar di satu perangkat (sumber) dan berlanjut di perangkat lainnya (tujuan). Setiap perangkat Cast dengan firmware terbaru dapat berfungsi sebagai sumber atau tujuan dalam transfer streaming.

Untuk mendapatkan perangkat tujuan baru selama transfer aliran, panggil CastSession#getCastDevice() saat peristiwa cast.framework.SessionState.SESSION_RESUMED dipanggil.

Lihat Streaming transfer di Web Receiver untuk informasi selengkapnya.