@thelevicole/youtube-to-html5-loader

Load YoutTube videos as HTML5 emebed element

Get started

Load library

First you need to include the library in your project, this can be achieved via NPM or jsDeliver.

NPM

npm i @thelevicole/youtube-to-html5-loader

import YouTubeToHtml5 from '@thelevicole/youtube-to-html5-loader'

jsDeliver

<script src="https://cdn.jsdelivr.net/npm/@thelevicole/youtube-to-html5-loader@5/dist/YouTubeToHtml5.js"></script>

Initiating

First setup your HTML something like:

<video data-yt2html5="YOUTUBE_URL_OR_ID_GOES_HERE"></video>

And then simply initiate the library with:

new YouTubeToHtml5();

Options

There are a number of options that can be passed to the constructor these are:

Option	Description	Type	Default
endpoint	This is the API url thats used for retrieving data. More information to come.	string	https://yt2html5.com/?id=
selector	The DOM selector used for finding video elements.	string	video[data-yt2html5]
attribute	This is the attribute where your YouTube id/url is stored on the element.	string	data-yt2html5
formats	Filter the API results by specific formats. For example [ '1080p', '720p' ] will only allow 1080p and 720p formats. An asterix will allow all streaming formats.	`string	array`
autoload	Whether or not to load all videos on library init.	boolean	true
withAudio	Whether or not to only load streams with audio.	boolean	true
withVideo	Whether or not to only load streams with video.	boolean	true

Changing the API endpoint and custom server

This package uses a man-in-the-middle server (yt2html.com) to handle the API requests. This can cause issues as YouTube often blocks the host causing the library to not work. A solution to this is to host your own man-in-the-middle server and change the libraries API endpoint.

Simply modify the libraries global endpoint with the below snippet. Make sure to place before any YouTubeToHtml5() initiations.

YouTubeToHtml5.defaultOptions.endpoint = 'http://myserver.com/?id=';

The server source can be found here: thelevicole/youtube-to-html5-server

Hooks

The library has a hook mechanism for filters and actions. If you've worked with WordPress before you'll be familiar with this concept.

Note: You'll need to disable auto loading when using any hooks. First create an instance, then bind your hooks and finally call the .load() method.

Filters

Modify and return values.

Request URL

You might want to modify the request URL on each element load. You can do this with the request.url filter. For example:

const controller = new YouTubeToHtml5({
	autoload: false
});

controller.addFilter('request.url', function(url) {
	return `${url}&cache_bust=${(new Date()).getTime()}`;
});

controller.load();

Actions

Run code every time the action is called.

Before each load

const controller = new YouTubeToHtml5({
	autoload: false
});

controller.addAction('load.before', function(element, data) {
	element.classList.add('is-loading');
});

controller.load();

After each load

const controller = new YouTubeToHtml5({
	autoload: false
});

controller.addAction('load.after', function(element, data) {
	element.classList.remove('is-loading');
});

controller.load();

After a successful load

const controller = new YouTubeToHtml5({
	autoload: false
});

controller.addAction('load.success', function(element, data) {
	element.classList.addClass('is-playable');
});

controller.load();

After a failed load

const controller = new YouTubeToHtml5({
	autoload: false
});

controller.addAction('load.failed', function(element, data) {
	element.classList.add('is-unplayable');
});

controller.load();

jQuery

The library now includes a simply jQuery plugin which can be used like so...

$('video[data-yt2html5]').youtubeToHtml5();

The .youtubeToHtml5() plugin returns the YouTubeToHtml5 class instance so adding hooks etc is just as described above...

const controller = $('video[data-yt2html5]').youtubeToHtml5({
	autoload: false
});

controller.addAction('load.failed', function(element, data) {
	element.classList.add('is-unplayable');
});

controller.load();

Accepted URL patterns

Below is a list of varying YouTube url patterns, which include http/s and www/non-www.

youtube.com/watch?v=ScMzIvxBSi4
youtube.com/watch?vi=ScMzIvxBSi4
youtube.com/v/ScMzIvxBSi4
youtube.com/vi/ScMzIvxBSi4
youtube.com/?v=ScMzIvxBSi4
youtube.com/?vi=ScMzIvxBSi4
youtu.be/ScMzIvxBSi4
youtube.com/embed/ScMzIvxBSi4
youtube.com/v/ScMzIvxBSi4
youtube.com/watch?v=ScMzIvxBSi4&wtv=wtv
youtube.com/watch?dev=inprogress&v=ScMzIvxBSi4&feature=related
m.youtube.com/watch?v=ScMzIvxBSi4
youtube-nocookie.com/embed/ScMzIvxBSi4