Co-Watching API を実装する

Co-Watching API は、複数の参加者の会議エクスペリエンスを管理 アプリでコンテンツを視聴している参加者の数を表します。

このガイドでは、Co-Watching API を実装する方法について説明します。

始める

Co-Watching API を使用するには、まず Meet アドオンを作成する必要があります。これらの手順が完了したら、新しいアドオン内から Co-Watching API の使用を開始できます。

Co-Watching API を使用するには、まず、 AddonSession オブジェクト、 Google Meet の共同アクティビティへのエントリ ポイントとなります。

TypeScript

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

CLOUD_PROJECT_NUMBER は、プロジェクトのプロジェクト番号に置き換えます。 Google Cloud プロジェクトです

同時視聴クライアントを作成する

まず、Terraform で CoWatchingClient オブジェクトAddonSessionから移動できます。

CoWatchingCient を作成するには、 createCoWatchingClient() メソッドを呼び出し、 CoWatchingDelegate 渡されます。

CoWatchingDelegate は、Co-Watching API がアプリを更新する方法です。 新しい状態が利用可能になったときにトリガーされます。onCoWatchingStateChanged() メソッドが呼び出されると、アプリは新しい状態をすぐに適用することが期待されます。

次のコードサンプルは、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
    },
  });

ACTIVITY_TITLE は、アクティビティのメディア タイトルに置き換えます。

現状の管理

ユーザーがアプリ内でアクションを起こすと、アプリケーションは 指定の API メソッドをすぐに呼び出すことができます。

これらのメソッドは、重要なイベントに応答する場合にのみ呼び出すようにしてください。対象 たとえば、アプリがプレイを進めるたびに呼び出す必要は 動画をご覧ください。作成した CoWatchingDelegate が、プレイアウトの更新を処理します。 役立ちます

次の方法で共同視聴の状態を制御できます。

  • notifyBuffering(): 以前のメディアからのバッファリングが原因でユーザーのアプリがバッファリングを開始したときに呼び出す またはネットワークの輻輳などの原因になります。

  • notifyPauseState(): ユーザーが再生中のメディアを一時停止または一時停止解除したときに呼び出します。

  • notifyPlayoutRate(): ユーザーが再生速度を新しい値( 1.25 倍)。

  • notifyReady(): バッファリングが完了し、メディアの再生の準備が整ったときに呼び出されます。

  • notifySeekToTimestamp(): ユーザーが明示的に再生位置を変更したときに呼び出します。

  • notifySwitchToMedia(): アクティブに再生中のメディアが変更されるたびに呼び出します。たとえば、ユーザーが ユーザーが新しい動画を選択するか、自動再生で次の動画が再生される。