web/video.js
1
0
Fork 0
mirror of https://github.com/videojs/video.js.git synced 2024-11-30 09:06:49 +02:00
Code Releases Activity

Reference videojs not vjs

Browse Source 
`vjs` isn't exported, so this was causing confusion. Update to use `videojs`.
This commit is contained in:
Matthew McClure 2015-01-26 09:27:40 -08:00
parent 1a11a8f256
commit d5bbd80db9
1 changed files with 3 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
docs/guides/plugins.md
View File

@ -23,7 +23,7 @@ Step 2: Registering A Plugin
-------------------------------
It's time to give the rest of the world the opportunity to be awed by your genius. When your plugin is loaded, it needs to let Video.js know this amazing new functionality is now available:
vjs.plugin('examplePlugin', examplePlugin);
videojs.plugin('examplePlugin', examplePlugin);
From this point on, your plugin will be added to the Video.js prototype and will show up as a property on every instance created. Make sure you choose a unique name that doesn't clash with any of the properties already in Video.js. Which leads us to...
@ -31,7 +31,7 @@ Step 3: Using A Plugin
----------------------
There are two ways to initialize a plugin. If you're creating your video tag dynamically, you can specify the plugins you'd like to initialize with it and any options you want to pass to them:
vjs('vidId', {
videojs('vidId', {
plugins: {
examplePlugin: {
exampleOption: true
@ -41,6 +41,7 @@ There are two ways to initialize a plugin. If you're creating your video tag dyn
If you've already initialized your video tag, you can activate a plugin at any time by calling its setup function directly:
var video = videojs('cool-vid');
video.examplePlugin({ exampleOption: true });
That's it. Head on over to the [Video.js wiki](https://github.com/videojs/video.js/wiki/Plugins) and add your plugin to the list so everyone else can check it out.