Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: split RecordVideo object into dir and size options in java #5389

Merged
merged 2 commits into from
Feb 10, 2021
Merged

docs: split RecordVideo object into dir and size options in java #5389

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3cb5eec
docs: split RecordVideo object into dir and size options in java
yury-s Feb 10, 2021
cd5fbce
Update comments
yury-s Feb 10, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
22 changes: 13 additions & 9 deletions docs/src/api/params.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -370,33 +370,37 @@ Optional setting to control whether to omit request content from the HAR. Defaul
Path on the filesystem to write the HAR file to.

## context-option-recordvideo
* langs: java, js
* langs: js
- `recordVideo` <[Object]>
- `dir` <[path]> Path to the directory to put videos into.
- `size` <[Object]> Optional dimensions of the recorded videos. If not specified the size will be equal to `viewport`.
If `viewport` is not configured explicitly the video size defaults to 1280x720. Actual picture of each page will be
scaled down if necessary to fit the specified size.
- `size` <[Object]> Optional dimensions of the recorded videos. If not specified the size will be equal to `viewport`
scaled down to fit into 800x800. If `viewport` is not configured explicitly it defaults to 1280x720 and video size
will be 800x450. Actual picture of each page will be scaled down if necessary to fit the specified size.
- `width` <[int]> Video frame width.
- `height` <[int]> Video frame height.

Enables video recording for all pages into `recordVideo.dir` directory. If not specified videos are not recorded. Make
sure to await [`method: BrowserContext.close`] for videos to be saved.

## python-context-option-recordvideo-dir
* langs: python
- `record_video_dir` <[path]>
* langs: csharp, java, python
- alias-python: record_video_dir
- `recordVideoDir` <[path]>

Path to the directory to put videos into.

## python-context-option-recordvideo-size
* langs: python
- `record_video_size` <[Object]>
* langs: csharp, java, python
- alias-python: record_video_size
- `recordVideoSize` <[Object]>
If `viewport` is not configured explicitly the video size defaults to 1280x720. Actual picture of each page will be
scaled down if necessary to fit the specified size.
- `width` <[int]> Video frame width.
- `height` <[int]> Video frame height.

Optional dimensions of the recorded videos. If not specified the size will be equal to `viewport`.
Dimensions of the recorded videos. If not specified the size will be equal to `viewport`
scaled down to fit into 800x800. If `viewport` is not configured explicitly it defaults to 1280x720 and video size
will be 800x450. Actual picture of each page will be scaled down if necessary to fit the specified size.

## context-option-proxy
- `proxy` <[Object]>
Expand Down
18 changes: 9 additions & 9 deletions types/types.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6520,9 +6520,9 @@ export interface BrowserType<Browser> {
dir: string;

/**
* Optional dimensions of the recorded videos. If not specified the size will be equal to `viewport`. If `viewport` is not
* configured explicitly the video size defaults to 1280x720. Actual picture of each page will be scaled down if necessary
* to fit the specified size.
* Optional dimensions of the recorded videos. If not specified the size will be equal to `viewport` scaled down to fit
* into 800x800. If `viewport` is not configured explicitly it defaults to 1280x720 and video size will be 800x450. Actual
* picture of each page will be scaled down if necessary to fit the specified size.
*/
size?: {
/**
Expand Down Expand Up @@ -7454,9 +7454,9 @@ export interface Browser extends EventEmitter {
dir: string;

/**
* Optional dimensions of the recorded videos. If not specified the size will be equal to `viewport`. If `viewport` is not
* configured explicitly the video size defaults to 1280x720. Actual picture of each page will be scaled down if necessary
* to fit the specified size.
* Optional dimensions of the recorded videos. If not specified the size will be equal to `viewport` scaled down to fit
* into 800x800. If `viewport` is not configured explicitly it defaults to 1280x720 and video size will be 800x450. Actual
* picture of each page will be scaled down if necessary to fit the specified size.
*/
size?: {
/**
Expand Down Expand Up @@ -9535,9 +9535,9 @@ export interface BrowserContextOptions {
dir: string;

/**
* Optional dimensions of the recorded videos. If not specified the size will be equal to `viewport`. If `viewport` is not
* configured explicitly the video size defaults to 1280x720. Actual picture of each page will be scaled down if necessary
* to fit the specified size.
* Optional dimensions of the recorded videos. If not specified the size will be equal to `viewport` scaled down to fit
* into 800x800. If `viewport` is not configured explicitly it defaults to 1280x720 and video size will be 800x450. Actual
* picture of each page will be scaled down if necessary to fit the specified size.
*/
size?: {
/**
Expand Down