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#if ENABLE(VIDEO)
30
31#include <wtf/PassRefPtr.h>
32
33namespace WebCore {
34
35class TimeRanges;
36
37typedef int ExceptionCode;
38
39class MediaControllerInterface {
40public:
41    virtual ~MediaControllerInterface() { };
42
43    // MediaController IDL:
44    virtual PassRefPtr<TimeRanges> buffered() const = 0;
45    virtual PassRefPtr<TimeRanges> seekable() const = 0;
46    virtual PassRefPtr<TimeRanges> played() = 0;
47
48    virtual double duration() const = 0;
49    virtual double currentTime() const = 0;
50    virtual void setCurrentTime(double, ExceptionCode&) = 0;
51
52    virtual bool paused() const = 0;
53    virtual void play() = 0;
54    virtual void pause() = 0;
55
56    virtual double defaultPlaybackRate() const = 0;
57    virtual void setDefaultPlaybackRate(double) = 0;
58
59    virtual double playbackRate() const = 0;
60    virtual void setPlaybackRate(double) = 0;
61
62    virtual double volume() const = 0;
63    virtual void setVolume(double, ExceptionCode&) = 0;
64
65    virtual bool muted() const = 0;
66    virtual void setMuted(bool) = 0;
67
68    enum ReadyState { HAVE_NOTHING, HAVE_METADATA, HAVE_CURRENT_DATA, HAVE_FUTURE_DATA, HAVE_ENOUGH_DATA };
69    virtual ReadyState readyState() const = 0;
70
71    // MediaControlElements:
72    virtual bool supportsFullscreen() const = 0;
73    virtual bool isFullscreen() const = 0;
74    virtual void enterFullscreen() = 0;
75
76    virtual bool hasAudio() const = 0;
77    virtual bool hasVideo() const = 0;
78    virtual bool hasClosedCaptions() const = 0;
79    virtual void setClosedCaptionsVisible(bool) = 0;
80    virtual bool closedCaptionsVisible() const = 0;
81
82    virtual bool supportsScanning() const = 0;
83
84    virtual void beginScrubbing() = 0;
85    virtual void endScrubbing() = 0;
86
87    virtual bool canPlay() const = 0;
88
89    virtual bool isLiveStream() const = 0;
90
91    virtual bool hasCurrentSrc() const = 0;
92
93    virtual void returnToRealtime() = 0;
94};
95
96}
97
98#endif
99#endif
100