From 3ba89cd43b1906f7d5aacfe76786e85c7ea9deb2 Mon Sep 17 00:00:00 2001 From: k-g-a Date: Fri, 16 Aug 2024 13:17:04 +0500 Subject: [PATCH] docs(media-controller): add seektoliveoffset documentation --- .../docs/en/components/media-controller.md | 21 +++++++++++++++++++ 1 file changed, 21 insertions(+) diff --git a/docs/src/pages/docs/en/components/media-controller.md b/docs/src/pages/docs/en/components/media-controller.md index 62b816573..f9aea0483 100644 --- a/docs/src/pages/docs/en/components/media-controller.md +++ b/docs/src/pages/docs/en/components/media-controller.md @@ -205,6 +205,27 @@ See also: ``` +### seektoliveoffset + +`seektoliveoffset` (positive number, seconds) + +For live media streams the `seektoliveoffset` defines the delta, in seconds, from the latest playable/seekable time that should count as the target time when seeking to live. + +By default, this value is equal to the value of `liveedgeoffset` attribute. The `` element uses this to seek to the live edge. This value is also used when user unpauses a live stream, if `noaautoseektolive` attribute is not specified. + +One may want to use this attribute with a value lower than `liveedgeoffset` to prevent `` indicator flickering after the seek to live request. + +See also: +- [liveedgeoffset attribute](#liveedgeoffset) +- [noautoseektolive attribute](#noautoseektolive) +- [mediastreamtype description](../stream-type) + +```html + + ... + +``` + ### noautoseektolive `noautoseektolive` (boolean)