截屏录制

用于从页面捕获截屏帧的接口。

---

方法

HideActionsAsync

新增于: v1.59 screencast.HideActionsAsync

移除操作装饰（action decorations）。

用法

await Screencast.HideActionsAsync();

返回

• void#

---

HideOverlaysAsync

新增于: v1.59 screencast.HideOverlaysAsync

隐藏覆盖层但不将其移除。

用法

await Screencast.HideOverlaysAsync();

返回

• void#

---

ShowActionsAsync

新增于: v1.59 screencast.ShowActionsAsync

启用交互元素的视觉标注。返回一个可释放对象（disposable），销毁该对象时将停止显示操作。

用法

await Screencast.ShowActionsAsync(options);

参数

• options ScreencastShowActionsOptions? (可选)

  • Cursor enum ScreencastCursor { None, Pointer }? (可选)添加于：v1.61#

    显示指针操作的装饰光标。"pointer"（默认值）会渲染一个从上一个操作点动画移动到下一个操作点的鼠标指针。"none" 则禁用光标装饰。

  • Duration [float]? (可选)#

    每个注释显示的持续时间（以毫秒为单位）。默认为 500。

  • FontSize int? (可选)#

    操作标题的字体大小（以像素为单位）。默认为 24。

  • Position enum AnnotatePosition { TopLeft, Top, TopRight, BottomLeft, Bottom, BottomRight }? (可选)#

    操作标题覆盖层的位置。默认为 "top-right"。

返回

• [Disposable]#

---

ShowChapterAsync

新增于: v1.59 screencast.ShowChapterAsync

显示一个带有标题和可选描述的章节覆盖层，居中显示在页面上并带有模糊背景。适用于录制视频时的旁白。覆盖层将在指定的持续时间（或默认 2000 毫秒）后移除。

用法

await Screencast.ShowChapterAsync(title, options);

参数

• title string#

  覆盖层中显著显示的标题文本。

• options ScreencastShowChapterOptions? (可选)

  • Description string? (可选)#

    标题下方显示的可选描述文本。

  • Duration [float]? (可选)#

    自动移除覆盖层前的持续时间（毫秒）。默认为 2000。

返回

• void#

---

ShowOverlayAsync

新增于: v1.59 screencast.ShowOverlayAsync

添加一个带有给定 HTML 内容的覆盖层。覆盖层将显示在页面上方直至被移除。返回一个可释放对象，销毁该对象时将移除覆盖层。

用法

await Screencast.ShowOverlayAsync(html, options);

参数

• html string#

  覆盖层的 HTML 内容。

• options ScreencastShowOverlayOptions? (可选)

  • Duration [float]? (可选)#

    自动移除覆盖层前的持续时间（毫秒）。若未提供，覆盖层将一直显示直到被手动关闭。

返回

• [Disposable]#

---

ShowOverlaysAsync

新增于: v1.59 screencast.ShowOverlaysAsync

显示覆盖层。

用法

await Screencast.ShowOverlaysAsync();

返回

• void#

---

StartAsync

新增于: v1.59 screencast.StartAsync

启动屏幕录制。当提供 Path 时，它会将录制的视频保存到指定文件。当提供 OnFrame 时，会将 JPEG 编码的帧传递给回调函数。两者可以同时使用。

用法

参数

• options ScreencastStartOptions? (可选)

  • OnFrame Func<[ScreencastFrame], Task> (可选)#

    • Data byte[]

      JPEG 编码的帧数据。

    • Timestamp [float]

      浏览器呈现帧的时间戳，单位为自 Unix 纪元以来的毫秒数。

    • ViewportWidth int

      捕获帧时页面视口的宽度。

    • ViewportHeight int

      捕获帧时页面视口的高度。

    接收 JPEG 编码帧数据以及捕获时页面视口大小的回调函数。

  • Path string? (可选)#

    停止截屏时视频应保存的路径。提供此参数时，将开始录制视频。

  • Quality int? (可选)#

    图像质量，介于 0-100 之间。

  • Size Size? (可选)#

    • Width int

      最大帧宽度（像素）。

    • Height int

      最大帧高度（像素）。

    指定屏幕录制帧的尺寸。实际帧会按比例缩放以保持页面的宽高比，可能会小于这些边界值。如果屏幕录制已激活（例如通过 tracing 或视频录制启动），则现有配置优先，帧大小可能会超过这些限制，或者此选项可能会被忽略。如果未指定，大小将等于页面视口，并缩放以适应 800×800。

返回

• [Disposable]#

---

StopAsync

新增于: v1.59 screencast.StopAsync

停止屏幕录制及视频记录（如果正在进行）。如果之前正在录制视频，它会将其保存到 Screencast.StartAsync() 中指定的路径。

用法

await Screencast.StopAsync();

返回

• void#