Add JSDoc for getDvrWindow

Dash-Industry-Forum · Dec 11, 2024 · 3720c9c · 3720c9c
1 parent 64f9e75
commit 3720c9c
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/src/streaming/MediaPlayer.js b/src/streaming/MediaPlayer.js
@@ -977,6 +977,10 @@ function MediaPlayer() {
         return t
     }
 
+    /**
+     * Returns information about the current DVR window including the start time, the end time, the window size.
+     * @returns {{startAsUtc: (*|number), size: number, endAsUtc: (*|number), start, end}|{}}
+     */
     function getDvrWindow() {
         if (!playbackInitialized) {
             throw PLAYBACK_NOT_INITIALIZED_ERROR;