slideshow/source/inc/externalmediashape.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_EXTERNALMEDIASHAPE_HXX
  21 #define INCLUDED_SLIDESHOW_EXTERNALMEDIASHAPE_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 media (video, sound).
  33
  34             This interface adds media handling methods to a shape. It
  35             allows starting/stopping and pausing playback.
  36          */
  37         class ExternalMediaShape : public Shape
  38         {
  39         public:
  40             // Animation methods
  41             //------------------------------------------------------------------
  42
  43             /** Notify the Shape that it should start with playback
  44
  45                 This method enters playback mode on all registered
  46                 views. It makes the media initially visible (for videos).
  47              */
  48             virtual void play() = 0;
  49
  50             /** Notify the Shape that it should stop playback
  51
  52                 This method leaves playback mode on all registered
  53                 views. The media is then rewound to the start, and
  54             removed from screen (for videos)
  55              */
  56             virtual void stop() = 0;
  57
  58             /** Notify the Shape that it should pause playback
  59
  60                 This method stops playback on all registered
  61                 views. The media stays visible (for videos)
  62              */
  63             virtual void pause() = 0;
  64
  65             /** Query whether the media is currently playing.
  66              */
  67             virtual bool isPlaying() const = 0;
  68
  69             /** Set media time in seconds.
  70
  71             @param fTime
  72             Time in seconds of the media time line, that should now be
  73             presented
  74              */
  75             virtual void setMediaTime(double fTime) = 0;
  76         };
  77
  78         typedef ::boost::shared_ptr< ExternalMediaShape > ExternalMediaShapeSharedPtr;
  79
  80     }
  81 }
  82
  83 #endif /* INCLUDED_SLIDESHOW_EXTERNALMEDIASHAPE_HXX */
  84
  85 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */