slideshow/source/inc/iexternalmediashapebase.hxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #ifndef INCLUDED_SLIDESHOW_SOURCE_INC_IEXTERNALMEDIASHAPEBASE_HXX
  21 #define INCLUDED_SLIDESHOW_SOURCE_INC_IEXTERNALMEDIASHAPEBASE_HXX
  22
  23 #include <boost/shared_ptr.hpp>
  24
  25 #include "shape.hxx"
  26
  27
  28 namespace slideshow
  29 {
  30     namespace internal
  31     {
  32         /** Represents a shape containing playable content rendered by
  33             external engine (e.g. media or applet).
  34
  35             This interface adds media handling methods to a shape. It
  36             allows starting/stopping and pausing playback.
  37         */
  38         class IExternalMediaShapeBase : public Shape
  39         {
  40         public:
  41             // Animation methods
  42
  43
  44             /** Notify the Shape that it should start with playback
  45
  46                 This method enters playback mode on all registered
  47                 views. It makes the media initially visible (for videos).
  48              */
  49             virtual void play() = 0;
  50
  51             /** Notify the Shape that it should stop playback
  52
  53                 This method leaves playback mode on all registered
  54                 views. The media is then rewound to the start, and
  55                 removed from screen (for videos)
  56              */
  57             virtual void stop() = 0;
  58
  59             /** Notify the Shape that it should pause playback
  60
  61                 This method stops playback on all registered
  62                 views. The media stays visible (for videos)
  63              */
  64             virtual void pause() = 0;
  65
  66             /** Query whether the media is currently playing.
  67              */
  68             virtual bool isPlaying() const = 0;
  69
  70             /** Set media time in seconds.
  71
  72             @param fTime
  73             Time in seconds of the media time line, that should now be
  74             presented
  75              */
  76             virtual void setMediaTime(double fTime) = 0;
  77         };
  78
  79         typedef ::boost::shared_ptr< IExternalMediaShapeBase > IExternalMediaShapeBaseSharedPtr;
  80
  81     }
  82 }
  83
  84 #endif // INCLUDED_SLIDESHOW_SOURCE_INC_IEXTERNALMEDIASHAPEBASE_HXX
  85
  86 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */