vidzit-dl v0.0.2

A simple Reddit video downloader that allows you to download videos from Reddit using node js. Made using node-fetch and ffmpeg.wasm.

IMPORTANT NOTE: Video can't be embedded (No Youtube links, No Vimeo, etc).

This is not an official Reddit library, but we do use Reddit's official web API.

📌 Table of Contents

• 📌 Table of Contents
• 💻 How To Install
• ✏️ Example
• 📖 API
  • VidzitDL
  • VidzitDL.initialize(redditURL) ⇒ Promise.\<VidzitDL>
  • vidzitDL.videoInfo
    • Example of Return JSON
  • vidzitDL.findFormatVideo(format) ⇒ JSON
    • Example of Return JSON
  • vidzitDL.findMaxFormatVideo() ⇒ JSON
    • Example of Return JSON
  • vidzitDL.createVideo(options) ⇒ Promise.\<Uint8Array>
• 🤝 How to Contribute (Thank You!)

💻 How To Install

npm install vidzit-dl

✏️ Example

const VidzitDL = require("vidzit-dl");

async function example1() {
    let video1 = await VidzitDL.initialize("https://www.reddit.com/r/IndieDev/comments/10hgvjq/vr_has_been_punishing_for_particles");
    console.log(video1.videoInfo);
    console.log(await video1.createVideo({
        format: '480',
        setLogger: function (type, message) {
            console.log(type + ": " + message);
        },
        setProgress: function (ratio) {
            console.log(ratio);
        }
    }));
}

async function example2() {
    let video1 = await VidzitDL.initialize("https://www.reddit.com/r/IndieDev/comments/10hgvjq/vr_has_been_punishing_for_particles");
    console.log(video1.videoInfo);
    console.log(await video1.createVideo());
}

example1()
example2()

📖 API

VidzitDL

Download reddit videos through node.js

Kind: global class
See: https://github.com/Guuzzeji/reddit-vid-dl#readme

VidzitDL.initialize(redditURL) ⇒ Promise.<VidzitDL>

Initialize the VidezDitDL class and create an object from it.

Kind: static method of VidzitDL
Returns: Promise.<VidzitDL> - returns an VidzitDL object that can be used to get information about the video dash urls and download the video

vidzitDL.videoInfo

Returns the video information like video url and reddit base url of post

Kind: instance property of VidzitDL

Example of Return JSON

{
  baseURL: "{URL to reddit post}"
  dashURL: "{URL to dash file}",
  dashContent: {
    video: [
      {
        type: "video",
        maxFormat: true || false,
        format: "720",
        url: "{URL to video format}",
      },
      ...
    ],
    audio: {
      type: "audio",
      url: "{URL to audio files}",
    }
  }
}

vidzitDL.findFormatVideo(format) ⇒ JSON

Searchs dash file to find video resolution (Ex: 480, 720, 1080). It can also return an error if video resolution is not found.

Kind: instance method of VidzitDL
Returns: JSON - A json of the video resolution url and other infomation

Example of Return JSON

{
  type: "video",
  maxFormat: true || false,
  format: "720",
  url: "{URL to video format}",
}

vidzitDL.findMaxFormatVideo() ⇒ JSON

Searchs dash file to find video resolution for max resolution of video.

Kind: instance method of VidzitDL
Returns: JSON - A json of the video resolution url and other infomation

Example of Return JSON

{
  type: "video",
  maxFormat: true,
  format: "1080",
  url: "{URL to video format}",
}

vidzitDL.createVideo(options) ⇒ Promise.<Uint8Array>

Creates a video with the specified format you want. OR can default to max resolution if not specified.

Kind: instance method of VidzitDL
See: More infomation how to use setLogger and setProgress https://github.com/ffmpegwasm/ffmpeg.wasm/blob/master/docs/api.md#ffmpeg-setlogging

🤝 How to Contribute (Thank You!)

• Fork the main branch

• Open your fork and add your changes / features / bug fixes

• Create a pull request

  • Make sure to add a description of what changes you have made and why your changes are important.