/youtube_explode_dart

Dart library to interact with many Youtube APIs

Primary LanguageDartBSD 3-Clause "New" or "Revised" LicenseBSD-3-Clause

YoutubeExplodeDart

This is a port of the YoutubeExplode library from C#, most of the functions, doc comments, readme information, is taken from YoutubeExplode repository.

Pub Version License Lint

It used to build Youtube Downloader Flutter (A cross-platform application to download video streams from youtube using this library & flutter)

YoutubeExplode is a library that provides an interface to query metadata of YouTube videos, playlists and channels, as well as to resolve and download video streams and closed caption tracks. Behind a layer of abstraction, the library parses raw page content and uses reverse-engineered AJAX requests to retrieve information. As it doesn't use the official API, there's also no need for an API key and there are no usage quotas.

Features

  • Retrieve metadata on videos, playlists, channels, streams, and closed captions
  • Execute search queries and get resulting videos.
  • Get or download video streams.
  • Get closed captions.
  • Get video comments.

Usage

Install

Add the dependency to the pubspec.yaml (Check for the latest version)

youtube_explode_dart: ^2.3.4

Import the library

import 'package:youtube_explode_dart/youtube_explode_dart.dart';

Getting metadata of a video

The following example shows how you can extract various metadata from a YouTube video:

// You can provide either a video ID or URL as String or an instance of `VideoId`.
var video = yt.videos.get('https://youtube.com/watch?v=Dpp1sIL1m5Q'); // Returns a Video instance.

var title = video.title; // "Scamazon Prime"
var author = video.author; // "Jim Browning"
var duration = video.duration; // Instance of Duration - 0:19:48.00000

Downloading a video stream

Every YouTube video has a number of streams available. These streams may have different containers, video quality, bitrate, etc.

On top of that, depending on the content of the stream, the streams are further divided into 3 categories:

  • Muxed streams -- contain both video and audio (available only in 360p)
  • Audio-only streams -- contain only audio
  • Video-only streams -- contain only video

You can request the stream manifest to get available streams for a particular video:

var yt = YoutubeExplode();

var manifest = yt.videos.streams.getManifest('Dpp1sIL1m5Q');

print(manifest); // Prints the list of streams available for the video.

// If you want to specify which youtube clients to use to get the manifest you can do so:
var manifest = yt.videos.streams.getManifest(videoId, ytClients: [
  YoutubeApiClient.safari,
  YoutubeApiClient.androidVr  
]); // The streams provided by both clients will be merged.

Once you get the manifest, you can filter through the streams and choose the one you're interested in downloading:

// highest bitrate audio-only stream
var streamInfo = streamManifest.audioOnly.withHigestBitrate();

// MP4 video-only stream
var streamInfo.videoOnly.where((e) => e.container == Container);

// Muxed (audio + video) stream with the highest video quality. NOTE: Don't rely on this, muxed streams are limited to 360p30.
var streamInfo = streamManifest.muxed.withHigestVideoQuality();

// HLS (m3u8) streams are also supported
var streamInfo = streamManifest.hls;

Finally, you can get the actual Stream object represented by the metadata:

// Get the actual byte stream
var stream = yt.video.streams.get(streamInfo);

// Open a file for writing.
var file = File(filePath);
var fileStream = file.openWrite();

// Pipe all the content of the stream into the file.
await stream.pipe(fileStream);

// Close the file.
await fileStream.flush();
await fileStream.close();

While it may be tempting to just always use muxed streams, it's important to note that they are limited in quality. Muxed streams don't go beyond 360p30.

If you want to download the video in maximum quality, you need to download the audio-only and video-only streams separately and then mux them together on your own. There are tools like FFmpeg that let you do that.

Working with playlists

Among other things, YoutubeExplode also supports playlists:

var yt = YoutubeExplode();

// Get playlist metadata.
var playlist = await yt.playlists.get('xxxxx');

var title = playlist.title;
var author = playlist.author;

  await for (var video in yt.playlists.getVideos(playlist.id)) {
    var videoTitle = video.title;
    var videoAuthor = video.author;
  }

var playlistVideos = await yt.playlists.getVideos(playlist.id);

// Get first 20 playlist videos.
var somePlaylistVideos = await yt.playlists.getVideos(playlist.id).take(20);

Extracting closed captions

Similarly, to streams, you can extract closed captions by getting the manifest and choosing the track you're interested in:

  var yt = YoutubeExplode();

  var trackManifest = await yt.videos.closedCaptions.getManifest('_QdPW8JrYzQ')

  var trackInfo = manifest.getByLanguage('en'); // Get english caption.
  
  if (trackInfo != null)
  {
     // Get the actual closed caption track.
     var track = await youtube.videos.closedCaptions.get(trackInfo);
      
    // Get the caption displayed at 1:01
    var caption = track.getByTime(Duration(seconds: 61));
    var text = caption?.text; // "And the game was afoot."
  }

Get a list of related videos

var video = yt.videos.get('https://youtube.com/watch?v=Dpp1sIL1m5Q');
var relatedVideos = await yt.videos.getRelatedVideos(video); // video must be a Video instance.
print(relatedVideos); //prints the list of related videos

// to get the next page of related videos
relatedVideos = await relatedVideos.nextPage();

If no related video is found getRelatedVideos or nextPage will return null.

Get comments

You can easily get the video comments of a given video, the return value of comments.getComments(video) is a list-like object which behaves exactly like a List but has an additional method nextPage() which is used in order to get the next comments, it returns null when there are no comments to be fetched anymore.

var comments = await yt.videos.comments.getComments(video);

var replies = await yt.videos.comments.getReplies(comment); // Fetch the comment replies

Cleanup

You need to close YoutubeExplode's http client, when done otherwise this could halt the dart process.

yt.close();

Troubleshooting

If you encounter any issues, please check that it has not been reported already in the issues section.

When reporting a new issue, make sure to follow the issue template and report the logs after having enabled the logging:

import 'package:logging/logging.dart';

...

// Before any YoutubeExplode code
Logger.root.level = Level.FINER;
Logger.root.onRecord.listen((e)  {
  print(e);
  if (e.error != null) {
   print(e.error);
   print(e.stackTrace);
  }
});

To the very minimum the video id causing the issue (if applicable) and the code snippet that is causing the issue must be provided.

Examples:

More examples available on GitHub.

Check the api documentation for additional information. You can find how most APIs can be used in the files inside the test/ folder.

Credits