Skip to content

A Library for puppeteer to retrieve audio and/or video streams

License

Notifications You must be signed in to change notification settings

InsideBSITheSecond/puppeteer-stream

This branch is 153 commits behind SamuelScheit/puppeteer-stream:main.

Folders and files

NameName
Last commit message
Last commit date

Latest commit

fecd54a ยท Sep 24, 2021

History

46 Commits
Sep 24, 2021
Jun 21, 2021
Sep 24, 2021
Sep 24, 2021
Feb 18, 2021
Feb 20, 2021
Feb 18, 2021
Dec 22, 2020
Mar 5, 2021
Jul 25, 2021
Sep 24, 2021
Feb 18, 2021

Repository files navigation

puppeteer-stream

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

Installation

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

Usage

ES5 import

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

or ES6 import

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

Notice: This will only work in headful mode

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 = 20; // The number of milliseconds to record into each packet.
}

and returns a Promise<Readable>

For a detailed documentation of the options have a look at the HTML5 MediaRecorder Options

Launch

The method launch(options) is just a slightly changed puppeteer launch function to start puppeteer in headful mode with this extension.

Example

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

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

async function test() {
	const browser = await launch({
		defaultViewport: {
			width: 1920,
			height: 1080,
		},
	});

	const page = await browser.newPage();
	await page.goto("https://www.youtube.com/watch?v=dQw4w9WgXcQ");
	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");
	}, 1000 * 10);
}

test();

About

A Library for puppeteer to retrieve audio and/or video streams

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • TypeScript 59.9%
  • JavaScript 40.1%