diff --git a/docs/API.md b/docs/API.md index c0dce1088da..53e6e06c1cb 100644 --- a/docs/API.md +++ b/docs/API.md @@ -437,7 +437,7 @@ A logger object could also be provided for custom logging: `config.debug = custo (default -1) - if set to -1, playback will start from initialTime=0 for VoD and according to `liveSyncDuration/liveSyncDurationCount` config params for Live -- Otherwise, playback will start from predefined value. (unless stated otherwise in `autoStartLoad=false` mode : in that case startPosition can be overrided using `hls.startLoad(startPosition)`). +- Otherwise, playback will start from predefined value. (unless stated otherwise in `autoStartLoad=false` mode : in that case startPosition can be overridden using `hls.startLoad(startPosition)`). ### `defaultAudioCodec` @@ -813,7 +813,7 @@ var customPlaylistLoader = function () { }; ``` -if you want to just make slight adjustements to existing loader implementation, you can also eventually override it, see an example below : +if you want to just make slight adjustments to existing loader implementation, you can also eventually override it, see an example below : ```js // special playlist post processing function @@ -925,7 +925,7 @@ Enable the default fps controller by setting `capLevelOnFPSDrop` to `true`. (default: internal track timeline controller) -Customized text track syncronization controller. +Customized text track synchronization controller. Parameter should be a class with a `destroy()` method: @@ -1217,7 +1217,7 @@ Calling this method will: ## Quality switch Control API By default, hls.js handles quality switch automatically, using heuristics based on fragment loading bitrate and quality level bandwidth exposed in the variant manifest. -It is also possible to manually control quality swith using below API. +It is also possible to manually control quality switch using below API. ### `hls.levels` @@ -1257,7 +1257,7 @@ Set to `-1` for automatic level selection. ### `hls.startLevel` - get/set: Start level index (level of first fragment that will be played back). - - if not overrided by user: first level appearing in manifest will be used as start level. + - if not overridden by user: first level appearing in manifest will be used as start level. - if -1: automatic start level selection, playback will start from level matching download bandwidth (determined from download of first segment). Default value is `hls.firstLevel`. @@ -1387,7 +1387,7 @@ Full list of Events is available below: - `Hls.Events.MEDIA_ATTACHING` - fired before MediaSource is attaching to media element - data: { media } -- `Hls.Events.MEDIA_ATTACHED` - fired when MediaSource has been succesfully attached to media element +- `Hls.Events.MEDIA_ATTACHED` - fired when MediaSource has been successfully attached to media element - data: { media } - `Hls.Events.MEDIA_DETACHING` - fired before detaching MediaSource from media element - data: { } diff --git a/docs/design.md b/docs/design.md index 80d958b356e..c688d246107 100644 --- a/docs/design.md +++ b/docs/design.md @@ -162,11 +162,11 @@ design idea is pretty simple : - tracks which parts of the buffer is not loaded correctly - tracks which parts of the buffer was unloaded by the coded frame eviction algorithm - [src/loader/fragment-loader.ts][] - - in charge of loading fragments, use xhr-loader if not overrided by user config + - in charge of loading fragments, use xhr-loader if not overridden by user config - [src/loader/key-loader.ts][] - in charge of loading decryption key - [src/loader/playlist-loader.ts][] - - in charge of loading manifest, and level playlists, use xhr-loader if not overrided by user config. + - in charge of loading manifest, and level playlists, use xhr-loader if not overridden by user config. - [src/remux/aac-helper.ts][] - helper class to create silent AAC frames (useful to handle streams with audio holes) - [src/remux/mp4-generator.ts][] @@ -204,7 +204,7 @@ design idea is pretty simple : - logging utils, useful for debug - [src/utils/xhr-loader.ts][] - XmlHttpRequest wrapper. it handles standard HTTP GET but also retries and timeout. - - retries : if xhr fails, HTTP GET will be retried after a predetermined delay. this delay is increasing following an exponential backoff. after a predetemined max number of retries, an error callback will be triggered. + - retries : if xhr fails, HTTP GET will be retried after a predetermined delay. this delay is increasing following an exponential backoff. after a predetermined max number of retries, an error callback will be triggered. - timeout: if load exceeds max allowed duration, a timeout callback will be triggered. it is up to the callback to decides whether the connection should be cancelled or not. [src/config.ts]: ../src/config.ts