dvblinkremote::RecordedTvItem Class Reference

Class for recorded TV items. More...

Inheritance diagram for dvblinkremote::RecordedTvItem:

Public Types
enum	DVBLinkRecordedTvItemState { RECORDED_TV_ITEM_STATE_IN_PROGRESS = 0, RECORDED_TV_ITEM_STATE_ERROR = 1, RECORDED_TV_ITEM_STATE_FORCED_TO_COMPLETION = 2, RECORDED_TV_ITEM_STATE_COMPLETED = 3 }
	An enum representing the state of the recorded TV item. More...
Public Types inherited from dvblinkremote::PlaybackItem
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
	RecordedTvItem (const std::string &objectId, const std::string &parentId, const std::string &playbackUrl, const std::string &thumbnailUrl, const RecordedTvItemMetadata *metadata)
	Initializes a new instance of the dvblinkremote::RecordedTvPlaybackItem class.
	~RecordedTvItem ()
	Destructor for cleaning up allocated memory.
Public Member Functions inherited from 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.
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
std::string	ChannelName
	The channel name of the recorded TV item.
int	ChannelNumber
	The channel number of the recorded TV item.
int	ChannelSubNumber
	The channel sub number of the recorded TV item.
DVBLinkRecordedTvItemState	State
	The state of the recored TV item.
Public Attributes inherited from dvblinkremote::PlaybackItem
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

Class for recorded TV items.

Member Enumeration Documentation

enum dvblinkremote::RecordedTvItem::DVBLinkRecordedTvItemState

An enum representing the state of the recorded TV item.

Enumerator:

RECORDED_TV_ITEM_STATE_IN_PROGRESS	Recording is in progress.
RECORDED_TV_ITEM_STATE_ERROR	Recording not started because of error.
RECORDED_TV_ITEM_STATE_FORCED_TO_COMPLETION	Recording was forced to completion, but may miss certain part at the end because it was cancelled by user.
RECORDED_TV_ITEM_STATE_COMPLETED	Recording completed successfully.

Constructor & Destructor Documentation

dvblinkremote::RecordedTvItem::RecordedTvItem	(	const std::string &	objectId,
		const std::string &	parentId,
		const std::string &	playbackUrl,
		const std::string &	thumbnailUrl,
		const RecordedTvItemMetadata *	metadata
	)

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

Parameters

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 recorded tv item.
thumbnailUrl	a constant string reference representing the URL to the recorded tv item thumbnail.
metadata	a constant RecordedTvItemMetadata reference representing the metadata for the recorded tv item.

dvblinkremote::RecordedTvItem::~RecordedTvItem

(

)

Destructor for cleaning up allocated memory.

Member Data Documentation

std::string dvblinkremote::RecordedTvItem::ChannelName

The channel name of the recorded TV item.

int dvblinkremote::RecordedTvItem::ChannelNumber

The channel number of the recorded TV item.

int dvblinkremote::RecordedTvItem::ChannelSubNumber

The channel sub number of the recorded TV item.

DVBLinkRecordedTvItemState dvblinkremote::RecordedTvItem::State

The state of the recored TV item.