3219a7748fe094365b9294412425089af249fa22
[WebKit-https.git] / Source / WebCore / Modules / mediasource / SourceBuffer.idl
1 /*
2  * Copyright (C) 2013 Google 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 are
6  * met:
7  *
8  *     * Redistributions of source code must retain the above copyright
9  * notice, this list of conditions and the following disclaimer.
10  *     * Redistributions in binary form must reproduce the above
11  * copyright notice, this list of conditions and the following disclaimer
12  * in the documentation and/or other materials provided with the
13  * distribution.
14  *     * Neither the name of Google Inc. nor the names of its
15  * contributors may be used to endorse or promote products derived from
16  * this software without specific prior written permission.
17  *
18  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
19  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
20  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
21  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
22  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
23  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
24  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
25  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
26  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
28  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29  */
30  
31 [Conditional=MEDIA_SOURCE] enum AppendMode {
32     "segments",
33     "sequence"
34 };
35
36 [
37     ActiveDOMObject,
38     Conditional=MEDIA_SOURCE,
39     ExportMacro=WEBCORE_EXPORT,
40 ] interface SourceBuffer : EventTarget {
41
42     [SetterRaisesException] attribute AppendMode mode;
43
44     readonly attribute boolean updating;
45   
46     // Returns the time ranges buffered.
47     [GetterRaisesException] readonly attribute TimeRanges buffered;
48
49     // Applies an offset to media segment timestamps.
50     [SetterRaisesException] attribute double timestampOffset;
51
52     // Track support
53     [Conditional=VIDEO_TRACK] readonly attribute AudioTrackList audioTracks;
54     [Conditional=VIDEO_TRACK] readonly attribute VideoTrackList videoTracks;
55     [Conditional=VIDEO_TRACK] readonly attribute TextTrackList textTracks;
56
57     [SetterRaisesException] attribute double appendWindowStart;
58     [SetterRaisesException] attribute unrestricted double appendWindowEnd;
59
60     // Append segment data.
61     [RaisesException] void appendBuffer(ArrayBuffer data);
62     [RaisesException] void appendBuffer(ArrayBufferView data);
63
64     // Abort the current segment append sequence.
65     [RaisesException] void abort();
66     [RaisesException] void remove(unrestricted double start, unrestricted double end);
67
68     attribute EventHandler onupdatestart;
69     attribute EventHandler onupdate;
70     attribute EventHandler onupdateend;
71     attribute EventHandler onerror;
72     attribute EventHandler onabort;
73 };
74