Source code
Revision control
Copy as Markdown
Other Tools
/* 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,
#ifndef DOM_MEDIA_MEDIACONTROL_CONTENTPLAYBACKCONTROLLER_H_
#define DOM_MEDIA_MEDIACONTROL_CONTENTPLAYBACKCONTROLLER_H_
#include "MediaControlKeySource.h"
#include "nsPIDOMWindow.h"
#include "mozilla/dom/BrowsingContext.h"
namespace mozilla::dom {
class MediaSession;
/**
* This interface is used to handle different playback control actions in the
* content process. Most of the methods are designed based on the
* MediaSessionAction values, which are defined in the media session spec [1].
*
* The reason we need that is to explicitly separate the implementation from all
* different defined methods. If we want to add a new method in the future, we
* can do that without modifying other methods.
*
* If the active media session has a corresponding MediaSessionActionHandler,
* then we would invoke it, or we would do nothing. However, for certain
* actions, such as `play`, `pause` and `stop`, we have default action handling
* in order to control playback correctly even if the website doesn't use media
* session at all or the media session doesn't have correspending action handler
* [2].
*
* [2]
*/
class MOZ_STACK_CLASS ContentPlaybackController {
public:
explicit ContentPlaybackController(BrowsingContext* aContext);
~ContentPlaybackController() = default;
// TODO: Convert Focus() to MOZ_CAN_RUN_SCRIPT
MOZ_CAN_RUN_SCRIPT_BOUNDARY void Focus();
void Play();
void Pause();
void SeekBackward(double aSeekOffset);
void SeekForward(double aSeekOffset);
void PreviousTrack();
void NextTrack();
void SkipAd();
void Stop();
void SeekTo(double aSeekTime, bool aFastSeek);
private:
void NotifyContentMediaControlKeyReceiver(
MediaControlKey aKey, Maybe<SeekDetails> aDetails = Nothing());
void NotifyMediaSession(MediaSessionAction aAction);
void NotifyMediaSession(const MediaSessionActionDetails& aDetails);
void NotifyMediaSessionWhenActionIsSupported(MediaSessionAction aAction);
bool IsMediaSessionActionSupported(MediaSessionAction aAction) const;
Maybe<uint64_t> GetActiveMediaSessionId() const;
MediaSession* GetMediaSession() const;
RefPtr<BrowsingContext> mBC;
};
class ContentMediaControlKeyHandler {
public:
static void HandleMediaControlAction(BrowsingContext* aContext,
const MediaControlAction& aAction);
};
} // namespace mozilla::dom
#endif