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

package/docs/reference/create-player.md

@@ -106,7 +106,7 @@ Details
 
 `config*`
 
-`CreatePlayerConfig<VideoFeatures>`
+`object`
 
 `—`
 
@@ -116,6 +116,10 @@ Description
 
 Player configuration with features and optional display name.
 
+Type
+
+`{ features: VideoFeatures; displayName?: string }`
+
 #### Return Value
 
 Property
@@ -126,11 +130,27 @@ Details
 
 `Player`
 
-`React.FC<PlayerProps<{ title: MediaContentValue; poster: MediaContentValue }>>`
+`FC<PlayerProps<InferPlayerConfig<VideoPlayerStore>>>`
+
+▸
+
+Description
+
+Provides a new player store to its descendants without adding a layout element.
 
 `usePlayer`
 
-`UsePlayerHook<VideoPlayerStore>`
+`function`
+
+▸
+
+Description
+
+Accesses the configured store, or subscribes to a selected value from it.
+
+Type
+
+`{ (): Store;; <R>(selector: (state: InferStoreState<Store>) => R): R; }`
 
 `useMedia`
 
@@ -138,6 +158,10 @@ Details
 
 ▸
 
+Description
+
+Returns the media currently attached beneath the generated Player, or `null` before attachment.
+
 Type
 
 `(() => Media | null)`
@@ -158,7 +182,7 @@ Details
 
 `config*`
 
-`CreatePlayerConfig<AudioFeatures>`
+`object`
 
 `—`
 
@@ -168,6 +192,10 @@ Description
 
 Player configuration with features and optional display name.
 
+Type
+
+`{ features: AudioFeatures; displayName?: string }`
+
 #### Return Value
 
 Property
@@ -178,11 +206,27 @@ Details
 
 `Player`
 
-`React.FC<PlayerProps<{ title: MediaContentValue; poster: MediaContentValue }>>`
+`FC<PlayerProps<InferPlayerConfig<AudioPlayerStore>>>`
+
+▸
+
+Description
+
+Provides a new player store to its descendants without adding a layout element.
 
 `usePlayer`
 
-`UsePlayerHook<AudioPlayerStore>`
+`function`
+
+▸
+
+Description
+
+Accesses the configured store, or subscribes to a selected value from it.
+
+Type
+
+`{ (): Store;; <R>(selector: (state: InferStoreState<Store>) => R): R; }`
 
 `useMedia`
 
@@ -190,6 +234,10 @@ Details
 
 ▸
 
+Description
+
+Returns the media currently attached beneath the generated Player, or `null` before attachment.
+
 Type
 
 `(() => Media | null)`
@@ -210,7 +258,7 @@ Details
 
 `config*`
 
-`CreatePlayerConfig<AnyPlayerFeature[]>`
+`object`
 
 `—`
 
@@ -220,6 +268,10 @@ Description
 
 Player configuration with features and optional display name.
 
+Type
+
+`{ features: Features; displayName?: string }`
+
 #### Return Value
 
 Property
@@ -230,11 +282,27 @@ Details
 
 `Player`
 
-`React.FC<PlayerProps<Config | object>>`
+`FC<PlayerProps<InferPlayerConfig<PlayerStore<Features>>>>`
+
+▸
+
+Description
+
+Provides a new player store to its descendants without adding a layout element.
 
 `usePlayer`
 
-`UsePlayerHook<PlayerStore<AnyPlayerFeature[]>>`
+`function`
+
+▸
+
+Description
+
+Accesses the configured store, or subscribes to a selected value from it.
+
+Type
+
+`{ (): Store;; <R>(selector: (state: InferStoreState<Store>) => R): R; }`
 
 `useMedia`
 
@@ -242,6 +310,10 @@ Details
 
 ▸
 
+Description
+
+Returns the media currently attached beneath the generated Player, or `null` before attachment.
+
 Type
 
 `(() => Media | null)`

package/docs/reference/create-selector.md

@@ -46,14 +46,12 @@ The slice to create a selector for.
 
 ### Return Value
 
+Property
+
 Type
 
 Details
 
-`Selector<object, InferSliceState<S> |...`
-
-▸
-
-Type
+`displayName`
 
-`Selector<object, InferSliceState<S> | undefined>`
+`string`

package/docs/reference/create-translator.md

@@ -28,7 +28,7 @@ Details
 
 `translations*`
 
-`object & Record<string, string | unde...`
+`object`
 
 `—`
 
@@ -40,11 +40,11 @@ Merged translation map for the active locale.
 
 Type
 
-`object & Record<string, string | undefined>`
+`{ [Key in TranslationKey]?: TranslationParams[Key] extends never ? string : Key extends keyof ParametricTranslations ? ParametricTranslations[Key] : string; } & Record<string, string | undefined>`
 
 `locale*`
 
-`string & object | 'ar' | 'az' | 'bs' ...`
+`(typeof LOCALES)[number] | string & o...`
 
 `—`
 
@@ -56,8 +56,18 @@ BCP 47 tag associated with the map (reserved for future locale-aware behavior).
 
 Type
 
-`string & object | 'ar' | 'az' | 'bs' | 'bg' | 'bn' | 'ca' | 'cs' | 'cy' | 'da' | 'de' | 'el' | 'es' | 'et' | 'eu' | 'fa' | 'fi' | 'fr' | 'gd' | 'gl' | 'he' | 'hi' | 'hr' | 'hu' | 'id' | 'it' | 'ja' | 'ko' | 'lt' | 'lv' | 'mr' | 'nb' | 'nl' | 'nn' | 'ne' | 'oc' | 'pl' | 'pt-BR' | 'pt-PT' | 'ro' | 'ru' | 'sk' | 'sl' | 'sr' | 'sv' | 'te' | 'th' | 'tr' | 'uk' | 'vi' | 'zh-CN' | 'zh-TW'`
+`(typeof LOCALES)[number] | string & object`
 
 ### Return Value
 
-`Translator`
+Type
+
+Details
+
+`object`
+
+▸
+
+Type
+
+`{ <Key extends string>( key: Key, ...args: Key extends TranslationKey ? TranslationParams[Key] extends never ? [params?: TranslationOptions] : [params: TranslationParams[Key] & TranslationOptions] : [params?: TextParams & TranslationOptions] ): string;; (text: Text, params?: TextParams): string; }`

package/docs/reference/dash-video.md

@@ -42,7 +42,7 @@ Details
 
 `source`
 
-`DashSource | null`
+`{ src?: string; engine?: DashEngineConfig } | null`
 
 `null`
 
@@ -52,7 +52,7 @@ Description
 
 Structured source: the MPD URL in `src`, plus dash.js settings in `engine.dashJs`. Replacing it re-derives `src`.
 
-dash.js takes settings on a live player, so changing `engine.dashJs` re-applies them in place instead of recreating the engine.
+Dash.js takes settings on a live player, so changing `engine.dashJs` re-applies them in place instead of recreating the engine.
 
 `src`
 
@@ -60,6 +60,61 @@ dash.js takes settings on a live player, so changing `engine.dashJs` re-applies
 
 `''`
 
+### Engine options
+
+#### `source.engine.dashJs`
+
+Pass dash.js’s own settings here. They’re handed to dash.js untouched, so every option in its [settings reference](https://cdn.dashjs.org/latest/jsdoc/module-Settings.html) works. Replacing the object resets any settings applied before it. [Media Sources](../concepts/media-sources.md) covers how engine options fit into a structured source.
+
+Each of the three below is a group of dash.js settings rather than a single value, and dash.js documents what’s inside them.
+
+tsx
+
+```
+<DashVideo
+  source={{
+    src: 'https://example.com/manifest.mpd',
+    engine: { dashJs: { streaming: { buffer: { fastSwitchEnabled: true } } } },
+  }}
+/>
+```
+
+Option
+
+Type
+
+Details
+
+`debug`
+
+`object`
+
+▸
+
+Type
+
+`{ logLevel?: LogLevel; dispatchEvent?: boolean } | undefined`
+
+`errors`
+
+`object`
+
+▸
+
+Type
+
+`{ recoverAttempts?: { mediaErrorDecode?: number } } | undefined`
+
+`streaming`
+
+`object`
+
+▸
+
+Type
+
+`{ abandonLoadTimeout?: number; wallclockTimeUpdateInterval?: number; manifestUpdateRetryInterval?: number; liveUpdateTimeThresholdInMilliseconds?: number; cacheInitSegments?: boolean; cacheInitSegmentsLimit?: number; applyServiceDescription?: boolean; applyProducerReferenceTime?: boolean; applyContentSteering?: boolean; enableManifestDurationMismatchFix?: boolean; parseInbandPrft?: boolean; enableManifestTimescaleMismatchFix?: boolean; capabilities?: { filterUnsupportedEssentialProperties?: boolean; supportedEssentialProperties?: [{ schemeIdUri?: string; value?: RegExp }]; useMediaCapabilitiesApi?: boolean; filterHDRMetadataFormatEssentialProperties?: boolean; filterVideoColorimetryEssentialProperties?: boolean; filterAudioChannelConfiguration?: boolean }; events?: { eventControllerRefreshDelay?: number; deleteEventMessageDataTimeout?: number }; timeShiftBuffer?: { calcFromSegmentTimeline?: boolean; fallbackToSegmentTimeline?: boolean }; metrics?: { maxListDepth?: number }; delay?: { liveDelayFragmentCount?: number; liveDelay?: number; useSuggestedPresentationDelay?: boolean }; protection?: { keepProtectionMediaKeys?: boolean; keepProtectionMediaKeysMaximumOpenSessions?: number; ignoreEmeEncryptedEvent?: boolean; detectPlayreadyMessageFormat?: boolean; ignoreKeyStatuses?: boolean }; buffer?: { enableSeekDecorrelationFix?: boolean; fastSwitchEnabled?: boolean; flushBufferAtTrackSwitch?: boolean; reuseExistingSourceBuffers?: boolean; bufferPruningInterval?: number; bufferToKeep?: number; bufferTimeAtTopQuality?: number; bufferTimeAtTopQualityLongForm?: number; initialBufferLevel?: number; bufferTimeDefault?: number; longFormContentDurationThreshold?: number; stallThreshold?: number; lowLatencyStallThreshold?: number; useAppendWindow?: boolean; setStallState?: boolean; avoidCurrentTimeRangePruning?: boolean; useChangeType?: boolean; mediaSourceDurationInfinity?: boolean; resetSourceBuffersForTrackSwitch?: boolean; syntheticStallEvents?: { enabled?: boolean; ignoreReadyState?: boolean } }; gaps?: { jumpGaps?: boolean; jumpLargeGaps?: boolean; smallGapLimit?: number; threshold?: number; enableSeekFix?: boolean; enableStallFix?: boolean; stallSeek?: number; seekOffset?: number }; utcSynchronization?: { enabled?: boolean; useManifestDateHeaderTimeSource?: boolean; backgroundAttempts?: number; timeBetweenSyncAttempts?: number; maximumTimeBetweenSyncAttempts?: number; minimumTimeBetweenSyncAttempts?: number; timeBetweenSyncAttemptsAdjustmentFactor?: number; maximumAllowedDrift?: number; enableBackgroundSyncAfterSegmentDownloadError?: boolean; defaultTimingSource?: { scheme?: string; value?: string }; artificialTimeOffsetToApply?: number }; scheduling?: { defaultTimeout?: number; lowLatencyTimeout?: number; scheduleWhilePaused?: boolean }; text?: { defaultEnabled?: boolean; dispatchForManualRendering?: boolean; extendSegmentedCues?: boolean; imsc?: { displayForcedOnlyMode?: boolean; enableRollUp?: boolean }; webvtt?: { customRenderingEnabled?: number } }; liveCatchup?: { maxDrift?: number; liveThreshold?: number; playbackRate?: { min?: number; max?: number }; playbackBufferMin?: number; enabled?: boolean; mode?: string; step?: { start: { min?: number; max?: number }; stop: { min?: number; max?: number } } }; lastBitrateCachingInfo?: { enabled?: boolean; ttl?: number }; lastMediaSettingsCachingInfo?: { enabled?: boolean; ttl?: number }; saveLastMediaSettingsForCurrentStreamingSession?: boolean; cacheLoadThresholds?: { video?: number; audio?: number }; trackSwitchMode?: { video?: TrackSwitchMode; audio?: TrackSwitchMode }; includePreselectionsInMediainfo?: boolean; includePreselectionsForInitialTrackSelection?: boolean; ignoreSelectionPriority?: boolean; prioritizeRoleMain?: boolean; assumeDefaultRoleAsMain?: boolean; selectionModeForInitialTrack?: TrackSelectionMode; blacklistExpiryTime?: number; fragmentRequestTimeout?: number; fragmentRequestProgressTimeout?: number; manifestRequestTimeout?: number; retryIntervals?: { MPD?: number; XLinkExpansion?: number; MediaSegment?: number; InitializationSegment?: number; BitstreamSwitchingSegment?: number; IndexSegment?: number; FragmentInfoSegment?: number; license?: number; licenseCertificate?: number; other?: number; lowLatencyReductionFactor?: number }; retryAttempts?: { MPD?: number; XLinkExpansion?: number; MediaSegment?: number; InitializationSegment?: number; BitstreamSwitchingSegment?: number; IndexSegment?: number; FragmentInfoSegment?: number; license?: number; licenseCertificate?: number; other?: number; lowLatencyMultiplyFactor?: number }; abr?: { limitBitrateByPortal?: boolean; usePixelRatioInLimitBitrateByPortal?: boolean; limitBitrateByPortalMinimum?: number; enableSupplementalPropertyAdaptationSetSwitching?: boolean; rules?: { throughputRule?: { active?: boolean }; bolaRule?: { active?: boolean }; insufficientBufferRule?: { active?: boolean; parameters?: { throughputSafetyFactor?: number; segmentIgnoreCount?: number } }; switchHistoryRule?: { active?: boolean; parameters?: { sampleSize?: number; switchPercentageThreshold?: number } }; droppedFramesRule?: { active?: boolean; parameters?: { minimumSampleSize?: number; droppedFramesPercentageThreshold?: number } }; abandonRequestsRule?: { active?: boolean; parameters?: { abandonDurationMultiplier?: number; minSegmentDownloadTimeThresholdInMs?: number; minThroughputSamplesThreshold?: number } }; l2ARule?: { active?: boolean }; loLPRule?: { active?: boolean } }; throughput?: { averageCalculationMode?: ThroughputCalculationModes; lowLatencyDownloadTimeCalculationMode?: LowLatencyDownloadTimeCalculationModes; useResourceTimingApi?: boolean; useNetworkInformationApi?: { xhr?: boolean; fetch?: boolean }; useDeadTimeLatency?: boolean; bandwidthSafetyFactor?: number; sampleSettings: { live?: number; vod?: number; enableSampleSizeAdjustment?: boolean; decreaseScale?: number; increaseScale?: number; maxMeasurementsToKeep?: number; averageLatencySampleAmount?: number }; ewma: { throughputSlowHalfLifeSeconds?: number; throughputFastHalfLifeSeconds?: number; latencySlowHalfLifeCount?: number; latencyFastHalfLifeCount?: number; weightDownloadTmeMultiplicationFactor?: number } }; maxBitrate?: { audio?: number; video?: number }; minBitrate?: { audio?: number; video?: number }; initialBitrate?: { audio?: number; video?: number }; autoSwitchBitrate?: { audio?: boolean; video?: boolean } }; cmcd?: { applyParametersFromMpd?: boolean; enabled?: boolean; sid?: string | null; cid?: string | null; rtp?: number | null; rtpSafetyFactor?: number; mode?: 'query' | 'header'; enabledKeys?: Array<string>; includeInRequests?: Array<string>; version?: number; eventTargets?: Array<{ enabled?: boolean; url?: string; events?: Array<string>; interval?: number; enabledKeys?: Array<string>; includeInRequests?: Array<string>; batchSize?: number }> }; cmsd?: { enabled?: boolean; abr?: { applyMb: boolean; etpWeightRatio?: number } }; defaultSchemeIdUri?: { viewpoint?: string; audioChannelConfiguration?: string; role?: string; accessibility?: string }; dvbReporting?: { reportingUrl?: string | null } } | undefined`
+
 ### Ref
 
 Forwards its ref to the rendered `<video>`. The ref is an [HTMLVideoElement](https://developer.mozilla.org/en-US/docs/Web/API/HTMLVideoElement) and exposes its complete native property and method API.