diff options
Diffstat (limited to 'dom/webidl/HTMLMediaElement.webidl')
| -rw-r--r-- | dom/webidl/HTMLMediaElement.webidl | 224 |
1 files changed, 224 insertions, 0 deletions
diff --git a/dom/webidl/HTMLMediaElement.webidl b/dom/webidl/HTMLMediaElement.webidl new file mode 100644 index 000000000..456579ec1 --- /dev/null +++ b/dom/webidl/HTMLMediaElement.webidl @@ -0,0 +1,224 @@ +/* -*- Mode: IDL; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */ +/* This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this file, + * You can obtain one at http://mozilla.org/MPL/2.0/. + * + * The origin of this IDL file is + * http://www.whatwg.org/specs/web-apps/current-work/#media-elements + * + * © Copyright 2004-2011 Apple Computer, Inc., Mozilla Foundation, and + * Opera Software ASA. You are granted a license to use, reproduce + * and create derivative works of this document. + */ + +interface HTMLMediaElement : HTMLElement { + + // error state + readonly attribute MediaError? error; + + // network state + [SetterThrows] + attribute DOMString src; + readonly attribute DOMString currentSrc; + + [SetterThrows] + attribute DOMString? crossOrigin; + const unsigned short NETWORK_EMPTY = 0; + const unsigned short NETWORK_IDLE = 1; + const unsigned short NETWORK_LOADING = 2; + const unsigned short NETWORK_NO_SOURCE = 3; + readonly attribute unsigned short networkState; + [SetterThrows] + attribute DOMString preload; + [NewObject] + readonly attribute TimeRanges buffered; + void load(); + DOMString canPlayType(DOMString type); + + // ready state + const unsigned short HAVE_NOTHING = 0; + const unsigned short HAVE_METADATA = 1; + const unsigned short HAVE_CURRENT_DATA = 2; + const unsigned short HAVE_FUTURE_DATA = 3; + const unsigned short HAVE_ENOUGH_DATA = 4; + readonly attribute unsigned short readyState; + readonly attribute boolean seeking; + + // playback state + [SetterThrows] + attribute double currentTime; + [Throws] + void fastSeek(double time); + readonly attribute unrestricted double duration; + [ChromeOnly] + readonly attribute boolean isEncrypted; + // TODO: Bug 847376 - readonly attribute any startDate; + readonly attribute boolean paused; + [SetterThrows] + attribute double defaultPlaybackRate; + [SetterThrows] + attribute double playbackRate; + [NewObject] + readonly attribute TimeRanges played; + [NewObject] + readonly attribute TimeRanges seekable; + readonly attribute boolean ended; + [SetterThrows] + attribute boolean autoplay; + [SetterThrows] + attribute boolean loop; + [Throws] + void play(); + [Throws] + void pause(); + + // TODO: Bug 847377 - mediaGroup and MediaController + // media controller + // attribute DOMString mediaGroup; + // attribute MediaController? controller; + + // controls + [SetterThrows] + attribute boolean controls; + [SetterThrows] + attribute double volume; + attribute boolean muted; + [SetterThrows] + attribute boolean defaultMuted; + + // TODO: Bug 847379 + // tracks + [Pref="media.track.enabled"] + readonly attribute AudioTrackList audioTracks; + [Pref="media.track.enabled"] + readonly attribute VideoTrackList videoTracks; + readonly attribute TextTrackList? textTracks; + TextTrack addTextTrack(TextTrackKind kind, + optional DOMString label = "", + optional DOMString language = ""); +}; + +// Mozilla extensions: +partial interface HTMLMediaElement { + [ChromeOnly] + readonly attribute MediaSource? mozMediaSourceObject; + [ChromeOnly] + readonly attribute DOMString mozDebugReaderData; + + [Pref="media.test.dumpDebugInfo"] + void mozDumpDebugInfo(); + + attribute MediaStream? srcObject; + // TODO: remove prefixed version soon (1183495). + attribute MediaStream? mozSrcObject; + + attribute boolean mozPreservesPitch; + readonly attribute boolean mozAutoplayEnabled; + + // NB: for internal use with the video controls: + [Func="IsChromeOrXBL"] attribute boolean mozAllowCasting; + [Func="IsChromeOrXBL"] attribute boolean mozIsCasting; + + // Mozilla extension: stream capture + [Throws, UnsafeInPrerendering] + MediaStream mozCaptureStream(); + [Throws, UnsafeInPrerendering] + MediaStream mozCaptureStreamUntilEnded(); + readonly attribute boolean mozAudioCaptured; + + // Mozilla extension: return embedded metadata from the stream as a + // JSObject with key:value pairs for each tag. This can be used by + // player interfaces to display the song title, artist, etc. + [Throws] + object? mozGetMetadata(); + + // Mozilla extension: provides access to the fragment end time if + // the media element has a fragment URI for the currentSrc, otherwise + // it is equal to the media duration. + readonly attribute double mozFragmentEnd; + + // Mozilla extension: an audio channel type for media elements. + // Read AudioChannel.webidl for more information about this attribute. + [SetterThrows, Pref="media.useAudioChannelAPI"] + attribute AudioChannel mozAudioChannelType; + + // In addition the media element has this new events: + // * onmozinterruptbegin - called when the media element is interrupted + // because of the audiochannel manager. + // * onmozinterruptend - called when the interruption is concluded + [Pref="media.useAudioChannelAPI"] + attribute EventHandler onmozinterruptbegin; + + [Pref="media.useAudioChannelAPI"] + attribute EventHandler onmozinterruptend; +}; + +// Encrypted Media Extensions +partial interface HTMLMediaElement { + [Pref="media.eme.apiVisible"] + readonly attribute MediaKeys? mediaKeys; + + // void, not any: https://www.w3.org/Bugs/Public/show_bug.cgi?id=26457 + [Pref="media.eme.apiVisible", NewObject] + Promise<void> setMediaKeys(MediaKeys? mediaKeys); + + [Pref="media.eme.apiVisible"] + attribute EventHandler onencrypted; + + [Pref="media.eme.apiVisible"] + attribute EventHandler onwaitingforkey; +}; + +// This is just for testing +partial interface HTMLMediaElement { + [Pref="media.useAudioChannelService.testing"] + readonly attribute double computedVolume; + [Pref="media.useAudioChannelService.testing"] + readonly attribute boolean computedMuted; + [Pref="media.useAudioChannelService.testing"] + readonly attribute unsigned long computedSuspended; +}; + +/* + * HTMLMediaElement::seekToNextFrame() is a Mozilla experimental feature. + * + * The SeekToNextFrame() method provides a way to access a video element's video + * frames one by one without going through the realtime playback. So, it lets + * authors use "frame" as unit to access the video element's underlying data, + * instead of "time". + * + * The SeekToNextFrame() is a kind of seek operation, so normally, once it is + * invoked, a "seeking" event is dispatched. However, if the media source has no + * video data or is not seekable, the operation is ignored without filing the + * "seeking" event. + * + * Once the SeekToNextFrame() is done, a "seeked" event should always be filed + * and a "ended" event might also be filed depends on where the media element's + * position before seeking was. There are two cases: + * Assume the media source has n+1 video frames where n is a non-negative + * integers and the frame sequence is indexed from zero. + * (1) If the currentTime is at anywhere smaller than the n-th frame's beginning + * time, say the currentTime is now pointing to a position which is smaller + * than the x-th frame's beginning time and larger or equal to the (x-1)-th + * frame's beginning time, where x belongs to [1, n], then the + * SeekToNextFrame() operation seeks the media to the x-th frame, sets the + * media's currentTime to the x-th frame's beginning time and dispatches a + * "seeked" event. + * (2) Otherwise, if the currentTime is larger or equal to the n-th frame's + * beginning time, then the SeekToNextFrame() operation sets the media's + * currentTime to the duration of the media source and dispatches a "seeked" + * event and an "ended" event. + */ +partial interface HTMLMediaElement { + [Throws, Pref="media.seekToNextFrame.enabled"] + Promise<void> seekToNextFrame(); +}; + +/* + * This is an API for simulating visibility changes to help debug and write + * tests about suspend-video-decoding. + */ +partial interface HTMLMediaElement { + [Pref="media.test.setVisible"] + void setVisible(boolean aVisible); +}; |