WebCore:
[WebKit-https.git] / WebCore / html / HTMLMediaElement.idl
1 /*
2  * Copyright (C) 2007 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 module html {
27 interface [GenerateConstructor, Conditional=VIDEO] HTMLMediaElement : HTMLElement {
28
29     // error state
30     readonly attribute MediaError error;
31
32     // network state
33     attribute DOMString src;
34     readonly attribute DOMString currentSrc;
35     
36     const unsigned short EMPTY = 0;
37     const unsigned short LOADING = 1;
38     const unsigned short LOADED_METADATA = 2;
39     const unsigned short LOADED_FIRST_FRAME = 3;
40     const unsigned short LOADED = 4;
41     readonly attribute unsigned short networkState;
42     readonly attribute float bufferingRate;
43     readonly attribute TimeRanges buffered;
44     void load() 
45         raises (DOMException);
46
47     // ready state
48     const unsigned short DATA_UNAVAILABLE = 0;
49     const unsigned short CAN_SHOW_CURRENT_FRAME = 1;
50     const unsigned short CAN_PLAY = 2;
51     const unsigned short CAN_PLAY_THROUGH = 3;
52     readonly attribute unsigned short readyState;
53     readonly attribute boolean seeking;
54
55     // playback state
56     attribute float currentTime
57         setter raises (DOMException);
58     readonly attribute float duration;
59     readonly attribute boolean paused;
60     attribute float defaultPlaybackRate 
61         setter raises (DOMException);
62     attribute float playbackRate 
63         setter raises (DOMException);
64     readonly attribute TimeRanges played;
65     readonly attribute TimeRanges seekable;
66     readonly attribute boolean ended;
67     attribute boolean autoplay;
68     void play() 
69         raises (DOMException);
70     void pause() 
71         raises (DOMException);
72
73     // looping
74     attribute float start;
75     attribute float end;
76     attribute float loopStart;
77     attribute float loopEnd;
78     attribute unsigned long playCount
79         setter raises (DOMException);
80     attribute unsigned long currentLoop;
81
82     // cue points
83     void addCuePoint(in float time, in VoidCallback callback, in boolean pause);
84     void removeCuePoint(in float time, in VoidCallback callback);
85
86     // controls
87     attribute boolean controls;
88     attribute float volume 
89         setter raises (DOMException);
90     attribute boolean muted;
91 };
92 }