Skip to content

Commit

Permalink
doc: clarify error documentation and state change doc
Browse files Browse the repository at this point in the history
  • Loading branch information
peaBerberian committed Nov 23, 2021
1 parent 82be922 commit e9d6c1b
Show file tree
Hide file tree
Showing 3 changed files with 4 additions and 7 deletions.
5 changes: 1 addition & 4 deletions doc/api/errors.md
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@ Among its properties, you have:

- ``url`` (``string``): The url the request has been on

- ``status`` (``Number``): Shortcut to the status code of the xhr.
- ``status`` (``Number``): Status code of the HTTP request.

- ``errorType`` (``string``): Further precision about what went wrong.

Expand All @@ -111,9 +111,6 @@ Among its properties, you have:
- ``"ERROR_HTTP_CODE"``: The request finished with a status code not in
the 2xx range.

- ``code`` (``number``): The HTTP code of the request at the time of the
error (`0` if no request has been done yet)

- ``xhr`` (``XMLHttpRequest|undefined``): The xhr associated with the request.
Not defined if the current content has been launched in `lowLatencyMode`.

Expand Down
2 changes: 1 addition & 1 deletion doc/api/loadVideo_options.md
Original file line number Diff line number Diff line change
Expand Up @@ -1280,7 +1280,7 @@ This object can take the following properties (all are optional):
- The request failed because of a timeout
- the request failed because of an unknown XHR error (might be a
- the request failed because of an unknown request error (might be a
parsing/interface error)
Expand Down
4 changes: 2 additions & 2 deletions doc/api/states.md
Original file line number Diff line number Diff line change
Expand Up @@ -295,8 +295,8 @@ set to `true` or not set:
From `ENDED` if the `stopAtEnd` [player option](./player_options.md) has been
set to `false`:

- `PLAYING`: The `play` method was called.
The content plays back from the beginning.
- `PLAYING`: The user replays the video by calling `rxPlayer.play()` usually
restarting the content from the start.

- `PAUSED`: A user seeked into a part of the content already-downloaded.
The content is paused after the seek, regardless of if you were paused
Expand Down

0 comments on commit e9d6c1b

Please sign in to comment.