当您加入 RealtimeKit 会议时，系统会自动设计会议布局以优化您的体验。这包括聚焦于共享内容和突出显示当前发言人，同时以较小的缩略图视图显示参与者。当您开始录制会议时，会使用名为 RtkGrid ↗ 的默认 UI kit 组件以相同的布局进行录制。
如果您希望为录制应用程序定制布局，RealtimeKit 的自定义录制 SDK 提供了极大的灵活性，可根据您的喜好定制录制的外观。您可以选择如下选项：
- 仅显示当前发言人视图
- 共享屏幕及缩略图画廊视图
- 共享屏幕及大当前发言人缩略图
- 共享屏幕但不带当前发言人或画廊视图
- 为您的录制自定义背景
- 竖屏布局等
让我们深入了解为 RealtimeKit 录制应用创建自定义外观所涉及的步骤。
自定义录制 SDK 在 UI Kit 或 Core SDK 之上使用。RealtimeKitRecording 类用于在 SDK 中管理录制功能。
constructor(options)
创建 RealtimeKitRecording 类的一个实例。
options (object)：选项对象。
| options (object) | 描述 |
|---|---|
options.waitTimeMs (number) |
在所有对端用户离开后，在离开会议前等待的时间（以毫秒为单位）。如果 autoStop 设置为 true，则忽略此选项。 |
options.autoStart (boolean) |
如果您想手动调用 startRecording 函数，请设置为 true。默认情况下，autoStart 参数设置为 true。如果您希望延迟录制的开始，可以将此参数的值设置为 false。在这种情况下，您稍后可以手动调用 startRecording() 函数。请注意，startRecording() 方法有 2 分钟的超时限制。如果建立 WebSocket 连接后 2 分钟内未调用此方法，录制过程将遇到错误。 |
options.autoStop (boolean) |
如果您想禁用自动对端离开并手动调用 stopRecording 函数，请设置为 true。 |
options.scanInterval (number) |
扫描自动对端离开的时间间隔（以毫秒为单位）。 |
options.devMode (boolean) |
设置为 true 以启用开发模式，这将启用日志并禁用某些功能。在本地测试录制应用时，还必须确保将此项设置为 true。 |
init(client: RealtimeKitClient)通过提供 RealtimeKitClient 对象初始化 SDK。在创建会议对象之后、调用 meeting.joinRoom() 之前调用此方法。
startRecording();手动开始录制。确保在构造函数选项中将 autoStart 传入为 true。
stopRecording();手动停止录制。确保在构造函数选项中将 autoStop 传入为 true。
cleanup();在离开会议后执行清理任务，例如清除已添加的侦听器并关闭 WebSocket 连接。
执行以下步骤为您的 RealtimeKit 会议创建录制应用。
npm i @cloudflare/realtimekit-recording-sdkimport { RealtimeKitRecording } from '@cloudflare/realtimekit-recording-sdk';const recordingSdk = new RealtimeKitRecording(options);在创建会议对象之后、调用 joinRoom 之前调用 init。
// 在调用 initMeeting 之后调用此方法
await recordingSdk.init();要手动开始录制，请调用 startRecording() 函数。例如，您希望在加载了应用中的 UI 内容且 autoStart 未设置为 true 时开始录制。在这些情况下，您可以在准备好开始录制时手动调用 startRecording() 函数。
// 如果 autoStart 设置为 false，这将抛出异常。
await recordingSdk.startRecording();要手动停止录制，请使用 stopRecording。
// 如果 autoStop 设置为 false，这将抛出异常。
await recordingSdk.stopRecording();一旦调用了 stopRecording，您录制应用中的录制器将在几秒钟后退出。此后，您将无法在录制应用中执行任何进一步的操作。
创建应用后，使用类似 Cloudflare Workers ↗ 的平台部署它。请务必记录部署应用的 URL，因为您必须在 RealtimeKit 的录制 API 中输入该 URL。
在 Start Recording a Meeting API 中，提供自定义 URL（从上一步获取），以指示已部署应用的位置。