8c249b1f3adce89518021c4ca38bb36171bb3ca9
[WebKit-https.git] / Source / WebCore / Modules / mediarecorder / MediaRecorder.idl
1 /*
2  * Copyright (C) 2018 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'' AND ANY
14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
15  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
16  * DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS BE LIABLE FOR ANY
17  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
18  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
19  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
20  * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
21  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
22  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
23  */
24
25 enum RecordingState { "inactive", "recording", "paused" };
26
27 [
28     ActiveDOMObject,
29     Conditional=MEDIA_STREAM,
30     Constructor(MediaStream stream, optional MediaRecorderOptions options),
31     ConstructorCallWith=Document,
32     ConstructorMayThrowException,
33     EnabledAtRuntime=MediaRecorder,
34     Exposed=Window
35 ] interface MediaRecorder : EventTarget {
36     readonly attribute RecordingState state;
37     // FIXME: Implement these:
38     // readonly attribute MediaStream stream;
39     // readonly attribute DOMString mimeType;
40     // attribute EventHandler onstart;
41     attribute EventHandler onstop;
42     attribute EventHandler ondataavailable;
43     // attribute EventHandler onpause;
44     // attribute EventHandler onresume;
45     attribute EventHandler onerror;
46     // readonly attribute unsigned long videoBitsPerSecond;
47     // readonly attribute unsigned long audioBitsPerSecond;
48
49     [MayThrowException, ImplementedAs=startRecording] void start(optional long timeslice);
50     [ImplementedAs=stopRecording] void stop();
51     // void pause();
52     // void resume();
53     // void requestData();
54
55     // static boolean isTypeSupported(DOMString type);
56 };
57
58 dictionary MediaRecorderOptions {
59     DOMString mimeType;
60     unsigned long audioBitsPerSecond;
61     unsigned long videoBitsPerSecond;
62     unsigned long bitsPerSecond;
63 };