mozilla-central/dom/media/mediacontrol/tests/browser/browser_audio_focus_management.js (file symbol)

Source code

Revision control

Copy as Markdown

Other Tools

Test Info: Errors

const PAGE_AUDIBLE =
const PAGE_INAUDIBLE =
const testVideoId = "autoplay";
/**
* These tests are used to ensure that the audio focus management works correctly
* amongs different tabs no matter the pref is on or off. If the pref is on,
* there is only one tab which is allowed to play audio at a time, the last tab
* starting audio will immediately stop other tabs which own audio focus. But
* notice that playing inaudible media won't gain audio focus. If the pref is
* off, all audible tabs can own audio focus at the same time without
* interfering each others.
*/
add_task(async function testDisableAudioFocusManagement() {
await switchAudioFocusManagerment(false);
info(`open audible autoplay media in tab1`);
const tab1 = await createLoadedTabWrapper(PAGE_AUDIBLE, { needCheck: false });
await checkOrWaitUntilMediaStartedPlaying(tab1, testVideoId);
info(`open same page on another tab, which shouldn't cause audio competing`);
const tab2 = await createLoadedTabWrapper(PAGE_AUDIBLE, { needCheck: false });
await checkOrWaitUntilMediaStartedPlaying(tab2, testVideoId);
info(`media in tab1 should be playing still`);
await checkOrWaitUntilMediaStartedPlaying(tab1, testVideoId);
info(`remove tabs`);
await clearTabsAndResetPref([tab1, tab2]);
});
add_task(async function testEnableAudioFocusManagement() {
await switchAudioFocusManagerment(true);
info(`open audible autoplay media in tab1`);
const tab1 = await createLoadedTabWrapper(PAGE_AUDIBLE, { needCheck: false });
await checkOrWaitUntilMediaStartedPlaying(tab1, testVideoId);
info(`open same page on another tab, which should cause audio competing`);
const tab2 = await createLoadedTabWrapper(PAGE_AUDIBLE, { needCheck: false });
await checkOrWaitUntilMediaStartedPlaying(tab2, testVideoId);
info(`media in tab1 should be stopped`);
await checkOrWaitUntilMediaStoppedPlaying(tab1, testVideoId);
info(`remove tabs`);
await clearTabsAndResetPref([tab1, tab2]);
});
add_task(async function testCheckAudioCompetingMultipleTimes() {
await switchAudioFocusManagerment(true);
info(`open audible autoplay media in tab1`);
const tab1 = await createLoadedTabWrapper(PAGE_AUDIBLE, { needCheck: false });
await checkOrWaitUntilMediaStartedPlaying(tab1, testVideoId);
info(`open same page on another tab, which should cause audio competing`);
const tab2 = await createLoadedTabWrapper(PAGE_AUDIBLE, { needCheck: false });
await checkOrWaitUntilMediaStartedPlaying(tab2, testVideoId);
info(`media in tab1 should be stopped`);
await checkOrWaitUntilMediaStoppedPlaying(tab1, testVideoId);
info(`play media in tab1 again`);
await playMedia(tab1);
info(`media in tab2 should be stopped`);
await checkOrWaitUntilMediaStoppedPlaying(tab2, testVideoId);
info(`play media in tab2 again`);
await playMedia(tab2);
info(`media in tab1 should be stopped`);
await checkOrWaitUntilMediaStoppedPlaying(tab1, testVideoId);
info(`remove tabs`);
await clearTabsAndResetPref([tab1, tab2]);
});
add_task(async function testMutedMediaWontInvolveAudioCompeting() {
await switchAudioFocusManagerment(true);
info(`open audible autoplay media in tab1`);
const tab1 = await createLoadedTabWrapper(PAGE_AUDIBLE, { needCheck: false });
await checkOrWaitUntilMediaStartedPlaying(tab1, testVideoId);
info(
`open inaudible media page on another tab, which shouldn't cause audio competing`
);
const tab2 = await createLoadedTabWrapper(PAGE_INAUDIBLE, {
needCheck: false,
});
await checkOrWaitUntilMediaStartedPlaying(tab2, testVideoId);
info(`media in tab1 should be playing still`);
await checkOrWaitUntilMediaStartedPlaying(tab1, testVideoId);
info(
`open audible media page on the third tab, which should cause audio competing`
);
const tab3 = await createLoadedTabWrapper(PAGE_AUDIBLE, { needCheck: false });
await checkOrWaitUntilMediaStartedPlaying(tab3, testVideoId);
info(`media in tab1 should be stopped`);
await checkOrWaitUntilMediaStoppedPlaying(tab1, testVideoId);
info(`media in tab2 should not be affected because it's inaudible.`);
await checkOrWaitUntilMediaStartedPlaying(tab2, testVideoId);
info(`remove tabs`);
await clearTabsAndResetPref([tab1, tab2, tab3]);
});
add_task(async function testStopMultipleTabsWhenSwitchingPrefDynamically() {
await switchAudioFocusManagerment(false);
info(`open audible autoplay media in tab1`);
const tab1 = await createLoadedTabWrapper(PAGE_AUDIBLE, { needCheck: false });
await checkOrWaitUntilMediaStartedPlaying(tab1, testVideoId);
info(`open same page on another tab, which shouldn't cause audio competing`);
const tab2 = await createLoadedTabWrapper(PAGE_AUDIBLE, { needCheck: false });
await checkOrWaitUntilMediaStartedPlaying(tab2, testVideoId);
await switchAudioFocusManagerment(true);
info(`open same page on the third tab, which should cause audio competing`);
const tab3 = await createLoadedTabWrapper(PAGE_AUDIBLE, { needCheck: false });
await checkOrWaitUntilMediaStartedPlaying(tab3, testVideoId);
info(`media in tab1 and tab2 should be stopped`);
await checkOrWaitUntilMediaStoppedPlaying(tab1, testVideoId);
await checkOrWaitUntilMediaStoppedPlaying(tab2, testVideoId);
info(`remove tabs`);
await clearTabsAndResetPref([tab1, tab2, tab3]);
});
/**
* The following are helper funcions.
*/
async function switchAudioFocusManagerment(enable) {
const state = enable ? "Enable" : "Disable";
info(`${state} audio focus management`);
await SpecialPowers.pushPrefEnv({
set: [["media.audioFocus.management", enable]],
});
}
async function playMedia(tab) {
await SpecialPowers.spawn(tab.linkedBrowser, [], () => {
return new Promise(resolve => {
const video = content.document.getElementById("autoplay");
if (!video) {
ok(false, `can't get the media element!`);
}
ok(video.paused, `media has not started yet`);
info(`wait until media starts playing`);
video.play();
video.onplaying = () => {
video.onplaying = null;
ok(true, `media started playing`);
resolve();
};
});
});
}
async function clearTabsAndResetPref(tabs) {
info(`clear tabs and reset pref`);
for (let tab of tabs) {
await tab.close();
}
await switchAudioFocusManagerment(false);
}