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

Abstract base class for playback objects. More...

Inheritance diagram for dvblinkremote::PlaybackObject:
dvblinkremote::PlaybackContainer dvblinkremote::PlaybackItem dvblinkremote::RecordedTvItem dvblinkremote::VideoItem

Public Types

enum  DVBLinkPlaybackObjectType { PLAYBACK_OBJECT_TYPE_CONTAINER = 0, PLAYBACK_OBJECT_TYPE_ITEM = 1 }
 An enum for playback object types. More...

Public Member Functions

 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.
DVBLinkPlaybackObjectTypeGetObjectType ()
 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.

Detailed Description

Abstract base class for playback objects.

Member Enumeration Documentation

An enum for playback object types.

Enumerator:
PLAYBACK_OBJECT_TYPE_CONTAINER 

Container object type.

PLAYBACK_OBJECT_TYPE_ITEM 

Item object type.

Constructor & Destructor Documentation

dvblinkremote::PlaybackObject::PlaybackObject ( const DVBLinkPlaybackObjectType  objectType,
const std::string &  objectId,
const std::string &  parentId 
)

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

Parameters
itemTypea constant DVBLinkPlaybackObjectType instance representing the type of the playback item.
objectIda constant string reference representing the identifier of the playback object.
parentIda constant string reference representing the identifier of the parent object for this playback object.
virtual dvblinkremote::PlaybackObject::~PlaybackObject ( )
pure virtual

Pure virtual destructor for cleaning up allocated memory.

Member Function Documentation

std::string& dvblinkremote::PlaybackObject::GetObjectID ( )

Gets the identifier of the playback object.

Returns
Playback object identifier
DVBLinkPlaybackObjectType& dvblinkremote::PlaybackObject::GetObjectType ( )

Gets the type of the playback object .

Returns
DVBLinkPlaybackObjectType instance reference
std::string& dvblinkremote::PlaybackObject::GetParentID ( )

Gets the identifier of the parent object for this playback object.

Returns
Parent identifier for this playback object