Skip to content

Commit

Permalink
docs(mux-player, mux-player-react): Updating docs to reflect keyboard… (
Browse files Browse the repository at this point in the history 
#889)

… nav seek offset behavior.
  • Loading branch information
@cjpillsbury
cjpillsbury authored Mar 20, 2024
1 parent b419de9 commit d9d0985
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 6 deletions.
4 changes: 2 additions & 2 deletions packages/mux-player-react/REFERENCE.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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"`) |
Expand Down
8 changes: 4 additions & 4 deletions packages/mux-player/REFERENCE.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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 |
Expand Down Expand Up @@ -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"`) |
Expand Down

0 comments on commit d9d0985

Please sign in to comment.