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     TypeChecking=Unrestricted,
  30 ] interface HTMLMediaElement : HTMLElement {
  31
  32     // error state
  33     [TypeChecking=Interface|Nullable] readonly attribute MediaError? error;
  34
  35     // network state
  36     [Reflect, URL, LogActivity=SetterOnly] attribute DOMString src;
  37     [URL, LogActivity=SetterOnly] readonly attribute DOMString currentSrc;
  38     [Reflect, ReflectOnly="anonymous"|"use-credentials", ReflectEmpty="anonymous", ReflectInvalid="anonymous"] attribute DOMString crossOrigin;
  39
  40     const unsigned short NETWORK_EMPTY = 0;
  41     const unsigned short NETWORK_IDLE = 1;
  42     const unsigned short NETWORK_LOADING = 2;
  43     const unsigned short NETWORK_NO_SOURCE = 3;
  44     readonly attribute unsigned short networkState;
  45     attribute DOMString preload;
  46
  47     readonly attribute TimeRanges buffered;
  48     void load();
  49     DOMString canPlayType(DOMString type, [Default=Undefined, TreatNullAs=NullString, TreatUndefinedAs=NullString] optional DOMString keySystem);
  50
  51     // ready state
  52     const unsigned short HAVE_NOTHING = 0;
  53     const unsigned short HAVE_METADATA = 1;
  54     const unsigned short HAVE_CURRENT_DATA = 2;
  55     const unsigned short HAVE_FUTURE_DATA = 3;
  56     const unsigned short HAVE_ENOUGH_DATA = 4;
  57     readonly attribute unsigned short readyState;
  58     readonly attribute boolean seeking;
  59
  60     // playback state
  61     [RaisesException=Setter] attribute double currentTime;
  62     readonly attribute unrestricted double duration;
  63     readonly attribute boolean paused;
  64     attribute double defaultPlaybackRate;
  65     attribute double playbackRate;
  66     readonly attribute TimeRanges played;
  67     readonly attribute TimeRanges seekable;
  68     readonly attribute boolean ended;
  69     [Reflect] attribute boolean autoplay;
  70     [Reflect] attribute boolean loop;
  71     void play();
  72     void pause();
  73
  74     // media controller
  75     [RuntimeEnabled=MediaController, Reflect] attribute DOMString mediaGroup;
  76     [RuntimeEnabled=MediaController, TypeChecking=Interface|Nullable] attribute MediaController? controller;
  77
  78     // controls
  79     attribute boolean controls;
  80     [RaisesException=Setter] attribute double volume;
  81     attribute boolean muted;
  82     [Reflect=muted] attribute boolean defaultMuted;
  83
  84     // tracks
  85     [RuntimeEnabled=AudioVideoTracks] readonly attribute AudioTrackList audioTracks;
  86     [RuntimeEnabled=AudioVideoTracks] readonly attribute VideoTrackList videoTracks;
  87     readonly attribute TextTrackList textTracks;
  88     [RaisesException] TextTrack addTextTrack(DOMString kind, optional DOMString label, optional DOMString language);
  89
  90     // WebKit extensions
  91
  92     // The number of bytes consumed by the media decoder.
  93     [MeasureAs=PrefixedAudioDecodedByteCount] readonly attribute unsigned long webkitAudioDecodedByteCount;
  94     [MeasureAs=PrefixedVideoDecodedByteCount] readonly attribute unsigned long webkitVideoDecodedByteCount;
  95
  96     [Reflect, RuntimeEnabled=SubresourceIntegrity] attribute DOMString integrity;
  97 };