1
0
mirror of https://github.com/videojs/video.js.git synced 2025-01-31 11:26:45 +02:00

@thijstriemstra fixed a number of typos in the docs. closes #1704

This commit is contained in:
Thijs Triemstra 2014-12-02 11:22:48 -08:00 committed by heff
parent 2de84da25f
commit 8a019ee046
12 changed files with 45 additions and 44 deletions

View File

@ -5,6 +5,7 @@ CHANGELOG
* @rutkat updated sliders to use keydown instead of keyup for more responsive key control ([view](https://github.com/videojs/video.js/pull/1616)) * @rutkat updated sliders to use keydown instead of keyup for more responsive key control ([view](https://github.com/videojs/video.js/pull/1616))
* @toloudis fixed an issue with checking for an existing source on the video element ([view](https://github.com/videojs/video.js/pull/1651)) * @toloudis fixed an issue with checking for an existing source on the video element ([view](https://github.com/videojs/video.js/pull/1651))
* @rafalwrzeszcz fixed the Flash object tag markup for strict XML ([view](https://github.com/videojs/video.js/pull/1702)) * @rafalwrzeszcz fixed the Flash object tag markup for strict XML ([view](https://github.com/videojs/video.js/pull/1702))
* @thijstriemstra fixed a number of typos in the docs ([view](https://github.com/videojs/video.js/pull/1704))
-------------------- --------------------

View File

@ -9,7 +9,7 @@ Create your own skin at http://designer.videojs.com
// (This file uses LESS. Learn more at http://lesscss.org/) // (This file uses LESS. Learn more at http://lesscss.org/)
// The base font size controls the size of everything, not just text. All // The base font size controls the size of everything, not just text. All
// diminensions use em-based sizes so that the scale along with the font size. // dimensions use em-based sizes so that the scale along with the font size.
// Try increasing it to 20px and see what happens. // Try increasing it to 20px and see what happens.
@base-font-size: 10px; @base-font-size: 10px;
@touch-device-font-size: 15px; @touch-device-font-size: 15px;
@ -60,7 +60,7 @@ Create your own skin at http://designer.videojs.com
/* SKIN /* SKIN
================================================================================ ================================================================================
The main class name for all skin-specific styles. To make your own skin, The main class name for all skin-specific styles. To make your own skin,
replace all occurances of 'vjs-default-skin' with a new name. Then add your new replace all occurrences of 'vjs-default-skin' with a new name. Then add your new
skin name to your video tag instead of the default skin. skin name to your video tag instead of the default skin.
e.g. <video class="video-js my-skin-name"> e.g. <video class="video-js my-skin-name">
*/ */
@ -111,7 +111,7 @@ The control icons are from a custom font. Each icon corresponds to a character
/* Slider - used for Volume bar and Seek bar */ /* Slider - used for Volume bar and Seek bar */
.vjs-default-skin .vjs-slider { .vjs-default-skin .vjs-slider {
/* Replace browser focus hightlight with handle highlight */// /* Replace browser focus highlight with handle highlight *///
outline: 0; outline: 0;
position: relative; position: relative;
cursor: pointer; cursor: pointer;
@ -855,7 +855,7 @@ control positioning and full window mode. **
/* Start with 10px for base font size so other dimensions can be em based and /* Start with 10px for base font size so other dimensions can be em based and
easily calculable. */ easily calculable. */
font-size: @base-font-size; font-size: @base-font-size;
/* Allow poster to be vertially aligned. */ /* Allow poster to be vertically aligned. */
vertical-align: middle; vertical-align: middle;
/* display: table-cell; */ /*This works in Safari but not Firefox.*/ /* display: table-cell; */ /*This works in Safari but not Firefox.*/

View File

@ -561,7 +561,7 @@ vjs.Component.prototype.buildCSSClass = function(){
* *
* The benefit of using this over `vjs.on(otherElement, 'eventName', myFunc)` * The benefit of using this over `vjs.on(otherElement, 'eventName', myFunc)`
* and `otherComponent.on('eventName', myFunc)` is that this way the listeners * and `otherComponent.on('eventName', myFunc)` is that this way the listeners
* will be automatically cleaned up when either component is diposed. * will be automatically cleaned up when either component is disposed.
* It will also bind myComponent as the context of myFunc. * It will also bind myComponent as the context of myFunc.
* *
* **NOTE**: When using this on elements in the page other than window * **NOTE**: When using this on elements in the page other than window
@ -742,7 +742,7 @@ vjs.Component.prototype.isReady_;
* *
* Allows for delaying ready. Override on a sub class prototype. * Allows for delaying ready. Override on a sub class prototype.
* If you set this.isReadyOnInitFinish_ it will affect all components. * If you set this.isReadyOnInitFinish_ it will affect all components.
* Specially used when waiting for the Flash player to asynchrnously load. * Specially used when waiting for the Flash player to asynchronously load.
* *
* @type {Boolean} * @type {Boolean}
* @private * @private
@ -760,7 +760,7 @@ vjs.Component.prototype.readyQueue_;
/** /**
* Bind a listener to the component's ready state * Bind a listener to the component's ready state
* *
* Different from event listeners in that if the ready event has already happend * Different from event listeners in that if the ready event has already happened
* it will trigger the function immediately. * it will trigger the function immediately.
* *
* @param {Function} fn Ready listener * @param {Function} fn Ready listener
@ -886,7 +886,7 @@ vjs.Component.prototype.unlockShowing = function(){
/** /**
* Disable component by making it unshowable * Disable component by making it unshowable
* *
* Currently private because we're movign towards more css-based states. * Currently private because we're moving towards more css-based states.
* @private * @private
*/ */
vjs.Component.prototype.disable = function(){ vjs.Component.prototype.disable = function(){
@ -1024,7 +1024,7 @@ vjs.Component.prototype.onResize;
* *
* This is used to support toggling the controls through a tap on the video. * This is used to support toggling the controls through a tap on the video.
* *
* We're requireing them to be enabled because otherwise every component would * We're requiring them to be enabled because otherwise every component would
* have this extra overhead unnecessarily, on mobile devices where extra * have this extra overhead unnecessarily, on mobile devices where extra
* overhead is especially bad. * overhead is especially bad.
* @private * @private

View File

@ -1,5 +1,5 @@
/** /**
* Core Object/Class for objects that use inheritance + contstructors * Core Object/Class for objects that use inheritance + constructors
* *
* To create a class that can be subclassed itself, extend the CoreObject class. * To create a class that can be subclassed itself, extend the CoreObject class.
* *
@ -52,7 +52,7 @@
vjs.CoreObject = vjs['CoreObject'] = function(){}; vjs.CoreObject = vjs['CoreObject'] = function(){};
// Manually exporting vjs['CoreObject'] here for Closure Compiler // Manually exporting vjs['CoreObject'] here for Closure Compiler
// because of the use of the extend/create class methods // because of the use of the extend/create class methods
// If we didn't do this, those functions would get flattend to something like // If we didn't do this, those functions would get flattened to something like
// `a = ...` and `this.prototype` would refer to the global object instead of // `a = ...` and `this.prototype` would refer to the global object instead of
// CoreObject // CoreObject
@ -78,10 +78,10 @@ vjs.CoreObject.extend = function(props){
// In Resig's simple class inheritance (previously used) the constructor // In Resig's simple class inheritance (previously used) the constructor
// is a function that calls `this.init.apply(arguments)` // is a function that calls `this.init.apply(arguments)`
// However that would prevent us from using `ParentObject.call(this);` // However that would prevent us from using `ParentObject.call(this);`
// in a Child constuctor because the `this` in `this.init` // in a Child constructor because the `this` in `this.init`
// would still refer to the Child and cause an inifinite loop. // would still refer to the Child and cause an infinite loop.
// We would instead have to do // We would instead have to do
// `ParentObject.prototype.init.apply(this, argumnents);` // `ParentObject.prototype.init.apply(this, arguments);`
// Bleh. We're not creating a _super() function, so it's good to keep // Bleh. We're not creating a _super() function, so it's good to keep
// the parent constructor reference simple. // the parent constructor reference simple.
subObj = function(){ subObj = function(){
@ -110,7 +110,7 @@ vjs.CoreObject.extend = function(props){
}; };
/** /**
* Create a new instace of this Object class * Create a new instance of this Object class
* *
* var myAnimal = Animal.create(); * var myAnimal = Animal.create();
* *

View File

@ -325,7 +325,7 @@ vjs.trigger = function(elem, event) {
* We've since updated to the latest version, but keeping this around * We've since updated to the latest version, but keeping this around
* for now just in case. * for now just in case.
*/ */
// // Added in attion to book. Book code was broke. // // Added in addition to book. Book code was broke.
// event = typeof event === 'object' ? // event = typeof event === 'object' ?
// event[vjs.expando] ? // event[vjs.expando] ?
// event : // event :

View File

@ -1,6 +1,6 @@
/** /**
* @fileoverview Exports for Video.js. * @fileoverview Exports for Video.js.
* Exports are publically available variables. * Exports are publicly available variables.
* All other variables (including function names) will probably * All other variables (including function names) will probably
* be renamed by closure compiler. * be renamed by closure compiler.
*/ */
@ -10,7 +10,7 @@
* *
* vjs is the same as the goog var in Closure Library. It holds all variables * vjs is the same as the goog var in Closure Library. It holds all variables
* used in Video.js development. Closure compiler will rename all variables, * used in Video.js development. Closure compiler will rename all variables,
* including class prototype functions, except those specifcally * including class prototype functions, except those specifically
* exported (eports.js). Don't assume any function you can use in Video.js * exported (eports.js). Don't assume any function you can use in Video.js
* development will be available on window.videojs for use with other js. * development will be available on window.videojs for use with other js.
* *
@ -18,7 +18,7 @@
* to something like 'a.b', or actually more likely 'a' removing it from * to something like 'a.b', or actually more likely 'a' removing it from
* a parent object. * a parent object.
* *
* videojs is a var that helps bridge bewteen internal and external development. * videojs is a var that helps bridge between internal and external development.
* Avoid using it over vjs when developing the Video.js core. * Avoid using it over vjs when developing the Video.js core.
* *
* _V_ is only external. It's just cute and short(er). Like jQuery === $. * _V_ is only external. It's just cute and short(er). Like jQuery === $.

View File

@ -2,7 +2,7 @@
var apiMap, specApi, browserApi, i; var apiMap, specApi, browserApi, i;
/** /**
* Store the browser-specifc methods for the fullscreen API * Store the browser-specific methods for the fullscreen API
* @type {Object|undefined} * @type {Object|undefined}
* @private * @private
*/ */

View File

@ -117,7 +117,7 @@ vjs.obj.merge = function(obj1, obj2){
vjs.obj.deepMerge = function(obj1, obj2){ vjs.obj.deepMerge = function(obj1, obj2){
var key, val1, val2; var key, val1, val2;
// make a copy of obj1 so we're not ovewriting original values. // make a copy of obj1 so we're not overwriting original values.
// like prototype.options_ and all sub options objects // like prototype.options_ and all sub options objects
obj1 = vjs.obj.copy(obj1); obj1 = vjs.obj.copy(obj1);
@ -213,7 +213,7 @@ vjs.bind = function(context, fn, uid) {
/** /**
* Element Data Store. Allows for binding data to an element without putting it directly on the element. * Element Data Store. Allows for binding data to an element without putting it directly on the element.
* Ex. Event listneres are stored here. * Ex. Event listeners are stored here.
* (also from jsninja.com, slightly modified and updated for closure compiler) * (also from jsninja.com, slightly modified and updated for closure compiler)
* @type {Object} * @type {Object}
* @private * @private
@ -432,7 +432,7 @@ vjs.setElementAttributes = function(el, attributes){
/** /**
* Get an element's attribute values, as defined on the HTML tag * Get an element's attribute values, as defined on the HTML tag
* Attributs are not the same as properties. They're defined on the tag * Attributes are not the same as properties. They're defined on the tag
* or with setAttribute (which shouldn't be used with HTML) * or with setAttribute (which shouldn't be used with HTML)
* This will return true or false for boolean attributes. * This will return true or false for boolean attributes.
* @param {Element} tag Element from which to get tag attributes * @param {Element} tag Element from which to get tag attributes
@ -695,7 +695,7 @@ vjs.get = function(url, onSuccess, onError, withCredentials){
}; };
/** /**
* Add to local storage (may removeable) * Add to local storage (may removable)
* @private * @private
*/ */
vjs.setLocalStorage = function(key, value){ vjs.setLocalStorage = function(key, value){
@ -718,7 +718,7 @@ vjs.setLocalStorage = function(key, value){
}; };
/** /**
* Get abosolute version of relative URL. Used to tell flash correct URL. * Get absolute version of relative URL. Used to tell flash correct URL.
* http://stackoverflow.com/questions/470832/getting-an-absolute-url-from-a-relative-one-ie6-issue * http://stackoverflow.com/questions/470832/getting-an-absolute-url-from-a-relative-one-ie6-issue
* @param {String} url URL to make absolute * @param {String} url URL to make absolute
* @return {String} Absolute URL * @return {String} Absolute URL
@ -780,7 +780,7 @@ vjs.parseUrl = function(url) {
}; };
/** /**
* Log messags to the console and history based on the type of message * Log messages to the console and history based on the type of message
* *
* @param {String} type The type of message, or `null` for `log` * @param {String} type The type of message, or `null` for `log`
* @param {[type]} args The args to be passed to the log * @param {[type]} args The args to be passed to the log

View File

@ -58,7 +58,7 @@ vjs.Flash = vjs.MediaTechController.extend({
// Merge default attributes with ones passed in // Merge default attributes with ones passed in
attributes = vjs.obj.merge({ attributes = vjs.obj.merge({
'id': objId, 'id': objId,
'name': objId, // Both ID and Name needed or swf to identifty itself 'name': objId, // Both ID and Name needed or swf to identify itself
'class': 'vjs-tech' 'class': 'vjs-tech'
}, options['attributes']) }, options['attributes'])
; ;
@ -129,7 +129,7 @@ vjs.Flash.prototype.src = function(src){
this.setRtmpConnection(src.connection); this.setRtmpConnection(src.connection);
this.setRtmpStream(src.stream); this.setRtmpStream(src.stream);
} else { } else {
// Make sure source URL is abosolute. // Make sure source URL is absolute.
src = vjs.getAbsoluteURL(src); src = vjs.getAbsoluteURL(src);
this.el_.vjs_src(src); this.el_.vjs_src(src);
} }

View File

@ -23,7 +23,7 @@ vjs.MediaTechController = vjs.Component.extend({
this.manualProgressOn(); this.manualProgressOn();
} }
// Manually track timeudpates in cases where the browser/flash player doesn't report it. // Manually track timeupdates in cases where the browser/flash player doesn't report it.
if (!this['featuresTimeupdateEvents']) { if (!this['featuresTimeupdateEvents']) {
this.manualTimeUpdatesOn(); this.manualTimeUpdatesOn();
} }

View File

@ -108,7 +108,7 @@ vjs.Player = vjs.Component.extend({
}); });
/** /**
* The players's stored language code * The player's stored language code
* *
* @type {String} * @type {String}
* @private * @private
@ -131,7 +131,7 @@ vjs.Player.prototype.language = function (languageCode) {
}; };
/** /**
* The players's stored language dictionary * The player's stored language dictionary
* *
* @type {Object} * @type {Object}
* @private * @private
@ -315,7 +315,7 @@ vjs.Player.prototype.createEl = function(){
// /* Media Technology (tech) // /* Media Technology (tech)
// ================================================================================ */ // ================================================================================ */
// Load/Create an instance of playback technlogy including element and API methods // Load/Create an instance of playback technology including element and API methods
// And append playback element in player div. // And append playback element in player div.
vjs.Player.prototype.loadTech = function(techName, source){ vjs.Player.prototype.loadTech = function(techName, source){
@ -454,7 +454,7 @@ vjs.Player.prototype.onPlay = function(){
}; };
/** /**
* Fired whenever the media begins wating * Fired whenever the media begins waiting
* @event waiting * @event waiting
*/ */
vjs.Player.prototype.onWaiting = function(){ vjs.Player.prototype.onWaiting = function(){
@ -462,7 +462,7 @@ vjs.Player.prototype.onWaiting = function(){
}; };
/** /**
* A handler for events that signal that waiting has eneded * A handler for events that signal that waiting has ended
* which is not consistent between browsers. See #1351 * which is not consistent between browsers. See #1351
* @private * @private
*/ */
@ -552,7 +552,7 @@ vjs.Player.prototype.onEnded = function(){
* @event durationchange * @event durationchange
*/ */
vjs.Player.prototype.onDurationChange = function(){ vjs.Player.prototype.onDurationChange = function(){
// Allows for cacheing value instead of asking player each time. // Allows for caching value instead of asking player each time.
// We need to get the techGet response and check for a value so we don't // We need to get the techGet response and check for a value so we don't
// accidentally cause the stack to blow up. // accidentally cause the stack to blow up.
var duration = this.techGet('duration'); var duration = this.techGet('duration');
@ -710,7 +710,7 @@ vjs.Player.prototype.currentTime = function(seconds){
// cache last currentTime and return. default to 0 seconds // cache last currentTime and return. default to 0 seconds
// //
// Caching the currentTime is meant to prevent a massive amount of reads on the tech's // Caching the currentTime is meant to prevent a massive amount of reads on the tech's
// currentTime when scrubbing, but may not provide much performace benefit afterall. // currentTime when scrubbing, but may not provide much performance benefit afterall.
// Should be tested. Also something has to read the actual current time or the cache will // Should be tested. Also something has to read the actual current time or the cache will
// never get updated. // never get updated.
return this.cache_.currentTime = (this.techGet('currentTime') || 0); return this.cache_.currentTime = (this.techGet('currentTime') || 0);
@ -730,7 +730,7 @@ vjs.Player.prototype.currentTime = function(seconds){
vjs.Player.prototype.duration = function(seconds){ vjs.Player.prototype.duration = function(seconds){
if (seconds !== undefined) { if (seconds !== undefined) {
// cache the last set value for optimiized scrubbing (esp. Flash) // cache the last set value for optimized scrubbing (esp. Flash)
this.cache_.duration = parseFloat(seconds); this.cache_.duration = parseFloat(seconds);
return this; return this;
@ -896,7 +896,7 @@ vjs.Player.prototype.muted = function(muted){
}; };
// Check if current tech can support native fullscreen // Check if current tech can support native fullscreen
// (e.g. with built in controls lik iOS, so not our flash swf) // (e.g. with built in controls like iOS, so not our flash swf)
vjs.Player.prototype.supportsFullScreen = function(){ vjs.Player.prototype.supportsFullScreen = function(){
return this.techGet('supportsFullScreen') || false; return this.techGet('supportsFullScreen') || false;
}; };
@ -967,7 +967,7 @@ vjs.Player.prototype.requestFullscreen = function(){
// Trigger fullscreenchange event after change // Trigger fullscreenchange event after change
// We have to specifically add this each time, and remove // We have to specifically add this each time, and remove
// when cancelling fullscreen. Otherwise if there's multiple // when canceling fullscreen. Otherwise if there's multiple
// players on a page, they would all be reacting to the same fullscreen // players on a page, they would all be reacting to the same fullscreen
// events // events
vjs.on(document, fsApi['fullscreenchange'], vjs.bind(this, function(e){ vjs.on(document, fsApi['fullscreenchange'], vjs.bind(this, function(e){

View File

@ -1,8 +1,8 @@
/** /**
* @fileoverview Text Tracks * @fileoverview Text Tracks
* Text tracks are tracks of timed text events. * Text tracks are tracks of timed text events.
* Captions - text displayed over the video for the hearing impared * Captions - text displayed over the video for the hearing impaired
* Subtitles - text displayed over the video for those who don't understand langauge in the video * Subtitles - text displayed over the video for those who don't understand language in the video
* Chapters - text displayed in a menu allowing the user to jump to particular points (chapters) in the video * Chapters - text displayed in a menu allowing the user to jump to particular points (chapters) in the video
* Descriptions (not supported yet) - audio descriptions that are read back to the user by a screen reading device * Descriptions (not supported yet) - audio descriptions that are read back to the user by a screen reading device
*/ */
@ -55,8 +55,8 @@ vjs.Player.prototype.addTextTrack = function(kind, label, language, options){
tracks.push(track); tracks.push(track);
// If track.dflt() is set, start showing immediately // If track.dflt() is set, start showing immediately
// TODO: Add a process to deterime the best track to show for the specific kind // TODO: Add a process to determine the best track to show for the specific kind
// Incase there are mulitple defaulted tracks of the same kind // In case there are multiple defaulted tracks of the same kind
// Or the user has a set preference of a specific language that should override the default // Or the user has a set preference of a specific language that should override the default
// Note: The setTimeout is a workaround because with the html5 tech, the player is 'ready' // Note: The setTimeout is a workaround because with the html5 tech, the player is 'ready'
// before it's child components (including the textTrackDisplay) have finished loading. // before it's child components (including the textTrackDisplay) have finished loading.
@ -472,7 +472,7 @@ vjs.TextTrack.prototype.parseCues = function(srcContent) {
text = []; text = [];
// Loop until a blank line or end of lines // Loop until a blank line or end of lines
// Assumeing trim('') returns false for blank lines // Assuming trim('') returns false for blank lines
while (lines[++i] && (line = vjs.trim(lines[i]))) { while (lines[++i] && (line = vjs.trim(lines[i]))) {
text.push(line); text.push(line);
} }