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