puppeteer/docs/api/puppeteer.cdpsession.md

48 lines
2.5 KiB
Markdown
Raw Normal View History

2022-07-05 13:41:43 +00:00
---
sidebar_label: CDPSession
---
# CDPSession class
The `CDPSession` instances are used to talk raw Chrome Devtools Protocol.
#### Signature:
2022-07-05 13:41:43 +00:00
```typescript
2023-09-13 13:47:55 +00:00
export declare abstract class CDPSession extends EventEmitter<CDPSessionEvents>
2022-07-05 13:41:43 +00:00
```
2023-09-13 13:47:55 +00:00
**Extends:** [EventEmitter](./puppeteer.eventemitter.md)&lt;[CDPSessionEvents](./puppeteer.cdpsessionevents.md)&gt;
2022-07-05 13:41:43 +00:00
## Remarks
Protocol methods can be called with [CDPSession.send()](./puppeteer.cdpsession.send.md) method and protocol events can be subscribed to with `CDPSession.on` method.
Useful links: [DevTools Protocol Viewer](https://chromedevtools.github.io/devtools-protocol/) and [Getting Started with DevTools Protocol](https://github.com/aslushnikov/getting-started-with-cdp/blob/HEAD/README.md).
The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `CDPSession` class.
## Example
```ts
const client = await page.target().createCDPSession();
await client.send('Animation.enable');
client.on('Animation.animationCreated', () =>
console.log('Animation created!')
);
const response = await client.send('Animation.getPlaybackRate');
console.log('playback rate is ' + response.playbackRate);
await client.send('Animation.setPlaybackRate', {
playbackRate: response.playbackRate / 2,
});
```
## Methods
| Method | Modifiers | Description |
| -------------------------------------------------- | --------- | --------------------------------------------------------------------------------------------------------------------------------------- |
| [connection](./puppeteer.cdpsession.connection.md) | | |
| [detach](./puppeteer.cdpsession.detach.md) | | Detaches the cdpSession from the target. Once detached, the cdpSession object won't emit any events and can't be used to send messages. |
| [id](./puppeteer.cdpsession.id.md) | | Returns the session's id. |
| [send](./puppeteer.cdpsession.send.md) | | |