Source/WebCore/Modules/mediasource/SourceBuffer.idl

/*
 * Copyright (C) 2013 Google Inc. All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are
 * met:
 *
 *     * Redistributions of source code must retain the above copyright
 * notice, this list of conditions and the following disclaimer.
 *     * Redistributions in binary form must reproduce the above
 * copyright notice, this list of conditions and the following disclaimer
 * in the documentation and/or other materials provided with the
 * distribution.
 *     * Neither the name of Google Inc. nor the names of its
 * contributors may be used to endorse or promote products derived from
 * this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
 
[Conditional=MEDIA_SOURCE] enum AppendMode {
    "segments",
    "sequence"
};

[
    ActiveDOMObject,
    Conditional=MEDIA_SOURCE,
    ExportMacro=WEBCORE_EXPORT,
] interface SourceBuffer : EventTarget {
    attribute AppendMode mode;

    readonly attribute boolean updating;
  
    // Returns the time ranges buffered.
    readonly attribute TimeRanges buffered;

    // Applies an offset to media segment timestamps.
    attribute double timestampOffset;

    // Track support
    [Conditional=VIDEO_TRACK] readonly attribute AudioTrackList audioTracks;
    [Conditional=VIDEO_TRACK] readonly attribute VideoTrackList videoTracks;
    [Conditional=VIDEO_TRACK] readonly attribute TextTrackList textTracks;

    attribute double appendWindowStart;
    attribute unrestricted double appendWindowEnd;

    // Append segment data.
    [MayThrowException] void appendBuffer(BufferSource data);

    // Abort the current segment append sequence.
    [MayThrowException] void abort();
    [MayThrowException] void remove(double start, unrestricted double end);

    attribute EventHandler onupdatestart;
    attribute EventHandler onupdate;
    attribute EventHandler onupdateend;
    attribute EventHandler onerror;
    attribute EventHandler onabort;

    [EnabledBySetting=SourceBufferChangeType, MayThrowException] void changeType(DOMString type);
};