Tích hợp Cast SDK vào ứng dụng Web Sender

Hướng dẫn dành cho nhà phát triển này mô tả cách thêm tính năng hỗ trợ Google Cast vào ứng dụng Web Sender bằng cách sử dụng Cast SDK.

Thuật ngữ

Thiết bị di động hoặc trình duyệt là người gửi có chức năng kiểm soát việc phát; thiết bị Google Cast là trình thu nhận, hiển thị nội dung trên màn hình để phát.

SDK người gửi web bao gồm 2 phần: API khung (cast.framework) và API cơ sở (chrome.cast). Nhìn chung, bạn thực hiện các lệnh gọi trên API khung cấp cao hơn và đơn giản hơn mà sau đó được xử lý bởi API cơ sở cấp thấp hơn.

Khung trình gửi đề cập đến API Khung, mô-đun và các tài nguyên liên quan cung cấp trình bao bọc xung quanh chức năng cấp thấp hơn. Ứng dụng người gửi hoặc ứng dụng Google Cast Chrome đề cập đến một ứng dụng web (HTML/JavaScript) chạy bên trong trình duyệt Chrome trên thiết bị của người gửi. Ứng dụng Bộ thu web là ứng dụng HTML/JavaScript chạy trên Chromecast hoặc thiết bị Google Cast.

Khung của người gửi sử dụng thiết kế lệnh gọi lại không đồng bộ để thông báo cho ứng dụng của người gửi về các sự kiện và để chuyển đổi giữa các trạng thái khác nhau trong vòng đời của ứng dụng Truyền.

Tải thư viện

Để triển khai các tính năng của Google Cast, ứng dụng của bạn cần biết vị trí của Google Cast Web Sender SDK (SDK trình gửi web của Google Cast), như minh hoạ dưới đây. Thêm tham số truy vấn URL loadCastFramework để tải API Khung người gửi web. Tất cả các trang trong ứng dụng của bạn đều phải tham chiếu đến thư viện như sau:

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

Khung

SDK Người gửi web sử dụng không gian tên cast.framework.*. Không gian tên đại diện cho những thông tin sau:

  • Các phương thức hoặc hàm gọi các thao tác trên API
  • Trình nghe sự kiện cho các chức năng của trình nghe trong API

Khung này bao gồm các thành phần chính sau:

  • CastContext là một đối tượng singleton cung cấp thông tin về trạng thái Truyền hiện tại và kích hoạt các sự kiện cho các thay đổi về trạng thái phiên Truyền và Trạng thái truyền.
  • Đối tượng CastSession quản lý phiên – đối tượng này cung cấp thông tin trạng thái và kích hoạt các sự kiện, chẳng hạn như thay đổi âm lượng thiết bị, trạng thái tắt tiếng và siêu dữ liệu ứng dụng.
  • Phần tử nút Truyền là một phần tử tuỳ chỉnh HTML đơn giản giúp mở rộng nút HTML. Nếu nút Truyền được cung cấp chưa đủ, bạn có thể sử dụng trạng thái Truyền để triển khai nút Truyền.
  • RemotePlayerController cung cấp liên kết dữ liệu để đơn giản hoá việc triển khai trình phát từ xa.

Hãy xem lại Tài liệu tham khảo API Google Cast Web Sender để biết nội dung mô tả đầy đủ về không gian tên.

Nút truyền

Thành phần nút Truyền trong ứng dụng của bạn do khung xử lý toàn bộ. Điều này bao gồm quản lý chế độ hiển thị cũng như xử lý sự kiện nhấp chuột.

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

Ngoài ra, bạn có thể tạo nút theo phương thức lập trình:

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

Bạn có thể áp dụng mọi kiểu bổ sung (chẳng hạn như kích thước hoặc vị trí) cho phần tử nếu cần. Sử dụng thuộc tính --connected-color để chọn màu cho trạng thái Web receiver đã kết nối và --disconnected-color cho trạng thái đã ngắt kết nối.

Khởi chạy

Sau khi tải API khung, ứng dụng sẽ gọi trình xử lý window.__onGCastApiAvailable. Bạn cần đảm bảo rằng ứng dụng sẽ đặt trình xử lý này trên window trước khi tải thư viện người gửi.

Trong trình xử lý này, bạn khởi chạy hoạt động tương tác Truyền bằng cách gọi phương thức setOptions(options) của CastContext.

Ví dụ:

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

Sau đó, bạn sẽ khởi chạy API như sau:

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

Trước tiên, ứng dụng sẽ truy xuất thực thể singleton của đối tượng CastContext do khung cung cấp. Sau đó, phương thức này sử dụng setOptions(options) bằng cách sử dụng đối tượng CastOptions để đặt applicationID.

Nếu đang sử dụng Trình thu nhận nội dung nghe nhìn mặc định (không yêu cầu đăng ký), bạn sẽ dùng hằng số do SDK Trình gửi web xác định trước, như minh hoạ bên dưới, thay vì applicationID:

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

Điều khiển phương tiện

Sau khi khởi động CastContext, ứng dụng có thể truy xuất CastSession hiện tại bất cứ lúc nào bằng getCurrentSession().

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

Bạn có thể sử dụng CastSession để tải nội dung nghe nhìn vào Thiết bị truyền đã kết nối bằng loadMedia(loadRequest). Trước tiên, hãy tạo MediaInfo bằng contentId và contentType cũng như mọi thông tin khác liên quan đến nội dung này. Sau đó, hãy tạo một LoadRequest từ đó, đặt tất cả thông tin liên quan cho yêu cầu. Cuối cùng, hãy gọi loadMedia(loadRequest) trên 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); });

Phương thức loadMedia sẽ trả về một Promise (Lời hứa) có thể dùng để thực hiện mọi thao tác cần thiết nhằm mang lại kết quả thành công. Nếu Lời hứa bị từ chối, đối số hàm sẽ là chrome.cast.ErrorCode.

Bạn có thể truy cập vào các biến trạng thái của người chơi trong RemotePlayer. Mọi hoạt động tương tác với RemotePlayer, bao gồm cả lệnh gọi lại sự kiện đa phương tiện và lệnh, đều được xử lý bằng RemotePlayerController.

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

RemotePlayerController cho phép ứng dụng kiểm soát toàn bộ nội dung nghe nhìn phát, TẠM DỪNG, DỪNG và XEM đối với nội dung nghe nhìn đã tải.

  • PHÁT/TẠM DỪNG: playerController.playOrPause();
  • DỪNG: playerController.stop();
  • XEM: playerController.seek();

Bạn có thể sử dụng RemotePlayer và RemotePlayerController với các khung liên kết dữ liệu, chẳng hạn như Polymer hoặc Angular, để triển khai trình phát từ xa.

Dưới đây là một đoạn mã cho 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>

Trạng thái nội dung nghe nhìn

Trong khi phát nội dung đa phương tiện, nhiều sự kiện có thể được ghi lại bằng cách thiết lập trình nghe cho nhiều sự kiện cast.framework.RemotePlayerEventType trên đối tượng RemotePlayerController.

Để nhận thông tin về trạng thái của nội dung nghe nhìn, hãy sử dụng sự kiện cast.framework.RemotePlayerEventType.MEDIA_INFO_CHANGED. Sự kiện này sẽ kích hoạt khi chế độ phát thay đổi và khi CastSession.getMediaSession().media thay đổi.

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;
  });

Khi các sự kiện như tạm dừng, phát, tiếp tục hoặc tua diễn ra, ứng dụng cần thao tác với các sự kiện đó và đồng bộ hoá giữa chính ứng dụng đó và ứng dụng Trình nhận web trên thiết bị Truyền. Hãy xem phần Thông tin cập nhật về trạng thái để biết thêm thông tin.

Cách hoạt động của tính năng quản lý phiên

SDK Truyền giới thiệu khái niệm về phiên Truyền, một cách hoạt động kết hợp các bước kết nối với một thiết bị, chạy (hoặc tham gia) ứng dụng Trình nhận web, kết nối với ứng dụng đó và khởi chạy một kênh điều khiển nội dung nghe nhìn. Vui lòng xem Hướng dẫn về vòng đời của ứng dụng Web receiver để biết thêm thông tin về các phiên truyền và vòng đời của Trình nhận web.

Các phiên hoạt động được quản lý bởi lớp CastContext mà ứng dụng của bạn có thể truy xuất qua cast.framework.CastContext.getInstance(). Các phiên riêng lẻ được biểu thị bằng các lớp con của lớp Session. Ví dụ: CastSession đại diện cho các phiên có thiết bị truyền. Ứng dụng của bạn có thể truy cập phiên Truyền đang hoạt động thông qua CastContext.getCurrentSession().

Để theo dõi trạng thái phiên, hãy thêm trình nghe vào CastContext cho loại sự kiện 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;
    }
  })

Đối với trường hợp ngắt kết nối, chẳng hạn như khi người dùng nhấp vào nút "dừng truyền" trong hộp thoại Truyền, bạn có thể thêm một trình nghe cho loại sự kiện RemotePlayerEventType.IS_CONNECTED_CHANGED trong trình nghe. Trong trình nghe, hãy kiểm tra xem RemotePlayer có bị ngắt kết nối hay không. Nếu có, hãy cập nhật trạng thái của người chơi trên máy nếu cần. Ví dụ:

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

Mặc dù người dùng có thể trực tiếp điều khiển quá trình chấm dứt tính năng Truyền thông qua nút Truyền khung, nhưng chính người gửi có thể dừng truyền bằng cách sử dụng đối tượng CastSession hiện tại.

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);
}

Chuyển sự kiện phát trực tiếp

Việc giữ nguyên trạng thái phiên là cơ sở của quá trình chuyển sự kiện phát trực tuyến, trong đó người dùng có thể di chuyển các luồng âm thanh và video hiện có trên các thiết bị bằng lệnh thoại, ứng dụng Google Home hoặc màn hình thông minh. Nội dung nghe nhìn ngừng phát trên một thiết bị (nguồn) và tiếp tục phát trên một thiết bị khác (đích đến). Mọi thiết bị truyền có chương trình cơ sở mới nhất đều có thể đóng vai trò là nguồn hoặc đích đến trong quá trình chuyển luồng.

Để lấy thiết bị đích mới trong quá trình chuyển luồng, hãy gọi CastSession#getCastDevice() khi sự kiện cast.framework.SessionState.SESSION_RESUMED được gọi.

Hãy xem bài viết Chuyển luồng trên Web receiver để biết thêm thông tin.

Trước
Thiết lập
Tiếp
Thêm các tính năng nâng cao