1*b1cdbd2cSJim Jagielski /**************************************************************
2*b1cdbd2cSJim Jagielski  *
3*b1cdbd2cSJim Jagielski  * Licensed to the Apache Software Foundation (ASF) under one
4*b1cdbd2cSJim Jagielski  * or more contributor license agreements.  See the NOTICE file
5*b1cdbd2cSJim Jagielski  * distributed with this work for additional information
6*b1cdbd2cSJim Jagielski  * regarding copyright ownership.  The ASF licenses this file
7*b1cdbd2cSJim Jagielski  * to you under the Apache License, Version 2.0 (the
8*b1cdbd2cSJim Jagielski  * "License"); you may not use this file except in compliance
9*b1cdbd2cSJim Jagielski  * with the License.  You may obtain a copy of the License at
10*b1cdbd2cSJim Jagielski  *
11*b1cdbd2cSJim Jagielski  *   http://www.apache.org/licenses/LICENSE-2.0
12*b1cdbd2cSJim Jagielski  *
13*b1cdbd2cSJim Jagielski  * Unless required by applicable law or agreed to in writing,
14*b1cdbd2cSJim Jagielski  * software distributed under the License is distributed on an
15*b1cdbd2cSJim Jagielski  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16*b1cdbd2cSJim Jagielski  * KIND, either express or implied.  See the License for the
17*b1cdbd2cSJim Jagielski  * specific language governing permissions and limitations
18*b1cdbd2cSJim Jagielski  * under the License.
19*b1cdbd2cSJim Jagielski  *
20*b1cdbd2cSJim Jagielski  *************************************************************/
21*b1cdbd2cSJim Jagielski 
22*b1cdbd2cSJim Jagielski 
23*b1cdbd2cSJim Jagielski 
24*b1cdbd2cSJim Jagielski #ifndef INCLUDED_SLIDESHOW_EXTERNALMEDIASHAPE_HXX
25*b1cdbd2cSJim Jagielski #define INCLUDED_SLIDESHOW_EXTERNALMEDIASHAPE_HXX
26*b1cdbd2cSJim Jagielski 
27*b1cdbd2cSJim Jagielski #include <boost/shared_ptr.hpp>
28*b1cdbd2cSJim Jagielski 
29*b1cdbd2cSJim Jagielski #include "shape.hxx"
30*b1cdbd2cSJim Jagielski 
31*b1cdbd2cSJim Jagielski 
32*b1cdbd2cSJim Jagielski namespace slideshow
33*b1cdbd2cSJim Jagielski {
34*b1cdbd2cSJim Jagielski     namespace internal
35*b1cdbd2cSJim Jagielski     {
36*b1cdbd2cSJim Jagielski         /** Represents a shape containing media (video, sound).
37*b1cdbd2cSJim Jagielski 
38*b1cdbd2cSJim Jagielski             This interface adds media handling methods to a shape. It
39*b1cdbd2cSJim Jagielski             allows starting/stopping and pausing playback.
40*b1cdbd2cSJim Jagielski          */
41*b1cdbd2cSJim Jagielski         class ExternalMediaShape : public Shape
42*b1cdbd2cSJim Jagielski         {
43*b1cdbd2cSJim Jagielski         public:
44*b1cdbd2cSJim Jagielski             // Animation methods
45*b1cdbd2cSJim Jagielski             //------------------------------------------------------------------
46*b1cdbd2cSJim Jagielski 
47*b1cdbd2cSJim Jagielski             /** Notify the Shape that it should start with playback
48*b1cdbd2cSJim Jagielski 
49*b1cdbd2cSJim Jagielski 				This method enters playback mode on all registered
50*b1cdbd2cSJim Jagielski 				views. It makes the media initially visible (for videos).
51*b1cdbd2cSJim Jagielski              */
52*b1cdbd2cSJim Jagielski             virtual void play() = 0;
53*b1cdbd2cSJim Jagielski 
54*b1cdbd2cSJim Jagielski             /** Notify the Shape that it should stop playback
55*b1cdbd2cSJim Jagielski 
56*b1cdbd2cSJim Jagielski 				This method leaves playback mode on all registered
57*b1cdbd2cSJim Jagielski 				views. The media is then rewound to the start, and
58*b1cdbd2cSJim Jagielski             removed from screen (for videos)
59*b1cdbd2cSJim Jagielski              */
60*b1cdbd2cSJim Jagielski             virtual void stop() = 0;
61*b1cdbd2cSJim Jagielski 
62*b1cdbd2cSJim Jagielski             /** Notify the Shape that it should pause playback
63*b1cdbd2cSJim Jagielski 
64*b1cdbd2cSJim Jagielski 				This method stops playback on all registered
65*b1cdbd2cSJim Jagielski 				views. The media stays visible (for videos)
66*b1cdbd2cSJim Jagielski              */
67*b1cdbd2cSJim Jagielski             virtual void pause() = 0;
68*b1cdbd2cSJim Jagielski 
69*b1cdbd2cSJim Jagielski             /** Query whether the media is currently playing.
70*b1cdbd2cSJim Jagielski              */
71*b1cdbd2cSJim Jagielski             virtual bool isPlaying() const = 0;
72*b1cdbd2cSJim Jagielski 
73*b1cdbd2cSJim Jagielski             /** Set media time in seconds.
74*b1cdbd2cSJim Jagielski 
75*b1cdbd2cSJim Jagielski             @param fTime
76*b1cdbd2cSJim Jagielski             Time in seconds of the media time line, that should now be
77*b1cdbd2cSJim Jagielski             presented
78*b1cdbd2cSJim Jagielski              */
79*b1cdbd2cSJim Jagielski             virtual void setMediaTime(double fTime) = 0;
80*b1cdbd2cSJim Jagielski         };
81*b1cdbd2cSJim Jagielski 
82*b1cdbd2cSJim Jagielski         typedef ::boost::shared_ptr< ExternalMediaShape > ExternalMediaShapeSharedPtr;
83*b1cdbd2cSJim Jagielski 
84*b1cdbd2cSJim Jagielski     }
85*b1cdbd2cSJim Jagielski }
86*b1cdbd2cSJim Jagielski 
87*b1cdbd2cSJim Jagielski #endif /* INCLUDED_SLIDESHOW_EXTERNALMEDIASHAPE_HXX */
88