From 11b7bf0dc3159ecf1d31ffc86f88875cbd692dc4 Mon Sep 17 00:00:00 2001 From: Ross Wollman Date: Mon, 1 Aug 2022 15:34:29 -0700 Subject: [PATCH] docs(video): caveat regarding saveAs throwing (#16120) Resolves https://github.com/microsoft/playwright-python/issues/1462. Relates https://github.com/microsoft/playwright-python/pull/1474, https://github.com/microsoft/playwright-java/pull/1020 --- docs/src/api/class-video.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/docs/src/api/class-video.md b/docs/src/api/class-video.md index e816b127f8..23eead4884 100644 --- a/docs/src/api/class-video.md +++ b/docs/src/api/class-video.md @@ -41,6 +41,18 @@ upon closing the browser context. This method throws when connected remotely. Saves the video to a user-specified path. It is safe to call this method while the video is still in progress, or after the page has closed. This method waits until the page is closed and the video is fully saved. +## method: Video.saveAs +* langs: java +* since: v1.11 + +Saves the video to a user-specified path. This must be called after [`method: Page.close`] (or [`method: BrowserContext.close`]), otherwise an error will be thrown. This method waits until the video is fully saved. + +## async method: Video.saveAs +* langs: python +* since: v1.11 + +Saves the video to a user-specified path. If using the sync API, this must be called after [`method: Page.close`] (or [`method: BrowserContext.close`]), otherwise an error will be thrown. If using the async API, it is safe to call this method while the video is still in progress, or after the page has closed. This method waits until the page is closed and the video is fully saved. + ### param: Video.saveAs.path * since: v1.11 - `path` <[path]>