puppeteer.page.screencast.md

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](https://www.webmproject.org/) format using the [VP9](https://www.webmproject.org/vp9/) video codec. The FPS is 30.

You must have [ffmpeg](https://ffmpeg.org/) 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();