Playable.h

Go to the documentation of this file.

/*------------------------------------------------------------------------------
 
    Copyright (c) 2004 Media Development Loan Fund
  
    This file is part of the Campcaster project.
    https://www.campware.org/
    To report bugs, send an e-mail to [email protected]
  
    Campcaster is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation; either version 2 of the License, or
    (at your option) any later version.
   
    Campcaster is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.
  
    You should have received a copy of the GNU General Public License
    along with Campcaster; if not, write to the Free Software
    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  
  
    Author   : $Author: fgerlits $
    Version  : $Revision: 2329 $
    Location : $URL: svn://code.campware.org/campcaster/trunk/campcaster/src/modules/core/include/LiveSupport/Core/Playable.h $
 
------------------------------------------------------------------------------*/
#ifndef LiveSupport_Core_Playable_h
 #define LiveSupport_Core_Playable_h
 
#ifndef __cplusplus
 #error This is a C++ include file
 #endif
 

/* ============================================================ include files */

#ifdef HAVE_CONFIG_H
 #include "configure.h"
#endif
 
#include <stdexcept>
#include <string>
#include <libxml++/libxml++.h>
#include <boost/date_time/posix_time/posix_time.hpp>
#include <boost/enable_shared_from_this.hpp>
#include <glibmm/ustring.h>

#include "LiveSupport/Core/Ptr.h"
#include "LiveSupport/Core/UniqueId.h"
#include "LiveSupport/Core/Configurable.h"


namespace LiveSupport {
namespace Core {

class   AudioClip;      // forward declarations to avoid circularity
class   Playlist;

using namespace boost::posix_time;

/* ================================================================ constants */


/* =================================================================== macros */


/* =============================================================== data types */

class Playable : public boost::enable_shared_from_this<Playable>
{
    public:

        enum Type { AudioClipType, PlaylistType };
 
    private:
 
        Type        type;
 
    protected:

        Playable(Type   typeParam)              throw ()
                    : type(typeParam)
        {
        }
 

    public:

        virtual
        ~Playable(void)                         throw ()
        {
        }

        virtual Ptr<UniqueId>::Ref
        getId(void) const                       throw () = 0;

        virtual Ptr<time_duration>::Ref
        getPlaylength(void) const               throw () = 0;


        virtual Ptr<const std::string>::Ref
        getUri(void) const                      throw () = 0;

        virtual void
        setUri(Ptr<const std::string>::Ref uri) throw () = 0;


        virtual Ptr<const std::string>::Ref
        getToken(void) const                    throw () = 0;

        virtual void
        setToken(Ptr<const std::string>::Ref token) 
                                                throw () = 0;


        virtual Ptr<const Glib::ustring>::Ref
        getTitle(void) const                    throw () = 0;

        virtual void
        setTitle(Ptr<const Glib::ustring>::Ref title)
                                                throw () = 0;


        virtual Ptr<Glib::ustring>::Ref
        getMetadata(const std::string &key) const
                                                throw () = 0;

        virtual void
        setMetadata(Ptr<const Glib::ustring>::Ref value, 
                    const std::string &key)
                                                throw (std::invalid_argument)
                                                                            = 0;

        virtual Ptr<Glib::ustring>::Ref
        getXmlElementString(void) const         throw () = 0;


        virtual Ptr<Glib::ustring>::Ref
        getXmlDocumentString(void) const        throw () = 0;


        Type
        getType(void) const                     throw ()
        {
            return type;
        }
 
        Ptr<AudioClip>::Ref
        getAudioClip(void)                      throw ();
 
        Ptr<Playlist>::Ref
        getPlaylist(void)                       throw ();
};


/* ================================================= external data structures */


/* ====================================================== function prototypes */


} // namespace Core
} // namespace LiveSupport

#endif // LiveSupport_Core_Playable_h
 

---