1 /*************************************************************************
2  *
3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4  *
5  * Copyright 2000, 2010 Oracle and/or its affiliates.
6  *
7  * OpenOffice.org - a multi-platform office productivity suite
8  *
9  * This file is part of OpenOffice.org.
10  *
11  * OpenOffice.org is free software: you can redistribute it and/or modify
12  * it under the terms of the GNU Lesser General Public License version 3
13  * only, as published by the Free Software Foundation.
14  *
15  * OpenOffice.org is distributed in the hope that it will be useful,
16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18  * GNU Lesser General Public License version 3 for more details
19  * (a copy is included in the LICENSE file that accompanied this code).
20  *
21  * You should have received a copy of the GNU Lesser General Public License
22  * version 3 along with OpenOffice.org.  If not, see
23  * <http://www.openoffice.org/license.html>
24  * for a copy of the LGPLv3 License.
25  *
26  ************************************************************************/
27 
28 #ifndef INCLUDED_SLIDESHOW_EXTERNALMEDIASHAPE_HXX
29 #define INCLUDED_SLIDESHOW_EXTERNALMEDIASHAPE_HXX
30 
31 #include <boost/shared_ptr.hpp>
32 
33 #include "shape.hxx"
34 
35 
36 namespace slideshow
37 {
38     namespace internal
39     {
40         /** Represents a shape containing media (video, sound).
41 
42             This interface adds media handling methods to a shape. It
43             allows starting/stopping and pausing playback.
44          */
45         class ExternalMediaShape : public Shape
46         {
47         public:
48             // Animation methods
49             //------------------------------------------------------------------
50 
51             /** Notify the Shape that it should start with playback
52 
53 				This method enters playback mode on all registered
54 				views. It makes the media initially visible (for videos).
55              */
56             virtual void play() = 0;
57 
58             /** Notify the Shape that it should stop playback
59 
60 				This method leaves playback mode on all registered
61 				views. The media is then rewound to the start, and
62             removed from screen (for videos)
63              */
64             virtual void stop() = 0;
65 
66             /** Notify the Shape that it should pause playback
67 
68 				This method stops playback on all registered
69 				views. The media stays visible (for videos)
70              */
71             virtual void pause() = 0;
72 
73             /** Query whether the media is currently playing.
74              */
75             virtual bool isPlaying() const = 0;
76 
77             /** Set media time in seconds.
78 
79             @param fTime
80             Time in seconds of the media time line, that should now be
81             presented
82              */
83             virtual void setMediaTime(double fTime) = 0;
84         };
85 
86         typedef ::boost::shared_ptr< ExternalMediaShape > ExternalMediaShapeSharedPtr;
87 
88     }
89 }
90 
91 #endif /* INCLUDED_SLIDESHOW_EXTERNALMEDIASHAPE_HXX */
92