当您加入 RealtimeKit 会议时,系统会自动设计会议布局以优化您的体验。这包括聚焦于共享内容和突出显示当前发言人,同时以较小的缩略图视图显示参与者。当您开始录制会议时,会使用名为 RtkGrid 的默认 UI kit 组件以相同的布局进行录制。
如果您希望为录制应用程序定制布局,RealtimeKit 的自定义录制 SDK 提供了极大的灵活性,可根据您的喜好定制录制的外观。您可以选择如下选项:
- 仅显示当前发言人视图
- 共享屏幕及缩略图画廊视图
- 共享屏幕及大当前发言人缩略图
- 共享屏幕但不带当前发言人或画廊视图
- 为您的录制自定义背景
- 竖屏布局等
当你调用 Start Recording 时,RealtimeKit 会启动一个 Cloudflare container,在其中打开 Chrome 浏览器,并加载录制应用 URL。如果你未在 url 参数中提供自定义 URL,则使用 RealtimeKit 的内部录制应用。
在 Chrome 浏览器中加载自定义录制应用之前,RealtimeKit 会将 authToken 和 config 查询参数附加到 URL。例如,如果你在 Start Recording API 中提供此 URL:
https://example.com/my-custom-recorderRealtimeKit 会使用以下参数加载该应用:
https://example.com/my-custom-recorder?authToken=AUTH_TOKEN_CREATED_BY_REALTIMEKIT&config=CONFIG_CREATED_BY_REALTIMEKIT占位符值表示由 RealtimeKit 提供的参数。不要自行将 authToken 或 config 添加到提交给 Start Recording API 的 URL。你的应用必须从 URL 读取这两个参数。
RealtimeKit 会为你开始录制的会议自动生成 authToken。它使用 recorder_preset_v2 预设生成此令牌。如果你尚未创建 recorder_preset_v2 预设,RealtimeKit 会使用由 RealtimeKit 管理、且在你的账户中不可见的同名全局预设。
你的自定义录制应用必须 接受此 authToken,并用它初始化 RealtimeKit SDK 以获取 meeting 对象。
你在 Start Recording API 中提供的任何配置(例如水印设置)都会通过 config 查询参数传递给录制应用。默认录制应用会自动读取并应用此配置。
如果你使用自定义录制应用,你负责读取并应用 config。浏览器中应用产出的内容会按原样录制。RealtimeKit 不会对自定义录制应用的输出应用任何额外的布局、水印或其他处理。
hidden_participant 标志仅控制录制器的可见性。启用后,它会向会议中的其他参与者隐藏录制器。
is_recorder 标志将参与者标识为录制器,并确保录制正常工作。如果你创建自定义 recorder_preset_v2 预设以自定义录制的颜色或外观,必须保持启用 is_recorder。移除 is_recorder 可能导致录制失败。移除 hidden_participant 可能导致录制器对其他参与者可见。
本地测试可让你查看录制应用 UI。直接在本地机器上打开录制应用 URL 不会开始录制。
仅用于本地测试时,创建一个带有 hidden_participant: true 的预设,然后在打开本地录制应用 URL 时,在 authToken 查询参数中传入使用该预设创建的身份验证令牌。这可让你查看录制器 UI 的外观。不要将本地测试令牌作为 authToken 包含在提交给 Start Recording API 的 URL 中。在实际录制中,RealtimeKit 会自动生成并传入录制器令牌。
为加快开发,请使用 Quick Tunnel 公开本地录制应用。例如,如果你的应用运行在端口 1111 上,请使用以下命令启动 Quick Tunnel:
cloudflared tunnel --url http://localhost:1111将 1111 替换为本地应用使用的端口。cloudflared 会打印一个公共的 trycloudflare.com URL。你可以在开始录制时将此 URL 用作自定义录制应用 URL,以便 Cloudflare container 可以加载你的本地应用。
在本地测试时,你可能在浏览器控制台中看到 WebSocket 错误,因为浏览器无法连接到 localhost:8080。本地测试期间可以忽略此错误。录制器在托管的 Cloudflare container 内使用此端口运行,WebSocket 连接是录制应用告知 container 录制所渲染网页的方式。
请参阅 recording SDK app examples ↗ 了解示例实现,包括 recording with watermark example ↗。
自定义录制 SDK 在 UI Kit 或 Core SDK 之上使用。@cloudflare/realtimekit-recording-sdk 软件包 ↗ 提供用于管理录制功能的 RealtimeKitRecording 类。
constructor(options)
创建 RealtimeKitRecording 类的一个实例。
options (object):选项对象。所有构造函数选项都是可选的。如果省略某个选项,RealtimeKit 会使用其默认值。
| options (object) | 描述 |
|---|---|
options.waitTimeMs (number) |
在所有对端用户离开后,在停止录制前等待的时间(以毫秒为单位)。当 autoStop 设置为 true 时,此选项生效。 |
options.autoStart (boolean) |
默认为 true,因此在调用 init() 时自动开始录制。仅当你想使用 startRecording() 手动开始录制时,才将其设置为 false。设置为 false 时,必须在 WebSocket 连接建立后 2 分钟内调用 startRecording(),否则录制过程将遇到错误。 |
options.autoStop (boolean) |
默认为 true,因此在所有对端用户离开后自动停止录制。仅当你想使用 stopRecording() 手动停止录制时,才将其设置为 false。 |
options.scanInterval (number) |
扫描自动对端离开的时间间隔(以毫秒为单位)。 |
options.devMode (boolean) |
设置为 true 以启用开发模式,这将启用日志并禁用某些功能。在本地测试录制应用时,还必须确保将此项设置为 true。 |
init(client: RealtimeKitClient)通过提供 RealtimeKitClient 对象初始化 SDK。在创建会议对象之后、调用 meeting.joinRoom() 之前调用此方法。
startRecording();在大多数情况下,请将 autoStart 保持为 true(默认值),以便自动开始录制。要手动开始录制,请在调用此方法之前,在构造函数选项中将 autoStart 设置为 false。
stopRecording();通常不需要调用此方法,因为 autoStop 默认为 true。要手动停止录制,请在调用此方法之前,在构造函数选项中将 autoStop 设置为 false。
cleanup();在离开会议后执行清理任务,例如清除已添加的侦听器并关闭 WebSocket 连接。
执行以下步骤为您的 RealtimeKit 会议创建录制应用。
npm i @cloudflare/realtimekit-recording-sdkimport { RealtimeKitRecording } from "@cloudflare/realtimekit-recording-sdk";const recordingSdk = new RealtimeKitRecording(options);在创建会议对象之后、调用 joinRoom 之前调用 init。
// Call this after you have initialized the RealtimeKit SDK and have the meeting object
await recordingSdk.init(meeting);要手动开始录制,请在 RealtimeKitRecording 构造函数选项中将 autoStart 设置为 false。然后在加载完 UI 内容并准备好开始录制后调用 startRecording()。
await recordingSdk.startRecording();要手动停止录制,请在 RealtimeKitRecording 构造函数选项中将 autoStop 设置为 false。然后在准备好停止录制时调用 stopRecording()。
await recordingSdk.stopRecording();一旦调用了 stopRecording,您录制应用中的录制器将在几秒钟后退出。此后,您将无法在录制应用中执行任何进一步的操作。
创建应用后,使用类似 Cloudflare Workers ↗ 的平台部署它。请务必记录部署应用的 URL,因为您必须在 RealtimeKit 的录制 API 中输入该 URL。
在 Start Recording a Meeting API 中,提供自定义 URL(从上一步获取),以指示已部署应用的位置。不要向此 URL 附加 authToken。RealtimeKit 在加载应用时会添加生成的 authToken 和 config 参数。