Back to Webdriverio

Session Screencast

website/docs/devtools/wdio/Screencast.md

9.29.04.5 KB
Original Source

Records browser sessions as .webm videos. Videos are displayed in the DevTools UI alongside the snapshot and DOM mutation views.

Available across all three adapters - WebdriverIO, Selenium WebDriver, and Nightwatch.js. The capture mode differs per framework (CDP push where possible, polling otherwise - see Browser Support below).

Demo

Setup

Screencast encoding requires ffmpeg on PATH and the fluent-ffmpeg package:

sh
# Install ffmpeg - https://ffmpeg.org/download.html
brew install ffmpeg        # macOS
sudo apt install ffmpeg    # Ubuntu/Debian

# Install fluent-ffmpeg
npm install fluent-ffmpeg

Configuration

ts
services: [
  [
    'devtools',
    {
      screencast: {
        enabled: true,
        captureFormat: 'jpeg',
        quality: 70,
        maxWidth: 1280,
        maxHeight: 720,
      }
    }
  ]
]

Options

OptionTypeDefaultDescription
enabledbooleanfalseEnable session recording
captureFormat'jpeg' | 'png''jpeg'Frame image format. Chrome/Chromium only - controls the format Chrome sends over CDP. Ignored in polling mode (Firefox, Safari) where screenshots are always PNG. Does not affect the output video container, which is always .webm
qualitynumber70JPEG compression quality 0-100. Only applies in Chrome/Chromium CDP mode with captureFormat: 'jpeg'
maxWidthnumber1280Maximum frame width in pixels. Chrome/Chromium only - Chrome scales frames before sending over CDP. Ignored in polling mode
maxHeightnumber720Maximum frame height in pixels. Chrome/Chromium only - same as above
pollIntervalMsnumber200Screenshot interval in milliseconds for non-Chrome browsers (polling mode). Lower = smoother video but more WebDriver round-trips during test execution

Browser Support

Recording works across all major browsers using automatic mode selection:

BrowserModeNotes
Chrome / Chromium / EdgeCDP pushChrome pushes frames over the DevTools Protocol. Efficient - no impact on test command timing
Firefox / Safari / othersBiDi pollingFalls back to calling browser.takeScreenshot() at pollIntervalMs intervals. Works wherever WebDriver screenshots are supported; adds a small overhead proportional to the interval

No configuration change is needed to switch modes - the service detects browser capabilities automatically and logs which mode is active.

Behaviour

  • Recording starts when the browser session opens and stops when it closes.
  • Leading blank frames (captured before the first URL navigation) are automatically trimmed so videos begin at the first meaningful page action.
  • If browser.reloadSession() is called mid-run, the service finalises the current recording and starts a fresh one for the new session. Each session produces its own .webm file.
  • When multiple recordings exist, the DevTools UI shows a Recording N dropdown to switch between them.

Where output files land

The directory each adapter picks is slightly different - they all share the same resolver in @wdio/devtools-core but feed it different inputs:

AdapterOutput location
WebdriverIOoutputDir if explicitly set in wdio.conf.ts, otherwise rootDir (the dir containing the config). Avoid setting outputDir just to control video paths - WDIO redirects worker logs there too.
SeleniumDirectory of the test file that just ran, falling back to process.cwd().
NightwatchDirectory of the test file, falling back to the directory containing nightwatch.conf.*, then process.cwd().

Directories under node_modules/ are skipped on the Selenium/Nightwatch path so symlinked workspaces don't dump videos into a dependency folder.

Output Files

Filenames are adapter-specific (the framework name appears in the prefix), but the shape is the same:

AdapterTrace JSONScreencast video
WebdriverIOwdio-trace-{sessionId}.jsonwdio-video-{sessionId}.webm
Selenium-selenium-video-{sessionId}.webm
Nightwatch-nightwatch-video-{sessionId}.webm

The trace JSON is currently produced by WDIO only; Selenium and Nightwatch stream the same data live to the dashboard but don't write a snapshot file today. The video is produced by every adapter when screencast.enabled: true.