Home | History | Annotate | Download | only in html
      1 /*
      2  * Copyright (C) 2011 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 #ifndef MediaControllerInterface_h
     27 #define MediaControllerInterface_h
     28 
     29 #include "wtf/PassRefPtr.h"
     30 
     31 namespace WebCore {
     32 
     33 class ExceptionState;
     34 class TimeRanges;
     35 
     36 class MediaControllerInterface {
     37 public:
     38     virtual ~MediaControllerInterface() { };
     39 
     40     // MediaController IDL:
     41     virtual PassRefPtr<TimeRanges> buffered() const = 0;
     42     virtual PassRefPtr<TimeRanges> seekable() const = 0;
     43     virtual PassRefPtr<TimeRanges> played() = 0;
     44 
     45     virtual double duration() const = 0;
     46     virtual double currentTime() const = 0;
     47     virtual void setCurrentTime(double, ExceptionState&) = 0;
     48 
     49     virtual bool paused() const = 0;
     50     virtual void play() = 0;
     51     virtual void pause() = 0;
     52 
     53     virtual double defaultPlaybackRate() const = 0;
     54     virtual void setDefaultPlaybackRate(double) = 0;
     55 
     56     virtual double playbackRate() const = 0;
     57     virtual void setPlaybackRate(double) = 0;
     58 
     59     virtual double volume() const = 0;
     60     virtual void setVolume(double, ExceptionState&) = 0;
     61 
     62     virtual bool muted() const = 0;
     63     virtual void setMuted(bool) = 0;
     64 
     65     enum ReadyState { HAVE_NOTHING, HAVE_METADATA, HAVE_CURRENT_DATA, HAVE_FUTURE_DATA, HAVE_ENOUGH_DATA };
     66     virtual ReadyState readyState() const = 0;
     67 
     68     // MediaControlElements:
     69     virtual bool supportsFullscreen() const = 0;
     70     virtual bool isFullscreen() const = 0;
     71     virtual void enterFullscreen() = 0;
     72 
     73     virtual bool hasAudio() const = 0;
     74     virtual bool hasVideo() const = 0;
     75     virtual bool hasClosedCaptions() const = 0;
     76     virtual void setClosedCaptionsVisible(bool) = 0;
     77     virtual bool closedCaptionsVisible() const = 0;
     78 
     79     virtual void beginScrubbing() = 0;
     80     virtual void endScrubbing() = 0;
     81 
     82     virtual bool canPlay() const = 0;
     83 
     84     virtual bool hasCurrentSrc() const = 0;
     85 };
     86 
     87 }
     88 
     89 #endif
     90