From 3695dab1d5b2a8f03c5ece6011a21aa39bc4fcfe Mon Sep 17 00:00:00 2001 From: Yury Semikhatsky Date: Tue, 9 Feb 2021 16:44:50 -0800 Subject: [PATCH] docs: split RecordVideo object into dir and size options in java (#5389) --- docs/src/api/params.md | 24 ++++++++++++++---------- types/types.d.ts | 18 +++++++++--------- 2 files changed, 23 insertions(+), 19 deletions(-) diff --git a/docs/src/api/params.md b/docs/src/api/params.md index 1e3f5a782339b..c744ac41cb91e 100644 --- a/docs/src/api/params.md +++ b/docs/src/api/params.md @@ -370,12 +370,12 @@ 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 the video size defaults to 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. @@ -383,20 +383,24 @@ Enables video recording for all pages into `recordVideo.dir` directory. If not s 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]> - If `viewport` is not configured explicitly the video size defaults to 1280x720. Actual picture of each page will be +* langs: csharp, java, python + - alias-python: record_video_size +- `recordVideoSize` <[Object]> + If `viewport` is not configured explicitly the video size defaults to 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. -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 the video size defaults to 800x450. +Actual picture of each page will be scaled down if necessary to fit the specified size. ## context-option-proxy - `proxy` <[Object]> diff --git a/types/types.d.ts b/types/types.d.ts index 30d8bfc4e4a4e..bf05d662dda3e 100644 --- a/types/types.d.ts +++ b/types/types.d.ts @@ -6520,9 +6520,9 @@ export interface BrowserType { 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 the video size defaults to 800x450. Actual picture of each page + * will be scaled down if necessary to fit the specified size. */ size?: { /** @@ -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 the video size defaults to 800x450. Actual picture of each page + * will be scaled down if necessary to fit the specified size. */ size?: { /** @@ -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 the video size defaults to 800x450. Actual picture of each page + * will be scaled down if necessary to fit the specified size. */ size?: { /**