DVBLink Remote API Library documentation  0.2.0-Master
 All Classes Namespaces Functions Variables Enumerations Enumerator Pages
dvblinkremote::ItemMetadata Class Reference

Represent metadata for an item. More...

Inheritance diagram for dvblinkremote::ItemMetadata:
dvblinkremote::Program dvblinkremote::RecordedTvItemMetadata dvblinkremote::VideoItemMetadata

Public Member Functions

 ItemMetadata ()
 Initializes a new instance of the dvblinkremote::ItemMetadata class.
 ItemMetadata (const std::string &title, const long startTime, const long duration)
 Initializes a new instance of the dvblinkremote::MetaData class.
 ItemMetadata (ItemMetadata &itemMetadata)
 Initializes a new instance of the dvblinkremote::ItemMetadata class by coping another dvblinkremote::ItemMetadata instance.
virtual ~ItemMetadata ()=0
 Pure virtual destructor for cleaning up allocated memory.
std::string & GetTitle ()
 Gets the title of the item.
void SetTitle (const std::string &title)
 Sets the title of the item.
long GetStartTime ()
 Gets the start time of the item.
void SetStartTime (const long startTime)
 Sets the start time of the item.
long GetDuration ()
 Gets the duration of the item.
void SetDuration (const long duration)
 Sets the duration of the item.

Public Attributes

std::string ShortDescription
std::string SubTitle
std::string Language
std::string Actors
std::string Directors
std::string Writers
std::string Producers
std::string Guests
std::string Keywords
std::string Image
long Year
long EpisodeNumber
long SeasonNumber
long Rating
long MaximumRating
bool IsHdtv
bool IsPremiere
bool IsRepeat
bool IsSeries
bool IsRecord
bool IsRepeatRecord
bool IsCatAction
bool IsCatComedy
bool IsCatDocumentary
bool IsCatDrama
bool IsCatEducational
bool IsCatHorror
bool IsCatKids
bool IsCatMovie
bool IsCatMusic
bool IsCatNews
bool IsCatReality
bool IsCatRomance
bool IsCatScifi
bool IsCatSerial
bool IsCatSoap
bool IsCatSpecial
bool IsCatSports
bool IsCatThriller
bool IsCatAdult

Detailed Description

Represent metadata for an item.

Constructor & Destructor Documentation

dvblinkremote::ItemMetadata::ItemMetadata ( )

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

dvblinkremote::ItemMetadata::ItemMetadata ( const std::string &  title,
const long  startTime,
const long  duration 
)

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

Parameters
titlea constant string reference representing the title of the item.
startTimea constant long representing the start time of the item.
durationa constant long representing the duration of the item.
Remarks
startTime and duration is the number of seconds, counted from UNIX epoc: 00:00:00 UTC on 1 January 1970.
dvblinkremote::ItemMetadata::ItemMetadata ( ItemMetadata itemMetadata)

Initializes a new instance of the dvblinkremote::ItemMetadata class by coping another dvblinkremote::ItemMetadata instance.

Parameters
itemMetadataa dvblinkremote::ItemMetadata reference.
virtual dvblinkremote::ItemMetadata::~ItemMetadata ( )
pure virtual

Pure virtual destructor for cleaning up allocated memory.

Member Function Documentation

long dvblinkremote::ItemMetadata::GetDuration ( )

Gets the duration of the item.

Returns
item duration
Remarks
Number of seconds, counted from UNIX epoc: 00:00:00 UTC on 1 January 1970.
long dvblinkremote::ItemMetadata::GetStartTime ( )

Gets the start time of the item.

Returns
Item start time
Remarks
Number of seconds, counted from UNIX epoc: 00:00:00 UTC on 1 January 1970.
std::string& dvblinkremote::ItemMetadata::GetTitle ( )

Gets the title of the item.

Returns
Item title
void dvblinkremote::ItemMetadata::SetDuration ( const long  duration)

Sets the duration of the item.

Parameters
durationa constant long representing the duration of the item.
void dvblinkremote::ItemMetadata::SetStartTime ( const long  startTime)

Sets the start time of the item.

Parameters
startTimea constant long representing the start time of the item.
void dvblinkremote::ItemMetadata::SetTitle ( const std::string &  title)

Sets the title of the item.

Parameters
titlea constant string reference representing the title of the item.

Member Data Documentation

std::string dvblinkremote::ItemMetadata::Actors
std::string dvblinkremote::ItemMetadata::Directors
long dvblinkremote::ItemMetadata::EpisodeNumber
std::string dvblinkremote::ItemMetadata::Guests
std::string dvblinkremote::ItemMetadata::Image
bool dvblinkremote::ItemMetadata::IsCatAction
bool dvblinkremote::ItemMetadata::IsCatAdult
bool dvblinkremote::ItemMetadata::IsCatComedy
bool dvblinkremote::ItemMetadata::IsCatDocumentary
bool dvblinkremote::ItemMetadata::IsCatDrama
bool dvblinkremote::ItemMetadata::IsCatEducational
bool dvblinkremote::ItemMetadata::IsCatHorror
bool dvblinkremote::ItemMetadata::IsCatKids
bool dvblinkremote::ItemMetadata::IsCatMovie
bool dvblinkremote::ItemMetadata::IsCatMusic
bool dvblinkremote::ItemMetadata::IsCatNews
bool dvblinkremote::ItemMetadata::IsCatReality
bool dvblinkremote::ItemMetadata::IsCatRomance
bool dvblinkremote::ItemMetadata::IsCatScifi
bool dvblinkremote::ItemMetadata::IsCatSerial
bool dvblinkremote::ItemMetadata::IsCatSoap
bool dvblinkremote::ItemMetadata::IsCatSpecial
bool dvblinkremote::ItemMetadata::IsCatSports
bool dvblinkremote::ItemMetadata::IsCatThriller
bool dvblinkremote::ItemMetadata::IsHdtv
bool dvblinkremote::ItemMetadata::IsPremiere
bool dvblinkremote::ItemMetadata::IsRecord
bool dvblinkremote::ItemMetadata::IsRepeat
bool dvblinkremote::ItemMetadata::IsRepeatRecord
bool dvblinkremote::ItemMetadata::IsSeries
std::string dvblinkremote::ItemMetadata::Keywords
std::string dvblinkremote::ItemMetadata::Language
long dvblinkremote::ItemMetadata::MaximumRating
std::string dvblinkremote::ItemMetadata::Producers
long dvblinkremote::ItemMetadata::Rating
long dvblinkremote::ItemMetadata::SeasonNumber
std::string dvblinkremote::ItemMetadata::ShortDescription
std::string dvblinkremote::ItemMetadata::SubTitle
std::string dvblinkremote::ItemMetadata::Writers
long dvblinkremote::ItemMetadata::Year