实现 Co-Doing API

Google Meet 实时共享 Co-Doing API 用于在会议参与者之间同步任意数据。这可以是您的应用所依赖的任何数据。

您必须将数据序列化为 Uint8Array 才能传输数据。如需了解详情,请参阅 JavaScript 标准库参考文档

如果您不确定如何对数据进行序列化,请查看以下代码示例。

本指南介绍了如何实现 Co-Doing API。

创建 CoDoingClient

首先,根据您在使用入门中创建的 AddonSession 创建一个 CoDoingClient

如需创建 CoDoingClient,请调用 AddonSession.createCoDoingClient 方法并提供 CoDoingDelegate

每当您的应用有可用的新状态时,Co-Doing API 都会通过 CoDoingDelegate 更新应用。当调用 CoDoingDelegate.onCoDoingStateChanged 方法时,应用应立即应用新状态。

以下代码示例展示了如何使用 Co-Doing API:

TypeScript

interface MyState {
  someString: string;
  someNumber: number;
}

/**
 * Serialize/deserialize using JSON.stringify
 * You can use any method you want; this is included for as an example
 */
function toBytes(state: MyState): Uint8Array {
  return new TextEncoder().encode(JSON.stringify(state));
}

function fromBytes(bytes: Uint8Array): MyState {
  return JSON.parse(new TextDecoder().decode(bytes)) as MyState;
}

  const coDoingClient = await addonSession.createCoDoingClient({
    activityTitle: "ACTIVITY_TITLE",
    onCoDoingStateChanged(coDoingState: CoDoingState) {
      const newState = fromBytes(coDoingState.bytes);
      // This function should apply newState to your ongoing CoDoing activity
    },
  });

ACTIVITY_TITLE 替换为您的 activity 的标题。

管理当前状态

当用户在您的应用中执行操作时,应用应立即调用 CoDoingClient.broadcastStateUpdate

以下代码示例展示了 CoDoingClient.broadcastStateUpdate 的实现:

TypeScript

const myState: MyState = {
  someString: "SOME_STRING",
  someNumber: 0
};

document.getElementById('some-button').onClick(() => {
  myState.someNumber = myState.someNumber + 1;
  coDoingClient.broadcastStateUpdate({ bytes: toBytes(myState) });
});

SOME_STRING 替换为应用的当前状态。