puppeteer-stream
TypeScript icon, indicating that this package has built-in type declarations

3.0.14 • Public • Published

puppeteer-stream

An Extension for Puppeteer to retrieve audio and/or video streams of a page

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, an API for meeting recording.

Installation

npm i puppeteer-stream
# or "yarn add puppeteer-stream"

Usage

Import

For ES5

const { launch, getStream } = require("puppeteer-stream");

or for ES6

import { launch, getStream } from "puppeteer-stream";

Launch

The method launch(options) takes additional to the original puppeteer launch function, the following options

{
	allowIncognito?: boolean, // to be able to use incognito mode
	closeDelay?: number, // to fix rarely occurring TargetCloseError, set and increase number (in ms)
}

and returns a Promise<Browser>

Headless

Works also in headless mode (no gui needed), just set headless: "new" in the launch options

Get Stream

The method getStream(options) takes the following options

{
	audio: boolean, // whether or not to enable audio
	video: boolean, // whether or not to enable video
	mimeType?: string, // optional mime type of the stream, e.g. "audio/webm" or "video/webm"
	audioBitsPerSecond?: number, // The chosen bitrate for the audio component of the media.
	videoBitsPerSecond?: number, // The chosen bitrate for the video component of the media.
	bitsPerSecond?: number, // The chosen bitrate for the audio and video components of the media. This can be specified instead of the above two properties. If this is specified along with one or the other of the above properties, this will be used for the one that isn't specified.
	frameSize?: number, // The number of milliseconds to record into each packet.
  	videoConstraints: {
		mandatory?: MediaTrackConstraints,
		optional?: MediaTrackConstraints
	},
	audioConstraints: {
		mandatory?: MediaTrackConstraints,
		optional?: MediaTrackConstraints
	},
}

and returns a Promise<Readable>

For a detailed documentation of the mimeType, audioBitsPerSecond, videoBitsPerSecond, bitsPerSecond, frameSize properties have a look at the HTML5 MediaRecorder Options and for the videoConstraints and audioConstraints properties have a look at the MediaTrackConstraints.

Example

const { launch, getStream, wss } = require("puppeteer-stream");
const fs = require("fs");

const file = fs.createWriteStream(__dirname + "/test.webm");

async function test() {
	const browser = await launch({
		executablePath: "C:/Program Files/Google/Chrome/Application/chrome.exe",
		// or on linux: "google-chrome-stable"
		// or on mac: "/Applications/Google Chrome.app/Contents/MacOS/Google Chrome"
		defaultViewport: {
			width: 1920,
			height: 1080,
		},
	});

	const page = await browser.newPage();
	await page.goto("https://www.youtube.com/embed/DzivgKuhNl4?autoplay=1");
	const stream = await getStream(page, { audio: true, video: true });
	console.log("recording");

	stream.pipe(file);
	setTimeout(async () => {
		await stream.destroy();
		file.close();
		console.log("finished");

		await browser.close();
		(await wss).close();
	}, 1000 * 10);
}

test();

Package Sidebar

Install

npm i puppeteer-stream

Weekly Downloads

2,309

Version

3.0.14

License

MIT

Unpacked Size

74.4 kB

Total Files

19

Last publish

Collaborators

  • samuelscheit