docs: abr configuration (#447)

`abr` configuration and some fixes
kaltura · Sep 13, 2020 · 14329ba · 14329ba
1 parent 2225a86
commit 14329ba
Showing 1 changed file with 97 additions and 20 deletions.
diff --git a/docs/configuration.md b/docs/configuration.md
@@ -81,9 +81,16 @@ var config = {
     ]
   },
   abr: {
+    enabled: true,
     fpsDroppedFramesInterval: 5000,
     fpsDroppedMonitoringThreshold: 0.2,
-    capLevelOnFPSDrop: true
+    capLevelOnFPSDrop: true,
+    capLevelToPlayerSize: false,
+    defaultBandwidthEstimate: 500e3,
+    restrictions: {
+      minBitrate: 0,
+      maxBitrate: Infinity
+    }
   },
   drm: {
     keySystem: ''
@@ -128,7 +135,7 @@ var config = {
 
 > ### config.sources
 >
-> ##### Type: `PKSourcesConfig`
+> ##### Type: `PKSourcesConfigObject`
 >
 > ```js
 > {
@@ -453,7 +460,7 @@ var config = {
 
 > ### config.playback
 >
-> ##### Type: `PKPlaybackConfig`
+> ##### Type: `PKPlaybackConfigObject`
 >
 > ```js
 > {
@@ -1235,53 +1242,125 @@ var config = {
 >
 > ```js
 > {
->  fpsDroppedMonitoringThreshold: number,
->  fpsDroppedFramesInterval: number,
->  capLevelOnFPSDrop: boolean
+>   enabled: boolean,
+>   fpsDroppedFramesInterval: number,
+>   fpsDroppedMonitoringThreshold: number,
+>   capLevelOnFPSDrop: boolean,
+>   capLevelToPlayerSize: boolean,
+>   defaultBandwidthEstimate: number,
+>   restrictions: {
+>     minBitrate: number,
+>     maxBitrate: number
+>   }
 > }
 > ```
 >
 > ##### Default:
 >
 > ```js
 > {
->  fpsDroppedMonitoringThreshold: 0.2,
->  fpsDroppedFramesInterval: 5000,
->  capLevelOnFPSDrop: true
+>   enabled: true,
+>   fpsDroppedFramesInterval: 5000,
+>   fpsDroppedMonitoringThreshold: 0.2,
+>   capLevelOnFPSDrop: true,
+>   capLevelToPlayerSize: false,
+>   defaultBandwidthEstimate: 500e3,
+>   restrictions: {
+>     minBitrate: 0,
+>     maxBitrate: Infinity
+>   }
 > }
 > ```
 >
-> ##### Description: Specifies flags to control / restrict the abr mechanism.
+> ##### Description: Specifies flags to control / restrict the ABR mechanism.
 >
+> > ### config.abr.enabled
+> >
+> > ##### Type: `boolean`
+> >
+> > ##### Default: `true`
+> >
+> > ##### Description: Whether the ABR mechanism is enabled.
+> >
+> > ##
+> >
 > > ### config.abr.fpsDroppedFramesInterval
 > >
 > > ##### Type: `number`
 > >
 > > ##### Default: `5000`
 > >
 > > ##### Description: Interval time in milliseconds to check if too many frames are dropped
->
-> ##
->
+> >
+> > ##
+> >
 > > ### config.abr.fpsDroppedMonitoringThreshold
 > >
 > > ##### Type: `number`
 > >
 > > ##### Default: `0.2`
 > >
 > > ##### Description: The allowed frames dropped threshold.
->
-> ##
->
+> >
+> > ##
+> >
 > > ### config.abr.capLevelOnFPSDrop
 > >
 > > ##### Type: `boolean`
 > >
 > > ##### Default: true
 > >
 > > ##### Description: If the player should cap the level when the fps exceeds the threshold.
->
-> ##
+> >
+> > ##
+> >
+> > ### config.abr.capLevelToPlayerSize
+> >
+> > ##### Type: `boolean`
+> >
+> > ##### Default: false
+> >
+> > ##### Description: If the player should cap the level to the player dimensions (width and height).
+> >
+> > ##
+> >
+> > ### config.abr.defaultBandwidthEstimate
+> >
+> > ##### Type: `number`
+> >
+> > ##### Default: 500000
+> >
+> > ##### Description: The default bandwidth estimate to use if there is not enough data, in bit/sec.                       
+> >
+> > ##
+> >
+> > ### config.abr.restrictions
+> >
+> > ##### Type: `object`
+> >
+> > ##### Default: `{}`
+> >
+> > ##### Description: The restrictions to apply to ABR decisions.
+> >
+> > ##
+> >
+> > > ### config.abr.restrictions.minBitrate
+> > >
+> > > ##### Type: `number`
+> > >
+> > > ##### Default: `0`
+> > >
+> > > ##### Description: The minimum bitrate in bit/sec.
+> > >
+> > > ##
+> > >
+> > > ### config.abr.restrictions.maxBitrate
+> > >
+> > > ##### Type: `number`
+> > >
+> > > ##### Default: `Infinity`
+> > >
+> > > ##### Description: The maximum bitrate in bit/sec.
 
 ##
 
@@ -1304,8 +1383,6 @@ var config = {
 > > ##### Default: ``
 > >
 > > ##### Description: A specific DRM key system to use.
->
-> ##
 
 ##