dvblinkremote::GetPlaybackObjectRequest Class Reference

Class for get playback object requests. More...

Inheritance diagram for dvblinkremote::GetPlaybackObjectRequest:

Public Types
enum	DVBLinkRequestedObjectType { REQUESTED_OBJECT_TYPE_ALL = -1, REQUESTED_OBJECT_TYPE_CONTAINER = 0, REQUESTED_OBJECT_TYPE_ITEM = 1 }
	An enum for requesting certain object types to be returned. More...
enum	DVBLinkRequestedItemType {   REQUESTED_ITEM_TYPE_ALL = -1, REQUESTED_ITEM_TYPE_RECORDED_TV = 0, REQUESTED_ITEM_TYPE_VIDEO = 1, REQUESTED_ITEM_TYPE_AUDIO = 2,   REQUESTED_ITEM_TYPE_IMAGE = 3 }
	An enum for requesting certain item types to be returned. More...

Public Member Functions
	GetPlaybackObjectRequest (const std::string &serverAddress)
	Initializes a new instance of the dvblinkremote::GetPlaybackObjectRequest class to recieve the DVBLink server container, i.e.
	GetPlaybackObjectRequest (const std::string &serverAddress, const std::string &objectId)
	Initializes a new instance of the dvblinkremote::GetPlaybackObjectRequest class.
	~GetPlaybackObjectRequest ()
	Destructor for cleaning up allocated memory.
std::string &	GetServerAddress ()
	Gets the server address for the playback object request.
std::string &	GetObjectID ()
	Gets the identifier for the playback object to recieve.

Public Attributes
DVBLinkRequestedObjectType	RequestedObjectType
	Indicates which type of objects to be requested.
DVBLinkRequestedItemType	RequestedItemType
	Indicates which type of items to be requested.
int	StartPosition
	The start position of objects to be requested.
int	RequestCount
	The number of objects to be requested.
bool	IncludeChildrenObjectsForRequestedObject
	Indicates if child objects of requested object identifier shall be included in result or not.

Detailed Description

Class for get playback object requests.

This is used as input parameter for the IDVBLinkRemoteConnection::GetPlaybackObject method.

See Also

IDVBLinkRemoteConnection::GetPlaybackObject()

Member Enumeration Documentation

enum dvblinkremote::GetPlaybackObjectRequest::DVBLinkRequestedItemType

An enum for requesting certain item types to be returned.

Enumerator:

REQUESTED_ITEM_TYPE_ALL	All requested item types will be returned.
REQUESTED_ITEM_TYPE_RECORDED_TV	Recorded TV items will be returned.
REQUESTED_ITEM_TYPE_VIDEO	Video items will be returned.
REQUESTED_ITEM_TYPE_AUDIO	Audio items will be returned.
REQUESTED_ITEM_TYPE_IMAGE	Image items will be returned.

enum dvblinkremote::GetPlaybackObjectRequest::DVBLinkRequestedObjectType

An enum for requesting certain object types to be returned.

Enumerator:

REQUESTED_OBJECT_TYPE_ALL	All requested object types will be returned.
REQUESTED_OBJECT_TYPE_CONTAINER	Container objects will be returned.
REQUESTED_OBJECT_TYPE_ITEM	Item objects will be returned.

Constructor & Destructor Documentation

dvblinkremote::GetPlaybackObjectRequest::GetPlaybackObjectRequest

(

const std::string &

serverAddress

)

Initializes a new instance of the dvblinkremote::GetPlaybackObjectRequest class to recieve the DVBLink server container, i.e.

the top level parent of all objects.

Parameters

serverAddress

a constant string reference representing the DVBLink server address.

Remarks

serverAddress is the IP address/server network name of the DVBLink server.

dvblinkremote::GetPlaybackObjectRequest::GetPlaybackObjectRequest	(	const std::string &	serverAddress,
		const std::string &	objectId
	)

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

Parameters

serverAddress	a constant string reference representing the DVBLink server address.
objectId	a constant string reference representing the identifier of the playback object to recieve.

Remarks

serverAddress is the IP address/server network name of the DVBLink server.

dvblinkremote::GetPlaybackObjectRequest::~GetPlaybackObjectRequest

(

)

Destructor for cleaning up allocated memory.

Member Function Documentation

std::string& dvblinkremote::GetPlaybackObjectRequest::GetObjectID

(

)

Gets the identifier for the playback object to recieve.

Returns

Playback object identifier

Remarks

Default value is empty string which refers to DVBLink server container, i.e. the top level parent of all objects.

std::string& dvblinkremote::GetPlaybackObjectRequest::GetServerAddress

(

)

Gets the server address for the playback object request.

Returns

Playback object request server address

Remarks

Ip address/server network name of the DVBLink server.

Member Data Documentation

bool dvblinkremote::GetPlaybackObjectRequest::IncludeChildrenObjectsForRequestedObject

Indicates if child objects of requested object identifier shall be included in result or not.

Remarks

Default value is false.

If false � returns information about object itself as specified by its object identifier.

If true � returns objects� children objects � containers and items.

int dvblinkremote::GetPlaybackObjectRequest::RequestCount

The number of objects to be requested.

Remarks

Default value is -1, e.g. all.

DVBLinkRequestedItemType dvblinkremote::GetPlaybackObjectRequest::RequestedItemType

Indicates which type of items to be requested.

Remarks

Default value is REQUESTED_ITEM_TYPE_ALL.

DVBLinkRequestedObjectType dvblinkremote::GetPlaybackObjectRequest::RequestedObjectType

Indicates which type of objects to be requested.

Remarks

Default value is REQUESTED_OBJECT_TYPE_ALL.

int dvblinkremote::GetPlaybackObjectRequest::StartPosition

The start position of objects to be requested.

Remarks

Default value is 0.