mirror of
https://github.com/videojs/video.js.git
synced 2025-01-15 10:39:58 +02:00
docs: fix some misspellings (#5082)
This commit is contained in:
parent
7da77661fc
commit
064c1be2ba
@ -118,7 +118,7 @@ The source URL to a video source to embed.
|
||||
|
||||
> Type: `string|number`
|
||||
|
||||
Sets the display height of the video player in pixels.
|
||||
Sets the display width of the video player in pixels.
|
||||
|
||||
## Video.js-specific Options
|
||||
|
||||
@ -259,7 +259,7 @@ Using `<source>` elements will have the same effect:
|
||||
|
||||
> Type: `boolean`
|
||||
|
||||
Gives the possibility to techs to override the player's poster
|
||||
Gives the possibility to techs to override the player's poster
|
||||
and integrate into the player's poster life-cycle.
|
||||
This can be useful when multiple techs are used and each has to set their own poster
|
||||
any time a new source is played.
|
||||
|
@ -80,11 +80,11 @@ class SeekBar extends Slider {
|
||||
}
|
||||
|
||||
/**
|
||||
* This function updates the play progress bar and accessiblity
|
||||
* This function updates the play progress bar and accessibility
|
||||
* attributes to whatever is passed in.
|
||||
*
|
||||
* @param {number} currentTime
|
||||
* The currentTime value that should be used for accessiblity
|
||||
* The currentTime value that should be used for accessibility
|
||||
*
|
||||
* @param {number} percent
|
||||
* The percentage as a decimal that the bar should be filled from 0-1.
|
||||
|
@ -39,7 +39,7 @@ class TextTrackButton extends TrackButton {
|
||||
*/
|
||||
createItems(items = [], TrackMenuItem = TextTrackMenuItem) {
|
||||
|
||||
// Label is an overide for the [track] off label
|
||||
// Label is an override for the [track] off label
|
||||
// USed to localise captions/subtitles
|
||||
let label;
|
||||
|
||||
|
@ -162,7 +162,7 @@ const listen = (target, method, type, listener) => {
|
||||
};
|
||||
|
||||
/**
|
||||
* Contains methods that provide event capabilites to an object which is passed
|
||||
* Contains methods that provide event capabilities to an object which is passed
|
||||
* to {@link module:evented|evented}.
|
||||
*
|
||||
* @mixin EventedMixin
|
||||
|
@ -1817,7 +1817,7 @@ class Player extends Component {
|
||||
* dragging it along the progress bar.
|
||||
*
|
||||
* @param {boolean} [isScrubbing]
|
||||
* wether the user is or is not scrubbing
|
||||
* whether the user is or is not scrubbing
|
||||
*
|
||||
* @return {boolean}
|
||||
* The value of scrubbing when getting
|
||||
@ -1887,7 +1887,7 @@ class Player extends Component {
|
||||
|
||||
seconds = parseFloat(seconds);
|
||||
|
||||
// Standardize on Inifity for signaling video is live
|
||||
// Standardize on Infinity for signaling video is live
|
||||
if (seconds < 0) {
|
||||
seconds = Infinity;
|
||||
}
|
||||
@ -1960,7 +1960,7 @@ class Player extends Component {
|
||||
*
|
||||
* @return {number}
|
||||
* A decimal between 0 and 1 representing the percent
|
||||
* that is bufferred 0 being 0% and 1 being 100%
|
||||
* that is buffered 0 being 0% and 1 being 100%
|
||||
*/
|
||||
bufferedPercent() {
|
||||
return bufferedPercent(this.buffered(), this.duration());
|
||||
@ -2039,7 +2039,7 @@ class Player extends Component {
|
||||
|
||||
/**
|
||||
* Get the current defaultMuted state, or turn defaultMuted on or off. defaultMuted
|
||||
* indicates the state of muted on intial playback.
|
||||
* indicates the state of muted on initial playback.
|
||||
*
|
||||
* ```js
|
||||
* var myPlayer = videojs('some-player-id');
|
||||
@ -2464,7 +2464,7 @@ class Player extends Component {
|
||||
}
|
||||
|
||||
/**
|
||||
* Set the source object on the tech, returns a boolean that indicates wether
|
||||
* Set the source object on the tech, returns a boolean that indicates whether
|
||||
* there is a tech that can play the source or not
|
||||
*
|
||||
* @param {Tech~SourceObject} source
|
||||
@ -2556,7 +2556,7 @@ class Player extends Component {
|
||||
|
||||
/**
|
||||
* Returns the fully qualified URL of the current source value e.g. http://mysite.com/video.mp4
|
||||
* Can be used in conjuction with `currentType` to assist in rebuilding the current source object.
|
||||
* Can be used in conjunction with `currentType` to assist in rebuilding the current source object.
|
||||
*
|
||||
* @return {string}
|
||||
* The current source
|
||||
@ -2582,7 +2582,7 @@ class Player extends Component {
|
||||
*
|
||||
* @param {boolean} [value]
|
||||
* - true means that we should preload
|
||||
* - false maens that we should not preload
|
||||
* - false means that we should not preload
|
||||
*
|
||||
* @return {string}
|
||||
* The preload attribute value when getting
|
||||
@ -3075,7 +3075,7 @@ class Player extends Component {
|
||||
/**
|
||||
* Gets or sets the current default playback rate. A default playback rate of
|
||||
* 1.0 represents normal speed and 0.5 would indicate half-speed playback, for instance.
|
||||
* defaultPlaybackRate will only represent what the intial playbackRate of a video was, not
|
||||
* defaultPlaybackRate will only represent what the initial playbackRate of a video was, not
|
||||
* not the current playbackRate.
|
||||
*
|
||||
* @see https://html.spec.whatwg.org/multipage/embedded-content.html#dom-media-defaultplaybackrate
|
||||
@ -3225,7 +3225,7 @@ class Player extends Component {
|
||||
/**
|
||||
* The player's language code
|
||||
* NOTE: The language should be set in the player options if you want the
|
||||
* the controls to be built with a specific language. Changing the lanugage
|
||||
* the controls to be built with a specific language. Changing the language
|
||||
* later will not update controls text.
|
||||
*
|
||||
* @param {string} [code]
|
||||
@ -3368,7 +3368,7 @@ class Player extends Component {
|
||||
}
|
||||
|
||||
/**
|
||||
* Determine wether or not flexbox is supported
|
||||
* Determine whether or not flexbox is supported
|
||||
*
|
||||
* @return {boolean}
|
||||
* - true if flexbox is supported
|
||||
|
@ -18,7 +18,7 @@ import setupSourceset from './setup-sourceset';
|
||||
/**
|
||||
* HTML5 Media Controller - Wrapper for HTML5 Media API
|
||||
*
|
||||
* @mixes Tech~SouceHandlerAdditions
|
||||
* @mixes Tech~SourceHandlerAdditions
|
||||
* @extends Tech
|
||||
*/
|
||||
class Html5 extends Tech {
|
||||
@ -502,7 +502,7 @@ class Html5 extends Tech {
|
||||
* Get the current height of the HTML5 media element.
|
||||
*
|
||||
* @return {number}
|
||||
* The heigth of the HTML5 media element.
|
||||
* The height of the HTML5 media element.
|
||||
*/
|
||||
height() {
|
||||
return this.el_.offsetHeight;
|
||||
@ -674,12 +674,12 @@ class Html5 extends Tech {
|
||||
* on the value of `featuresNativeTextTracks`
|
||||
*
|
||||
* @param {Object} options
|
||||
* The object should contain the options to intialize the TextTrack with.
|
||||
* The object should contain the options to initialize the TextTrack with.
|
||||
*
|
||||
* @param {string} [options.kind]
|
||||
* `TextTrack` kind (subtitles, captions, descriptions, chapters, or metadata).
|
||||
*
|
||||
* @param {string} [options.label].
|
||||
* @param {string} [options.label]
|
||||
* Label to identify the text track
|
||||
*
|
||||
* @param {string} [options.language]
|
||||
@ -915,7 +915,7 @@ Html5.canControlPlaybackRate = function() {
|
||||
* Object.defineProperty.
|
||||
*
|
||||
* @return {boolean}
|
||||
* - True if builtin attributes can be overriden
|
||||
* - True if builtin attributes can be overridden
|
||||
* - False otherwise
|
||||
*/
|
||||
Html5.canOverrideAttributes = function() {
|
||||
@ -1020,7 +1020,7 @@ Html5.prototype.featuresVolumeControl = Html5.canControlVolume();
|
||||
Html5.prototype.featuresPlaybackRate = Html5.canControlPlaybackRate();
|
||||
|
||||
/**
|
||||
* Boolean indicating wether the `Tech` supports the `sourceset` event.
|
||||
* Boolean indicating whether the `Tech` supports the `sourceset` event.
|
||||
*
|
||||
* @type {boolean}
|
||||
* @default
|
||||
@ -1050,7 +1050,7 @@ Html5.prototype.featuresFullscreenResize = true;
|
||||
|
||||
/**
|
||||
* Boolean indicating whether the `HTML5` tech currently supports the progress event.
|
||||
* If this is false, manual `progress` events will be triggred instead.
|
||||
* If this is false, manual `progress` events will be triggered instead.
|
||||
*
|
||||
* @type {boolean}
|
||||
* @default
|
||||
@ -1059,7 +1059,7 @@ Html5.prototype.featuresProgressEvents = true;
|
||||
|
||||
/**
|
||||
* Boolean indicating whether the `HTML5` tech currently supports the timeupdate event.
|
||||
* If this is false, manual `timeupdate` events will be triggred instead.
|
||||
* If this is false, manual `timeupdate` events will be triggered instead.
|
||||
*
|
||||
* @default
|
||||
*/
|
||||
@ -1452,7 +1452,7 @@ Html5.resetMediaElement = function(el) {
|
||||
|
||||
/**
|
||||
* Get the value of the `error` from the media element. `error` indicates any
|
||||
* MediaError that may have occured during playback. If error returns null there is no
|
||||
* MediaError that may have occurred during playback. If error returns null there is no
|
||||
* current error.
|
||||
*
|
||||
* @method Html5#error
|
||||
@ -1472,7 +1472,7 @@ Html5.resetMediaElement = function(el) {
|
||||
* @return {boolean}
|
||||
* - The value of `seeking` from the media element.
|
||||
* - True indicates that the media is currently seeking to a new position.
|
||||
* - Flase indicates that the media is not seeking to a new position at this time.
|
||||
* - False indicates that the media is not seeking to a new position at this time.
|
||||
*
|
||||
* @see [Spec]{@link https://www.w3.org/TR/html5/embedded-content-0.html#dom-media-seeking}
|
||||
*/
|
||||
@ -1555,7 +1555,7 @@ Html5.resetMediaElement = function(el) {
|
||||
* Get the value of `networkState` from the media element. `networkState` indicates
|
||||
* the current network state. It returns an enumeration from the following list:
|
||||
* - 0: NETWORK_EMPTY
|
||||
* - 1: NEWORK_IDLE
|
||||
* - 1: NETWORK_IDLE
|
||||
* - 2: NETWORK_LOADING
|
||||
* - 3: NETWORK_NO_SOURCE
|
||||
*
|
||||
@ -1601,7 +1601,7 @@ Html5.resetMediaElement = function(el) {
|
||||
'videoWidth',
|
||||
|
||||
/**
|
||||
* Get the value of `videoHeight` from the video element. `videoHeigth` indicates
|
||||
* Get the value of `videoHeight` from the video element. `videoHeight` indicates
|
||||
* the current height of the video in css pixels.
|
||||
*
|
||||
* @method Html5#videoHeight
|
||||
@ -1721,7 +1721,7 @@ Html5.resetMediaElement = function(el) {
|
||||
|
||||
// wrap native functions with a function
|
||||
// The list is as follows:
|
||||
// pause, load play
|
||||
// pause, load, play
|
||||
[
|
||||
/**
|
||||
* A wrapper around the media elements `pause` function. This will call the `HTML5`
|
||||
@ -1760,10 +1760,10 @@ Tech.withSourceHandlers(Html5);
|
||||
/**
|
||||
* Native source handler for Html5, simply passes the source to the media element.
|
||||
*
|
||||
* @proprety {Tech~SourceObject} source
|
||||
* @property {Tech~SourceObject} source
|
||||
* The source object
|
||||
*
|
||||
* @proprety {Html5} tech
|
||||
* @property {Html5} tech
|
||||
* The instance of the HTML5 tech.
|
||||
*/
|
||||
Html5.nativeSourceHandler = {};
|
||||
|
@ -179,7 +179,7 @@ const getSrcDescriptor = (el) => {
|
||||
};
|
||||
|
||||
/**
|
||||
* Patches browser internal functions so that we can tell syncronously
|
||||
* Patches browser internal functions so that we can tell synchronously
|
||||
* if a `<source>` was appended to the media element. For some reason this
|
||||
* causes a `sourceset` if the the media element is ready and has no source.
|
||||
* This happens when:
|
||||
|
Loading…
Reference in New Issue
Block a user