From e71e6ad0dda3ada7b3a15d7e6e2b700aa628f24a Mon Sep 17 00:00:00 2001 From: Harvey Zack Date: Thu, 4 Jul 2024 09:57:13 +0800 Subject: [PATCH] feat: Add support for custom file names in screenshot functionality --- packages/artplayer-vitepress/docs/advanced/property.md | 4 ++-- packages/artplayer-vitepress/docs/en/advanced/property.md | 5 +++-- packages/artplayer/types/player.d.ts | 2 +- 3 files changed, 6 insertions(+), 5 deletions(-) diff --git a/packages/artplayer-vitepress/docs/advanced/property.md b/packages/artplayer-vitepress/docs/advanced/property.md index aab4ee0de..8ee7b4dd8 100644 --- a/packages/artplayer-vitepress/docs/advanced/property.md +++ b/packages/artplayer-vitepress/docs/advanced/property.md @@ -344,7 +344,7 @@ art.on('ready', () => { - Type: `Function` -下载当前视频帧的截图 +下载当前视频帧的截图, 可选参数为截图名字
▶ Run Code
@@ -355,7 +355,7 @@ var art = new Artplayer({ }); art.on('ready', () => { - art.screenshot(); + art.screenshot('your-name'); }); ``` diff --git a/packages/artplayer-vitepress/docs/en/advanced/property.md b/packages/artplayer-vitepress/docs/en/advanced/property.md index 29b32b8f5..396da29e8 100644 --- a/packages/artplayer-vitepress/docs/en/advanced/property.md +++ b/packages/artplayer-vitepress/docs/en/advanced/property.md @@ -338,7 +338,7 @@ Some videos do not have a duration, such as videos that are being live streamed - Type: `Function` -Download a screenshot of the current video frame +Download a screenshot of the current video frame, optional parameter is the screenshot name
▶ Run Code
@@ -349,9 +349,10 @@ var art = new Artplayer({ }); art.on('ready', () => { - art.screenshot(); + art.screenshot('your-name'); }); ``` + ## `getDataURL` - Type: `Function` diff --git a/packages/artplayer/types/player.d.ts b/packages/artplayer/types/player.d.ts index 925e20cf7..a6b08416c 100644 --- a/packages/artplayer/types/player.d.ts +++ b/packages/artplayer/types/player.d.ts @@ -72,7 +72,7 @@ export declare class Player { switchQuality(url: string): Promise; getDataURL(): Promise; getBlobUrl(): Promise; - screenshot(): Promise; + screenshot(name?: string): Promise; airplay(): void; autoSize(): void; autoHeight(): void;