mcnasby/youtube-tv

A small, slick, library independent YouTube User/Playlist player

YoutubeTV

NOW with API Version 3 Support!!
A small, slick, library independent YouTube User/Playlist player

Features

• Library Independent
• Customizable via CSS
• Autoplay
• Remove YouTube Chrome
• Supports Playlists and Users
• jQuery Support
• Module Support
• Responsive Support
• Alternative color scheme

Demos

• Default Player Options
• Chromeless Player
• Playlist Support
• Full Screen Player (Good for a .tv website?)
• jQuery Support
• Responsive Support
• Multiple Players

Obtaining Youtube API Key

As part of the update to Youtube's API version 3, it is required to obtain an API Key from Google's Developer Console.

To obtain your API Key you can follow this guide using steps 1 to 3. https://developers.google.com/youtube/v3/getting-started

Then: 4. under APIs & auth > Credentials > Create new Key > (Select) Browser Key 5. (Recommended) Set any referrers to your domain to prevent unauthorized use of your key. 6. (Optional) Additionally disabling any other unused APIs that are enabled.

Installation

After obtaining your API Key, fill it in ytv.js near the top via this line:
var apiKey = 'YOUR_API_KEY_HERE';

Include both the ytv.css and ytv.js in your HTML file and you are good to go.

<link href="src/ytv.css" type="text/css" rel="stylesheet" />
<script src="src/ytv.js" type="text/javascript"></script>

Usage

After your page has loaded, you may call the script like so:

<div id="YourPlayerID"></div>

document.addEventListener("DOMContentLoaded", function(event) {
    var controller = new YTV('YourPlayerID', {
	   user: 'YoutubeUsername'
    });
});

Technical Note: Above DOMContentLoaded is preferred for speed on modern browsers (additionally works down to IE9). However the demos are mostly using window.onload which is a slower option but compatible with older browsers (IE8 or older). Good examples of this difference can be found here (microsoft.com) and here (jspref.com)

Note: If you are using a newer YouTube channel you may have a Channel ID which may look similar to this: UCXXXXXXXXXXXXXXXXXXXXXX If so, use channelId: 'UCXXXXXXXXXXXXXXXXXXXXXX' to replace user!

User vs Channel ID

By visiting the intended channel's Youtube home page. The URL should look like one of the following.

User ID user: ''

Channel ID channelId: ''

Additional Options

Additional options you may wish to add to get started.

In addition to user and channelId you can also use playlist ID's which can also replace user and channelId or work along side them. playlist: 'PLAYLIST_ID_HERE' To chain multiple playlists together, separate them by comma's. Example: playlist: 'PLAYLIST_ID1,PLAYLIST_ID2,PLAYLIST_ID3'

Add this to enable the responsive Youtube-TV player allowing the player to adjust from desktop resolution all the way to mobile devices. responsive: true

Accent colour will appear beside the active video in the list. This will accept any CSS value from #FFF to orange. accent: '#008D54'

If you prefer the light theme over the dark, add these 2 options (or mix 'n match if desired). playerTheme: 'light' listTheme: 'light'

Don't forget comma's between each option!

YTV accepts two parameters. The first is a string of the element ID you want to use as the player, OR it may the element itself. The second parameter is an object of options defined below:

Settings, Defaults and Details

settings = {
    element: null,
    user: null,
    channelId: null,
    playlist: '',
    fullscreen: false,
    accent: '#fff',
    controls: true,
    annotations: false,
    autoplay: false,
    chainVideos: true,
    browsePlaylists: false,
    playerTheme: 'dark',
    listTheme: 'dark',
    responsive: false,
    playId:'',
    sortList: false,
    reverseList: false,
    shuffleList: false,
    wmode: 'opaque',
    events: {
        videoReady: function(){},
        stateChange: function(){}
    }
}

• element: The element or element ID to apply the YouTube TV Player to
• user: (String) The Username of the YouTube user you want to display videos from
• channelId: (String) The Channel ID of the YouTube channel you want to display videos from (for newer accounts)
• playlist: (String) The Playlist ID(s) you would like to load separated by comma's (Overrides user)
• browsePlaylists: (Boolean) If true and the specified user has YouTube playlists, they will be accessible in the player by clicking the users Username
• fullscreen: (Boolean) If true, the player will take up all the available space on the users browser screen
• accent: (String) A CSS color string to apply to the accents of the player
• controls: (Boolean) If false, the normal YouTube controls will be hidden.
• annotations: (Boolean) If false, the annotations from the YouTube video will be hidden
• autoplay: (Boolean) If true, the first video in the list will automatically play once the player has loaded
• chainVideos: (Boolean) If true, the next video in que will automatically play after the current video has completed
• playerTheme: (String) Sets the youtube player theme. Default is dark with an alterative light color scheme.
• listTheme: (String) Sets the playlist theme. Default is dark with a light theme to match the alternative player theme.
• responsive: (Boolean) If true, it enables a responsive design to support various resolutions including mobile devices. Default currently false.
• playId: (String) On load this option will allow you to select the first video to play/display. Enter the id of the video you want to display. (ie. .../watch?v=VIDEOID to playId: 'VIDEOID').
• sortList: (Boolean) If true, this option will sort the video list by date uploaded.
• reverseList: (Boolean) If true, this option will reverse order of the videos. (Can be combined with other sorting option to reverse after sorting).
• shuffleList: (Boolean) If true, this option will shuffle the video list. (Useful for music playlists).
• wmode: (String) Sets the Window Mode property for transparency, layering, and positioning in the browser. Values can be: window - movie plays in its own rectangular window on a web page. opaque - the movie hides everything on the page behind it. transparent - the background of the HTML page shows through all transparent portions of the movie, this may slow animation performance.
• events: The respective events will fire when key actions in the player have been called

Responsive Design

Youtube-TV can now adapt to various changes in resolution based on it's parent canvas/container. Currently set to max-width:992px to match Bootstrap's responsive transitions, but can be modified to match any other responsive boilerplate.

Playlist beside

(image resized on github don't be fooled >_<)

Playlist on bottom

Better for mobile devices

Public Methods

destroy

Destroys the YouTube TV Player and all associated elements/events

controller.destroy();

fullscreen.state()

Returns true if in Fullscreen Mode

controller.fullscreen.state();

fullscreen.enter()

Enters into Fullscreen Mode

controller.fullscreen.enter();

fullscreen.exit()

Exits Fullscreen Mode

controller.fullscreen.exit();

jQuery Support

YTV may be used as a jQuery plugin in the following fashion:

$('#frame').ytv({opts});

Licensing

MIT Licensing

Copyright (c) 2013 Jacob Kelley

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.