feat(UI): Add config for refreshTickInSeconds (#6386)

Closes #6376 --------- Co-authored-by: Álvaro Velad Galván <ladvan91@hotmail.com>
shaka-project · Apr 3, 2024 · dbdef5d · dbdef5d
1 parent 7e32636
commit dbdef5d
Show file tree

Hide file tree

Showing 5 changed files with 9 additions and 2 deletions.
diff --git a/AUTHORS b/AUTHORS
@@ -59,6 +59,7 @@ JW Player <*@jwplayer.com>
 Konstantin Grushetsky <github@grushetsky.net>
 Lucas Gabriel Sánchez <unkiwii@gmail.com>
 Martin Stark <martin.stark@eyevinn.se>
+Mariano Facundo Scigliano <mfacundo94@gmail.com>
 Matthias Van Parijs <matvp91@gmail.com>
 Mattias Wadman <mattias.wadman@gmail.com>
 Mirego <*@mirego.com>

diff --git a/CONTRIBUTORS b/CONTRIBUTORS
@@ -88,6 +88,7 @@ Leandro Ribeiro Moreira <leandro.ribeiro.moreira@gmail.com>
 Loïc Raux <loicraux@gmail.com>
 Lucas Gabriel Sánchez <unkiwii@gmail.com>
 Martin Stark <martin.stark@eyevinn.se>
+Mariano Facundo Scigliano <mfacundo94@gmail.com>
 Matias Russitto <russitto@gmail.com>
 Mathieu Côté <mcote@mirego.com>
 Matthias Van Parijs <matvp91@gmail.com>

diff --git a/ui/controls.js b/ui/controls.js
@@ -187,7 +187,7 @@ shaka.ui.Controls = class extends shaka.util.FakeEventTarget {
     this.onCastStatusChange_();
 
     // Start this timer after we are finished initializing everything,
-    this.timeAndSeekRangeTimer_.tickEvery(/* seconds= */ 0.125);
+    this.timeAndSeekRangeTimer_.tickEvery(this.config_.refreshTickInSeconds);
 
     this.eventManager_.listen(this.localization_,
         shaka.ui.Localization.LOCALE_CHANGED, (e) => {

diff --git a/ui/externs/ui.js b/ui/externs/ui.js
@@ -92,7 +92,8 @@ shaka.extern.UIVolumeBarColors;
  *   preferDocumentPictureInPicture: boolean,
  *   showAudioChannelCountVariants: boolean,
  *   seekOnTaps: boolean,
- *   tapSeekDistance: number
+ *   tapSeekDistance: number,
+ *   refreshTickInSeconds: number
  * }}
  *
  * @property {!Array.<string>} controlPanelElements
@@ -228,6 +229,9 @@ shaka.extern.UIVolumeBarColors;
  *   right part of the video. If less than or equal to 0,
  *   no seeking will occur.
  *   Defaults to 10 seconds.
+ * @property {number} refreshTickInSeconds
+ *   The time interval, in seconds, to update the seek bar.
+ *   Defaults to 0.125 seconds.
  * @exportDoc
  */
 shaka.extern.UIConfiguration;

diff --git a/ui/ui.js b/ui/ui.js
@@ -250,6 +250,7 @@ shaka.ui.Overlay = class {
       showAudioChannelCountVariants: true,
       seekOnTaps: true,
       tapSeekDistance: 10,
+      refreshTickInSeconds: 0.125,
     };
 
     // eslint-disable-next-line no-restricted-syntax