gecko-dev/dom/webidl/MediaSession.webidl
alwu 371b11291d Bug 1582509 - part1 : implement 'MediaPositionState' and 'setPositionState()'. r=emilio
According to the spec [1], implement the dictionary `MediaPositionState` and `setPositionState()`.

[1] https://w3c.github.io/mediasession/#dom-mediasession-setpositionstate

Differential Revision: https://phabricator.services.mozilla.com/D66500

--HG--
extra : moz-landing-system : lando
2020-03-19 19:29:40 +00:00

84 lines
2.1 KiB
Plaintext

/* -*- Mode: IDL; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this file,
* You can obtain one at http://mozilla.org/MPL/2.0/.
*
* The origin of this IDL file is
* https://w3c.github.io/mediasession/#idl-index
*/
enum MediaSessionPlaybackState {
"none",
"paused",
"playing"
};
// TODO: Implement the missing seekto (bug 1621403) and skipad (bug 1582569) actions
enum MediaSessionAction {
"play",
"pause",
"seekbackward",
"seekforward",
"previoustrack",
"nexttrack",
"stop",
};
callback MediaSessionActionHandler = void(MediaSessionActionDetails details);
[Exposed=Window, Pref="dom.media.mediasession.enabled"]
interface MediaSession {
attribute MediaMetadata? metadata;
attribute MediaSessionPlaybackState playbackState;
void setActionHandler(MediaSessionAction action, MediaSessionActionHandler? handler);
[Throws]
void setPositionState(optional MediaPositionState state = {});
// Fire the action handler. It's test-only for now.
[ChromeOnly]
void notifyHandler(MediaSessionActionDetails details);
};
[Exposed=Window, Pref="dom.media.mediasession.enabled"]
interface MediaMetadata {
[Throws]
constructor(optional MediaMetadataInit init = {});
attribute DOMString title;
attribute DOMString artist;
attribute DOMString album;
// https://github.com/w3c/mediasession/issues/237
// Take and return `MediaImage` on setter and getter.
[Frozen, Cached, Pure, Throws]
attribute sequence<object> artwork;
};
dictionary MediaMetadataInit {
DOMString title = "";
DOMString artist = "";
DOMString album = "";
sequence<MediaImage> artwork = [];
};
dictionary MediaImage {
required USVString src;
DOMString sizes = "";
DOMString type = "";
};
dictionary MediaSessionActionDetails {
required MediaSessionAction action;
// Merge MediaSessionSeekActionDetails here:
// https://github.com/w3c/mediasession/issues/234
double seekOffset;
};
dictionary MediaPositionState {
double duration;
double playbackRate;
double position;
};