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

Static Public Member Functions
static bool	GetBookmarksForFile (const std::string &filePath, VECBOOKMARKS &bookmarks, std::vector< EType > types)
	Retrieve bookmarks for the file.
static std::vector< std::chrono::milliseconds >	BookmarksToPositions (const VECBOOKMARKS &bookmarks)
	Create a list of the start timestamps of the standard bookmarks from the provided list.
static void	AddToPositions (const CBookmark &bookmark, std::vector< std::chrono::milliseconds > &positions)
	Add a bookmark to the provided list.

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

Member Enumeration Documentation

EType

enum CBookmark::EType

Enumerator
STANDARD
RESUME
EPISODE

Constructor & Destructor Documentation

CBookmark()

CBookmark::CBookmark

(

)

Member Function Documentation

AddToPositions()

void CBookmark::AddToPositions ( const CBookmark & bookmark, std::vector< std::chrono::milliseconds > & positions )

static

Add a bookmark to the provided list.

Parameters

[in]	bookmark	the bookmark
[in]	positions	list of bookmark start timestamps

Todo

use a std::set instead?

BookmarksToPositions()

std::vector< std::chrono::milliseconds > CBookmark::BookmarksToPositions ( const VECBOOKMARKS & bookmarks )

static

Create a list of the start timestamps of the standard bookmarks from the provided list.

Parameters

[in]

bookmarks

list of bookmarks

Returns

list of bookmarks' start timestamp

GetBookmarksForFile()

bool CBookmark::GetBookmarksForFile ( const std::string & filePath, VECBOOKMARKS & bookmarks, std::vector< EType > types )

static

Retrieve bookmarks for the file.

Parameters

[in]	filePath	file
[in,out]	bookmarks	list of bookmarks
[in]	types	types of bookmark to retrieve

Returns

true for success, false otherwise

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:

• Bookmark.h
• Bookmark.cpp