Kodi Documentation 22.0
Kodi is an open source media player and entertainment hub.
Loading...
Searching...
No Matches
CBookmark Class Reference

#include <Bookmark.h>

Public Types

enum  EType { STANDARD = 0 , RESUME = 1 , EPISODE = 2 }
 

Public Member Functions

 CBookmark ()
 
void Reset ()
 
bool IsSet () const
 returns true if this bookmark has been set.
 
bool IsPartWay () const
 returns true if this bookmark is part way through the video file
 
bool HasSavedPlayerState () const
 returns true if this bookmark has a stored serialized player state
 

Public Attributes

double timeInSeconds
 
double totalTimeInSeconds
 
long partNumber
 
std::string thumbNailImage
 
std::string playerState
 
std::string player
 
long seasonNumber
 
long episodeNumber
 
enum CBookmark::EType type
 

Member Enumeration Documentation

◆ EType

Enumerator
STANDARD 
RESUME 
EPISODE 

Constructor & Destructor Documentation

◆ CBookmark()

CBookmark::CBookmark ( )

Member Function Documentation

◆ HasSavedPlayerState()

bool CBookmark::HasSavedPlayerState ( ) const

returns true if this bookmark has a stored serialized player state

Returns
true if playerState is not empty.

◆ IsPartWay()

bool CBookmark::IsPartWay ( ) const

returns true if this bookmark is part way through the video file

Returns
true if both totalTimeInSeconds and timeInSeconds are positive.

◆ IsSet()

bool CBookmark::IsSet ( ) const

returns true if this bookmark has been set.

Returns
true if totalTimeInSeconds is positive.

◆ Reset()

void CBookmark::Reset ( )

Member Data Documentation

◆ episodeNumber

long CBookmark::episodeNumber

◆ partNumber

long CBookmark::partNumber

◆ player

std::string CBookmark::player

◆ playerState

std::string CBookmark::playerState

◆ seasonNumber

long CBookmark::seasonNumber

◆ thumbNailImage

std::string CBookmark::thumbNailImage

◆ timeInSeconds

double CBookmark::timeInSeconds

◆ totalTimeInSeconds

double CBookmark::totalTimeInSeconds

◆ type

enum CBookmark::EType CBookmark::type

The documentation for this class was generated from the following files: