Skip to content
ScreenCI

OverlayPlacement

OverlayPlacement = { fullScreen: true; } | { aspectRatio?: number; relativeTo: "screen" | "recording"; width: number; x: number; y: number; } | { aspectRatio?: number; height: number; relativeTo: "screen" | "recording"; x: number; y: number; }

Defined in: events.ts:419

Placement of a visual asset overlay. Coordinates are CSS pixels in the recording viewport (the same space Playwright’s boundingBox(), page.mouse, and viewportSize() use), with the asset anchored at its top-left corner. The renderer maps these recording-viewport pixels into the final output frame, so the output size never has to be known when the recording is authored.

  • fullScreen fills the entire output frame.
  • The positioned variants place the asset against the full output frame (relativeTo: 'screen') or the composited recording area (relativeTo: 'recording', the default). Provide exactly one of width or height; the other dimension is derived from the asset’s intrinsic aspect ratio, or from aspectRatio (width / height) when given.