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 enum AppendMode {
  32     "segments",
  33     "sequence"
  34 };
  35
  36 [
  37     NoInterfaceObject,
  38     ActiveDOMObject,
  39     RuntimeEnabled=MediaSource
  40 ] interface SourceBuffer : EventTarget {
  41
  42     // Gets or sets the AppendMode.
  43     // FIXME: Remove MediaSourceExperimental once mode attribute is implemented and stabilized. See http://crbug.com/249422.
  44     [RaisesException=Setter, RuntimeEnabled=MediaSourceExperimental] attribute AppendMode mode;
  45
  46     readonly attribute boolean updating;
  47
  48     // Returns the time ranges buffered.
  49     [RaisesException=Getter] readonly attribute TimeRanges buffered;
  50
  51     // Applies an offset to media segment timestamps.
  52     [RaisesException=Setter] attribute double timestampOffset;
  53
  54     // Presentation timestamp for the start of append window.
  55     [RaisesException=Setter] attribute double appendWindowStart;
  56
  57     // Presentation timestamp for the end of append window.
  58     [RaisesException=Setter] attribute double appendWindowEnd;
  59
  60     // Append segment data.
  61     [RaisesException] void appendBuffer(ArrayBuffer data);
  62     [RaisesException] void appendBuffer(ArrayBufferView data);
  63
  64     [RaisesException, RuntimeEnabled=Stream] void appendStream(Stream stream, optional unsigned long long maxSize);
  65
  66     // Abort the current segment append sequence.
  67     [RaisesException] void abort();
  68     [RaisesException] void remove(double start, double end);
  69 };
  70