-
Notifications
You must be signed in to change notification settings - Fork 7.4k
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
feat: Add mediasession support #8309
Open
mister-ben
wants to merge
20
commits into
videojs:main
Choose a base branch
from
mister-ben:feat-mediasession
base: main
Could not load branches
Branch not found: {{ refName }}
Could not load tags
Nothing to show
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
20 commits
Select commit
Hold shift + click to select a range
4467521
feat: Add mediasession support
mister-ben 768ef78
Merge branch 'main' into feat-mediasession
mister-ben 9be74c3
move to separate file
mister-ben 232e021
Merge branch 'main' into feat-mediasession
mister-ben aa076f4
add type
mister-ben 2b2d856
Merge branch 'main' into feat-mediasession
mister-ben c9bd625
mock test
mister-ben b9c3aa6
guard against non finite duration
mister-ben b67a9ee
more tests
mister-ben 2a10d09
always need to wait for playlist
mister-ben 8a659d2
more tests
mister-ben 16bf589
repush
mister-ben d892c16
lint
mister-ben 5314f5d
lint
mister-ben 6332b13
more test coverage
mister-ben 662989b
test handlers to incresase coverage
mister-ben 4136a53
Merge branch 'main' into feat-mediasession
mister-ben 43536f0
fix playlist handler test
mister-ben e6c541c
Merge branch 'main' into feat-mediasession
mister-ben b249c67
Apply suggestions from code review
mister-ben File filter
Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,132 @@ | ||
import window from 'global/window'; | ||
import {getMimetype} from './utils/mimetypes'; | ||
|
||
/** | ||
* @method initMediaSession Sets up media session if supported and configured | ||
* @this { import('./player').default } Player | ||
*/ | ||
export const initMediaSession = function() { | ||
if (!this.options_.mediaSession || !('mediaSession' in window.navigator)) { | ||
return; | ||
} | ||
const ms = window.navigator.mediaSession; | ||
const defaultSkipTime = 15; | ||
|
||
const actionHandlers = [ | ||
['play', () => { | ||
this.play(); | ||
}], | ||
['pause', () => { | ||
this.pause(); | ||
}], | ||
['stop', () => { | ||
this.pause(); | ||
this.currentTime(0); | ||
}], | ||
// videojs-contrib-ads | ||
['seekbackward', (details) => { | ||
if (this.usingPlugin('ads') && this.ads.inAdBreak()) { | ||
return; | ||
} | ||
this.currentTime(Math.max(0, this.currentTime() - (details.skipOffset || defaultSkipTime))); | ||
}], | ||
['seekforward', (details) => { | ||
if (this.usingPlugin('ads') && this.ads.inAdBreak()) { | ||
return; | ||
} | ||
this.currentTime(Math.min(this.duration(), this.currentTime() + (details.skipOffset || defaultSkipTime))); | ||
}], | ||
['seekto', (details) => { | ||
if (this.usingPlugin('ads') && this.ads.inAdBreak()) { | ||
return; | ||
} | ||
this.currentTime(details.seekTime); | ||
}] | ||
]; | ||
|
||
// Using Google's recommendation that expects some handler may not be settable, especially as we | ||
// want to support older Chrome | ||
// https://web.dev/media-session/#let-users-control-whats-playing | ||
for (const [action, handler] of actionHandlers) { | ||
try { | ||
ms.setActionHandler(action, handler); | ||
} catch (error) { | ||
this.log.debug(`Couldn't register media session action "${action}".`); | ||
} | ||
} | ||
|
||
const setUpMediaSessionPlaylist = () => { | ||
try { | ||
ms.setActionHandler('previoustrack', () => { | ||
this.playlist.previous(); | ||
}); | ||
ms.setActionHandler('nexttrack', () => { | ||
this.playlist.next(); | ||
}); | ||
} catch (error) { | ||
this.log.debug('Couldn\'t register playlist media session actions.'); | ||
} | ||
}; | ||
|
||
// Only setup playlist handlers if / when playlist plugin is present | ||
this.on('pluginsetup:playlist', setUpMediaSessionPlaylist); | ||
|
||
/** | ||
* | ||
* Updates the mediaSession metadata. Fires `updatemediasession` as an | ||
* opportunity to modify the metadata | ||
* | ||
* @fires Player#updatemediasession | ||
*/ | ||
const updateMediaSession = () => { | ||
const currentMedia = this.getMedia(); | ||
const playlistItem = this.usingPlugin('playlist') ? Object.assign({}, this.playlist()[this.playlist.currentItem()]) : {}; | ||
const mediaSessionData = { | ||
title: currentMedia.title || playlistItem.name || '', | ||
artist: currentMedia.artist || playlistItem.artist || '', | ||
album: currentMedia.album || playlistItem.album || '' | ||
}; | ||
|
||
if (currentMedia.artwork) { | ||
mediaSessionData.artwork = currentMedia.artwork; | ||
} else if (playlistItem.artwork) { | ||
mediaSessionData.artwork = playlistItem.artwork; | ||
} else if (this.poster()) { | ||
mediaSessionData.artwork = [{ | ||
src: this.poster(), | ||
type: getMimetype(this.poster()) | ||
}]; | ||
} | ||
|
||
// This allows the metadata to be updated before being set, e.g. if loadMedia() is not used. | ||
this.trigger('updatemediasession', mediaSessionData); | ||
|
||
ms.metadata = new window.MediaMetadata(mediaSessionData); | ||
}; | ||
|
||
const updatePositionState = () => { | ||
const dur = parseFloat(this.duration()); | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Question, is there a case that requires a There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. That can probably go There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. |
||
|
||
if (Number.isFinite(dur)) { | ||
ms.setPositionState({ | ||
duration: dur, | ||
playbackRate: this.playbackRate(), | ||
position: this.currentTime() | ||
}); | ||
} | ||
}; | ||
|
||
this.on('playing', () => { | ||
// Called on each `playing` rather than `sourceset`, in case of multiple players on a page | ||
updateMediaSession(); | ||
ms.playbackState = 'playing'; | ||
}); | ||
|
||
this.on('pause', () => { | ||
ms.playbackState = 'paused'; | ||
}); | ||
|
||
if ('setPositionState' in ms) { | ||
this.on('timeupdate', updatePositionState); | ||
} | ||
}; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Question, do you think it would be a good idea to use
skipButtons
values if they are available? This would allow a unified experience between theplayer
and themediaSession
.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think that makes sense, yes.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
What do you think about keeping this property as it is for now and adding this modification via another PR? Because it would be nice to have the
titleBar
values as well.