xbmc/video/Bookmark.h

   1 /*
   2  *  Copyright (C) 2005-2018 Team Kodi
   3  *  This file is part of Kodi - https://kodi.tv
   4  *
   5  *  SPDX-License-Identifier: GPL-2.0-or-later
   6  *  See LICENSES/README.md for more information.
   7  */
   8
   9 #pragma once
  10
  11 #include <string>
  12 #include <vector>
  13
  14 class CBookmark
  15 {
  16 public:
  17   CBookmark();
  18   void Reset();
  19
  20   /*! \brief returns true if this bookmark has been set.
  21    \return true if totalTimeInSeconds is positive.
  22    */
  23   bool IsSet() const;
  24
  25   /*! \brief returns true if this bookmark is part way through the video file
  26    \return true if both totalTimeInSeconds and timeInSeconds are positive.
  27    */
  28   bool IsPartWay() const;
  29
  30   /*! \brief returns true if this bookmark has a stored serialized player state
  31    \return true if playerState is not empty.
  32    */
  33   bool HasSavedPlayerState() const;
  34
  35   double timeInSeconds;
  36   double totalTimeInSeconds;
  37   long partNumber;
  38   std::string thumbNailImage;
  39   std::string playerState;
  40   std::string player;
  41   long seasonNumber;
  42   long episodeNumber;
  43
  44   enum EType
  45   {
  46     STANDARD = 0,
  47     RESUME = 1,
  48     EPISODE = 2
  49   } type;
  50 };
  51
  52 typedef std::vector<CBookmark> VECBOOKMARKS;
  53