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

microsoft · Feb 10, 2021 · 3695dab · 3695dab
1 parent e2013b2
commit 3695dab
Show file tree

Hide file tree

Showing 2 changed files with 23 additions and 19 deletions.
diff --git a/docs/src/api/params.md b/docs/src/api/params.md
@@ -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 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.
 
 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]>
-  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
@@ -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 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?: {
       /**