mirror of
https://gitlab.winehq.org/wine/wine-gecko.git
synced 2024-09-13 09:24:08 -07:00
a81a17e866
Implements a media.mozGetMetadata() method returning a new javascript object whose properties are key value pairs respresenting metadata tags from the media resource. This data is available after readystate enters METADATA_LOADED. Currently this is only implemented for Ogg Vorbis streams. Media format metadata is parsed out by the media decoders. In the nsCodecStateMachine::ReadMetadata subclasses we fill in an nsDataHashtable pointer using the format-specifc api. The hash pointer is passed up to the media element as part of the MetadataLoaded event. The hash is deleted if the load is aborted. The audio metadata is also reset to zero (as in the constructor), resolving a todo comment.
113 lines
4.1 KiB
Plaintext
113 lines
4.1 KiB
Plaintext
/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
|
|
/* vim:set ts=2 sw=2 sts=2 et cindent: */
|
|
/* 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/. */
|
|
|
|
#include "nsIDOMHTMLElement.idl"
|
|
#include "nsIDOMMediaError.idl"
|
|
#include "nsIDOMTimeRanges.idl"
|
|
|
|
interface nsIDOMMediaStream;
|
|
|
|
/**
|
|
* The nsIDOMHTMLMediaElement interface is an interface to be implemented by the HTML
|
|
* <audio> and <video> elements.
|
|
*
|
|
* For more information on this interface, please see
|
|
* http://www.whatwg.org/specs/web-apps/current-work/#htmlmediaelement
|
|
*
|
|
* @status UNDER_DEVELOPMENT
|
|
*/
|
|
|
|
// undef the GetCurrentTime macro defined in WinBase.h from the MS Platform SDK
|
|
%{C++
|
|
#ifdef GetCurrentTime
|
|
#undef GetCurrentTime
|
|
#endif
|
|
%}
|
|
|
|
[scriptable, uuid(e901c0cb-0698-4470-b057-246f64fc7e57)]
|
|
interface nsIDOMHTMLMediaElement : nsIDOMHTMLElement
|
|
{
|
|
// error state
|
|
readonly attribute nsIDOMMediaError error;
|
|
|
|
// network state
|
|
[implicit_jscontext] attribute jsval src;
|
|
readonly attribute DOMString currentSrc;
|
|
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;
|
|
attribute DOMString preload;
|
|
readonly attribute nsIDOMTimeRanges buffered;
|
|
void load();
|
|
DOMString canPlayType(in 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
|
|
attribute double currentTime;
|
|
readonly attribute double initialTime;
|
|
readonly attribute double duration;
|
|
readonly attribute boolean paused;
|
|
readonly attribute nsIDOMTimeRanges played;
|
|
readonly attribute nsIDOMTimeRanges seekable;
|
|
readonly attribute boolean ended;
|
|
readonly attribute boolean mozAutoplayEnabled;
|
|
attribute boolean autoplay;
|
|
attribute boolean loop;
|
|
void play();
|
|
void pause();
|
|
|
|
// controls
|
|
attribute boolean controls;
|
|
attribute double volume;
|
|
attribute boolean muted;
|
|
attribute boolean defaultMuted;
|
|
|
|
// Mozilla extension: stream capture
|
|
nsIDOMMediaStream mozCaptureStream();
|
|
nsIDOMMediaStream mozCaptureStreamUntilEnded();
|
|
readonly attribute boolean mozAudioCaptured;
|
|
|
|
// Mozilla extension: extra stream metadata information, used as part
|
|
// of MozAudioAvailable events and the mozWriteAudio() method. The
|
|
// mozFrameBufferLength method allows for the size of the framebuffer
|
|
// used within MozAudioAvailable events to be changed. The new size must
|
|
// be between 512 and 16384. The default size, for a media element with
|
|
// audio is (mozChannels * 1024).
|
|
readonly attribute unsigned long mozChannels;
|
|
readonly attribute unsigned long mozSampleRate;
|
|
attribute unsigned long mozFrameBufferLength;
|
|
|
|
// 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.
|
|
[implicit_jscontext]
|
|
jsval mozGetMetadata();
|
|
|
|
// Mozilla extension: load data from another media element. This is like
|
|
// load() but we don't run the resource selection algorithm; instead
|
|
// we just set our source to other's currentSrc. This is optimized
|
|
// so that this element will get access to all of other's cached/
|
|
// buffered data. In fact any future data downloaded by this element or
|
|
// other will be sharable by both elements.
|
|
void mozLoadFrom(in nsIDOMHTMLMediaElement other);
|
|
|
|
// 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;
|
|
};
|