summaryrefslogtreecommitdiffstats
path: root/dom/media/mediacontrol/tests/browser/browser_media_control_playback_state.js
blob: 4d30566e0a9882bafdfd172a7382eec6900e337a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
const PAGE_NON_AUTOPLAY =
  "https://example.com/browser/dom/media/mediacontrol/tests/browser/file_non_autoplay.html";

const testVideoId = "video";

add_task(async function setupTestingPref() {
  await SpecialPowers.pushPrefEnv({
    set: [
      ["media.mediacontrol.testingevents.enabled", true],
      ["dom.media.mediasession.enabled", true],
    ],
  });
});

/**
 * This test is used to check the actual playback state [1] of the main media
 * controller. The declared playback state is the playback state from the active
 * media session, and the guessed playback state is determined by the media's
 * playback state. Both the declared playback and the guessed playback state
 * would be used to decide the final result of the actual playback state.
 *
 * [1] https://w3c.github.io/mediasession/#actual-playback-state
 */
add_task(async function testDefaultPlaybackStateBeforeAnyMediaStart() {
  info(`open media page`);
  const tab = await createLoadedTabWrapper(PAGE_NON_AUTOPLAY, {
    needCheck: false,
  });

  info(`before media starts, playback state should be 'none'`);
  await isActualPlaybackStateEqualTo(tab, "none");

  info(`remove tab`);
  await tab.close();
});

add_task(async function testGuessedPlaybackState() {
  info(`open media page`);
  const tab = await createLoadedTabWrapper(PAGE_NON_AUTOPLAY);

  info(
    `Now declared='none', guessed='playing', so actual playback state should be 'playing'`
  );
  await setGuessedPlaybackState(tab, "playing");
  await isActualPlaybackStateEqualTo(tab, "playing");

  info(
    `Now declared='none', guessed='paused', so actual playback state should be 'paused'`
  );
  await setGuessedPlaybackState(tab, "paused");
  await isActualPlaybackStateEqualTo(tab, "paused");

  info(`remove tab`);
  await tab.close();
});

add_task(async function testBothGuessedAndDeclaredPlaybackState() {
  info(`open media page`);
  const tab = await createLoadedTabWrapper(PAGE_NON_AUTOPLAY);

  info(
    `Now declared='paused', guessed='playing', so actual playback state should be 'playing'`
  );
  await setDeclaredPlaybackState(tab, "paused");
  await setGuessedPlaybackState(tab, "playing");
  await isActualPlaybackStateEqualTo(tab, "playing");

  info(
    `Now declared='paused', guessed='paused', so actual playback state should be 'paused'`
  );
  await setGuessedPlaybackState(tab, "paused");
  await isActualPlaybackStateEqualTo(tab, "paused");

  info(
    `Now declared='playing', guessed='paused', so actual playback state should be 'playing'`
  );
  await setDeclaredPlaybackState(tab, "playing");
  await isActualPlaybackStateEqualTo(tab, "playing");

  info(`remove tab`);
  await tab.close();
});

/**
 * The following are helper functions.
 */
function setGuessedPlaybackState(tab, state) {
  if (state == "playing") {
    return playMedia(tab, testVideoId);
  } else if (state == "paused") {
    return pauseMedia(tab, testVideoId);
  }
  // We won't set the state `stopped`, which would only happen if no any media
  // has ever been started in the page.
  ok(false, `should only set 'playing' or 'paused' state`);
  return Promise.resolve();
}

async function isActualPlaybackStateEqualTo(tab, expectedState) {
  const controller = tab.linkedBrowser.browsingContext.mediaController;
  if (controller.playbackState != expectedState) {
    await new Promise(r => (controller.onplaybackstatechange = r));
  }
  is(
    controller.playbackState,
    expectedState,
    `current state '${controller.playbackState}' is equal to '${expectedState}'`
  );
}

function setDeclaredPlaybackState(tab, state) {
  return SpecialPowers.spawn(tab.linkedBrowser, [state], playbackState => {
    info(`set declared playback state to '${playbackState}'`);
    content.navigator.mediaSession.playbackState = playbackState;
  });
}