[MediaStream] RealtimeMediaSource should be able to vend hashed IDs
[WebKit-https.git] / Source / WebCore / Modules / mediastream / MediaStreamTrack.idl
1 /*
2  * Copyright (C) 2011 Google Inc. All rights reserved.
3  * Copyright (C) 2013-2016 Apple Inc. All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1.  Redistributions of source code must retain the above copyright
9  *     notice, this list of conditions and the following disclaimer.
10  * 2.  Redistributions in binary form must reproduce the above copyright
11  *     notice, this list of conditions and the following disclaimer in the
12  *     documentation and/or other materials provided with the distribution.
13  *
14  * THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS'' AND ANY
15  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
16  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
17  * DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS BE LIABLE FOR ANY
18  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
19  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
20  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
21  * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
23  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 enum MediaStreamTrackState { "live", "ended" };
27
28 [
29     ActiveDOMObject,
30     Conditional=MEDIA_STREAM,
31     CustomToJSObject,
32     ExportToWrappedFunction,
33     PrivateIdentifier,
34     PublicIdentifier,
35 ] interface MediaStreamTrack : EventTarget {
36     readonly attribute DOMString kind;
37     readonly attribute DOMString id;
38     readonly attribute DOMString label;
39     attribute boolean enabled;
40     attribute DOMString contentHint;
41     readonly attribute boolean muted;
42     attribute EventHandler onmute;
43     attribute EventHandler onunmute;
44     readonly attribute MediaStreamTrackState readyState;
45     attribute EventHandler onended;
46
47     MediaStreamTrack clone();
48     [ImplementedAs=stopTrack] void stop();
49
50     MediaTrackCapabilities getCapabilities();
51     MediaTrackConstraints getConstraints();
52     MediaTrackSettings getSettings();
53     Promise<void> applyConstraints(optional MediaTrackConstraints constraints);
54
55     attribute EventHandler onoverconstrained;
56 };
57
58 [
59     Conditional=MEDIA_STREAM,
60     JSGenerateToJSObject,
61 ] dictionary MediaTrackCapabilities {
62     LongRange width;
63     LongRange height;
64     DoubleRange aspectRatio;
65     DoubleRange frameRate;
66     sequence<DOMString> facingMode;
67     DoubleRange volume;
68     LongRange sampleRate;
69     LongRange sampleSize;
70     sequence<boolean> echoCancellation;
71     // FIXME 169871: add latency
72     // FIXME 169871: add channelCount
73     DOMString deviceId;
74     DOMString groupId;
75 };
76
77 [
78     Conditional=MEDIA_STREAM,
79     JSGenerateToJSObject,
80 ] dictionary MediaTrackSettings {
81     long width;
82     long height;
83     double aspectRatio;
84     double frameRate;
85     DOMString facingMode;
86     double volume;
87     long sampleRate;
88     long sampleSize;
89     boolean echoCancellation;
90     // FIXME 169871: add latency
91     // FIXME 169871: add channelCount
92     DOMString deviceId;
93     DOMString groupId;
94 };