Changeset 278222 in webkit

Timestamp:

May 28, 2021 1:08:08 PM (14 months ago)

Author:

Jean-Yves Avenard

Message:

Add MediaSession.callActionHandler
​https://bugs.webkit.org/show_bug.cgi?id=226077
rdar://77463304

Reviewed by Eric Carlson.

Source/WebCore:

Make it possible for JavaScript to be able to trigger a MediaSession action
handler so a MediaSession.coordinator polyfill such as one provided by an
external JS library will work.
Test: media/media-session/callActionHandler.html

• Modules/mediasession/MediaSession.cpp:

(WebCore::MediaSession::callActionHandler):

• Modules/mediasession/MediaSession.h:
• Modules/mediasession/MediaSession.idl: Add method definition.

LayoutTests:

• media/media-session/callActionHandler-expected.txt: Added.
• media/media-session/callActionHandler.html: Added.

Location:

trunk

Files:

• LayoutTests/ChangeLog (modified) (1 diff)
• LayoutTests/media/media-session/callActionHandler-expected.txt (added)
• LayoutTests/media/media-session/callActionHandler.html (added)
• Source/WebCore/ChangeLog (modified) (1 diff)
• Source/WebCore/Modules/mediasession/MediaSession.cpp (modified) (2 diffs)
• Source/WebCore/Modules/mediasession/MediaSession.h (modified) (3 diffs)
• Source/WebCore/Modules/mediasession/MediaSession.idl (modified) (1 diff)

trunk/LayoutTests/ChangeLog

@@ +1 @@
+2021-05-28  Jean-Yves Avenard  <jya@apple.com>
+
+        Add MediaSession.callActionHandler
+        https://bugs.webkit.org/show_bug.cgi?id=226077
+        rdar://77463304
+
+        Reviewed by Eric Carlson.
+
+        * media/media-session/callActionHandler-expected.txt: Added.
+        * media/media-session/callActionHandler.html: Added.
+
 2021-05-28  Alan Bujtas  <zalan@apple.com>
 

trunk/Source/WebCore/ChangeLog

@@ +1 @@
+2021-05-28  Jean-Yves Avenard  <jya@apple.com>
+
+        Add MediaSession.callActionHandler
+        https://bugs.webkit.org/show_bug.cgi?id=226077
+        rdar://77463304
+
+        Reviewed by Eric Carlson.
+
+        Make it possible for JavaScript to be able to trigger a MediaSession action
+        handler so a MediaSession.coordinator polyfill such as one provided by an
+        external JS library will work.
+        Test: media/media-session/callActionHandler.html
+
+        * Modules/mediasession/MediaSession.cpp:
+        (WebCore::MediaSession::callActionHandler):
+        * Modules/mediasession/MediaSession.h:
+        * Modules/mediasession/MediaSession.idl: Add method definition.
+
 2021-05-28  Alan Bujtas  <zalan@apple.com>
 

trunk/Source/WebCore/Modules/mediasession/MediaSession.cpp

@@ -32 +32 @@
 #include "EventNames.h"
 #include "HTMLMediaElement.h"
+#include "JSDOMPromiseDeferred.h"
 #include "JSMediaPositionState.h"
 #include "JSMediaSessionAction.h"
@@ -273 +274 @@
 }
 
-bool MediaSession::callActionHandler(const MediaSessionActionDetails& actionDetails)
+void MediaSession::callActionHandler(const MediaSessionActionDetails& actionDetails, DOMPromiseDeferred<void>&& promise)
+{
+    ALWAYS_LOG(LOGIDENTIFIER);
+
+    if (!callActionHandler(actionDetails, TriggerGestureIndicator::No)) {
+        promise.reject(InvalidStateError);
+        return;
+    }
+
+    promise.resolve();
+}
+
+bool MediaSession::callActionHandler(const MediaSessionActionDetails& actionDetails, TriggerGestureIndicator triggerGestureIndicator)
 {
     if (auto handler = m_actionHandlers.get(actionDetails.action)) {
-        UserGestureIndicator gestureIndicator(ProcessingUserGesture, document());
+        Optional<UserGestureIndicator> maybeGestureIndicator;
+        if (triggerGestureIndicator == TriggerGestureIndicator::Yes)
+            maybeGestureIndicator.emplace(ProcessingUserGesture, document());
         handler->handleEvent(actionDetails);
         return true;

trunk/Source/WebCore/Modules/mediasession/MediaSession.h

@@ -51 +51 @@
 class MediaSessionCoordinatorPrivate;
 class Navigator;
+template<typename> class DOMPromiseDeferred;
 
 class MediaSession : public RefCounted<MediaSession>, public ActiveDOMObject, public EventTargetWithInlineData {
@@ -66 +67 @@
 
     void setActionHandler(MediaSessionAction, RefPtr<MediaSessionActionHandler>&&);
+
+    void callActionHandler(const MediaSessionActionDetails&, DOMPromiseDeferred<void>&&);
 
     ExceptionOr<void> setPositionState(Optional<MediaPositionState>&&);
@@ -88 +91 @@
 
     bool hasActiveActionHandlers() const { return !m_actionHandlers.isEmpty(); }
-    WEBCORE_EXPORT bool callActionHandler(const MediaSessionActionDetails&);
+    enum class TriggerGestureIndicator {
+        No,
+        Yes,
+    };
+    WEBCORE_EXPORT bool callActionHandler(const MediaSessionActionDetails&, TriggerGestureIndicator = TriggerGestureIndicator::Yes);
 
     const Logger& logger() const { return *m_logger.get(); }

trunk/Source/WebCore/Modules/mediasession/MediaSession.idl

@@ -38 +38 @@
     undefined setActionHandler(MediaSessionAction action, MediaSessionActionHandler? handler);
 
+    Promise<undefined> callActionHandler(MediaSessionActionDetails actionDetails);
+
     undefined setPositionState(optional MediaPositionState? state = null);
 };