michael@0: /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
michael@0: /* vim:set ts=2 sw=2 sts=2 et cindent: */
michael@0: /* This Source Code Form is subject to the terms of the Mozilla Public
michael@0:  * License, v. 2.0. If a copy of the MPL was not distributed with this
michael@0:  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
michael@0: 
michael@0: #include "nsIDOMHTMLElement.idl"
michael@0: #include "nsIDOMMediaError.idl"
michael@0: #include "nsIDOMTimeRanges.idl"
michael@0: 
michael@0: interface nsIDOMMediaStream;
michael@0: 
michael@0: /**
michael@0:  * The nsIDOMHTMLMediaElement interface is an interface to be implemented by the HTML
michael@0:  * <audio> and <video> elements.
michael@0:  *
michael@0:  * For more information on this interface, please see
michael@0:  * http://www.whatwg.org/specs/web-apps/current-work/#htmlmediaelement
michael@0:  *
michael@0:  * @status UNDER_DEVELOPMENT
michael@0:  */
michael@0: 
michael@0: // undef the GetCurrentTime macro defined in WinBase.h from the MS Platform SDK
michael@0: %{C++
michael@0: #ifdef GetCurrentTime
michael@0: #undef GetCurrentTime
michael@0: #endif
michael@0: %}
michael@0: 
michael@0: [scriptable, uuid(1f9393e8-2df0-4072-87b9-c26999b09acc)]
michael@0: interface nsIDOMHTMLMediaElement : nsISupports
michael@0: {
michael@0:   // error state
michael@0:   readonly attribute nsIDOMMediaError error;
michael@0: 
michael@0:   // network state
michael@0:            attribute DOMString src;
michael@0:            attribute nsIDOMMediaStream mozSrcObject;
michael@0:   readonly attribute DOMString currentSrc;
michael@0:            attribute DOMString crossOrigin;
michael@0:   const unsigned short NETWORK_EMPTY = 0;
michael@0:   const unsigned short NETWORK_IDLE = 1;
michael@0:   const unsigned short NETWORK_LOADING = 2;
michael@0:   const unsigned short NETWORK_NO_SOURCE = 3;
michael@0:   readonly attribute unsigned short networkState;
michael@0:            attribute DOMString preload;
michael@0:   readonly attribute nsIDOMTimeRanges buffered;
michael@0:   void load();
michael@0:   DOMString canPlayType(in DOMString type);
michael@0: 
michael@0:   // ready state
michael@0:   const unsigned short HAVE_NOTHING = 0;
michael@0:   const unsigned short HAVE_METADATA = 1;
michael@0:   const unsigned short HAVE_CURRENT_DATA = 2;
michael@0:   const unsigned short HAVE_FUTURE_DATA = 3;
michael@0:   const unsigned short HAVE_ENOUGH_DATA = 4;
michael@0:   readonly attribute unsigned short readyState;
michael@0:   readonly attribute boolean seeking;
michael@0: 
michael@0:   // playback state
michael@0:            attribute double currentTime;
michael@0:   readonly attribute double duration;
michael@0:   readonly attribute boolean paused;
michael@0:            attribute double defaultPlaybackRate;
michael@0:            attribute double playbackRate;
michael@0:            attribute boolean mozPreservesPitch;
michael@0:   readonly attribute nsIDOMTimeRanges played;
michael@0:   readonly attribute nsIDOMTimeRanges seekable;
michael@0:   readonly attribute boolean ended;
michael@0:   readonly attribute boolean mozAutoplayEnabled;
michael@0:            attribute boolean autoplay;
michael@0:            attribute boolean loop;
michael@0:   void play();
michael@0:   void pause();
michael@0: 
michael@0:   // controls
michael@0:            attribute boolean controls;
michael@0:            attribute double volume;
michael@0:            attribute boolean muted;
michael@0:            attribute boolean defaultMuted;
michael@0: 
michael@0:   // Mozilla extension: stream capture
michael@0:   nsIDOMMediaStream mozCaptureStream();
michael@0:   nsIDOMMediaStream mozCaptureStreamUntilEnded();
michael@0:   readonly attribute boolean mozAudioCaptured;
michael@0: 
michael@0:   // Mozilla extension: return embedded metadata from the stream as a
michael@0:   // JSObject with key:value pairs for each tag. This can be used by
michael@0:   // player interfaces to display the song title, artist, etc.
michael@0:   [implicit_jscontext]
michael@0:   jsval mozGetMetadata();
michael@0: 
michael@0:   // Mozilla extension: provides access to the fragment end time if
michael@0:   // the media element has a fragment URI for the currentSrc, otherwise
michael@0:   // it is equal to the media duration.
michael@0:   readonly attribute double mozFragmentEnd;
michael@0: 
michael@0:    // Mozilla extension: an audio channel type for media elements.
michael@0:    // An exception is thrown if the app tries to change the audio channel type
michael@0:    // without the permission (manifest file for B2G apps).
michael@0:    // The supported values are:
michael@0:    // * normal (default value)
michael@0:    //   Automatically paused if "notification" or higher priority channel
michael@0:    //   is played
michael@0:    //   Use case: normal applications
michael@0:    // * content
michael@0:    //   Automatically paused if "notification" or higher priority channel
michael@0:    //   is played. Also paused if another app starts using "content"
michael@0:    //   channel. Using this channel never affects applications using
michael@0:    //   the "normal" channel.
michael@0:    //   Use case: video/audio players
michael@0:    // * notification
michael@0:    //   Automatically paused if "alarm" or higher priority channel is played.
michael@0:    //   Use case: New email, incoming SMS
michael@0:    // * alarm
michael@0:    //   Automatically paused if "telephony" or higher priority channel is
michael@0:    //   played.
michael@0:    //   User case: Alarm clock, calendar alarms
michael@0:    // * telephony
michael@0:    //   Automatically paused if "ringer" or higher priority
michael@0:    //   channel is played.
michael@0:    //   Use case: dialer, voip
michael@0:    // * ringer
michael@0:    //   Automatically paused if "publicnotification" or higher priority
michael@0:    //   channel is played.
michael@0:    //   Use case: dialer, voip
michael@0:    // * publicnotification
michael@0:    //   Always plays in speaker, even when headphones are plugged in.
michael@0:    //   Use case: Camera shutter sound.
michael@0:    attribute DOMString mozAudioChannelType;
michael@0: 
michael@0:   // In addition the media element has this new events:
michael@0:   // * onmozinterruptbegin - called when the media element is interrupted
michael@0:   //   because of the audiochannel manager.
michael@0:   // * onmozinterruptend - called when the interruption is concluded
michael@0: };