@videojs/react 10.0.0-beta.31 → 10.0.0-beta.32

package/docs/reference/seek-indicator.md

@@ -0,0 +1,448 @@
+# SeekIndicator
+
+A temporary visual indicator for keyboard and gesture seeking
+
+## Import
+
+tsx
+
+```
+import { SeekIndicator } from '@videojs/react';
+```
+
+## Anatomy
+
+tsx
+
+```
+<SeekIndicator.Root>
+  <SeekIndicator.Value />
+</SeekIndicator.Root>
+```
+
+## Behavior
+
+`SeekIndicator` displays feedback for seek actions emitted by a [`Hotkey`](./hotkey.md) or [`Gesture`](./gesture.md) in the same player `Container`. It does not react to current-time changes or seek commands invoked directly through the player store.
+
+Action
+
+Direction
+
+Value
+
+`seekStep`
+
+The sign of `value` determines `forward` or `backward`
+
+The absolute number of seconds, such as `10s`
+
+`seekToPercent`
+
+The target percentage is compared with the current time
+
+The formatted current time when the action occurred
+
+Rapid `seekStep` actions in the same direction accumulate while the indicator is open. For example, two 10-second forward actions display `20s`. Changing direction or using `seekToPercent` starts a new display. During a rapid sequence, another full step is not added when it would pass the start or duration boundary.
+
+For `seekToPercent`, pass a percentage from 0 to 100 as `value`. A `Hotkey` with `keys="0-9"` can omit `value`; the pressed digit maps to 0%, 10%, and so on through 90%.
+
+The indicator closes after `closeDelay`, which defaults to 800 milliseconds. React stops rendering the Root after its close transition. The HTML custom element remains in the document with `hidden` until the next handled seek action.
+
+## Styling
+
+Attribute
+
+Values
+
+Description
+
+`data-open`
+
+Present / absent
+
+Present while the indicator is open
+
+`data-direction`
+
+`"forward"` | `"backward"`
+
+Direction of the handled seek
+
+`data-starting-style`
+
+Present / absent
+
+Present during the open transition
+
+`data-ending-style`
+
+Present / absent
+
+Present during the close transition
+
+Position the Root from `data-direction` and use the transition attributes for entry and exit styles.
+
+React renders standard DOM elements. Add a `className` to the Root:
+
+css
+
+```
+.seek-indicator[data-direction="backward"] {
+  left: 1rem;
+}
+
+.seek-indicator[data-direction="forward"] {
+  right: 1rem;
+}
+
+.seek-indicator[data-starting-style],
+.seek-indicator[data-ending-style] {
+  opacity: 0;
+}
+```
+
+## Accessibility
+
+`SeekIndicator` is visual feedback and does not create a live region. Keep the same seek operation available through keyboard-operable controls, and pair it with [`StatusAnnouncer`](./status-announcer.md) when changes should be announced to screen readers. Do not make `SeekIndicator.Value` a live region because rapid seek input would produce repeated announcements.
+
+## Examples
+
+### Basic Usage
+
+Focus the player, then press the left or right arrow key to seek by ten seconds. Press a digit from 0 through 9 to seek to a percentage of the duration.
+
+Focus the player · ←/→: seek 10s · 0–9: seek to percent
+
+App.tsx
+
+App.css
+
+```
+import { Container, createPlayer, Hotkey, SeekIndicator } from '@videojs/react';
+import { Video, videoFeatures } from '@videojs/react/video';
+
+import './BasicUsage.css';
+
+const { Player } = createPlayer({ features: videoFeatures });
+
+export default function BasicUsage() {
+  return (
+    <Player>
+      <Container className="react-seek-indicator-basic" tabIndex={0}>
+        <Video src="https://stream.mux.com/BV3YZtogl89mg9VcNBhhnHm02Y34zI1nlMuMQfAbl3dM/highest.mp4" autoPlay muted playsInline loop />
+        <p className="react-seek-indicator-basic__instructions">
+          Focus the player · ←/→: seek 10s · 0–9: seek to percent
+        </p>
+        <SeekIndicator.Root className="react-seek-indicator-basic__indicator" aria-hidden="true">
+          <SeekIndicator.Value className="react-seek-indicator-basic__value" />
+        </SeekIndicator.Root>
+        <Hotkey keys="ArrowLeft" action="seekStep" value={-10} />
+        <Hotkey keys="ArrowRight" action="seekStep" value={10} />
+        <Hotkey keys="0-9" action="seekToPercent" />
+      </Container>
+    </Player>
+  );
+}
+```
+```
+.react-seek-indicator-basic {
+  position: relative;
+}
+
+.react-seek-indicator-basic:focus-visible {
+  outline: 3px solid #60a5fa;
+  outline-offset: 2px;
+}
+
+.react-seek-indicator-basic video {
+  display: block;
+  width: 100%;
+}
+
+.react-seek-indicator-basic__instructions {
+  position: absolute;
+  top: 10px;
+  left: 50%;
+  padding: 6px 10px;
+  margin: 0;
+  color: white;
+  text-align: center;
+  background: rgb(0 0 0 / 70%);
+  border-radius: 4px;
+  translate: -50%;
+}
+
+.react-seek-indicator-basic__indicator {
+  position: absolute;
+  top: 50%;
+  left: 50%;
+  display: grid;
+  min-width: 72px;
+  padding: 16px;
+  color: white;
+  pointer-events: none;
+  background: rgb(0 0 0 / 72%);
+  border-radius: 9999px;
+  place-items: center;
+  transform: translate(-50%, -50%);
+  transition:
+    opacity 160ms ease-in-out,
+    scale 160ms ease-in-out;
+}
+
+.react-seek-indicator-basic__indicator::before {
+  font-size: 24px;
+  line-height: 1;
+  content: "↔";
+}
+
+.react-seek-indicator-basic__indicator[data-direction="backward"] {
+  right: auto;
+  left: 16px;
+  transform: translateY(-50%);
+}
+
+.react-seek-indicator-basic__indicator[data-direction="backward"]::before {
+  content: "↶";
+}
+
+.react-seek-indicator-basic__indicator[data-direction="forward"] {
+  right: 16px;
+  left: auto;
+  transform: translateY(-50%);
+}
+
+.react-seek-indicator-basic__indicator[data-direction="forward"]::before {
+  content: "↷";
+}
+
+.react-seek-indicator-basic__indicator[data-starting-style],
+.react-seek-indicator-basic__indicator[data-ending-style] {
+  opacity: 0;
+  scale: 0.85;
+}
+
+.react-seek-indicator-basic__value {
+  font-variant-numeric: tabular-nums;
+}
+```
+
+## API Reference
+
+### 
+
+Root
+
+#### Props
+
+Prop
+
+Type
+
+Default
+
+Details
+
+`closeDelay`
+
+`number`
+
+`—`
+
+▸
+
+Description
+
+Delay in milliseconds before the indicator closes.
+
+#### State
+
+State is accessible via the `render`, `className`, and `style` props.
+
+Property
+
+Type
+
+Details
+
+`transitionStarting`
+
+`boolean`
+
+▸
+
+Description
+
+Whether the open transition is in progress.
+
+`transitionEnding`
+
+`boolean`
+
+▸
+
+Description
+
+Whether the close transition is in progress.
+
+`open`
+
+`boolean`
+
+▸
+
+Description
+
+Whether the indicator is open.
+
+`generation`
+
+`number`
+
+▸
+
+Description
+
+Increments each time a seek input action updates the indicator.
+
+`direction`
+
+`'forward' | 'backward' | null`
+
+▸
+
+Description
+
+Direction of the seek, or `null` when the target does not change the current time.
+
+`count`
+
+`number`
+
+▸
+
+Description
+
+Number of same-direction seek steps accumulated in the current display.
+
+`seekTotal`
+
+`number`
+
+▸
+
+Description
+
+Absolute number of seconds accumulated from seek-step actions.
+
+`value`
+
+`string | null`
+
+▸
+
+Description
+
+Accumulated seek-step label, or `null` for percentage seeks.
+
+`currentTime`
+
+`string`
+
+▸
+
+Description
+
+Formatted current time captured when the input action occurred.
+
+#### Data attributes
+
+Attribute
+
+Type
+
+Details
+
+`data-open`
+
+▸
+
+Description
+
+Present while the indicator is open.
+
+`data-direction`
+
+`'forward' | 'backward' | null`
+
+▸
+
+Description
+
+Direction of the seek as `"forward"` or `"backward"`.
+
+`data-starting-style`
+
+▸
+
+Description
+
+Present during the open transition.
+
+`data-ending-style`
+
+▸
+
+Description
+
+Present during the close transition.
+
+### 
+
+Value
+
+#### Props
+
+Prop
+
+Type
+
+Default
+
+Details
+
+`className`
+
+`string | ((state: SeekIndicatorCore.State) => string | undefined)`
+
+`—`
+
+▸
+
+Description
+
+Class name or function returning class name from state.
+
+`render`
+
+`ReactElement | ((props: HTMLProps, state: SeekIndicatorCore.State) => ReactElement | null)`
+
+`—`
+
+▸
+
+Description
+
+Render prop for custom element.
+
+`style`
+
+`CSSProperties | ((state: SeekIndicatorCore.State) => CSSProperties | undefined)`
+
+`—`
+
+▸
+
+Description
+
+Style or function returning style from state.

package/docs/reference/shaka-video.md

@@ -2,7 +2,7 @@
 
 Video element powered by Shaka Player for DASH, HLS, and progressive playback with DRM
 
-Video element powered by [Shaka Player](https://github.com/shaka-project/shaka-player). One element plays DASH, HLS, and progressive files, and it’s the media component to reach for when you need DRM.
+Choose [Shaka Player](https://github.com/shaka-project/shaka-player) when one media component needs to play DASH, HLS, and progressive files, or when playback requires DRM.
 
 ## Load a source
 
@@ -93,7 +93,7 @@ Details
 
 `preload`
 
-`MediaPreloadType`
+`'' | 'none' | 'metadata' | 'auto'`
 
 `'metadata'`
 
@@ -111,7 +111,7 @@ A play intent is a `play` event, a target that is already playing, or `autoplay`
 
 `source`
 
-`ShakaSource | null`
+`{ src?: string; type?: string; drm?: DrmSystemsConfig; engine?: ShakaEngineConfig } | null`
 
 `null`
 
@@ -131,7 +131,7 @@ Shaka takes configuration on a live player, so changing `engine.shaka` re-applie
 
 `streamType`
 
-`MediaStreamType`
+`(typeof MediaStreamTypes)[keyof typeof MediaStreamTypes]`
 
 `'unknown'`
 
@@ -168,11 +168,17 @@ Details
 
 Type
 
-`{ advanced?: { droppedFramesBanDuration?: number; droppedFramesInterval?: number; droppedFramesThreshold?: number; fastHalfLife?: number; minBytes?: number; minTotalBytes?: number; slowHalfLife?: number; }; ... 15 more ...; useNetworkInformation?: boolean; }`
+`{ advanced?: { droppedFramesBanDuration?: number; droppedFramesInterval?: number; droppedFramesThreshold?: number; fastHalfLife?: number; minBytes?: number; minTotalBytes?: number; slowHalfLife?: number }; bandwidthDowngradeTarget?: number; bandwidthUpgradeTarget?: number; cacheLoadThreshold?: number; clearBufferSwitch?: boolean; defaultBandwidthEstimate?: number; droppedFrames?: boolean; enabled?: boolean; ignoreDevicePixelRatio?: boolean; minTimeToSwitch?: number; preferNetworkInformationBandwidth?: boolean; restrictToElementSize?: boolean; restrictToScreenSize?: boolean; restrictions?: { maxBandwidth?: number; maxChannelsCount?: number; maxFrameRate?: number; maxHeight?: number; maxPixels?: number; maxWidth?: number; minBandwidth?: number; minChannelsCount?: number; minFrameRate?: number; minHeight?: number; minPixels?: number; minWidth?: number }; safeMarginSwitch?: number; switchInterval?: number; useNetworkInformation?: boolean } | undefined`
 
 `abrFactory`
 
-`Factory`
+`undefined | function`
+
+▸
+
+Type
+
+`(() => shaka.extern.AbrManager) | undefined`
 
 `accessibility`
 
@@ -182,11 +188,17 @@ Type
 
 Type
 
-`{ handleForcedSubtitlesAutomatically?: boolean; speechToText?: { enabled?: boolean; languagesToTranslate?: string[]; maxTextLength?: number; processLocally?: boolean; }; }`
+`{ handleForcedSubtitlesAutomatically?: boolean; speechToText?: { enabled?: boolean; languagesToTranslate?: string[]; maxTextLength?: number; processLocally?: boolean } } | undefined`
 
 `adaptationSetCriteriaFactory`
 
-`Factory`
+`undefined | function`
+
+▸
+
+Type
+
+`(() => shaka.extern.AdaptationSetCriteria) | undefined`
 
 `ads`
 
@@ -196,7 +208,7 @@ Type
 
 Type
 
-`{ allowPreloadOnDomElements?: boolean; allowStartInMiddleOfInterstitial?: boolean; customPlayheadTracker?: boolean; disableDASHInterstitial?: boolean; disableHLSInterstitial?: boolean; ... 6 more ...; supportsMultipleMediaElements?: boolean; }`
+`{ allowPreloadOnDomElements?: boolean; allowStartInMiddleOfInterstitial?: boolean; customPlayheadTracker?: boolean; disableDASHInterstitial?: boolean; disableHLSInterstitial?: boolean; disablePlayedLinearAdSkip?: boolean; disableSnapback?: boolean; disableTrackingEvents?: boolean; disableTrackingForPlayedLinearAds?: boolean; interstitialPreloadAheadTime?: number; skipPlayDetection?: boolean; supportsMultipleMediaElements?: boolean } | undefined`
 
 `cmcd`
 
@@ -206,7 +218,7 @@ Type
 
 Type
 
-`{ contentId?: string; enabled?: boolean; eventTargets?: CmcdTarget[] | null; includeKeys?: string[]; rtpSafetyFactor?: number; sessionId?: string; useHeaders?: boolean; version?: number; }`
+`{ contentId?: string; enabled?: boolean; eventTargets?: shaka.extern.CmcdTarget[] | null; includeKeys?: string[]; rtpSafetyFactor?: number; sessionId?: string; useHeaders?: boolean; version?: number } | undefined`
 
 `cmsd`
 
@@ -216,7 +228,7 @@ Type
 
 Type
 
-`{ applyMaximumSuggestedBitrate?: boolean; enabled?: boolean; estimatedThroughputWeightRatio?: number; }`
+`{ applyMaximumSuggestedBitrate?: boolean; enabled?: boolean; estimatedThroughputWeightRatio?: number } | undefined`
 
 `drm`
 
@@ -226,11 +238,11 @@ Type
 
 Type
 
-`{ advanced?: { [x: string]: { audioRobustness?: string[] | null; distinctiveIdentifierRequired?: boolean; headers?: { [x: string]: string | undefined; }; individualizationServer?: string; persistentStateRequired?: boolean; serverCertificate?: Uint8Array<...> | null; serverCertificateUri?: string; sessionType?: strin...`
+`{ advanced?: object | null; clearKeys?: object; defaultAudioRobustnessForWidevine?: string; defaultVideoRobustnessForWidevine?: string; delayLicenseRequestUntilPlayed?: boolean; failureCallback?: ((a: shaka.util.Error) => any); ignoreDuplicateInitData?: boolean; initDataTransform?: ((a: Uint8Array, b: string, c: shaka.extern.DrmInfo | null) => Uint8Array); keySystemsMapping?: object; logLicenseExchange?: boolean; minHdcpVersion?: string; parseInbandPsshEnabled?: boolean; persistentSessionOnlinePlayback?: boolean; persistentSessionsMetadata?: shaka.extern.PersistentSessionMetadata[]; preferredKeySystems?: string[]; renewalIntervalSec?: number; retryParameters?: { backoffFactor?: number; baseDelay?: number; connectionTimeout?: number; fuzzFactor?: number; maxAttempts?: number; stallTimeout?: number; timeout?: number }; servers?: object; updateExpirationTime?: number } | undefined`
 
 `ignoreHardwareResolution`
 
-`boolean`
+`boolean | undefined`
 
 `lcevc`
 
@@ -240,7 +252,7 @@ Type
 
 Type
 
-`{ drawLogo?: boolean; dynamicPerformanceScaling?: boolean; enabled?: boolean; logLevel?: number; poster?: boolean; }`
+`{ drawLogo?: boolean; dynamicPerformanceScaling?: boolean; enabled?: boolean; logLevel?: number; poster?: boolean } | undefined`
 
 `manifest`
 
@@ -250,17 +262,17 @@ Type
 
 Type
 
-`{ availabilityWindowOverride?: number; continueLoadingWhenPaused?: boolean; dash?: { autoCorrectDrift?: boolean; clockSyncUri?: string; enableFastSwitching?: boolean; ignoreEmptyAdaptationSet?: boolean; ... 8 more ...; xlinkFailGracefully?: boolean; }; ... 15 more ...; updatePeriod?: number; }`
+`{ availabilityWindowOverride?: number; continueLoadingWhenPaused?: boolean; dash?: { autoCorrectDrift?: boolean; clockSyncUri?: string; enableFastSwitching?: boolean; ignoreEmptyAdaptationSet?: boolean; ignoreMaxSegmentDuration?: boolean; ignoreMinBufferTime?: boolean; ignoreSuggestedPresentationDelay?: boolean; initialSegmentLimit?: number; keySystemsByURI?: object; manifestPreprocessorTXml?: ((a: shaka.extern.xml.Node) => any); sequenceMode?: boolean; useStreamOnceInPeriodFlattening?: boolean; xlinkFailGracefully?: boolean }; defaultPresentationDelay?: number; disableAudio?: boolean; disableChapters?: boolean; disableIFrames?: boolean; disableText?: boolean; disableThumbnails?: boolean; disableVideo?: boolean; enableAudioGroups?: boolean; hls?: { allowLowLatencyByteRangeOptimization?: boolean; allowRangeRequestsToGuessMimeType?: boolean; chaptersUri?: string; defaultAudioCodec?: string; defaultVideoCodec?: string; disableClosedCaptionsDetection?: boolean; disableCodecGuessing?: boolean; ignoreImageStreamFailures?: boolean; ignoreManifestProgramDateTime?: boolean; ignoreManifestProgramDateTimeForTypes?: string[]; ignoreManifestTimestampsInSegmentsMode?: boolean; ignoreTextStreamFailures?: boolean; liveSegmentsDelay?: number; mediaPlaylistFullMimeType?: string; sequenceMode?: boolean }; ignoreDrmInfo?: boolean; ignoreSupplementalCodecs?: boolean; msf?: { authorizationToken?: string; catalogPreprocessor?: ((a: any) => any); fingerprintUri?: string; namespaces?: string[]; subscribeFilterType?: shaka.config.MsfFilterType; useFetchCatalog?: boolean; version?: shaka.config.MsfVersion }; raiseFatalErrorOnManifestUpdateRequestFailure?: boolean; retryParameters?: { backoffFactor?: number; baseDelay?: number; connectionTimeout?: number; fuzzFactor?: number; maxAttempts?: number; stallTimeout?: number; timeout?: number }; segmentRelativeVttTiming?: boolean; updatePeriod?: number } | undefined`
 
 `mediaSource`
 
-`function`
+`object`
 
 ▸
 
 Type
 
-`{ addExtraFeaturesToSourceBuffer?: (a: string) => string; codecSwitchingStrategy?: CodecSwitchingStrategy; correctEc3Enca?: boolean; dispatchAllEmsgBoxes?: boolean; ... 6 more ...; useSourceElements?: boolean; }`
+`{ addExtraFeaturesToSourceBuffer?: ((a: string) => string); codecSwitchingStrategy?: shaka.config.CodecSwitchingStrategy; correctEc3Enca?: boolean; dispatchAllEmsgBoxes?: boolean; durationReductionEmitsUpdateEnd?: boolean; forceTransmux?: boolean; insertFakeEncryptionInInit?: boolean; modifyCueCallback?: ((a: shaka.text.Cue, b: string | null, c: shaka.extern.TextParser.TimeContext) => any); repairIFrames?: boolean; transmuxWorkerUrl?: string; useSourceElements?: boolean } | undefined`
 
 `networking`
 
@@ -270,41 +282,59 @@ Type
 
 Type
 
-`{ commonAccessTokenHeaderName?: string; forceHTTP?: boolean; forceHTTPS?: boolean; minBytesForProgressEvents?: number; }`
+`{ commonAccessTokenHeaderName?: string; forceHTTP?: boolean; forceHTTPS?: boolean; minBytesForProgressEvents?: number } | undefined`
 
 `offline`
 
-`function`
+`object`
 
 ▸
 
 Type
 
-`{ downloadSizeCallback?: (a: number) => Promise<boolean>; numberOfParallelDownloads?: number; progressCallback?: (a: StoredContent, b: number) => any; trackSelectionCallback?: (a: TrackList) => Promise<...>; usePersistentLicense?: boolean; }`
+`{ downloadSizeCallback?: ((a: number) => Promise<boolean>); numberOfParallelDownloads?: number; progressCallback?: ((a: shaka.extern.StoredContent, b: number) => any); trackSelectionCallback?: ((a: shaka.extern.TrackList) => Promise<shaka.extern.TrackList>); usePersistentLicense?: boolean } | undefined`
 
 `playRangeEnd`
 
-`number`
+`number | undefined`
 
 `playRangeStart`
 
-`number`
+`number | undefined`
 
 `preferredAudio`
 
-`AudioPreference[]`
+`shaka.extern.AudioPreference[] | unde...`
+
+▸
+
+Type
+
+`shaka.extern.AudioPreference[] | undefined`
 
 `preferredDecodingAttributes`
 
-`string[]`
+`string[] | undefined`
 
 `preferredText`
 
-`TextPreference[]`
+`shaka.extern.TextPreference[] | undef...`
+
+▸
+
+Type
+
+`shaka.extern.TextPreference[] | undefined`
 
 `preferredVideo`
 
-`VideoPreference[]`
+`shaka.extern.VideoPreference[] | unde...`
+
+▸
+
+Type
+
+`shaka.extern.VideoPreference[] | undefined`
 
 `queue`
 
@@ -314,7 +344,7 @@ Type
 
 Type
 
-`{ preloadNextUrlWindow?: number; preloadPrevItem?: boolean; repeatMode?: RepeatMode; }`
+`{ preloadNextUrlWindow?: number; preloadPrevItem?: boolean; repeatMode?: shaka.config.RepeatMode } | undefined`
 
 `restrictions`
 
@@ -324,7 +354,7 @@ Type
 
 Type
 
-`{ maxBandwidth?: number; maxChannelsCount?: number; maxFrameRate?: number; maxHeight?: number; maxPixels?: number; maxWidth?: number; minBandwidth?: number; minChannelsCount?: number; minFrameRate?: number; minHeight?: number; minPixels?: number; minWidth?: number; }`
+`{ maxBandwidth?: number; maxChannelsCount?: number; maxFrameRate?: number; maxHeight?: number; maxPixels?: number; maxWidth?: number; minBandwidth?: number; minChannelsCount?: number; minFrameRate?: number; minHeight?: number; minPixels?: number; minWidth?: number } | undefined`
 
 `streaming`
 
@@ -334,7 +364,7 @@ Type
 
 Type
 
-`{ allowMediaSourceRecoveries?: boolean; avoidEvictionOnQuotaExceededError?: boolean; bufferBehind?: number; bufferingGoal?: number; clampAppendWindowToDuration?: boolean; clearDecodingCache?: boolean; ... 40 more ...; vodDynamicPlaybackRateLowBufferRate?: number; }`
+`{ allowMediaSourceRecoveries?: boolean; avoidEvictionOnQuotaExceededError?: boolean; bufferBehind?: number; bufferingGoal?: number; clampAppendWindowToDuration?: boolean; clearDecodingCache?: boolean; crossBoundaryStrategy?: shaka.config.CrossBoundaryStrategy; disableAudioPrefetch?: boolean; disableTextPrefetch?: boolean; disableVideoPrefetch?: boolean; dontChooseCodecs?: boolean; durationBackoff?: number; evictionGoal?: number; failureCallback?: ((a: shaka.util.Error) => any); gapDetectionThreshold?: number; gapJumpTimerTime?: number; gapPadding?: number; ignoreTextStreamFailures?: boolean; inaccurateManifestTolerance?: number; liveSync?: { dynamicTargetLatency?: { enabled?: boolean; maxAttempts?: number; maxLatency?: number; minLatency?: number; rebufferIncrement?: number; stabilityThreshold?: number }; enabled?: boolean; maxPlaybackRate?: number; minPlaybackRate?: number; panicMode?: boolean; panicThreshold?: number; targetLatency?: number; targetLatencyTolerance?: number }; loadTimeout?: number; lowLatencyMode?: boolean; maxDisabledTime?: number; minTimeBetweenRecoveries?: number; observeQualityChanges?: boolean; preferNativeDash?: boolean; preferNativeHls?: boolean; prefetchAudioLanguages?: string[]; preloadNextUrlWindow?: number; processSrcEqualMetadata?: boolean; rebufferingGoal?: number; retryParameters?: { backoffFactor?: number; baseDelay?: number; connectionTimeout?: number; fuzzFactor?: number; maxAttempts?: number; stallTimeout?: number; timeout?: number }; returnToEndOfLiveWindowWhenOutside?: boolean; safeSeekEndOffset?: number; safeSeekOffset?: number; segmentPrefetchLimit?: number; shouldFixTimestampOffset?: boolean; stallEnabled?: boolean; stallSkip?: number; stallThreshold?: number; startAtSegmentBoundary?: boolean; stopFetchingOnPause?: boolean; updateIntervalSeconds?: number; useNativeHlsForFairPlay?: boolean; vodDynamicPlaybackRate?: boolean; vodDynamicPlaybackRateBufferRatio?: number; vodDynamicPlaybackRateLowBufferRate?: number } | undefined`
 
 `textDisplayer`
 
@@ -344,11 +374,17 @@ Type
 
 Type
 
-`{ fontScaleFactor?: number; positionArea?: PositionArea; subtitleDelay?: number; suspendRenderingWhenHidden?: boolean; }`
+`{ fontScaleFactor?: number; positionArea?: shaka.config.PositionArea; subtitleDelay?: number; suspendRenderingWhenHidden?: boolean } | undefined`
 
 `textDisplayFactory`
 
-`Factory`
+`undefined | function`
+
+▸
+
+Type
+
+`((a: shaka.Player) => shaka.extern.TextDisplayer) | undefined`
 
 ### Ref