About
PlayDL Music Extractor is a Extractor/Scrapper and Helps Players to fetch data from play-dl or Custom Extractors , as Per reduces extra work and credentials.
- Object-oriented , means Value returned in a structure format
- Supports Youtube , Spotify , Reverbnation , SoundCloud , Facebook Urls and Even Youtube Search
- Delay/Buffer Timeout is max 3 seconds on tracks and 7 sec for Playlists
- Customisable Extractors
- Performant
- 100% coverage of play-dl and custom extractors
Installation
Node.js 16 or newer is required.
npm install playdl-music-extractor
Example usage
Extractor Video/Playlist/Album Data from any Platform :-
const { Extractor, StreamDownloader } = require('playdl-music-extractor') //For CommonJS
OR
import { Extractor, StreamDownloader } from 'playdl-music-extractor' //for ES6
var Data = await Extractor(Url || Query, {
Limit: 1,
Quality: 'highest',
Proxy: undefined, //[{"Ip-Address:Port-Number"}] Format(Proxy)
IgnoreError: true,
})
var StreamData = await StreamDownloader(Url || Query, {
Limit: 1,
Quality: 'highest',
Proxy: undefined, //[{"Ip-Address:Port-Number"}] Format(Proxy)
IgnoreError: true,
})
Strucutre of Data/Track
Data : {
playlist : Boolean,
tracks : [
{
Id: 0,
url: String,
title: String,
video_Id: String,
author: String,
author_link: String,
description: String,
custom_extractor: `play-dl`,
duration: 0,
human_duration: 0
stream: String, // Stream Related things will be sent via StreamDownloader()
stream_type: String,
stream_video_Id: String,
orignal_extractor: 'youtube' | 'spotify' | 'facebook' | 'arbitrary',
thumbnail: String,
channelId: 0 || String,
channel_url: String,
likes: 0,
is_live: false,
dislikes: 0,
stream_duration: 0,
human_stream_duration: 0,
}]
}
Extractor() is same as StreamDownloader() but it will not download info related to Streams like - "stream","stream_type" and e.t.c , just the info about the Query
"<Track>.stream_duration" is Stream Duration in Milliseconds as Stream is from Youtube
Data.tracks[0].stream can be used in terms of stream value in @discordjs/voice or any other Audio package After using - StreamDownloader() .
Use-Case for @discordjs/voice Package
const { StreamDownloader } = require('playdl-music-extractor')
const { createAudioResource } = require('@discordjs/voice')
const Data = await StreamDownloader('Despacito', {
Limit: 1,
Quality: 'highest',
Proxy: undefined, //[{"Ip-Address:Port-Number"}] Format(Proxy)
IgnoreError: true,
})
var Audio_Resource = createAudioResource(Data.tracks[0].stream ,{
inputType: Data.tracks[0].stream_type
})
/*
- Rest is mentioned in @discordjs/voice examples , from here "Audio_Resource" is important
- Extractor() is same as StreamDownloader() but it will not download info related to Streams like - "stream","stream_type" and e.t.c , just the info about the Query
*/
Links
Contributing
Before creating an issue, please ensure that it hasn't already been reported/suggested, and double-check the ReadMe.md
Help
If you don't understand something in the ReadMe.md , you are experiencing problems, or you just need a gentle
nudge in the right direction, please don't hesitate to join our official Support Server.