Skip to content

Expose additional metrics for low latency #387

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 13 commits into from
May 20, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .releasinator.json
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,4 @@
"displayPattern": "$.$.$",
"enforceUserFacingLabel": false,
"projectType": "npm-like"
}
}
12 changes: 11 additions & 1 deletion src/playbackstrategy/msestrategy.js
Original file line number Diff line number Diff line change
Expand Up @@ -85,6 +85,7 @@ function MSEStrategy(
},
playbackBitrate: undefined,
bufferLength: undefined,
latency: undefined,
fragmentInfo: {
requestTime: undefined,
numDownloaded: undefined,
Expand Down Expand Up @@ -115,6 +116,7 @@ function MSEStrategy(
QUOTA_EXCEEDED: "quotaExceeded",
TEXT_TRACKS_ADDED: "allTextTracksAdded",
CURRENT_TRACK_CHANGED: "currentTrackChanged",
PLAYBACK_RATE_CHANGED: "playbackRateChanged",
}

function onLoadedMetaData() {
Expand Down Expand Up @@ -344,6 +346,7 @@ function MSEStrategy(
Plugins.interface.onPlayerInfoUpdated({
bufferLength: playerMetadata.bufferLength,
playbackBitrate: playerMetadata.playbackBitrate,
latency: playerMetadata.latency,
})
}

Expand Down Expand Up @@ -480,11 +483,13 @@ function MSEStrategy(
dashMetrics = mediaPlayer.getDashMetrics()

if (dashMetrics) {
playerMetadata.latency = mediaPlayer.getCurrentLiveLatency()
playerMetadata.bufferLength = dashMetrics.getCurrentBufferLevel(event.mediaType)
DebugTool.staticMetric("buffer-length", playerMetadata.bufferLength)
Plugins.interface.onPlayerInfoUpdated({
bufferLength: playerMetadata.bufferLength,
playbackBitrate: playerMetadata.playbackBitrate,
latency: playerMetadata.latency,
})
}
}
Expand Down Expand Up @@ -692,6 +697,11 @@ function MSEStrategy(
mediaPlayer.on(DashJSEvents.TEXT_TRACKS_ADDED, handleTextTracks)
mediaPlayer.on(DashJSEvents.MANIFEST_LOADING_FINISHED, manifestLoadingFinished)
mediaPlayer.on(DashJSEvents.CURRENT_TRACK_CHANGED, onCurrentTrackChanged)
mediaPlayer.on(DashJSEvents.PLAYBACK_RATE_CHANGED, onPlaybackRateChanged)
}

function onPlaybackRateChanged(event) {
Plugins.interface.onPlaybackRateChanged(event)
}

function handleTextTracks() {
Expand Down Expand Up @@ -880,7 +890,7 @@ function MSEStrategy(
mediaPlayer.off(DashJSEvents.GAP_JUMP_TO_END, onGapJump)
mediaPlayer.off(DashJSEvents.QUOTA_EXCEEDED, onQuotaExceeded)
mediaPlayer.off(DashJSEvents.CURRENT_TRACK_CHANGED, onCurrentTrackChanged)

mediaPlayer.off(DashJSEvents.PLAYBACK_RATE_CHANGED, onPlaybackRateChanged)
mediaPlayer = undefined
}

Expand Down
1 change: 1 addition & 0 deletions src/playbackstrategy/msestrategy.test.js
Original file line number Diff line number Diff line change
Expand Up @@ -646,6 +646,7 @@ describe("Media Source Extensions Playback Strategy", () => {

expect(Plugins.interface.onPlayerInfoUpdated).toHaveBeenCalledWith({
playbackBitrate: undefined,
latency: undefined,
bufferLength: 15,
})
})
Expand Down
1 change: 1 addition & 0 deletions src/plugins.js
Original file line number Diff line number Diff line change
Expand Up @@ -50,5 +50,6 @@ export default {
onSubtitlesDynamicLoadError: (evt) => callOnAllPlugins("onSubtitlesDynamicLoadError", evt),
onFragmentContentLengthMismatch: (evt) => callOnAllPlugins("onFragmentContentLengthMismatch", evt),
onQuotaExceeded: (evt) => callOnAllPlugins("onQuotaExceeded", evt),
onPlaybackRateChanged: (evt) => callOnAllPlugins("onPlaybackRateChanged", evt),
},
}