(misc) fixing incorrect default config values in API.md (video-dev#2184)

Biswaranjanp · Mar 27, 2019 · 592860f · 592860f
1 parent cc46ea0
commit 592860f
Showing 1 changed file with 27 additions and 15 deletions.
diff --git a/docs/API.md b/docs/API.md
@@ -296,8 +296,9 @@ Configuration parameters could be provided to hls.js upon instantiation of `Hls`
    var config = {
       autoStartLoad: true,
       startPosition: -1,
-      capLevelToPlayerSize: false,
       debug: false,
+      capLevelOnFPSDrop: false,
+      capLevelToPlayerSize: false,
       defaultAudioCodec: undefined,
       initialLiveManifestSize: 1,
       maxBufferLength: 30,
@@ -308,46 +309,57 @@ Configuration parameters could be provided to hls.js upon instantiation of `Hls`
       highBufferWatchdogPeriod: 3,
       nudgeOffset: 0.1,
       nudgeMaxRetry: 3,
-      maxFragLookUpTolerance: 0.2,
+      maxFragLookUpTolerance: 0.25,
       liveSyncDurationCount: 3,
-      liveMaxLatencyDurationCount: 10,
+      liveMaxLatencyDurationCount: Infinity,
       enableWorker: true,
       enableSoftwareAES: true,
       manifestLoadingTimeOut: 10000,
       manifestLoadingMaxRetry: 1,
-      manifestLoadingRetryDelay: 500,
+      manifestLoadingRetryDelay: 1000,
       manifestLoadingMaxRetryTimeout: 64000,
       startLevel: undefined,
       levelLoadingTimeOut: 10000,
       levelLoadingMaxRetry: 4,
-      levelLoadingRetryDelay: 500,
+      levelLoadingRetryDelay: 1000,
       levelLoadingMaxRetryTimeout: 64000,
       fragLoadingTimeOut: 20000,
       fragLoadingMaxRetry: 6,
-      fragLoadingRetryDelay: 500,
+      fragLoadingRetryDelay: 1000,
       fragLoadingMaxRetryTimeout: 64000,
       startFragPrefetch: false,
+      fpsDroppedMonitoringPeriod: 5000,
+      fpsDroppedMonitoringThreshold: 0.2,
       appendErrorMaxRetry: 3,
       loader: customLoader,
       fLoader: customFragmentLoader,
       pLoader: customPlaylistLoader,
       xhrSetup: XMLHttpRequestSetupCallback,
       fetchSetup: FetchSetupCallback,
-      abrController: customAbrController,
+      abrController: AbrController,
+      bufferController: BufferController,
+      capLevelController: CapLevelController,
+      fpsController: FPSController,
       timelineController: TimelineController,
       enableWebVTT: true,
       enableCEA708Captions: true,
       stretchShortVideoTrack: false,
       maxAudioFramesDrift: 1,
       forceKeyFrameOnDiscontinuity: true,
-      abrEwmaFastLive: 5.0,
+      abrEwmaFastLive: 3.0,
       abrEwmaSlowLive: 9.0,
-      abrEwmaFastVoD: 4.0,
-      abrEwmaSlowVoD: 15.0,
+      abrEwmaFastVoD: 3.0,
+      abrEwmaSlowVoD: 9.0,
       abrEwmaDefaultEstimate: 500000,
       abrBandWidthFactor: 0.95,
       abrBandWidthUpFactor: 0.7,
-      minAutoBitrate: 0
+      abrMaxWithRealBitrate: false,
+      maxStarvationDelay: 4,
+      maxLoadingDelay: 4,
+      minAutoBitrate: 0,
+      emeEnabled: false,
+      widevineLicenseUrl: undefined,
+      requestMediaKeySystemAccessFunc: requestMediaKeySystemAccess
   };
 
   var hls = new Hls(config);
@@ -464,7 +476,7 @@ Max nb of nudge retries before hls.js raise a fatal BUFFER_STALLED_ERROR
 
 ### `maxFragLookUpTolerance`
 
-(default 0.2s)
+(default 0.25s)
 
 This tolerance factor is used during fragment lookup.
 Instead of checking whether buffered.end is located within [start, end] range, frag lookup will be done by checking  within [start-maxFragLookUpTolerance, end-maxFragLookUpTolerance] range.
@@ -898,7 +910,7 @@ parameter should be a boolean
 
 ### `abrEwmaFastLive`
 
-(default: `5.0`)
+(default: `3.0`)
 
 Fast bitrate Exponential moving average half-life, used to compute average bitrate for Live streams.
 Half of the estimate is based on the last abrEwmaFastLive seconds of sample history.
@@ -918,7 +930,7 @@ parameter should be a float greater than [abrEwmaFastLive](#abrewmafastlive)
 
 ### `abrEwmaFastVoD`
 
-(default: `4.0`)
+(default: `3.0`)
 
 Fast bitrate Exponential moving average half-life, used to compute average bitrate for VoD streams.
 Half of the estimate is based on the last abrEwmaFastVoD seconds of sample history.
@@ -928,7 +940,7 @@ parameter should be a float greater than 0
 
 ### `abrEwmaSlowVoD`
 
-(default: `15.0`)
+(default: `9.0`)
 
 Slow bitrate Exponential moving average half-life, used to compute average bitrate for VoD streams.
 Half of the estimate is based on the last abrEwmaSlowVoD seconds of sample history.