src/third_party/WebKit/Source/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 // https://dvcs.w3.org/hg/html-media/raw-file/tip/media-source/media-source.html#idl-def-SourceBuffer
  32
  33 enum AppendMode {
  34     "segments",
  35     "sequence"
  36 };
  37
  38 [
  39     ActiveDOMObject,
  40     NoInterfaceObject,
  41     RuntimeEnabled=MediaSource,
  42     TypeChecking=Interface|Nullable|Unrestricted,
  43 ] interface SourceBuffer : EventTarget {
  44
  45     // Gets or sets the AppendMode.
  46     // FIXME: Remove MediaSourceExperimental once mode attribute is implemented and stabilized. See http://crbug.com/249422.
  47     [RaisesException=Setter, RuntimeEnabled=MediaSourceExperimental] attribute AppendMode mode;
  48
  49     readonly attribute boolean updating;
  50
  51     // Returns the time ranges buffered.
  52     [RaisesException=Getter] readonly attribute TimeRanges buffered;
  53
  54     // Applies an offset to media segment timestamps.
  55     [RaisesException=Setter] attribute double timestampOffset;
  56
  57     // Presentation timestamp for the start of append window.
  58     [RaisesException=Setter] attribute double appendWindowStart;
  59
  60     // Presentation timestamp for the end of append window.
  61     [RaisesException=Setter] attribute unrestricted double appendWindowEnd;
  62
  63     // Append segment data.
  64     [RaisesException] void appendBuffer(ArrayBuffer data);
  65     [RaisesException] void appendBuffer(ArrayBufferView data);
  66
  67     [RaisesException, RuntimeEnabled=Stream] void appendStream(Stream stream, optional unsigned long long maxSize);
  68
  69     // Abort the current segment append sequence.
  70     [RaisesException] void abort();
  71     // Pending W3C bug: "Change SourceBuffer.remove() end parameter to 'unrestricted double'",
  72     // https://www.w3.org/Bugs/Public/show_bug.cgi?id=25518
  73     [RaisesException] void remove(double start, double end);
  74 };
  75