[iOS] Replace "node assistance" terminology in WebKit with "focused element"
[WebKit-https.git] / Source / WebKit / UIProcess / WebMediaSessionFocusManager.h
1 /*
2  * Copyright (C) 2015 Apple Inc. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
14  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
15  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
17  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
18  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
19  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
20  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
21  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
22  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
23  * THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 #pragma once
27
28 #if ENABLE(MEDIA_SESSION)
29
30 #include "APIObject.h"
31 #include "WebContextSupplement.h"
32 #include "WebMediaSessionFocusManagerClient.h"
33 #include "WebPageProxy.h"
34
35 namespace WebKit {
36
37 typedef std::pair<WebPageProxy*, uint64_t> FocusedMediaElement;
38
39 class WebMediaSessionFocusManager : public API::ObjectImpl<API::Object::Type::MediaSessionFocusManager>, public WebContextSupplement {
40 public:
41     static const char* supplementName();
42
43     static Ref<WebMediaSessionFocusManager> create(WebProcessPool*);
44
45     void initializeClient(const WKMediaSessionFocusManagerClientBase*);
46
47     bool valueForPlaybackAttribute(WKMediaSessionFocusManagerPlaybackAttribute) const;
48     void updatePlaybackAttributesFromMediaState(WebPageProxy*, uint64_t, WebCore::MediaProducer::MediaStateFlags);
49     void setVolumeOfFocusedMediaElement(double);
50
51     void setFocusedMediaElement(WebPageProxy&, uint64_t);
52     void clearFocusedMediaElement();
53
54     using API::Object::ref;
55     using API::Object::deref;
56
57 private:
58     explicit WebMediaSessionFocusManager(WebProcessPool*);
59
60     // WebContextSupplement
61     void refWebContextSupplement() override;
62     void derefWebContextSupplement() override;
63
64     void updatePlaybackAttribute(WKMediaSessionFocusManagerPlaybackAttribute, bool);
65
66     std::unique_ptr<FocusedMediaElement> m_focusedMediaElement;
67     WKMediaSessionFocusManagerPlaybackAttributes m_playbackAttributes { 0 };
68     WebMediaSessionFocusManagerClient m_client;
69 };
70
71 } // namespace WebKit
72
73 #endif // ENABLE(MEDIA_SESSION)