puppeteer/website/versioned_docs/version-21.6.0/api/puppeteer.page.screencast.md
release-please[bot] 8c0ac61260
chore: release main (#11431)
Co-authored-by: release-please[bot] <55107282+release-please[bot]@users.noreply.github.com>
2023-12-06 09:04:56 +01:00

1.4 KiB

sidebar_label
Page.screencast

Page.screencast() method

Captures a screencast of this page.

Signature:

class Page {
  screencast(options?: Readonly<ScreencastOptions>): Promise<ScreenRecorder>;
}

Parameters

Parameter Type Description
options Readonly<ScreencastOptions> (Optional) Configures screencast behavior.

Returns:

Promise<ScreenRecorder>

Remarks

All recordings will be WebM format using the VP9 video codec. The FPS is 30.

You must have ffmpeg installed on your system.

Example

Recording a page:

import puppeteer from 'puppeteer';

// Launch a browser
const browser = await puppeteer.launch();

// Create a new page
const page = await browser.newPage();

// Go to your site.
await page.goto("https://www.example.com");

// Start recording.
const recorder = await page.screencast({path: 'recording.webm'});

// Do something.

// Stop recording.
await recorder.stop();

browser.close();