dvblinkremote::PlaybackItem Class Reference

Abstract base class for playback items. More...

Inheritance diagram for dvblinkremote::PlaybackItem:

Public Types
enum	DVBLinkPlaybackItemType { PLAYBACK_ITEM_TYPE_RECORDED_TV = 0, PLAYBACK_ITEM_TYPE_VIDEO = 1, PLAYBACK_ITEM_TYPE_AUDIO = 2, PLAYBACK_ITEM_TYPE_IMAGE = 3 }
	An enum for playback item types. More...
Public Types inherited from dvblinkremote::PlaybackObject
enum	DVBLinkPlaybackObjectType { PLAYBACK_OBJECT_TYPE_CONTAINER = 0, PLAYBACK_OBJECT_TYPE_ITEM = 1 }
	An enum for playback object types. More...

Public Member Functions
	PlaybackItem (const DVBLinkPlaybackItemType itemType, const std::string &objectId, const std::string &parentId, const std::string &playbackUrl, const std::string &thumbnailUrl, const ItemMetadata *metadata)
	Initializes a new instance of the dvblinkremote::PlaybackItem class.
virtual	~PlaybackItem ()=0
	Pure virtual destructor for cleaning up allocated memory.
DVBLinkPlaybackItemType &	GetItemType ()
	Gets the type of the playback item .
std::string &	GetPlaybackUrl ()
	Gets the URL for stream playback of the playback item.
std::string &	GetThumbnailUrl ()
	Gets the URL to the playback item thumbnail.
ItemMetadata &	GetMetadata ()
	Gets the metadata for the playback item.
Public Member Functions inherited from dvblinkremote::PlaybackObject
	PlaybackObject (const DVBLinkPlaybackObjectType objectType, const std::string &objectId, const std::string &parentId)
	Initializes a new instance of the dvblinkremote::PlaybackObject class.
virtual	~PlaybackObject ()=0
	Pure virtual destructor for cleaning up allocated memory.
DVBLinkPlaybackObjectType &	GetObjectType ()
	Gets the type of the playback object .
std::string &	GetObjectID ()
	Gets the identifier of the playback object.
std::string &	GetParentID ()
	Gets the identifier of the parent object for this playback object.

Public Attributes
bool	CanBeDeleted
	Identifies whether this item can be deleted.
long	Size
	Item file size in bytes.
long	CreationTime
	Time when item was created.

Detailed Description

Abstract base class for playback items.

Member Enumeration Documentation

enum dvblinkremote::PlaybackItem::DVBLinkPlaybackItemType

An enum for playback item types.

Enumerator:

PLAYBACK_ITEM_TYPE_RECORDED_TV	Recorded TV item.
PLAYBACK_ITEM_TYPE_VIDEO	Video item.
PLAYBACK_ITEM_TYPE_AUDIO	Audio item.
PLAYBACK_ITEM_TYPE_IMAGE	Image item.

Constructor & Destructor Documentation

dvblinkremote::PlaybackItem::PlaybackItem	(	const DVBLinkPlaybackItemType	itemType,
		const std::string &	objectId,
		const std::string &	parentId,
		const std::string &	playbackUrl,
		const std::string &	thumbnailUrl,
		const ItemMetadata *	metadata
	)

Initializes a new instance of the dvblinkremote::PlaybackItem class.

Parameters

itemType	a constant DVBLinkPlaybackItemType instance representing the type of the playback item.
objectId	a constant string reference representing the identifier of the playback object.
parentId	a constant string reference representing the identifier of the parent object for this playback object.
playbackUrl	a constant string reference representing the URL for stream playback of the playback item.
thumbnailUrl	a constant string reference representing the URL to the playback item thumbnail.
metadata	a constant ItemMetadata reference representing the metadata for the playback item.

virtual dvblinkremote::PlaybackItem::~PlaybackItem ( )

pure virtual

Pure virtual destructor for cleaning up allocated memory.

Member Function Documentation

DVBLinkPlaybackItemType& dvblinkremote::PlaybackItem::GetItemType

(

)

Gets the type of the playback item .

Returns

DVBLinkPlaybackItemType instance reference

ItemMetadata& dvblinkremote::PlaybackItem::GetMetadata

(

)

Gets the metadata for the playback item.

Returns

ItemMetadata instance reference

std::string& dvblinkremote::PlaybackItem::GetPlaybackUrl

(

)

Gets the URL for stream playback of the playback item.

Returns

Playback URL

std::string& dvblinkremote::PlaybackItem::GetThumbnailUrl

(

)

Gets the URL to the playback item thumbnail.

Returns

Thumbnail URL

Member Data Documentation

bool dvblinkremote::PlaybackItem::CanBeDeleted

Identifies whether this item can be deleted.

long dvblinkremote::PlaybackItem::CreationTime

Time when item was created.

Remarks

Number of seconds, counted from UNIX epoc: 00:00:00 UTC on 1 January 1970.

long dvblinkremote::PlaybackItem::Size

Item file size in bytes.