From e9d6c1bf403d467a46124893f96a219d13bebf44 Mon Sep 17 00:00:00 2001 From: Paul Berberian Date: Wed, 16 Jun 2021 16:48:37 +0200 Subject: [PATCH] doc: clarify error documentation and state change doc --- doc/api/errors.md | 5 +---- doc/api/loadVideo_options.md | 2 +- doc/api/states.md | 4 ++-- 3 files changed, 4 insertions(+), 7 deletions(-) diff --git a/doc/api/errors.md b/doc/api/errors.md index e40f0e4505..704348fff4 100644 --- a/doc/api/errors.md +++ b/doc/api/errors.md @@ -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. @@ -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`. diff --git a/doc/api/loadVideo_options.md b/doc/api/loadVideo_options.md index efa17b9ce8..6db25bfc5c 100644 --- a/doc/api/loadVideo_options.md +++ b/doc/api/loadVideo_options.md @@ -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) diff --git a/doc/api/states.md b/doc/api/states.md index 8263d48a57..d2681b28d0 100644 --- a/doc/api/states.md +++ b/doc/api/states.md @@ -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