From e543cc59926bcf269695e5174418ddf0fa00deab Mon Sep 17 00:00:00 2001 From: Christian Pillsbury Date: Tue, 19 Mar 2024 08:57:27 -0700 Subject: [PATCH] docs(mux-player, mux-player-react): Updating docs to reflect keyboard nav seek offset behavior. --- packages/mux-player-react/REFERENCE.md | 4 ++-- packages/mux-player/REFERENCE.md | 8 ++++---- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/packages/mux-player-react/REFERENCE.md b/packages/mux-player-react/REFERENCE.md index 9e0060136..767bd6495 100644 --- a/packages/mux-player-react/REFERENCE.md +++ b/packages/mux-player-react/REFERENCE.md @@ -24,8 +24,8 @@ | `accentColor` | `string` (Any valid CSS color style) | The accent color used by the player's UI | `undefined` | | `defaultShowRemainingTime` | `boolean` | Show remaining playback time (instead of current playback time) by default | `false` | | `playbackRates` | `number[]` | Array of numbers used by the playback rate button. | N/A | -| `forwardSeekOffset` | `number` (seconds) | Offset applied to the forward seek button | `10` | -| `backwardSeekOffset` | `number` (seconds) | Offset applied to the backward seek button | `10` | +| `forwardSeekOffset` | `number` (seconds) | Offset applied to the forward seek button and keyboard navigation | `10` | +| `backwardSeekOffset` | `number` (seconds) | Offset applied to the backward seek button and keyboard navigation | `10` | | `defaultHiddenCaptions` | `boolean` | Hide captions by default instead of showing them on initial load (when available) | `false` | | `defaultDuration` | `number` (seconds) | Applies a duration value before the media has loaded. Useful when used in conjunction with `preload="none"` | N/A | | `beaconCollectionDomain` | `string` (domain name) | Assigns a custom domain to be used for [Mux Data](https://docs.mux.com/guides/data/monitor-html5-video-element#features) collection. NOTE: Must be set before `playbackId` to apply to Mux Data monitoring. | `undefined` (`"litix.io"`) | diff --git a/packages/mux-player/REFERENCE.md b/packages/mux-player/REFERENCE.md index f4ff10ef4..3e0260ca4 100644 --- a/packages/mux-player/REFERENCE.md +++ b/packages/mux-player/REFERENCE.md @@ -34,8 +34,8 @@ | `primary-color` | `string` (Any valid CSS color style) | The primary color used by the player's UI | N/A | | `secondary-color` | `string` (Any valid CSS color style) | The secondary color used by the player's UI | N/A | | `accent-color` | `string` (Any valid CSS color style) | The accent color used by the player's UI | N/A | -| `forward-seek-offset` | `number` (seconds) | Offset applied to the forward seek button | `10` | -| `backward-seek-offset` | `number` (seconds) | Offset applied to the backward seek button | `10` | +| `forward-seek-offset` | `number` (seconds) | Offset applied to the forward seek button and keyboard navigation | `10` | +| `backward-seek-offset` | `number` (seconds) | Offset applied to the backward seek button and keyboard navigation | `10` | | `playback-token` | `string` | The playback token for signing the `src` URL. | N/A | | `thumbnail-token` | `string` | The thumbnail token for signing the `poster` URL. | N/A | | `storyboard-token` | `string` | The storyboard token for signing the storyboard URL. | N/A | @@ -110,8 +110,8 @@ | `accentColor` | `string` (Any valid CSS color style) | The accent color used by the player's UI | `undefined` | | `defaultShowRemainingTime` | `boolean` | Show remaining playback time (instead of current playback time) by default | `false` | | `playbackRates` | `number[]` | Array of numbers used by the playback rate button. | N/A | -| `forwardSeekOffset` | `number` (seconds) | Offset applied to the forward seek button | `10` | -| `backwardSeekOffset` | `number` (seconds) | Offset applied to the backward seek button | `10` | +| `forwardSeekOffset` | `number` (seconds) | Offset applied to the forward seek button and keyboard navigation | `10` | +| `backwardSeekOffset` | `number` (seconds) | Offset applied to the backward seek button and keyboard navigation | `10` | | `defaultHiddenCaptions` | `boolean` | Hide captions by default instead of showing them on initial load (when available) | `false` | | `defaultDuration` | `number` (seconds) | Applies a duration value before the media has loaded. Useful when used in conjunction with `preload="none"` | N/A | | `beaconCollectionDomain` | `string` (domain name) | Assigns a custom domain to be used for [Mux Data](https://docs.mux.com/guides/data/monitor-html5-video-element#features) collection. NOTE: Must be set before `playbackId` to apply to Mux Data monitoring. | `undefined` (`"litix.io"`) |