Add a settings parameter for the EventController.js refresh delay

index.d.ts

@@ -138,7 +138,8 @@ declare namespace dashjs {
             useAppendWindow?: boolean,
             manifestUpdateRetryInterval?: number;
             stallThreshold?: number;
-            filterUnsupportedEssentialProperties?: true
+            filterUnsupportedEssentialProperties?: boolean;
+            eventControllerRefreshDelay?: number;
             utcSynchronization?: {
                 backgroundAttempts?: number,
                 timeBetweenSyncAttempts?: number,

src/core/Settings.js

@@ -82,6 +82,7 @@ import {HTTPRequest} from '../streaming/vo/metrics/HTTPRequest';
  *          manifestUpdateRetryInterval: 100,
  *          stallThreshold: 0.5,
  *          filterUnsupportedEssentialProperties: true,
+ *          eventControllerRefreshDelay: 100,
  *          utcSynchronization: {
  *              backgroundAttempts: 2,
  *              timeBetweenSyncAttempts: 30,
@@ -364,6 +365,8 @@ import {HTTPRequest} from '../streaming/vo/metrics/HTTPRequest';
  * Stall threshold used in BufferController.js to determine whether a track should still be changed and which buffer range to prune.
  * @property {boolean} [filterUnsupportedEssentialProperties=true]
  * Enable to filter all the AdaptationSets and Representations which contain an unsupported \<EssentialProperty\> element.
+ * @property {number} [eventControllerRefreshDelay=100]
+ * Defines the delay in milliseconds between two consecutive checks for events to be fired.
  * @property {module:Settings~UtcSynchronizationSettings} utcSynchronization Settings related to UTC clock synchronization
  * @property {module:Settings~LiveCatchupSettings} liveCatchup  Settings related to live catchup.
  * @property {module:Settings~CachingInfoSettings} [lastBitrateCachingInfo={enabled: true, ttl: 360000}]
@@ -627,6 +630,7 @@ function Settings() {
             manifestUpdateRetryInterval: 100,
             stallThreshold: 0.5,
             filterUnsupportedEssentialProperties: true,
+            eventControllerRefreshDelay: 100,
             utcSynchronization: {
                 backgroundAttempts: 2,
                 timeBetweenSyncAttempts: 30,

src/streaming/controllers/EventController.js

@@ -43,7 +43,6 @@ function EventController() {
     const MPD_CALLBACK_SCHEME = 'urn:mpeg:dash:event:callback:2015';
     const MPD_CALLBACK_VALUE = 1;
 
-    const REFRESH_DELAY = 100;
     const REMAINING_EVENTS_THRESHOLD = 300;
 
     const EVENT_HANDLED_STATES = {
@@ -63,6 +62,7 @@ function EventController() {
         lastEventTimerCall,
         manifestUpdater,
         playbackController,
+        settings,
         eventHandlingInProgress,
         isStarted;
 
@@ -118,9 +118,10 @@ function EventController() {
         try {
             checkConfig();
             logger.debug('Start Event Controller');
-            if (!isStarted && !isNaN(REFRESH_DELAY)) {
+            const refreshDelay = settings.get().streaming.eventControllerRefreshDelay;
+            if (!isStarted && !isNaN(refreshDelay)) {
                 isStarted = true;
-                eventInterval = setInterval(_onEventTimer, REFRESH_DELAY);
+                eventInterval = setInterval(_onEventTimer, refreshDelay);
             }
         } catch (e) {
             throw e;
@@ -504,14 +505,16 @@ function EventController() {
             if (!config) {
                 return;
             }
-
             if (config.manifestUpdater) {
                 manifestUpdater = config.manifestUpdater;
             }
-
             if (config.playbackController) {
                 playbackController = config.playbackController;
             }
+            if (config.settings) {
+                settings = config.settings;
+            }
+
         } catch (e) {
             throw e;
         }

src/streaming/controllers/StreamController.js

@@ -131,7 +131,8 @@ function StreamController() {
         eventController = EventController(context).getInstance();
         eventController.setConfig({
             manifestUpdater: manifestUpdater,
-            playbackController: playbackController
+            playbackController: playbackController,
+            settings
         });
         eventController.start();
 

test/unit/streaming.controllers.EventController.js

@@ -3,6 +3,7 @@ import EventBus from '../../src/core/EventBus';
 import MediaPlayerEvents from '../../src/streaming/MediaPlayerEvents';
 import PlaybackControllerMock from './mocks/PlaybackControllerMock';
 import ManifestUpdaterMock from './mocks/ManifestUpdaterMock';
+import Settings from '../../src/core/Settings';
 
 const expect = require('chai').expect;
 const context = {};
@@ -13,6 +14,7 @@ describe('EventController', function () {
 
     let manifestUpdaterMock = new ManifestUpdaterMock();
     let playbackControllerMock = new PlaybackControllerMock();
+    const settings = Settings(context).getInstance();
 
     const manifestExpiredEventStub = {
         'duration': 0,
@@ -58,7 +60,8 @@ describe('EventController', function () {
             eventController.reset();
             eventController.setConfig({
                 manifestUpdater: manifestUpdaterMock,
-                playbackController: playbackControllerMock
+                playbackController: playbackControllerMock,
+                settings
             });
         });