eyevinn-channel-engine 3.3.2 → 3.3.3

package/README.md

@@ -109,6 +109,7 @@ Available options when constructing the Channel Engine object are:
 - `cloudWatchMetrics`: Output CloudWatch JSON metrics on console log. Default is false.
 - `useDemuxedAudio`: Enable playing VODs with multiple audio tracks. Default is false.
 - `alwaysNewSegments`: Force all new HLS media sequences to always contain at least 1 new segment. Default is false.
+- `diffCompensationRate`: The rate for how much time is added on each sequence to slow down the playhead until it is back on schedule. Default is 0.5 (delay with half a segment duration).
 
 ## High Availability
 

package/engine/server.js

@@ -109,6 +109,9 @@ class ChannelEngine {
     if (options && options.forceTargetDuration) {
       this.streamerOpts.forceTargetDuration = options.forceTargetDuration;
     }
+    if (options && options.diffCompensationRate) {
+      this.streamerOpts.diffCompensationRate = options.diffCompensationRate;
+    }
     const handleMasterRoute = async (req, res, next) => {
       debug(req.params);
       let m;
@@ -237,6 +240,7 @@ class ChannelEngine {
         maxTickInterval: channel.options && channel.options.maxTickInterval ? channel.options.maxTickInterval : this.streamerOpts.defaultMaxTickInterval,
         targetDurationPadding: channel.options && channel.options.targetDurationPadding ? channel.options.targetDurationPadding : this.streamerOpts.targetDurationPadding,
         forceTargetDuration: channel.options && channel.options.forceTargetDuration ? channel.options.forceTargetDuration : this.streamerOpts.forceTargetDuration,
+        diffCompensationRate: channel.options && channel.options.diffCompensationRate ? channel.options.diffCompensationRate : this.streamerOpts.diffCompensationRate,
         profile: channel.profile,
         audioTracks: channel.audioTracks,
         closedCaptions: channel.closedCaptions,
@@ -454,6 +458,7 @@ class ChannelEngine {
       options.maxTickInterval = this.streamerOpts.defaultMaxTickInterval;
       options.targetDurationPadding = this.streamerOpts.targetDurationPadding;
       options.forceTargetDuration = this.streamerOpts.forceTargetDuration;
+      options.diffCompensationRate = this.streamerOpts.diffCompensationRate;
       // if we are initiating a master manifest
       // outside of specific Channel context,
       // if slate options are set at the ChannelEngine level, then set these here

package/engine/session.js

@@ -15,7 +15,7 @@ const ChaosMonkey = require('./chaos_monkey.js');
 const AVERAGE_SEGMENT_DURATION = 3000;
 const DEFAULT_PLAYHEAD_DIFF_THRESHOLD = 1000;
 const DEFAULT_MAX_TICK_INTERVAL = 10000;
-const DIFF_CORRECTION_RATE = 0.5;
+const DEFAULT_DIFF_COMPENSATION_RATE = 0.5;
 
 const timer = ms => new Promise(res => setTimeout(res, ms));
 
@@ -43,6 +43,7 @@ class Session {
     this.cloudWatchLogging = false;
     this.playheadDiffThreshold = DEFAULT_PLAYHEAD_DIFF_THRESHOLD;
     this.maxTickInterval = DEFAULT_MAX_TICK_INTERVAL;
+    this.diffCompensationRate = DEFAULT_DIFF_COMPENSATION_RATE;
     this.diffCompensation = null;
     this.timePositionOffset = 0;
     this.prevVodMediaSeq = {
@@ -119,6 +120,9 @@ class Session {
       if (config.forceTargetDuration) {
         this.forceTargetDuration = config.forceTargetDuration;
       }
+      if (config.diffCompensationRate) {
+        this.diffCompensationRate = config.diffCompensationRate;
+      }
     }
   }
 
@@ -213,7 +217,7 @@ class Session {
             }
           // Apply external diff compensation if available.
           if (this.diffCompensation && this.diffCompensation > 0) {
-            const DIFF_COMPENSATION = (reqTickInterval * DIFF_CORRECTION_RATE).toFixed(2) * 1000;
+            const DIFF_COMPENSATION = (reqTickInterval * this.diffCompensationRate).toFixed(2) * 1000;
             debug(`[${this._sessionId}]: Adding ${DIFF_COMPENSATION}msec to tickInterval to compensate for schedule diff (current=${this.diffCompensation}msec)`);
             tickInterval += (DIFF_COMPENSATION / 1000);
             this.diffCompensation -= DIFF_COMPENSATION;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eyevinn-channel-engine",
-  "version": "3.3.2",
+  "version": "3.3.3",
   "description": "OTT TV Channel Engine",
   "main": "index.js",
   "scripts": {