[Modern Media Controls] Turn modern media controls on by default
[WebKit-https.git] / Source / WebCore / Modules / mediacontrols / MediaControlsHost.idl
1 /*
2  * Copyright (C) 2013, 2014 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. ``AS IS'' AND ANY
14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE INC. OR
17  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
18  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
19  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
20  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
21  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
23  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 
24  */
25
26 enum DeviceType {
27     "none",
28     "airplay",
29     "tvout"
30 };
31
32 [
33     Conditional=MEDIA_CONTROLS_SCRIPT,
34     ImplementationLacksVTable,
35     NoInterfaceObject,
36 ] interface MediaControlsHost {
37     sequence<TextTrack> sortedTrackListForMenu(TextTrackList trackList);
38     sequence<AudioTrack> sortedTrackListForMenu(AudioTrackList trackList);
39     DOMString displayNameForTrack((TextTrack or AudioTrack)? track);
40     readonly attribute TextTrack captionMenuOffItem;
41     readonly attribute TextTrack captionMenuAutomaticItem;
42     readonly attribute DOMString captionDisplayMode;
43     void setSelectedTextTrack(TextTrack? track);
44     void setPreparedToReturnVideoLayerToInline(boolean prepared);
45     readonly attribute HTMLElement textTrackContainer;
46     readonly attribute boolean allowsInlineMediaPlayback;
47     readonly attribute boolean supportsFullscreen;
48     readonly attribute boolean isVideoLayerInline;
49     readonly attribute boolean userGestureRequired;
50     readonly attribute boolean isInMediaDocument;
51
52     readonly attribute DOMString externalDeviceDisplayName;
53     readonly attribute DeviceType externalDeviceType;
54
55     attribute boolean controlsDependOnPageScaleFactor;
56     
57     void updateTextTrackContainer();
58     void enteredFullscreen();
59     void exitedFullscreen();
60
61     DOMString generateUUID();
62
63     [EnabledAtRuntime=ModernMediaControls] readonly attribute DOMString shadowRootCSSText;
64     [EnabledAtRuntime=ModernMediaControls] DOMString base64StringForIconAndPlatform(DOMString iconName, DOMString platform);
65 };