puppeteer/new-docs/puppeteer.protocol.headlessexperimental.beginframerequest.screenshot.md

14 lines
851 B
Markdown
Raw Normal View History

<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [puppeteer](./puppeteer.md) &gt; [Protocol](./puppeteer.protocol.md) &gt; [HeadlessExperimental](./puppeteer.protocol.headlessexperimental.md) &gt; [BeginFrameRequest](./puppeteer.protocol.headlessexperimental.beginframerequest.md) &gt; [screenshot](./puppeteer.protocol.headlessexperimental.beginframerequest.screenshot.md)
## Protocol.HeadlessExperimental.BeginFrameRequest.screenshot property
If set, a screenshot of the frame will be captured and returned in the response. Otherwise, no screenshot will be captured. Note that capturing a screenshot can fail, for example, during renderer initialization. In such a case, no screenshot data will be returned.
<b>Signature:</b>
```typescript
screenshot?: ScreenshotParams;
```