jQuery TubePlayer Plugin
A jQuery wrapper around the YouTube Player API.
The TubePlayer plugin allows developers to focus on functionality as opposed to infrastructure around the YouTube player. The plugin exposes meaningful methods that are triggered based on state changes from the player API. The plugin also provides events that can be triggered on it allowing developers to create a customized player remote, programmatically control videos, gain access for analytics purposes and much more.
Getting Started
Download the production version or the development version.
In your web page:
Documentation
TubePlayer Plugin Defaults
$tubeplayerdefaultssettings = // Plugin init params width: 480 // the width of the player height: 270 // the height of the player allowFullScreen: "true" // true by default, allow user to go full screen initialVideo: "DkoeNLuMbcI" // the video that is loaded into the player start: 0 preferredQuality: "default" // preferred quality: auto, small, medium, large, hd720 controls: 1 // whether the player should have the controls visible, 0 or 1 or 2 showRelated: false // show the related videos when the player ends, 0 or 1 playsinline: false // setting for ipad autoPlay: false // whether the player should autoplay the video, 0 or 1 color: "red" // possible options: "red" or "white" showinfo: false // if you want the player to include details about the video modestbranding: true // specify to include/exclude the YouTube watermark annotations: true // show annotations? loop: 0 // whether or not the player will loop protocol: 'http' // Player Trigger Specific Functionality {} // after the play method is called {} // after the pause method is called {} // after the player is stopped {} // after the video has been seeked to a defined point {} // after the player is muted {} // after the player is unmuted // Player State Change Specific Functionality {} // player returns a state of unstarted {} // player returns a state of ended {} // player returns a state of playing {} // player returns a state of paused {} // player returns a state of buffering {} // player returns a state of cued {} // player is initially loaded and attached to the DOM {} // player quality changes {} // player rate changes // Error State Specific Functionality {} // if a video cant be found {} // if a video isnt embeddable {} // if we've got an invalid param and can't play ;
Player API Events (tubeplayer options)
User invoked callbacks
onPlay
onPause
onStop
onSeek
onMute
onUnMute
Player invoked callbacks
onPlayerUnstarted
onPlayerEnded
onPlayerPlaying
onPlayerPaused
onPlayerBuffering
onPlayerCued
onPlayerLoaded
onQualityChange
onRateChange
onErrorNotFound
onErrorNotEmbeddable
onErrorInvalidParameter
TubePlayer API Methods
Player
; ;;; ;; ;; // or use seconds ; ; ;
Sound
;;; ;; // 0-100
Playback
;; // video must support this and be sized appropriately ; ; // video must support this
Playlist
;; ;;;
Data/Info
;;;
Testing
Unit Tests
The test/ folder contains the unit test scripts. This is a good place to get an idea for what's going on. You can also get some insight into the things the plugin can do.
TubePlayer Debug Console
The test_console/ folder within this repository, contains a fully functional debug console for the tubeplayer project.
The console enables the quick creation and destruction of a youtube player with UI controls to supplement the various specified inputs. The console allows the user to invoke operations and observe the effects (e.g. onPlayerPlaying, onPlay), by printing each action being invoked on the TubePlayer plugin while going through them. Additionally, the console has the necessary links to follow up in API docs.
In order to use the console, you will need to run a web server. A simple example would be to use python's SimpleHTTPServer. Here is an example of how to create host one on port 8082, from your command line navigate to the appropriate directory you want to serve up and then:
python -m SimpleHTTPServer 8082
There is a bash script that will run the debug console from the root directory. Assuming $CWD is the root directory:
./scripts/server.sh
To access..
- the debug console, navigate to
http://localhost:8082/test_console/index.html
- the unit tests, navigate to
http://localhost:8082/test/tubeplayer.html
Changelog
A detailed overview of the release notes can be found in the CHANGELOG.
License
Copyright (c) Nirvana Tikku Licensed under the MIT license.