src/third_party/WebKit/Source/core/html/HTMLMediaElement.idl

   1 /*
   2  * Copyright (C) 2007, 2010, 2011, 2012 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 COMPUTER, INC. ``AS IS'' AND ANY
  14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  16  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE COMPUTER, INC. OR
  17  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
  18  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
  19  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
  20  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
  21  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  23  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  24  */
  25
  26 [
  27     ActiveDOMObject,
  28     RuntimeEnabled=Media,
  29 ] interface HTMLMediaElement : HTMLElement {
  30
  31     // error state
  32     readonly attribute MediaError error;
  33
  34     // network state
  35     [Reflect, URL, PerWorldBindings, ActivityLogging=SetterForIsolatedWorlds] attribute DOMString src;
  36     [URL, PerWorldBindings, ActivityLogging=SetterForIsolatedWorlds] readonly attribute DOMString currentSrc;
  37     [Reflect, ReflectOnly="anonymous"|"use-credentials", ReflectEmpty="anonymous", ReflectInvalid="anonymous"] attribute DOMString crossOrigin;
  38
  39     const unsigned short NETWORK_EMPTY = 0;
  40     const unsigned short NETWORK_IDLE = 1;
  41     const unsigned short NETWORK_LOADING = 2;
  42     const unsigned short NETWORK_NO_SOURCE = 3;
  43     readonly attribute unsigned short networkState;
  44     attribute DOMString preload;
  45
  46     readonly attribute TimeRanges buffered;
  47     void load();
  48     DOMString canPlayType(DOMString type, [Default=Undefined, TreatNullAs=NullString, TreatUndefinedAs=NullString] optional DOMString keySystem);
  49
  50     // ready state
  51     const unsigned short HAVE_NOTHING = 0;
  52     const unsigned short HAVE_METADATA = 1;
  53     const unsigned short HAVE_CURRENT_DATA = 2;
  54     const unsigned short HAVE_FUTURE_DATA = 3;
  55     const unsigned short HAVE_ENOUGH_DATA = 4;
  56     readonly attribute unsigned short readyState;
  57     readonly attribute boolean seeking;
  58
  59     // playback state
  60     [RaisesException=Setter] attribute double currentTime;
  61     readonly attribute double duration;
  62     readonly attribute boolean paused;
  63     attribute double defaultPlaybackRate;
  64     attribute double playbackRate;
  65     readonly attribute TimeRanges played;
  66     readonly attribute TimeRanges seekable;
  67     readonly attribute boolean ended;
  68     [Reflect] attribute boolean autoplay;
  69     [Reflect] attribute boolean loop;
  70     void play();
  71     void pause();
  72
  73     // media controller
  74     [Reflect] attribute DOMString mediaGroup;
  75     [StrictTypeChecking] attribute MediaController controller;
  76
  77     // controls
  78     attribute boolean controls;
  79     [RaisesException=Setter] attribute double volume;
  80     attribute boolean muted;
  81     [Reflect=muted] attribute boolean defaultMuted;
  82
  83     // tracks
  84     [RuntimeEnabled=VideoTrack] readonly attribute TextTrackList textTracks;
  85     [RuntimeEnabled=VideoTrack, RaisesException] TextTrack addTextTrack(DOMString kind, optional DOMString label, optional DOMString language);
  86
  87     // WebKit extensions
  88
  89     // The number of bytes consumed by the media decoder.
  90     [MeasureAs=PrefixedAudioDecodedByteCount] readonly attribute unsigned long webkitAudioDecodedByteCount;
  91     [MeasureAs=PrefixedVideoDecodedByteCount] readonly attribute unsigned long webkitVideoDecodedByteCount;
  92
  93     [Reflect, RuntimeEnabled=SubresourceIntegrity] attribute DOMString integrity;
  94 };