video

const video: Video

Defined in: video.ts:1401

ScreenCI video recording test fixture.

Extended Playwright test that automatically records browser interactions as video. Configure capture/render options with video.recordOptions(...) / video.renderOptions(...) per video, or project-wide in your config file.

Example

Basic usage:

import { video, voices } from 'screenci'

// Voice is a render option; the narration text is declared with video.narration.
video.renderOptions({ narration: { voice: { name: voices.Ava } } }).narration({
  en: {
    homepage: 'User navigates to homepage.',
    signup: 'Clicks the sign up button.',
  },
})('Tutorial', async ({ page, narration }) => {
  await page.goto('https://example.com')
  await narration.homepage()

  await page.click('text=Sign up')
  await narration.signup()
})