cUPnPResources Class Reference

#include <resources.h>

Collaboration diagram for cUPnPResources:

[legend]

List of all members.

Public Member Functions
int	getResourcesOfObject (cUPnPClassObject *Object)
int	loadResources ()
cUPnPResource *	getResource (unsigned int ResourceID)
int	createFromChannel (cUPnPClassVideoBroadcast *Object, cChannel *Channel)
int	createFromRecording (cUPnPClassVideoItem *Object, cRecording *Recording)
int	createFromFile (cUPnPClassItem *Object, cString File)
Static Public Member Functions
static cUPnPResources *	getInstance ()

---

Detailed Description

The resource manager

This manages the resources in an internal cache. It may create a new resource from a channel, a recording or a custom file.

---

Member Function Documentation

int cUPnPResources::createFromChannel	(	cUPnPClassVideoBroadcast *	Object,
		cChannel *	Channel
	)

Create resource from channel

This creates a new resource from the given channel. It determines what kind of video stream it is and further details if available. It stores the resource in the database after creating it.

Parameters:

	Object	the videoBroadcast item which holds the resource
	Channel	the VDR TV channel

Returns:

returns

• 0, if loading was successful
• <0, otherwise

int cUPnPResources::createFromFile	(	cUPnPClassItem *	Object,
		cString	File
	)

Create resource from file

This creates a new resource from the given file. It determines all available information about the resource by analizing the content. It stores the resource in the database after creating it.

Parameters:

	Object	the item which holds the resource
	File	the file name

Returns:

returns

• 0, if loading was successful
• <0, otherwise

int cUPnPResources::createFromRecording	(	cUPnPClassVideoItem *	Object,
		cRecording *	Recording
	)

Create resource from recording

This creates a new resource from the given recording. It determines what kind of video stream it is and further details if available. It stores the resource in the database after creating it.

Parameters:

	Object	the videoItem item which holds the resource
	Recording	the VDR TV recording

Returns:

returns

• 0, if loading was successful
• <0, otherwise

cUPnPResources * cUPnPResources::getInstance

(

)

[static]

Get the instance of the resource manager

This returns the instance of the resource manager.

Returns:

the instance of the manager

cUPnPResource * cUPnPResources::getResource

(

unsigned int

ResourceID

)

Get a resource by ID

This returns a resource by its resource ID

Parameters:

ResourceID

the resource ID of the demanded resource

Returns:

the requested resource

int cUPnPResources::getResourcesOfObject

(

cUPnPClassObject *

Object

)

Fill object with its resources

This will load all the resources from the database, which are associated to the given object

Parameters:

Object

the object, which shall be filled

Returns:

returns

• 0, if loading was successful
• <0, otherwise

int cUPnPResources::loadResources

(

)

Loads all resources from database

This loads all resources from the database into the internal cache.

Returns:

returns

• 0, if loading was successful
• <0, otherwise

---

The documentation for this class was generated from the following files:

• database/resources.h
• database/resources.cpp