Skip to content

Commit

Permalink
docs: Fix a few typos (#4415)
Browse files Browse the repository at this point in the history
There are small typos in:
- docs/API.md
- docs/design.md

Fixes:
- Should read `overridden` rather than `overrided`.
- Should read `synchronization` rather than `syncronization`.
- Should read `switch` rather than `swith`.
- Should read `successfully` rather than `succesfully`.
- Should read `predetermined` rather than `predetemined`.
- Should read `adjustments` rather than `adjustements`.

Co-authored-by: Tom Jenkinson <tjenkinson@users.noreply.github.com>
  • Loading branch information
timgates42 and tjenkinson authored Nov 6, 2021
1 parent 4f33488 commit feab619
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 9 deletions.
12 changes: 6 additions & 6 deletions docs/API.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`

Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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:

Expand Down Expand Up @@ -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`

Expand Down Expand Up @@ -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`.
Expand Down Expand Up @@ -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: { }
Expand Down
6 changes: 3 additions & 3 deletions docs/design.md
Original file line number Diff line number Diff line change
Expand Up @@ -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][]
Expand Down Expand Up @@ -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
Expand Down

0 comments on commit feab619

Please sign in to comment.