puppeteer-screencorder 3.0.6

package/CHANGELOG.md

@@ -0,0 +1,77 @@
+# Changelog
+
+All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
+
+### [3.0.6](https://github.com/prasanaworld/puppeteer-screen-recorder/compare/v3.0.5...v3.0.6) (2024-10-27)
+
+### [3.0.5](https://github.com/prasanaworld/puppeteer-screen-recorder/compare/v3.0.4...v3.0.5) (2024-08-04)
+
+### [3.0.4](https://github.com/prasanaworld/puppeteer-screen-recorder/compare/v3.0.3...v3.0.4) (2024-08-04)
+
+### [3.0.3](https://github.com/prasanaworld/puppeteer-screen-recorder/compare/v3.0.2...v3.0.3) (2024-02-18)
+
+### [3.0.2](https://github.com/prasanaworld/puppeteer-screen-recorder/compare/v3.0.1...v3.0.2) (2024-02-18)
+
+### [3.0.1](https://github.com/prasanaworld/puppeteer-screen-recorder/compare/v3.0.0...v3.0.1) (2024-02-18)
+
+## [3.0.0](https://github.com/prasanaworld/puppeteer-screen-recorder/compare/v2.2.0...v3.0.0) (2024-02-18)
+
+## [2.2.0](https://github.com/prasanaworld/puppeteer-screen-recorder/compare/v2.0.2...v2.2.0) (2024-02-18)
+
+
+### Features
+
+* add autopad option on ffmpeg configuration ([6f53e21](https://github.com/prasanaworld/puppeteer-screen-recorder/commit/6f53e21cd76c24a3808d8af24a243234d6a09ddc))
+
+### [2.1.2](https://github.com/prasanaworld/puppeteer-screen-recorder/compare/v2.1.1...v2.1.2) (2022-10-05)
+
+### [2.1.1](https://github.com/prasanaworld/puppeteer-screen-recorder/compare/v2.1.0...v2.1.1) (2022-09-17)
+
+## [2.1.0](https://github.com/prasanaworld/puppeteer-screen-recorder/compare/v2.0.2...v2.1.0) (2022-08-29)
+
+
+### Features
+
+* add autopad option on ffmpeg configuration ([6f53e21](https://github.com/prasanaworld/puppeteer-screen-recorder/commit/6f53e21cd76c24a3808d8af24a243234d6a09ddc))
+
+### [2.0.4](https://github.com/prasanaworld/puppeteer-screen-recorder/compare/v2.0.3...v2.0.4) (2022-08-27)
+
+### [2.0.3](https://github.com/prasanaworld/puppeteer-screen-recorder/compare/v2.0.2...v2.0.3) (2022-08-06)
+
+### [2.0.2](https://github.com/prasanaworld/puppeteer-screen-recorder/compare/v2.0.0...v2.0.2) (2021-09-26)
+
+### [2.0.1](https://github.com/prasanaworld/puppeteer-screen-recorder/compare/v1.1.12...v2.0.1) (2021-09-25)
+
+### [1.1.12](https://github.com/prasanaworld/puppeteer-screen-recorder/compare/v1.1.11...v1.1.12) (2021-09-25)
+
+### [1.1.11](https://github.com/prasanaworld/puppeteer-screen-recorder/compare/v1.1.10...v1.1.11) (2021-05-17)
+
+### [1.1.10](https://github.com/prasanaworld/puppeteer-screen-recorder/compare/v1.1.9...v1.1.10) (2021-05-17)
+
+### [1.1.9](https://github.com/prasanaworld/puppeteer-screen-recorder/compare/v1.1.8...v1.1.9) (2021-03-28)
+
+### [1.1.8](https://github.com/prasanaworld/puppeteer-screen-recorder/compare/v1.1.7...v1.1.8) (2021-03-28)
+
+### [1.1.7](https://github.com/prasanaworld/puppeteer-screen-recorder/compare/v1.1.6...v1.1.7) (2021-03-28)
+
+### [1.1.6](https://github.com/prasanaworld/puppeteer-screen-recorder/compare/v1.1.5...v1.1.6) (2021-03-04)
+
+### [1.1.5](https://github.com/prasanaworld/puppeteer-screen-recorder/compare/v1.1.3...v1.1.5) (2021-02-26)
+
+### [1.1.4](https://github.com/prasanaworld/puppeteer-screen-recorder/compare/v1.1.3...v1.1.4) (2021-02-26)
+
+### [1.1.3](https://github.com/prasanaworld/puppeteer-screen-recorder/compare/v1.1.2...v1.1.3) (2021-02-25)
+
+### [1.1.2](https://github.com/prasanaworld/puppeteer-screen-recorder/compare/v1.1.1...v1.1.2) (2021-02-25)
+
+### [1.1.1](https://github.com/prasanaworld/puppeteer-screen-recorder/compare/v1.1.0...v1.1.1) (2021-02-24)
+
+## [1.1.0](https://github.com/prasanaworld/puppeteer-screen-recorder/compare/v1.0.4...v1.1.0) (2021-02-23)
+
+### [1.0.4](https://github.com/prasanaworld/puppeteer-screen-recorder/compare/v1.0.3...v1.0.4) (2021-02-23)
+
+### [1.0.3](https://github.com/prasanaworld/puppeteer-screen-recorder/compare/v1.0.2...v1.0.3) (2021-02-22)
+
+### [1.0.2](https://github.com/prasanaworld/puppeteer-screen-recorder/compare/v1.0.1...v1.0.2) (2021-02-22)
+
+### 1.0.1 (2021-02-22)

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 prasana kannan
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,271 @@
+# <img alt="puppeteer screen recorder logo" width="128px" src="https://github.com/prasanaworld/puppeteer-screen-recorder/blob/main/asserts/puppeteer-screen-recorder.png" /> puppeteer-screen-recorder
+
+A puppeteer Plugin that uses the native [chrome devtool protocol](https://chromedevtools.github.io/devtools-protocol/tot/Page/#method-startScreencast) for capturing video frame by frame. Also supports an option to follow pages that are opened by the current page object.
+[Check out API Docs](https://prasanaworld.github.io/puppeteer-screen-recorder/classes/puppeteerscreenrecorder.html).
+
+![Website](https://img.shields.io/website?url=https%3A%2F%2Fprasanaworld.github.io%2Fpuppeteer-screen-recorder%2Fclasses%2Fpuppeteerscreenrecorder.html&style=plastic&logo=website&label=Documentation) ![Discord](https://img.shields.io/discord/1246821801120632902?style=plastic&logo=discord&label=Join%20Our%20Discord%20Server&link=https%3A%2F%2Fdiscord.com%2Fchannels%2F1246821801120632902%2F1246821801120632905)
+
+[![NPM](https://nodei.co/npm/puppeteer-screen-recorder.png)](https://npmjs.org/package/puppeteer-screen-recorder)
+
+![GitHub](https://img.shields.io/github/license/prasanaworld/puppeteer-screen-recorder) ![GitHub Sponsors](https://img.shields.io/github/sponsors/prasanaworld?label=Github%20Sponsours) ![Open Collective backers and sponsors](https://img.shields.io/opencollective/all/puppeteer-screen-recorder?label=Open%20Collective%20sponsors)
+
+![GitHub package.json version](https://img.shields.io/github/package-json/v/prasanaworld/puppeteer-screen-recorder) ![GitHub top language](https://img.shields.io/github/languages/top/prasanaworld/puppeteer-screen-recorder) ![npm](https://img.shields.io/npm/dt/puppeteer-screen-recorder) ![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/prasanaworld/puppeteer-screen-recorder/ci.yml)
+
+![GitHub forks](https://img.shields.io/github/forks/prasanaworld/puppeteer-screen-recorder?style=social) ![GitHub Repo stars](https://img.shields.io/github/stars/prasanaworld/puppeteer-screen-recorder?style=social) ![GitHub watchers](https://img.shields.io/github/watchers/prasanaworld/puppeteer-screen-recorder?style=social) ![Twitter Follow](https://img.shields.io/twitter/follow/prasanaworld?style=social)
+
+<a href="https://github.com/prasanaworld/puppeteer-screen-recorder/issues/new">Add Feature Request</a>
+
+</p>
+
+## Recording video/audio from video conferencing calls
+
+If you’re looking to use this repo to retrieve video or audio streams from meeting platforms like Zoom, Google Meet, Microsoft Teams, consider checking out [Recall.ai](https://www.recall.ai/?utm_source=github&utm_medium=sponsorship&utm_campaign=puppeteer-screen-recorder), an API for meeting recording.
+
+## Be a Sponsor
+
+Puppeteer-screen-recorder isn't backed by a company, so the future of this project depends on you. Become a sponsor or a backer - help the open source community.
+
+#### **For Companies and Businesses**
+
+By becoming a Github Sponsor, your company and brand will be recognized as a one that gives back to the open source tools that run your business and one that respects your developers time and your customers' experience. For more details contact [Author - Prasana Kannan](prasanaworld@gmail.com)
+
+#### **For Developers**
+
+By helping your company become a Github Sponsor, you will not only feel great about giving back to the open source tools that run your business run, If you believe your company could become a sponsor, then please reach out!
+
+- [open-collective](https://opencollective.com/puppeteer-screen-recorder)
+- [Paypal](https://paypal.me/prasanaworld)
+- [Bitcoin - 3NdGW6wKVFgxa1X5XxRDNHqMWAhGNSrA5A](3NdGW6wKVFgxa1X5XxRDNHqMWAhGNSrA5A)
+
+## Getting Started
+
+### How to use 
+![How to use](https://raw.githubusercontent.com/prasanaworld/puppeteer-screen-recorder/main/asserts/video_demo.gif)
+
+### Installation Guide
+
+Using Npm
+
+```sh
+npm install puppeteer-screen-recorder
+```
+
+Using Yarn
+
+```sh
+yarn add puppeteer-screen-recorder
+```
+
+### API Description
+
+**1. Import the plugin using ES6 or commonjs.**
+
+```javascript
+// ES6
+import { PuppeteerScreenRecorder } from 'puppeteer-screen-recorder';
+
+// or commonjs
+const { PuppeteerScreenRecorder } = require('puppeteer-screen-recorder');
+```
+
+**2. Setup the Configuration object.**
+
+```javascript
+const Config = {
+  followNewTab: true,
+  fps: 25,
+  ffmpeg_Path: '<path of ffmpeg_path>' || null,
+  videoFrame: {
+    width: 1024,
+    height: 768,
+  },
+  videoCrf: 18,
+  videoCodec: 'libx264',
+  videoPreset: 'ultrafast',
+  videoBitrate: 1000,
+  autopad: {
+    color: 'black' | '#35A5FF',
+  },
+  aspectRatio: '4:3',
+};
+```
+
+> - **followNewTab** : Boolean value which is indicate whether to follow the tab or not. Default value is true.
+
+> - **fps**: Numeric value which denotes no.of Frames per second in which the video should be recorded. default value is 25.
+
+> - **ffmpeg_Path**: String value pointing to the installation of [FFMPEG](https://ffmpeg.org/). Default is null (Automatically install the FFMPEG and use it).
+
+> - **videoFrame**: An object which is to specify the width and height of the capturing video frame. Default to browser viewport size.
+
+> - **aspectRatio**: Specify the aspect ratio of the video. Default value is `4:3`.
+
+> - **autopad**: Specify whether autopad option is used and its color. Default to autopad deactivation mode.
+
+> - **recordDurationLimit**: Numerical value specify duration (in seconds) to record the video. By default video is recorded till stop method is invoked`. (Note: It's mandatory to invoke Stop() method even if this value is set)
+
+**3. create a new instance of video recording**
+
+```javascript
+const recorder = new PuppeteerScreenRecorder(page, Config); // Config is optional
+
+// or
+
+const recorder = new PuppeteerScreenRecorder(page);
+```
+
+> - **page**: Puppeteer page object which needs to captured.
+> - **config**: Config is an optional object.
+>   Default value is `{ followNewTab: true, fps: 25, ffmpeg_Path: null }`
+
+**4. Start Video capturing**
+
+**Option 1 - Start video capturing and save as file**
+
+```javascript
+const SavePath = './test/demo.mp4';
+await recorder.start(savePath);
+```
+
+**Option 2 - Start Video capturing using stream**
+
+```javascript
+const pipeStream = new PassThrough();
+await recorder.startStream(pipeStream);
+```
+
+> **pass**: Any writeable stream that will be an output for the stream recorder. Video is recorded and streamed with .mp4 extension.
+
+> **savePath**: string value indicating the directory on where to save the video. The path must also specify the name of the video with extension .mp4 (example - ./test/puppeteer-demo.mp4). Starting from v2, support added for extensions mp4, avi, mov and webm.
+
+**5. Stop the video capturing.**
+
+```javascript
+await recorder.stop();
+```
+
+### Example
+
+```javascript
+const puppeteer = require('puppeteer');
+const { PuppeteerScreenRecorder } = require('puppeteer-screen-recorder');
+
+(async () => {
+  const browser = await puppeteer.launch();
+  const page = await browser.newPage();
+  const recorder = new PuppeteerScreenRecorder(page);
+  await recorder.start('./report/video/simple.mp4'); // supports extension - mp4, avi, webm and mov
+  await page.goto('https://example.com');
+
+  await page.goto('https://test.com');
+  await recorder.stop();
+  await browser.close();
+})();
+```
+
+## Key Feature
+
+### 1. Follow Page Automatically
+
+Automatically follows pages (multiple pages) which are opened at runtime, which will be part of video capturing. Also support options to disable the default flow.
+
+### 2. No overhead over FF_MPEG library
+
+FFMPEG library's installation and configuration are automatically managed by the library internally. Also offers options to configure with custom library path.
+
+### 3. Native Implementation
+
+This plugin works directly with native [chrome devtool protocol](https://chromedevtools.github.io/devtools-protocol/tot/Page/#method-startScreencast) to capture the video under the wood without any other thirdparty puppeteer plugins for screen capturing.
+
+### 4. Adopted the Chromium principles
+
+Adopted Chromium principles such as Speed, Security, Stability and Simplicity. It also ensures no frames are missed during video capturing and doesn't impact the performance, since its doesn't use any other puppeteer plugin internally.
+
+### 5. Supports multiple video format and stream
+
+Supports multiple video format like AVI, MP4, MOV and WEBM. Enable support for writable or duplex stream for process the output streaming .
+
+
+## FAQ
+
+Some of the frequently asked question about puppeteer screen recording are
+
+**Q: Does it support Chrome in headless mode?**
+
+---
+
+Yes, it supports Both headless and headFul mode.
+
+It records full length video, frame by frame even when Chrome runs in headless mode.
+
+**Q: Does it support multiple extension?**
+
+---
+
+Yes, Starting from version 2.0, support multiple extension like AVI, MP4, MOV and WEBM.
+
+**Q: Does it use the window object?**
+
+---
+
+No, it's not tied to the window Object.
+
+**Q: Does it follows pages which are opened at runtime**
+
+---
+
+Yes, it automatically follows pages which is created at runtime.
+
+**Q: is there an option to disable video recording for new page created and record video only for the page object passed**
+
+---
+
+Yes, By setting the `options.followNewTab` to false, it record only video for the passed page object alone.
+
+**Q: Does it support to record video at 60 fps**
+
+---
+
+Yes, video can be recorded at 60 fps. By setting `options.fps` to 60.
+
+**Q:Does it use the window object?**
+
+---
+
+No, it doesn't use the window object.
+
+**Q: Does it use FFMPEG internally?**
+
+---
+
+Yes, it uses FFMPEG with optimized options to speed up the video recording using stream from chrome devtool protocol.
+
+**Q: Does it support Webm?**
+
+---
+
+Webm format is supported.
+
+**Q: Is it possible to output the stream for further processing/enhancing?**
+
+---
+
+Yes. By passing writable stream/duplex stream to `startStream` method.
+
+**Q: Can I limit the time of recording, like to stop after 2 minutes?**
+
+---
+
+By specifying the time to record (in seconds) using `option.recordDurationLimit`
+
+**Q: Does it support audio recording?**
+
+---
+
+No, it doesn't audio recording.
+
+**Q: Does it support GIF format, any plan to support in fur?**
+
+---
+
+No, it wont support GIF. since Gif is considered as a image format.

package/build/main/example/index.d.ts

@@ -0,0 +1 @@
+export {};

package/build/main/example/index.js

@@ -0,0 +1,38 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const puppeteer_1 = __importDefault(require("puppeteer"));
+const PuppeteerScreenRecorder_1 = require("../lib/PuppeteerScreenRecorder");
+/** @ignore */
+function sleep(time) {
+    return new Promise((resolve) => {
+        setTimeout(resolve, time);
+    });
+}
+/** @ignore */
+async function testStartMethod(format) {
+    const executablePath = process.env['PUPPETEER_EXECUTABLE_PATH'];
+    const browser = await puppeteer_1.default.launch(Object.assign(Object.assign({}, (executablePath ? { executablePath: executablePath } : {})), { headless: false }));
+    const page = await browser.newPage();
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    const recorder = new PuppeteerScreenRecorder_1.PuppeteerScreenRecorder(page);
+    await page.setViewport({
+        width: 1920,
+        height: 1080,
+        deviceScaleFactor: 1,
+    });
+    await recorder.start(format);
+    await page.goto('https://developer.mozilla.org/en-US/docs/Web/CSS/animation');
+    await sleep(10 * 1000);
+    await recorder.stop();
+    await browser.close();
+}
+async function executeSample(format) {
+    return testStartMethod(format);
+}
+executeSample('./report/video/simple1.mp4').then(() => {
+    console.log('completed');
+});
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi8uLi9zcmMvZXhhbXBsZS9pbmRleC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOzs7OztBQUFBLDBEQUFrQztBQUVsQyw0RUFBeUU7QUFFekUsY0FBYztBQUNkLFNBQVMsS0FBSyxDQUFDLElBQVk7SUFDekIsT0FBTyxJQUFJLE9BQU8sQ0FBQyxDQUFDLE9BQU8sRUFBRSxFQUFFO1FBQzdCLFVBQVUsQ0FBQyxPQUFPLEVBQUUsSUFBSSxDQUFDLENBQUM7SUFDNUIsQ0FBQyxDQUFDLENBQUM7QUFDTCxDQUFDO0FBRUQsY0FBYztBQUNkLEtBQUssVUFBVSxlQUFlLENBQUMsTUFBYztJQUMzQyxNQUFNLGNBQWMsR0FBRyxPQUFPLENBQUMsR0FBRyxDQUFDLDJCQUEyQixDQUFDLENBQUM7SUFDaEUsTUFBTSxPQUFPLEdBQUcsTUFBTSxtQkFBUyxDQUFDLE1BQU0saUNBQ2pDLENBQUMsY0FBYyxDQUFDLENBQUMsQ0FBQyxFQUFFLGNBQWMsRUFBRSxjQUFjLEVBQUUsQ0FBQyxDQUFDLENBQUMsRUFBRSxDQUFDLEtBQzdELFFBQVEsRUFBRSxLQUFLLElBQ2YsQ0FBQztJQUNILE1BQU0sSUFBSSxHQUFHLE1BQU0sT0FBTyxDQUFDLE9BQU8sRUFBRSxDQUFDO0lBQ3JDLDhEQUE4RDtJQUM5RCxNQUFNLFFBQVEsR0FBRyxJQUFJLGlEQUF1QixDQUFDLElBQVcsQ0FBQyxDQUFDO0lBQzFELE1BQU0sSUFBSSxDQUFDLFdBQVcsQ0FBQztRQUNyQixLQUFLLEVBQUUsSUFBSTtRQUNYLE1BQU0sRUFBRSxJQUFJO1FBQ1osaUJBQWlCLEVBQUUsQ0FBQztLQUNyQixDQUFDLENBQUM7SUFFSCxNQUFNLFFBQVEsQ0FBQyxLQUFLLENBQUMsTUFBTSxDQUFDLENBQUM7SUFFN0IsTUFBTSxJQUFJLENBQUMsSUFBSSxDQUFDLDREQUE0RCxDQUFDLENBQUM7SUFDOUUsTUFBTSxLQUFLLENBQUMsRUFBRSxHQUFHLElBQUksQ0FBQyxDQUFDO0lBRXZCLE1BQU0sUUFBUSxDQUFDLElBQUksRUFBRSxDQUFDO0lBQ3RCLE1BQU0sT0FBTyxDQUFDLEtBQUssRUFBRSxDQUFDO0FBQ3hCLENBQUM7QUFFRCxLQUFLLFVBQVUsYUFBYSxDQUFDLE1BQU07SUFDakMsT0FBTyxlQUFlLENBQUMsTUFBTSxDQUFDLENBQUM7QUFDakMsQ0FBQztBQUVELGFBQWEsQ0FBQyw0QkFBNEIsQ0FBQyxDQUFDLElBQUksQ0FBQyxHQUFHLEVBQUU7SUFDcEQsT0FBTyxDQUFDLEdBQUcsQ0FBQyxXQUFXLENBQUMsQ0FBQztBQUMzQixDQUFDLENBQUMsQ0FBQyJ9

package/build/main/index.d.ts

@@ -0,0 +1,2 @@
+export * from './lib/pageVideoStreamTypes';
+export * from './lib/PuppeteerScreenRecorder';

package/build/main/index.js

@@ -0,0 +1,19 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./lib/pageVideoStreamTypes"), exports);
+__exportStar(require("./lib/PuppeteerScreenRecorder"), exports);
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvaW5kZXgudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7Ozs7Ozs7Ozs7Ozs7OztBQUFBLDZEQUEyQztBQUMzQyxnRUFBOEMifQ==

package/build/main/lib/PuppeteerScreenRecorder.d.ts

@@ -0,0 +1,85 @@
+/// <reference types="node" />
+import { Writable } from 'stream';
+import { Page } from 'puppeteer';
+/**
+ * PuppeteerScreenRecorder class is responsible for managing the video
+ *
+ * ```typescript
+ * const screenRecorderOptions = {
+ *  followNewTab: true,
+ *  fps: 15,
+ * }
+ * const savePath = "./test/demo.mp4";
+ * const screenRecorder = new PuppeteerScreenRecorder(page, screenRecorderOptions);
+ * await screenRecorder.start(savePath);
+ *  // some puppeteer action or test
+ * await screenRecorder.stop()
+ * ```
+ */
+export declare class PuppeteerScreenRecorder {
+    private page;
+    private options;
+    private streamReader;
+    private streamWriter;
+    private isScreenCaptureEnded;
+    constructor(page: Page, options?: {});
+    /**
+     * @ignore
+     */
+    private setupListeners;
+    /**
+     * @ignore
+     */
+    private ensureDirectoryExist;
+    /**
+     * @ignore
+     * @private
+     * @method startStreamReader
+     * @description start listening for video stream from the page.
+     * @returns PuppeteerScreenRecorder
+     */
+    private startStreamReader;
+    /**
+     * @public
+     * @method getRecordDuration
+     * @description return the total duration of the video recorded,
+     *  1. if this method is called before calling the stop method, it would be return the time till it has recorded.
+     *  2. if this method is called after stop method, it would give the total time for recording
+     * @returns total duration of video
+     */
+    getRecordDuration(): string;
+    /**
+     *
+     * @public
+     * @method start
+     * @param savePath accepts a path string to store the video
+     * @description Start the video capturing session
+     * @returns PuppeteerScreenRecorder
+     * @example
+     * ```
+     *  const savePath = './test/demo.mp4'; //.mp4 is required
+     *  await recorder.start(savePath);
+     * ```
+     */
+    start(savePath: string): Promise<PuppeteerScreenRecorder>;
+    /**
+     *
+     * @public
+     * @method startStream
+     * @description Start the video capturing session in a stream
+     * @returns {PuppeteerScreenRecorder}
+     * @example
+     * ```
+     *  const stream = new PassThrough();
+     *  await recorder.startStream(stream);
+     * ```
+     */
+    startStream(stream: Writable): Promise<PuppeteerScreenRecorder>;
+    /**
+     * @public
+     * @method stop
+     * @description stop the video capturing session
+     * @returns indicate whether stop is completed correct or not, if true without any error else false.
+     */
+    stop(): Promise<boolean>;
+}

package/build/main/lib/PuppeteerScreenRecorder.js

@@ -0,0 +1,149 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PuppeteerScreenRecorder = void 0;
+const fs_1 = __importDefault(require("fs"));
+const path_1 = require("path");
+const pageVideoStreamCollector_1 = require("./pageVideoStreamCollector");
+const pageVideoStreamWriter_1 = __importDefault(require("./pageVideoStreamWriter"));
+/**
+ * @ignore
+ * @default
+ * @description This will be option passed to the puppeteer screen recorder
+ */
+const defaultPuppeteerScreenRecorderOptions = {
+    followNewTab: true,
+    fps: 15,
+    quality: 100,
+    ffmpeg_Path: null,
+    videoFrame: {
+        width: null,
+        height: null,
+    },
+    aspectRatio: '4:3',
+};
+/**
+ * PuppeteerScreenRecorder class is responsible for managing the video
+ *
+ * ```typescript
+ * const screenRecorderOptions = {
+ *  followNewTab: true,
+ *  fps: 15,
+ * }
+ * const savePath = "./test/demo.mp4";
+ * const screenRecorder = new PuppeteerScreenRecorder(page, screenRecorderOptions);
+ * await screenRecorder.start(savePath);
+ *  // some puppeteer action or test
+ * await screenRecorder.stop()
+ * ```
+ */
+class PuppeteerScreenRecorder {
+    constructor(page, options = {}) {
+        this.isScreenCaptureEnded = null;
+        this.options = Object.assign({}, defaultPuppeteerScreenRecorderOptions, options);
+        this.streamReader = new pageVideoStreamCollector_1.pageVideoStreamCollector(page, this.options);
+        this.page = page;
+    }
+    /**
+     * @ignore
+     */
+    setupListeners() {
+        this.page.once('close', async () => await this.stop());
+        this.streamReader.on('pageScreenFrame', (pageScreenFrame) => {
+            this.streamWriter.insert(pageScreenFrame);
+        });
+        this.streamWriter.once('videoStreamWriterError', () => this.stop());
+    }
+    /**
+     * @ignore
+     */
+    async ensureDirectoryExist(dirPath) {
+        return new Promise((resolve, reject) => {
+            try {
+                fs_1.default.mkdirSync(dirPath, { recursive: true });
+                return resolve(dirPath);
+            }
+            catch (error) {
+                reject(error);
+            }
+        });
+    }
+    /**
+     * @ignore
+     * @private
+     * @method startStreamReader
+     * @description start listening for video stream from the page.
+     * @returns PuppeteerScreenRecorder
+     */
+    async startStreamReader() {
+        this.setupListeners();
+        await this.streamReader.start();
+        return this;
+    }
+    /**
+     * @public
+     * @method getRecordDuration
+     * @description return the total duration of the video recorded,
+     *  1. if this method is called before calling the stop method, it would be return the time till it has recorded.
+     *  2. if this method is called after stop method, it would give the total time for recording
+     * @returns total duration of video
+     */
+    getRecordDuration() {
+        if (!this.streamWriter) {
+            return '00:00:00:00';
+        }
+        return this.streamWriter.duration;
+    }
+    /**
+     *
+     * @public
+     * @method start
+     * @param savePath accepts a path string to store the video
+     * @description Start the video capturing session
+     * @returns PuppeteerScreenRecorder
+     * @example
+     * ```
+     *  const savePath = './test/demo.mp4'; //.mp4 is required
+     *  await recorder.start(savePath);
+     * ```
+     */
+    async start(savePath) {
+        await this.ensureDirectoryExist((0, path_1.dirname)(savePath));
+        this.streamWriter = new pageVideoStreamWriter_1.default(savePath, this.options);
+        return this.startStreamReader();
+    }
+    /**
+     *
+     * @public
+     * @method startStream
+     * @description Start the video capturing session in a stream
+     * @returns {PuppeteerScreenRecorder}
+     * @example
+     * ```
+     *  const stream = new PassThrough();
+     *  await recorder.startStream(stream);
+     * ```
+     */
+    async startStream(stream) {
+        this.streamWriter = new pageVideoStreamWriter_1.default(stream, this.options);
+        return this.startStreamReader();
+    }
+    /**
+     * @public
+     * @method stop
+     * @description stop the video capturing session
+     * @returns indicate whether stop is completed correct or not, if true without any error else false.
+     */
+    async stop() {
+        if (this.isScreenCaptureEnded !== null) {
+            return this.isScreenCaptureEnded;
+        }
+        await this.streamReader.stop();
+        this.isScreenCaptureEnded = await this.streamWriter.stop();
+        return this.isScreenCaptureEnded;
+    }
+}
+exports.PuppeteerScreenRecorder = PuppeteerScreenRecorder;
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiUHVwcGV0ZWVyU2NyZWVuUmVjb3JkZXIuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi8uLi9zcmMvbGliL1B1cHBldGVlclNjcmVlblJlY29yZGVyLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7Ozs7OztBQUFBLDRDQUFvQjtBQUNwQiwrQkFBK0I7QUFLL0IseUVBQXNFO0FBRXRFLG9GQUE0RDtBQUU1RDs7OztHQUlHO0FBQ0gsTUFBTSxxQ0FBcUMsR0FBbUM7SUFDNUUsWUFBWSxFQUFFLElBQUk7SUFDbEIsR0FBRyxFQUFFLEVBQUU7SUFDUCxPQUFPLEVBQUUsR0FBRztJQUNaLFdBQVcsRUFBRSxJQUFJO0lBQ2pCLFVBQVUsRUFBRTtRQUNWLEtBQUssRUFBRSxJQUFJO1FBQ1gsTUFBTSxFQUFFLElBQUk7S0FDYjtJQUNELFdBQVcsRUFBRSxLQUFLO0NBQ25CLENBQUM7QUFFRjs7Ozs7Ozs7Ozs7Ozs7R0FjRztBQUNILE1BQWEsdUJBQXVCO0lBT2xDLFlBQVksSUFBVSxFQUFFLE9BQU8sR0FBRyxFQUFFO1FBRjVCLHlCQUFvQixHQUFtQixJQUFJLENBQUM7UUFHbEQsSUFBSSxDQUFDLE9BQU8sR0FBRyxNQUFNLENBQUMsTUFBTSxDQUMxQixFQUFFLEVBQ0YscUNBQXFDLEVBQ3JDLE9BQU8sQ0FDUixDQUFDO1FBQ0YsSUFBSSxDQUFDLFlBQVksR0FBRyxJQUFJLG1EQUF3QixDQUFDLElBQUksRUFBRSxJQUFJLENBQUMsT0FBTyxDQUFDLENBQUM7UUFDckUsSUFBSSxDQUFDLElBQUksR0FBRyxJQUFJLENBQUM7SUFDbkIsQ0FBQztJQUVEOztPQUVHO0lBQ0ssY0FBYztRQUNwQixJQUFJLENBQUMsSUFBSSxDQUFDLElBQUksQ0FBQyxPQUFPLEVBQUUsS0FBSyxJQUFJLEVBQUUsQ0FBQyxNQUFNLElBQUksQ0FBQyxJQUFJLEVBQUUsQ0FBQyxDQUFDO1FBRXZELElBQUksQ0FBQyxZQUFZLENBQUMsRUFBRSxDQUFDLGlCQUFpQixFQUFFLENBQUMsZUFBZSxFQUFFLEVBQUU7WUFDMUQsSUFBSSxDQUFDLFlBQVksQ0FBQyxNQUFNLENBQUMsZUFBZSxDQUFDLENBQUM7UUFDNUMsQ0FBQyxDQUFDLENBQUM7UUFFSCxJQUFJLENBQUMsWUFBWSxDQUFDLElBQUksQ0FBQyx3QkFBd0IsRUFBRSxHQUFHLEVBQUUsQ0FBQyxJQUFJLENBQUMsSUFBSSxFQUFFLENBQUMsQ0FBQztJQUN0RSxDQUFDO0lBRUQ7O09BRUc7SUFDSyxLQUFLLENBQUMsb0JBQW9CLENBQUMsT0FBTztRQUN4QyxPQUFPLElBQUksT0FBTyxDQUFDLENBQUMsT0FBTyxFQUFFLE1BQU0sRUFBRSxFQUFFO1lBQ3JDLElBQUk7Z0JBQ0YsWUFBRSxDQUFDLFNBQVMsQ0FBQyxPQUFPLEVBQUUsRUFBRSxTQUFTLEVBQUUsSUFBSSxFQUFFLENBQUMsQ0FBQztnQkFDM0MsT0FBTyxPQUFPLENBQUMsT0FBTyxDQUFDLENBQUM7YUFDekI7WUFBQyxPQUFPLEtBQUssRUFBRTtnQkFDZCxNQUFNLENBQUMsS0FBSyxDQUFDLENBQUM7YUFDZjtRQUNILENBQUMsQ0FBQyxDQUFDO0lBQ0wsQ0FBQztJQUVEOzs7Ozs7T0FNRztJQUNLLEtBQUssQ0FBQyxpQkFBaUI7UUFDN0IsSUFBSSxDQUFDLGNBQWMsRUFBRSxDQUFDO1FBRXRCLE1BQU0sSUFBSSxDQUFDLFlBQVksQ0FBQyxLQUFLLEVBQUUsQ0FBQztRQUNoQyxPQUFPLElBQUksQ0FBQztJQUNkLENBQUM7SUFFRDs7Ozs7OztPQU9HO0lBQ0ksaUJBQWlCO1FBQ3RCLElBQUksQ0FBQyxJQUFJLENBQUMsWUFBWSxFQUFFO1lBQ3RCLE9BQU8sYUFBYSxDQUFDO1NBQ3RCO1FBQ0QsT0FBTyxJQUFJLENBQUMsWUFBWSxDQUFDLFFBQVEsQ0FBQztJQUNwQyxDQUFDO0lBRUQ7Ozs7Ozs7Ozs7OztPQVlHO0lBQ0ksS0FBSyxDQUFDLEtBQUssQ0FBQyxRQUFnQjtRQUNqQyxNQUFNLElBQUksQ0FBQyxvQkFBb0IsQ0FBQyxJQUFBLGNBQU8sRUFBQyxRQUFRLENBQUMsQ0FBQyxDQUFDO1FBRW5ELElBQUksQ0FBQyxZQUFZLEdBQUcsSUFBSSwrQkFBcUIsQ0FBQyxRQUFRLEVBQUUsSUFBSSxDQUFDLE9BQU8sQ0FBQyxDQUFDO1FBQ3RFLE9BQU8sSUFBSSxDQUFDLGlCQUFpQixFQUFFLENBQUM7SUFDbEMsQ0FBQztJQUVEOzs7Ozs7Ozs7OztPQVdHO0lBQ0ksS0FBSyxDQUFDLFdBQVcsQ0FBQyxNQUFnQjtRQUN2QyxJQUFJLENBQUMsWUFBWSxHQUFHLElBQUksK0JBQXFCLENBQUMsTUFBTSxFQUFFLElBQUksQ0FBQyxPQUFPLENBQUMsQ0FBQztRQUNwRSxPQUFPLElBQUksQ0FBQyxpQkFBaUIsRUFBRSxDQUFDO0lBQ2xDLENBQUM7SUFFRDs7Ozs7T0FLRztJQUNJLEtBQUssQ0FBQyxJQUFJO1FBQ2YsSUFBSSxJQUFJLENBQUMsb0JBQW9CLEtBQUssSUFBSSxFQUFFO1lBQ3RDLE9BQU8sSUFBSSxDQUFDLG9CQUFvQixDQUFDO1NBQ2xDO1FBRUQsTUFBTSxJQUFJLENBQUMsWUFBWSxDQUFDLElBQUksRUFBRSxDQUFDO1FBQy9CLElBQUksQ0FBQyxvQkFBb0IsR0FBRyxNQUFNLElBQUksQ0FBQyxZQUFZLENBQUMsSUFBSSxFQUFFLENBQUM7UUFDM0QsT0FBTyxJQUFJLENBQUMsb0JBQW9CLENBQUM7SUFDbkMsQ0FBQztDQUNGO0FBN0hELDBEQTZIQyJ9