play-dl-fix/docs/YouTube/README.md

YouTube

Basic Usage

const youtube = require('play-dl');
// ES6: import youtube from 'play-dl';
const options = {
    limit : 1
}
const results = await youtube.search('post malone sunflower', options);

Validate

yt_validate(url : string)

This will validate url and return type or boolean

Returns : video | playlist | search | false

let check = yt_validate(url)

if(!check) // Invalid URL

if(check === "video") //URL is video url

if(check === "playlist") //URL is a playlist url

if(check === "search") // Given term is not a video ID and PlayList ID.

Extract ID

extractID(url : string)

This will return videoID or playlistID from a url

Note : URL like this will return a playlist ID only.

let id = extractID(url)

Video

InfoOptions

This are the info options that can be passed as a parameter in video_info and video_basic_info

• proxy : Optional parameter to add support of proxies. As of now, HTTPS proxies are only supported. So make sure to get HTTPS proxies only.
• htmldata : boolean Set this to true if you are passing a html body as first parameter.

const video = await video_basic_info(url, { proxy : ['url'] }) // Accepts a url which has port in it.

const video = await video_basic_info(url, {proxy : [{
        host : "IP or hostname",
        port : 8080
    }]
}) // Or add a json containing hostname and port.

// Use any https package to use proxy and then do this

const video = await video_basic_info(body, { htmldata : true }) // You can use video_info function also.

video_basic_info(url : string, options? : InfoOptions)

The basic video details play-dl fetches at first from url or videoID.

const video = await video_basic_info(url)

video_info(url : string, , options? : InfoOptions)

This contains everything with deciphered formats along with video_details. It can fetech data from url or videoID.

const video = await video_info(url)

• format property

  This returns all the formats available for a video.

  const video = await video_info(url)
  console.log(video.format)
  

decipher_info(data : InfoData)

This contains everything with deciphered formats along with video_details. It uses data returned by video_basic_info. This function is useful if you use video_basic_info earlier in your code and want to convert the output for use with stream_from_info

const basic_video = await video_basic_info(url);

const video = await decipher_info(basic_video);

Playlist

playlist_info(url : string, options : PlaylistOptions)

This fetches all details about a playlist from a url or playlistID.

const playlist = await playlist_info(url)
//This only fetches first 100 videos from a playlist

const playlist = await playlist_info(url, { incomplete : true })
//This only fetches first 100 videos from a playlist and also parses playlist with hidden videos

const playlist = await playlist_info(url, { proxy : [''] }) // Same 2 options as mentioned in InfoOptions

• fetch() method

  This fetches and returns all videos from the whole provided playlist .

  const playlist = await playlist_info(url)
  //This only fetches first 100 videos from a playlist
  
  await playlist.fetch()
  // This one fetches all videos from a playlist.
  

• page(page_number : number)

  This returns no. of videos from a page.

  Every 100 videos have been divided into pages. Example: There are 782 videos in a playlist, so there will be 8 pages.

  const playlist = await playlist_info(url);
  // This only fetches first 100 videos from a playlist.
  
  await playlist.fetch();
  // This one fetches all videos from a playlist.
  
  console.log(playlist.page(1));
  // This displays first 100 videos of a playlist
  
  

• total_pages property

  This returns total no. of pages that have been fetched so far.

  const playlist = await playlist_info(url)
  //This only fetches first 100 videos from a playlist.
  
  await playlist.fetch()
  // This one fetches all videos from a playlist.
  
  console.log(playlist.total_pages)
  // This displays total no. of pages fetched so far.
  
  for(let i = 1; i <= playlist.total_pages; i++){
      queue.push(...playlist.page(i))
  } // This will push every video in that playlist to your queue
  

• total_videos property

  This returns total no. of videos that have been fetched so far.

  const playlist = await playlist_info(url)
  //This only fetches first 100 videos from a playlist.
  
  await playlist.fetch()
  // This one fetches all videos from a playlist.
  
  console.log(playlist.total_videos)
  // This displays total no. of videos fetched so far.
  

• videoCount property

  This returns total no. of videos in the provided playlist.

  const playlist = await playlist_info(url)
  //This only fetches first 100 videos from a playlist.
  
  await playlist.fetch()
  // This one fetches all videos from a playlist.
  
  console.log(playlist.videoCount)
  // This displays total no. of videos in a playlist.