Triển khai API cùng xem

Co-Watching API quản lý trải nghiệm 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 Co-Watching API.

Bắt đầu

Để sử dụng Co-Watching API, trước tiên, bạn phải Triển khai một 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 Co-Watching API, hãy bắt đầu bằng cách lấy một đố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 nhau trong Google Meet:

TypeScript

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

Thay thế CLOUD_PROJECT_NUMBER bằng số dự án của dự án trên Google Cloud.

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

Để bắt đầu, hãy tạo một đối tượng CoWatchingClient từ AddonSession.

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

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

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

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 của bạn, ứng dụng của bạn dự kiế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 các phương thức này mỗi khi ứng dụng của bạn chuyển sang một video đang phát. CoWatchingDelegate mà bạn tạo sẽ xử lý việc nhận các vị trí phát được cập nhật trong những trường hợp nà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ộ nhớ đệm do lưu vào bộ nhớ đệm từ một lần chuyển đổi nội dung nghe nhìn trước đó, thao tác tìm kiếm nội dung nghe nhìn hoặc tình trạng 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 đệm hoàn tất và nội dung nghe nhìn hiệ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 bắt đầu video tiếp theo.