Triển khai API cùng xem

API cùng xem quản lý trải nghiệm trong cuộc họp của nhiều người tham gia xem hoặc nghe nội dung trong ứng dụng của bạn.

Hướng dẫn này giải thích cách triển khai API cùng xem.

Bắt đầu

Để sử dụng API Cùng xem, trước tiên, bạn phải Triển khai tiện ích bổ sung Meet. Sau khi hoàn tất các bước đó, bạn có thể bắt đầu sử dụng API Cùng xem trong tiện ích bổ sung mới.

Để sử dụng API Cùng xem, hãy bắt đầu bằng cách lấy đối tượng AddonSession. Đối tượng này đóng vai trò là điểm truy cập cho các hoạt động cùng làm trên Google Meet:

TypeScript

const session = await window.meet.addon.createAddonSession({
    cloudProjectNumber: "CLOUD_PROJECT_NUMBER",
});

Thay thế CLOUD_PROJECT_NUMBER bằng số dự án là dự án Google Cloud của bạn.

Tạo ứng dụng cùng xem

Để bắt đầu, hãy tạo một CoWatchingClient khỏi AddonSession.

Để tạo CoWatchingCient, hãy gọi phương thức createCoWatchingClient() và cung cấp một CoWatchingDelegate .

CoWatchingDelegate là cách API Co-Watching cập nhật ứng dụng của bạn bất cứ khi nào ứng dụng có trạng thái mới. Dự kiến, khi onCoWatchingStateChanged() được gọi, ứng dụng của bạn sẽ ngay lập tức áp dụng trạng thái mới.

Mã mẫu sau đây cho biết cách sử dụng API Co-Watching (Xem cùng):

TypeScript

 const coWatchingClient = await addonSession.createCoWatchingClient({
    activityTitle: "ACTIVITY_TITLE",
    onCoWatchingStateQuery() {
      // This function should return the current state of your CoWatching activity
      return getMyApplicationCoWatchingState();
    },
    onCoWatchingStateChanged(coWatchingState: CoWatchingState) {
      // This function should apply newState to your ongoing CoWatching activity
    },
  });

Thay thế ACTIVITY_TITLE bằng tiêu đề nội dung nghe nhìn của hoạt động.

Quản lý trạng thái hiện tại

Khi người dùng thực hiện hành động trong ứng dụng, ứng dụng của bạn sẽ gọi ngay các phương thức API được cung cấp.

Bạn chỉ nên gọi các phương thức này để phản hồi các sự kiện quan trọng. Để ví dụ: bạn không cần gọi chúng mỗi khi ứng dụng của bạn chơi video. Các tên người dùng trên CoWatchingDelegate mà bạn tạo sẽ nhận thông tin cập nhật về các màn chơi vị trí của bạn trong những trường hợp như vậy.

Bạn có thể kiểm soát trạng thái cùng xem bằng các phương thức sau:

  • notifyBuffering(): Gọi khi ứng dụng của người dùng bắt đầu lưu vào bộ đệm do nội dung nghe nhìn trước đó được lưu vào bộ đệm chuyển đổi, tìm kiếm nội dung đa phương tiện hoặc tắc nghẽn mạng.

  • notifyPauseState(): Gọi khi người dùng tạm dừng hoặc tiếp tục phát nội dung nghe nhìn.

  • notifyPlayoutRate(): Gọi khi người dùng cập nhật tốc độ phát thành một giá trị mới (ví dụ: 1,25x).

  • notifyReady(): Gọi khi quá trình lưu vào bộ đệm hoàn tất và nội dung nghe nhìn đã sẵn sàng phát.

  • notifySeekToTimestamp(): Gọi khi người dùng thay đổi rõ ràng vị trí phát.

  • notifySwitchToMedia(): Gọi bất cứ khi nào nội dung nghe nhìn đang phát thay đổi. Ví dụ: người dùng chọn một video mới hoặc tính năng tự động phát sẽ bắt đầu video tiếp theo.