src/html/HTMLMediaElement.idl

0001 /*
0002  * Copyright (C) 2007 Apple Inc.  All rights reserved.
0003  *
0004  * Redistribution and use in source and binary forms, with or without
0005  * modification, are permitted provided that the following conditions
0006  * are met:
0007  * 1. Redistributions of source code must retain the above copyright
0008  *    notice, this list of conditions and the following disclaimer.
0009  * 2. Redistributions in binary form must reproduce the above copyright
0010  *    notice, this list of conditions and the following disclaimer in the
0011  *    documentation and/or other materials provided with the distribution.
0012  *
0013  * THIS SOFTWARE IS PROVIDED BY APPLE COMPUTER, INC. ``AS IS'' AND ANY
0014  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
0015  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
0016  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE COMPUTER, INC. OR
0017  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
0018  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
0019  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
0020  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
0021  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
0022  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
0023  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
0024  */
0025
0026 module html {
0027 interface [GenerateConstructor, Conditional=VIDEO] HTMLMediaElement : HTMLElement {
0028
0029     // error state
0030     readonly attribute MediaError error;
0031
0032     // network state
0033              attribute DOMString src;
0034     readonly attribute DOMString currentSrc;
0035
0036     const unsigned short NETWORK_EMPTY = 0;
0037     const unsigned short NETWORK_IDLE = 1;
0038     const unsigned short NETWORK_LOADING = 2;
0039     const unsigned short NETWORK_NO_SOURCE = 3;
0040     readonly attribute unsigned short networkState;
0041              attribute boolean autobuffer;
0042     readonly attribute TimeRanges buffered;
0043     void load()
0044         raises (DOMException);
0045     DOMString canPlayType(in DOMString type);
0046
0047     // ready state
0048     const unsigned short HAVE_NOTHING = 0;
0049     const unsigned short HAVE_METADATA = 1;
0050     const unsigned short HAVE_CURRENT_DATA = 2;
0051     const unsigned short HAVE_FUTURE_DATA = 3;
0052     const unsigned short HAVE_ENOUGH_DATA = 4;
0053     readonly attribute unsigned short readyState;
0054     readonly attribute boolean seeking;
0055
0056     // playback state
0057              attribute float currentTime
0058                  setter raises (DOMException);
0059     readonly attribute float startTime;
0060     readonly attribute float duration;
0061     readonly attribute boolean paused;
0062              attribute float defaultPlaybackRate
0063                  setter raises (DOMException);
0064              attribute float playbackRate
0065                  setter raises (DOMException);
0066     readonly attribute TimeRanges played;
0067     readonly attribute TimeRanges seekable;
0068     readonly attribute boolean ended;
0069              attribute boolean autoplay;
0070              attribute boolean loop;
0071     void play()
0072         raises (DOMException);
0073     void pause()
0074         raises (DOMException);
0075
0076     // controls
0077              attribute boolean controls;
0078              attribute float volume
0079                  setter raises (DOMException);
0080              attribute boolean muted;
0081 };
0082 }