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

package/docs/reference/hlsjs-video.md

@@ -42,7 +42,7 @@ Details
 
 `preload`
 
-`PreloadType`
+`MediaPreloadType`
 
 `'metadata'`
 
@@ -54,7 +54,7 @@ Preload type (`'none'` / `'metadata'` / `'auto'`).
 
 `source`
 
-`HlsSource | null`
+`{ src?: string; type?: SourceType; preferPlayback?: PlaybackType; drm?: DrmSystemsConfig; maxAutoResolution?: MediaResolution; capRenditionToPlayerSize?: boolean; minAutoResolution?: MediaResolution; engine?: HlsEngineConfig } | null`
 
 `null`
 
@@ -80,7 +80,7 @@ Media source URL. Assigning it replaces the identity half of `source` and leaves
 
 `streamType`
 
-`StreamType`
+`(typeof MediaStreamTypes)[keyof typeof MediaStreamTypes]`
 
 `'unknown'`
 
@@ -117,19 +117,19 @@ Details
 
 `abrBandWidthFactor`
 
-`number`
+`number | undefined`
 
 `abrBandWidthUpFactor`
 
-`number`
+`number | undefined`
 
 `abrController`
 
-`typeof AbrController`
+`typeof AbrController | undefined`
 
 `abrEwmaDefaultEstimate`
 
-`number`
+`number | undefined`
 
 ▸
 
@@ -139,135 +139,141 @@ Default bandwidth estimate in bits/s prior to collecting fragment bandwidth samp
 
 `abrEwmaDefaultEstimateMax`
 
-`number`
+`number | undefined`
 
 `abrEwmaFastLive`
 
-`number`
+`number | undefined`
 
 `abrEwmaFastVoD`
 
-`number`
+`number | undefined`
 
 `abrEwmaSlowLive`
 
-`number`
+`number | undefined`
 
 `abrEwmaSlowVoD`
 
-`number`
+`number | undefined`
 
 `abrMaxWithRealBitrate`
 
-`boolean`
+`boolean | undefined`
 
 `appendErrorMaxRetry`
 
-`number`
+`number | undefined`
 
 `assetPlayerId`
 
-`string`
+`string | undefined`
 
 `audioPreference`
 
-`AudioSelectionOption`
+`AudioSelectionOption | undefined`
 
 `audioStreamController`
 
-`typeof AudioStreamController`
+`typeof AudioStreamController | undefined`
 
 `audioTrackController`
 
-`typeof AudioTrackController`
+`typeof AudioTrackController | undefined`
 
 `autoStartLoad`
 
-`boolean`
+`boolean | undefined`
 
 `backBufferLength`
 
-`number`
+`number | undefined`
 
 `bufferController`
 
-`typeof BufferController`
+`typeof BufferController | undefined`
 
 `capLevelController`
 
-`typeof CapLevelController`
+`typeof CapLevelController | undefined`
 
 `capLevelOnFPSDrop`
 
-`boolean`
+`boolean | undefined`
 
 `capLevelToPlayerSize`
 
-`boolean`
+`boolean | undefined`
 
 `captionsTextTrack1Label`
 
-`string`
+`string | undefined`
 
 `captionsTextTrack1LanguageCode`
 
-`string`
+`string | undefined`
 
 `captionsTextTrack2Label`
 
-`string`
+`string | undefined`
 
 `captionsTextTrack2LanguageCode`
 
-`string`
+`string | undefined`
 
 `captionsTextTrack3Label`
 
-`string`
+`string | undefined`
 
 `captionsTextTrack3LanguageCode`
 
-`string`
+`string | undefined`
 
 `captionsTextTrack4Label`
 
-`string`
+`string | undefined`
 
 `captionsTextTrack4LanguageCode`
 
-`string`
+`string | undefined`
 
 `certLoadPolicy`
 
-`LoadPolicy`
+`LoadPolicy | undefined`
 
 `cmcd`
 
-`CMCDControllerConfig`
+`CMCDControllerConfig | undefined`
 
 `cmcdController`
 
-`typeof CMCDController`
+`typeof CMCDController | undefined`
 
 `contentSteeringController`
 
-`typeof ContentSteeringController`
+`typeof ContentSteeringController | un...`
+
+▸
+
+Type
+
+`typeof ContentSteeringController | undefined`
 
 `cueHandler`
 
-`CuesInterface`
+`CuesInterface | undefined`
 
 `debug`
 
-`boolean | ILogger`
+`boolean | ILogger | undefined`
 
 `defaultAudioCodec`
 
-`string`
+`string | undefined`
 
 `detectStallWithCurrentTimeMs`
 
-`number`
+`number | undefined`
 
 `drmSystemOptions`
 
@@ -275,423 +281,435 @@ Default bandwidth estimate in bits/s prior to collecting fragment bandwidth samp
 
 `drmSystems`
 
-`Partial<Record<KeySystems, DRMSystemC...`
-
-▸
-
-Type
-
-`Partial<Record<KeySystems, DRMSystemConfiguration>> | undefined`
+`DRMSystemsConfiguration | undefined`
 
 `emeController`
 
-`typeof EMEController`
+`typeof EMEController | undefined`
 
 `emeEnabled`
 
-`boolean`
+`boolean | undefined`
 
 `enableCEA708Captions`
 
-`boolean`
+`boolean | undefined`
 
 `enableDateRangeMetadataCues`
 
-`boolean`
+`boolean | undefined`
 
 `enableEmsgKLVMetadata`
 
-`boolean`
+`boolean | undefined`
 
 `enableEmsgMetadataCues`
 
-`boolean`
+`boolean | undefined`
 
 `enableID3MetadataCues`
 
-`boolean`
+`boolean | undefined`
 
 `enableIMSC1`
 
-`boolean`
+`boolean | undefined`
 
 `enableInterstitialPlayback`
 
-`boolean`
+`boolean | undefined`
 
 `enableSoftwareAES`
 
-`boolean`
+`boolean | undefined`
 
 `enableWebVTT`
 
-`boolean`
+`boolean | undefined`
 
 `enableWorker`
 
-`boolean`
+`boolean | undefined`
 
 `errorController`
 
-`typeof ErrorController`
+`typeof ErrorController | undefined`
 
 `fetchSetup`
 
-`function`
+`Request) | undefined | function`
 
 ▸
 
 Type
 
-`(context: LoaderContext, initParams: any) => Request | Promise<Request>`
+`((context: LoaderContext, initParams: any) => Promise<Request> | Request) | undefined`
 
 `fLoader`
 
-`FragmentLoaderConstructor`
+`FragmentLoaderConstructor | undefined`
 
 `forceKeyFrameOnDiscontinuity`
 
-`boolean`
+`boolean | undefined`
 
 `fpsController`
 
-`typeof FPSController`
+`typeof FPSController | undefined`
 
 `fpsDroppedMonitoringPeriod`
 
-`number`
+`number | undefined`
 
 `fpsDroppedMonitoringThreshold`
 
-`number`
+`number | undefined`
 
 `fragLoadingMaxRetry`
 
-`number`
+`number | undefined`
 
 `fragLoadingMaxRetryTimeout`
 
-`number`
+`number | undefined`
 
 `fragLoadingRetryDelay`
 
-`number`
+`number | undefined`
 
 `fragLoadingTimeOut`
 
-`number`
+`number | undefined`
 
 `fragLoadPolicy`
 
-`LoadPolicy`
+`LoadPolicy | undefined`
 
 `frontBufferFlushThreshold`
 
-`number`
+`number | undefined`
 
 `highBufferWatchdogPeriod`
 
-`number`
+`number | undefined`
 
 `ignoreDevicePixelRatio`
 
-`boolean`
+`boolean | undefined`
 
 `ignorePlaylistParsingErrors`
 
-`boolean`
+`boolean | undefined`
 
 `initialLiveManifestSize`
 
-`number`
+`number | undefined`
 
 `interstitialAppendInPlace`
 
-`boolean`
+`boolean | undefined`
 
 `interstitialAssetListLoadPolicy`
 
-`LoadPolicy`
+`LoadPolicy | undefined`
 
 `interstitialLiveLookAhead`
 
-`number`
+`number | undefined`
 
 `interstitialsController`
 
-`typeof InterstitialsController`
+`typeof InterstitialsController | unde...`
+
+▸
+
+Type
+
+`typeof InterstitialsController | undefined`
 
 `keyLoadPolicy`
 
-`LoadPolicy`
+`LoadPolicy | undefined`
 
 `levelLoadingMaxRetry`
 
-`number`
+`number | undefined`
 
 `levelLoadingMaxRetryTimeout`
 
-`number`
+`number | undefined`
 
 `levelLoadingRetryDelay`
 
-`number`
+`number | undefined`
 
 `levelLoadingTimeOut`
 
-`number`
+`number | undefined`
 
 `licenseResponseCallback`
 
-`function`
+`undefined | function`
 
 ▸
 
 Type
 
-`(this: Hls, xhr: XMLHttpRequest, url: string, keyContext: MediaKeySessionContext) => ArrayBuffer`
+`((this: Hls, xhr: XMLHttpRequest, url: string, keyContext: MediaKeySessionContext) => ArrayBuffer) | undefined`
 
 `licenseXhrSetup`
 
-`function`
+`Uint8Array | Promise<Uint8Array | void>) | undefined | function`
 
 ▸
 
 Type
 
-`(this: Hls, xhr: XMLHttpRequest, url: string, keyContext: MediaKeySessionContext, licenseChallenge: Uint8Array<ArrayBufferLike>) => void | ... 1 more ... | Promise<...>`
+`((this: Hls, xhr: XMLHttpRequest, url: string, keyContext: MediaKeySessionContext, licenseChallenge: Uint8Array) => void | Uint8Array | Promise<Uint8Array | void>) | undefined`
 
 `liveBackBufferLength`
 
-`number | null`
+`number | null | undefined`
 
 `liveDurationInfinity`
 
-`boolean`
+`boolean | undefined`
 
 `liveMaxLatencyDuration`
 
-`number`
+`number | undefined`
 
 `liveMaxLatencyDurationCount`
 
-`number`
+`number | undefined`
 
 `liveSyncDuration`
 
-`number`
+`number | undefined`
 
 `liveSyncDurationCount`
 
-`number`
+`number | undefined`
 
 `liveSyncMode`
 
-`"buffered" | "edge"`
+`'edge' | 'buffered' | undefined`
 
 `liveSyncOnStallIncrease`
 
-`number`
+`number | undefined`
 
 `loader`
 
-`function`
+`object`
 
 ▸
 
 Type
 
-`new (confg: HlsConfig) => Loader<LoaderContext>`
+`{ new (confg: HlsConfig): Loader<LoaderContext>; } | undefined`
 
 `lowLatencyMode`
 
-`boolean`
+`boolean | undefined`
 
 `manifestLoadingMaxRetry`
 
-`number`
+`number | undefined`
 
 `manifestLoadingMaxRetryTimeout`
 
-`number`
+`number | undefined`
 
 `manifestLoadingRetryDelay`
 
-`number`
+`number | undefined`
 
 `manifestLoadingTimeOut`
 
-`number`
+`number | undefined`
 
 `manifestLoadPolicy`
 
-`LoadPolicy`
+`LoadPolicy | undefined`
 
 `maxAudioFramesDrift`
 
-`number`
+`number | undefined`
 
 `maxBufferHole`
 
-`number`
+`number | undefined`
 
 `maxBufferLength`
 
-`number`
+`number | undefined`
 
 `maxBufferSize`
 
-`number`
+`number | undefined`
 
 `maxDevicePixelRatio`
 
-`number`
+`number | undefined`
 
 `maxFragLookUpTolerance`
 
-`number`
+`number | undefined`
 
 `maxLiveSyncPlaybackRate`
 
-`number`
+`number | undefined`
 
 `maxLoadingDelay`
 
-`number`
+`number | undefined`
 
 `maxMaxBufferLength`
 
-`number`
+`number | undefined`
 
 `maxStarvationDelay`
 
-`number`
+`number | undefined`
 
 `minAutoBitrate`
 
-`number`
+`number | undefined`
 
 `nudgeMaxRetry`
 
-`number`
+`number | undefined`
 
 `nudgeOffset`
 
-`number`
+`number | undefined`
 
 `nudgeOnVideoHole`
 
-`boolean`
+`boolean | undefined`
 
 `playlistLoadPolicy`
 
-`LoadPolicy`
+`LoadPolicy | undefined`
 
 `pLoader`
 
-`PlaylistLoaderConstructor`
+`PlaylistLoaderConstructor | undefined`
 
 `preferManagedMediaSource`
 
-`boolean`
+`boolean | undefined`
 
 `preserveManualLevelOnError`
 
-`boolean`
+`boolean | undefined`
 
 `primarySessionId`
 
-`string`
+`string | undefined`
 
 `progressive`
 
-`boolean`
+`boolean | undefined`
 
 `renderTextTracksNatively`
 
-`boolean`
+`boolean | undefined`
 
 `requestMediaKeySystemAccessFunc`
 
-`MediaKeyFunc | null`
+`MediaKeyFunc | null | undefined`
 
 `requireKeySystemAccessOnStart`
 
-`boolean`
+`boolean | undefined`
 
 `startFragPrefetch`
 
-`boolean`
+`boolean | undefined`
 
 `startLevel`
 
-`number`
+`number | undefined`
 
 `startOnSegmentBoundary`
 
-`boolean`
+`boolean | undefined`
 
 `startPosition`
 
-`number`
+`number | undefined`
 
 `steeringManifestLoadPolicy`
 
-`LoadPolicy`
+`LoadPolicy | undefined`
 
 `stretchShortVideoTrack`
 
-`boolean`
+`boolean | undefined`
 
 `subtitlePreference`
 
-`SubtitleSelectionOption`
+`SubtitleSelectionOption | undefined`
 
 `subtitleStreamController`
 
-`typeof SubtitleStreamController`
+`typeof SubtitleStreamController | und...`
+
+▸
+
+Type
+
+`typeof SubtitleStreamController | undefined`
 
 `subtitleTrackController`
 
-`typeof SubtitleTrackController`
+`typeof SubtitleTrackController | unde...`
+
+▸
+
+Type
+
+`typeof SubtitleTrackController | undefined`
 
 `testBandwidth`
 
-`boolean`
+`boolean | undefined`
 
 `timelineController`
 
-`typeof TimelineController`
+`typeof TimelineController | undefined`
 
 `timelineOffset`
 
-`number`
+`number | undefined`
 
 `useMediaCapabilities`
 
-`boolean`
+`boolean | undefined`
 
 `videoPreference`
 
-`VideoSelectionOption`
+`VideoSelectionOption | undefined`
 
 `widevineLicenseUrl`
 
-`string`
+`string | undefined`
 
 `workerPath`
 
-`string | null`
+`string | null | undefined`
 
 `xhrSetup`
 
-`function`
+`void) | undefined | function`
 
 ▸
 
 Type
 
-`(xhr: XMLHttpRequest, url: string) => void | Promise<void>`
+`((xhr: XMLHttpRequest, url: string) => Promise<void> | void) | undefined`
 
 #### `source.engine.nativeHls`