DVBLink Remote API Library documentation
0.2.0-Master
|
Class for playback container. More...
Public Types | |
enum | DVBLinkPlaybackContainerType { PLAYBACK_CONTAINER_TYPE_UNKNOWN = -1, PLAYBACK_CONTAINER_TYPE_SOURCE = 0, PLAYBACK_CONTAINER_TYPE_TYPE = 1, PLAYBACK_CONTAINER_TYPE_CATEGORY = 2, PLAYBACK_CONTAINER_TYPE_GROUP = 3 } |
An enum for playback container types. More... | |
enum | DVBLinkPlaybackContainerContentType { PLAYBACK_CONTAINER_CONTENT_TYPE_UNKNOWN = -1, PLAYBACK_CONTAINER_CONTENT_TYPE_RECORDED_TV = 0, PLAYBACK_CONTAINER_CONTENT_TYPE_VIDEO = 1, PLAYBACK_CONTAINER_CONTENT_TYPE_AUDIO = 2, PLAYBACK_CONTAINER_CONTENT_TYPE_IMAGE = 3 } |
An enum for playback container content 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 | |
PlaybackContainer (const std::string &objectId, const std::string &parentId, const std::string &name, const DVBLinkPlaybackContainerType containerType, const DVBLinkPlaybackContainerContentType containerContentType) | |
Initializes a new instance of the dvblinkremote::PlaybackContainer class. | |
~PlaybackContainer () | |
Destructor for cleaning up allocated memory. | |
std::string & | GetName () |
Gets the name of the playback container. | |
DVBLinkPlaybackContainerType & | GetContainerType () |
Gets the type of the playback container . | |
DVBLinkPlaybackContainerContentType & | GetContainerContentType () |
Gets the content type of the playback items in this playback container . | |
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 | Description |
The description of the playback container. | |
std::string | Logo |
The logo of the playback container. | |
int | TotalCount |
The total amount of items in the playback container. | |
std::string | SourceID |
Identifies a physical source of this container. |
Class for playback container.
An enum for playback container content types.
dvblinkremote::PlaybackContainer::PlaybackContainer | ( | const std::string & | objectId, |
const std::string & | parentId, | ||
const std::string & | name, | ||
const DVBLinkPlaybackContainerType | containerType, | ||
const DVBLinkPlaybackContainerContentType | containerContentType | ||
) |
Initializes a new instance of the dvblinkremote::PlaybackContainer class.
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. |
name | a constant string reference representing the name of the playback container. |
containerType | a constant DVBLinkPlaybackContainerType instance representing the type of the playback container. |
containerContentType | a constant DVBLinkPlaybackContainerContentType instance representing the content type of the playback items in this playback container. |
dvblinkremote::PlaybackContainer::~PlaybackContainer | ( | ) |
Destructor for cleaning up allocated memory.
DVBLinkPlaybackContainerContentType& dvblinkremote::PlaybackContainer::GetContainerContentType | ( | ) |
Gets the content type of the playback items in this playback container .
DVBLinkPlaybackContainerType& dvblinkremote::PlaybackContainer::GetContainerType | ( | ) |
Gets the type of the playback container .
std::string& dvblinkremote::PlaybackContainer::GetName | ( | ) |
Gets the name of the playback container.
std::string dvblinkremote::PlaybackContainer::Description |
The description of the playback container.
std::string dvblinkremote::PlaybackContainer::Logo |
The logo of the playback container.
std::string dvblinkremote::PlaybackContainer::SourceID |
Identifies a physical source of this container.
int dvblinkremote::PlaybackContainer::TotalCount |
The total amount of items in the playback container.