Skip to content

Commit

Permalink
docs(media-controller): add seektoliveoffset documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
k-g-a committed Sep 17, 2024
1 parent 9a05feb commit 3ba89cd
Showing 1 changed file with 21 additions and 0 deletions.
21 changes: 21 additions & 0 deletions docs/src/pages/docs/en/components/media-controller.md
Original file line number Diff line number Diff line change
Expand Up @@ -205,6 +205,27 @@ See also:
</media-controller>
```

### 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 `<media-live-button>` 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 `<media-live-button>` indicator flickering after the seek to live request.

See also:
- [liveedgeoffset attribute](#liveedgeoffset)
- [noautoseektolive attribute](#noautoseektolive)
- [mediastreamtype description](../stream-type)

```html
<media-controller liveedgeoffset="10" seektoliveoffset="7">
...
</media-controller>
```

### noautoseektolive

`noautoseektolive` (boolean)
Expand Down

0 comments on commit 3ba89cd

Please sign in to comment.