Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion dotnet/docs/api/class-tracing.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@ await Page.Context.Tracing.GroupEndAsync();
Specifies a custom location for the group to be shown in the trace viewer. Defaults to the location of the [Tracing.GroupAsync()](/api/class-tracing.mdx#tracing-group) call.

**Returns**
- [void]<a aria-hidden="true" tabIndex="-1" class="list-anchor-link" id="tracing-group-return"/><a href="#tracing-group-return" class="list-anchor">#</a>
- [Disposable]<a aria-hidden="true" tabIndex="-1" class="list-anchor-link" id="tracing-group-return"/><a href="#tracing-group-return" class="list-anchor">#</a>

---

Expand Down
21 changes: 9 additions & 12 deletions dotnet/docs/api/class-video.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,9 @@ Console.WriteLine(await page.Video.GetPathAsync());
Alternatively, you can use [Video.StartAsync()](/api/class-video.mdx#video-start) and [Video.StopAsync()](/api/class-video.mdx#video-stop) to record video manually. This approach is mutually exclusive with the `recordVideo` option.

```csharp
await page.Video.StartAsync();
await page.Video.StartAsync(new() { Path = "video.webm" });
// ... perform actions ...
await page.Video.StopAsync(new() { Path = "video.webm" });
await page.Video.StopAsync();
```


Expand Down Expand Up @@ -91,13 +91,16 @@ Starts video recording. This method is mutually exclusive with the `recordVideo`
**Usage**

```csharp
await page.Video.StartAsync();
await page.Video.StartAsync(new() { Path = "video.webm" });
// ... perform actions ...
await page.Video.StopAsync(new() { Path = "video.webm" });
await page.Video.StopAsync();
```

**Arguments**
- `options` `VideoStartOptions?` *(optional)*
- `Path` [string]? *(optional)*<a aria-hidden="true" tabIndex="-1" class="list-anchor-link" id="video-start-option-path"/><a href="#video-start-option-path" class="list-anchor">#</a>

Path where the video should be saved when the recording is stopped.
- `Size` Size? *(optional)*<a aria-hidden="true" tabIndex="-1" class="list-anchor-link" id="video-start-option-size"/><a href="#video-start-option-size" class="list-anchor">#</a>
- `Width` [int]

Expand All @@ -109,7 +112,7 @@ await page.Video.StopAsync(new() { Path = "video.webm" });
Optional dimensions of the recorded video. If not specified the size will be equal to page viewport scaled down to fit into 800x800. Actual picture of the page will be scaled down if necessary to fit the specified size.

**Returns**
- [void]<a aria-hidden="true" tabIndex="-1" class="list-anchor-link" id="video-start-return"/><a href="#video-start-return" class="list-anchor">#</a>
- [Disposable]<a aria-hidden="true" tabIndex="-1" class="list-anchor-link" id="video-start-return"/><a href="#video-start-return" class="list-anchor">#</a>

---

Expand All @@ -122,15 +125,9 @@ Stops video recording started with [Video.StartAsync()](/api/class-video.mdx#vid
**Usage**

```csharp
await Video.StopAsync(options);
await Video.StopAsync();
```

**Arguments**
- `options` `VideoStopOptions?` *(optional)*
- `Path` [string]? *(optional)*<a aria-hidden="true" tabIndex="-1" class="list-anchor-link" id="video-stop-option-path"/><a href="#video-stop-option-path" class="list-anchor">#</a>

Path where the video should be saved.

**Returns**
- [void]<a aria-hidden="true" tabIndex="-1" class="list-anchor-link" id="video-stop-return"/><a href="#video-stop-return" class="list-anchor">#</a>

Expand Down
2 changes: 1 addition & 1 deletion java/docs/api/class-tracing.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ page.context().tracing().groupEnd();
Specifies a custom location for the group to be shown in the trace viewer. Defaults to the location of the [Tracing.group()](/api/class-tracing.mdx#tracing-group) call.

**Returns**
- [void]<a aria-hidden="true" tabIndex="-1" class="list-anchor-link" id="tracing-group-return"/><a href="#tracing-group-return" class="list-anchor">#</a>
- [Disposable]<a aria-hidden="true" tabIndex="-1" class="list-anchor-link" id="tracing-group-return"/><a href="#tracing-group-return" class="list-anchor">#</a>

---

Expand Down
20 changes: 8 additions & 12 deletions java/docs/api/class-video.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,9 @@ System.out.println(page.video().path());
Alternatively, you can use [Video.start()](/api/class-video.mdx#video-start) and [Video.stop()](/api/class-video.mdx#video-stop) to record video manually. This approach is mutually exclusive with the `recordVideo` option.

```java
page.video().start();
page.video().start(new Video.StartOptions().setPath(Paths.get("video.webm")));
// ... perform actions ...
page.video().stop(new Video.StopOptions().setPath(Paths.get("video.webm")));
page.video().stop();
```


Expand Down Expand Up @@ -91,13 +91,16 @@ Starts video recording. This method is mutually exclusive with the `recordVideo`
**Usage**

```java
page.video().start();
page.video().start(new Video.StartOptions().setPath(Paths.get("video.webm")));
// ... perform actions ...
page.video().stop(new Video.StopOptions().setPath(Paths.get("video.webm")));
page.video().stop();
```

**Arguments**
- `options` `Video.StartOptions` *(optional)*
- `setPath` [Path] *(optional)*<a aria-hidden="true" tabIndex="-1" class="list-anchor-link" id="video-start-option-path"/><a href="#video-start-option-path" class="list-anchor">#</a>

Path where the video should be saved when the recording is stopped.
- `setSize` Size *(optional)*<a aria-hidden="true" tabIndex="-1" class="list-anchor-link" id="video-start-option-size"/><a href="#video-start-option-size" class="list-anchor">#</a>
- `setWidth` [int]

Expand All @@ -109,7 +112,7 @@ page.video().stop(new Video.StopOptions().setPath(Paths.get("video.webm")));
Optional dimensions of the recorded video. If not specified the size will be equal to page viewport scaled down to fit into 800x800. Actual picture of the page will be scaled down if necessary to fit the specified size.

**Returns**
- [void]<a aria-hidden="true" tabIndex="-1" class="list-anchor-link" id="video-start-return"/><a href="#video-start-return" class="list-anchor">#</a>
- [Disposable]<a aria-hidden="true" tabIndex="-1" class="list-anchor-link" id="video-start-return"/><a href="#video-start-return" class="list-anchor">#</a>

---

Expand All @@ -123,15 +126,8 @@ Stops video recording started with [Video.start()](/api/class-video.mdx#video-st

```java
Video.stop();
Video.stop(options);
```

**Arguments**
- `options` `Video.StopOptions` *(optional)*
- `setPath` [Path] *(optional)*<a aria-hidden="true" tabIndex="-1" class="list-anchor-link" id="video-stop-option-path"/><a href="#video-stop-option-path" class="list-anchor">#</a>

Path where the video should be saved.

**Returns**
- [void]<a aria-hidden="true" tabIndex="-1" class="list-anchor-link" id="video-stop-return"/><a href="#video-stop-return" class="list-anchor">#</a>

Expand Down
17 changes: 17 additions & 0 deletions nodejs/docs/api/class-browsercontext.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -227,6 +227,23 @@ await browserContext.close(options);

---

### contextOptions {#browser-context-context-options}

<font size="2" style={{position: "relative", top: "-20px"}}>Added in: v1.59</font><x-search>browserContext.contextOptions</x-search>

Returns the context options that were used to create this browser context. The return type matches the options accepted by [browser.newContext()](/api/class-browser.mdx#browser-new-context).

**Usage**

```js
browserContext.contextOptions();
```

**Returns**
- [Object]<a aria-hidden="true" tabIndex="-1" class="list-anchor-link" id="browser-context-context-options-return"/><a href="#browser-context-context-options-return" class="list-anchor">#</a>

---

### cookies {#browser-context-cookies}

<font size="2" style={{position: "relative", top: "-20px"}}>Added before v1.9</font><x-search>browserContext.cookies</x-search>
Expand Down
45 changes: 22 additions & 23 deletions nodejs/docs/api/class-page.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -1861,29 +1861,6 @@ await page.routeWebSocket('/ws', ws => {

---

### screencast {#page-screencast}

<font size="2" style={{position: "relative", top: "-20px"}}>Added in: v1.59</font><x-search>page.screencast</x-search>

Returns the [Screencast] object associated with this page.

**Usage**

```js
const screencast = page.screencast();
screencast.on('screencastFrame', data => {
console.log('received frame, jpeg size:', data.length);
});
await screencast.start();
// ... perform actions ...
await screencast.stop();
```

**Returns**
- [Screencast]<a aria-hidden="true" tabIndex="-1" class="list-anchor-link" id="page-screencast-return"/><a href="#page-screencast-return" class="list-anchor">#</a>

---

### screenshot {#page-screenshot}

<font size="2" style={{position: "relative", top: "-20px"}}>Added before v1.9</font><x-search>page.screenshot</x-search>
Expand Down Expand Up @@ -2617,6 +2594,28 @@ page.request

---

### screencast {#page-screencast}

<font size="2" style={{position: "relative", top: "-20px"}}>Added in: v1.59</font><x-search>page.screencast</x-search>

[Screencast] object associated with this page.

**Usage**

```js
page.screencast.on('screencastFrame', data => {
console.log('received frame, jpeg size:', data.length);
});
await page.screencast.start();
// ... perform actions ...
await page.screencast.stop();
```

**Type**
- [Screencast]

---

### touchscreen {#page-touchscreen}

<font size="2" style={{position: "relative", top: "-20px"}}>Added before v1.9</font><x-search>page.touchscreen</x-search>
Expand Down
6 changes: 3 additions & 3 deletions nodejs/docs/api/class-screencast.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ Starts capturing screencast frames. Frames are emitted as [screencast.on('screen
**Usage**

```js
const screencast = page.screencast();
const screencast = page.screencast;
screencast.on('screencastframe', ({ data, width, height }) => {
console.log(`frame ${width}x${height}, size: ${data.length}`);
});
Expand All @@ -45,7 +45,7 @@ await screencast.stop();
Maximum screencast frame dimensions. The output frame may be smaller to preserve the page aspect ratio. Defaults to 800×800.

**Returns**
- [Promise]&lt;[void]&gt;<a aria-hidden="true" tabIndex="-1" class="list-anchor-link" id="screencast-start-return"/><a href="#screencast-start-return" class="list-anchor">#</a>
- [Promise]&lt;[Disposable]&gt;<a aria-hidden="true" tabIndex="-1" class="list-anchor-link" id="screencast-start-return"/><a href="#screencast-start-return" class="list-anchor">#</a>

---

Expand Down Expand Up @@ -79,7 +79,7 @@ Emitted for each captured JPEG screencast frame while the screencast is running.
**Usage**

```js
const screencast = page.screencast();
const screencast = page.screencast;
screencast.on('screencastframe', ({ data, width, height }) => {
console.log(`frame ${width}x${height}, jpeg size: ${data.length}`);
require('fs').writeFileSync('frame.jpg', data);
Expand Down
2 changes: 1 addition & 1 deletion nodejs/docs/api/class-tracing.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ await test.step('Log in', async () => {
Specifies a custom location for the group to be shown in the trace viewer. Defaults to the location of the [tracing.group()](/api/class-tracing.mdx#tracing-group) call.

**Returns**
- [Promise]&lt;[void]&gt;<a aria-hidden="true" tabIndex="-1" class="list-anchor-link" id="tracing-group-return"/><a href="#tracing-group-return" class="list-anchor">#</a>
- [Promise]&lt;[Disposable]&gt;<a aria-hidden="true" tabIndex="-1" class="list-anchor-link" id="tracing-group-return"/><a href="#tracing-group-return" class="list-anchor">#</a>

---

Expand Down
20 changes: 8 additions & 12 deletions nodejs/docs/api/class-video.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,9 @@ console.log(await page.video().path());
Alternatively, you can use [video.start()](/api/class-video.mdx#video-start) and [video.stop()](/api/class-video.mdx#video-stop) to record video manually. This approach is mutually exclusive with the `recordVideo` option.

```js
await page.video().start();
await page.video().start({ path: 'video.webm' });
// ... perform actions ...
await page.video().stop({ path: 'video.webm' });
await page.video().stop();
```


Expand Down Expand Up @@ -91,13 +91,16 @@ Starts video recording. This method is mutually exclusive with the `recordVideo`
**Usage**

```js
await page.video().start();
await page.video().start({ path: 'video.webm' });
// ... perform actions ...
await page.video().stop({ path: 'video.webm' });
await page.video().stop();
```

**Arguments**
- `options` [Object] *(optional)*
- `path` [string] *(optional)*<a aria-hidden="true" tabIndex="-1" class="list-anchor-link" id="video-start-option-path"/><a href="#video-start-option-path" class="list-anchor">#</a>

Path where the video should be saved when the recording is stopped.
- `size` [Object] *(optional)*<a aria-hidden="true" tabIndex="-1" class="list-anchor-link" id="video-start-option-size"/><a href="#video-start-option-size" class="list-anchor">#</a>
- `width` [number]

Expand All @@ -109,7 +112,7 @@ await page.video().stop({ path: 'video.webm' });
Optional dimensions of the recorded video. If not specified the size will be equal to page viewport scaled down to fit into 800x800. Actual picture of the page will be scaled down if necessary to fit the specified size.

**Returns**
- [Promise]&lt;[void]&gt;<a aria-hidden="true" tabIndex="-1" class="list-anchor-link" id="video-start-return"/><a href="#video-start-return" class="list-anchor">#</a>
- [Promise]&lt;[Disposable]&gt;<a aria-hidden="true" tabIndex="-1" class="list-anchor-link" id="video-start-return"/><a href="#video-start-return" class="list-anchor">#</a>

---

Expand All @@ -123,15 +126,8 @@ Stops video recording started with [video.start()](/api/class-video.mdx#video-st

```js
await video.stop();
await video.stop(options);
```

**Arguments**
- `options` [Object] *(optional)*
- `path` [string] *(optional)*<a aria-hidden="true" tabIndex="-1" class="list-anchor-link" id="video-stop-option-path"/><a href="#video-stop-option-path" class="list-anchor">#</a>

Path where the video should be saved.

**Returns**
- [Promise]&lt;[void]&gt;<a aria-hidden="true" tabIndex="-1" class="list-anchor-link" id="video-stop-return"/><a href="#video-stop-return" class="list-anchor">#</a>

Expand Down
2 changes: 1 addition & 1 deletion nodejs/docs/ci.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -171,7 +171,7 @@ jobs:
- name: Install Playwright Browsers
run: npx playwright install --with-deps
- name: Run changed Playwright tests
run: npx playwright test --only-changed=$GITHUB_BASE_REF
run: npx playwright test --only-changed=origin/$GITHUB_BASE_REF
if: github.event_name == 'pull_request'
- name: Run Playwright tests
run: npx playwright test
Expand Down
2 changes: 1 addition & 1 deletion python/docs/api/class-tracing.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -121,7 +121,7 @@ await page.context.tracing.group_end()
Specifies a custom location for the group to be shown in the trace viewer. Defaults to the location of the [tracing.group()](/api/class-tracing.mdx#tracing-group) call.

**Returns**
- [NoneType]<a aria-hidden="true" tabIndex="-1" class="list-anchor-link" id="tracing-group-return"/><a href="#tracing-group-return" class="list-anchor">#</a>
- [Disposable]<a aria-hidden="true" tabIndex="-1" class="list-anchor-link" id="tracing-group-return"/><a href="#tracing-group-return" class="list-anchor">#</a>

---

Expand Down
Loading
Loading