cUPnPClassMovie Class Reference

#include <object.h>

Inheritance diagram for cUPnPClassMovie:

[legend]

Collaboration diagram for cUPnPClassMovie:

[legend]

List of all members.

Public Member Functions
virtual cStringList *	getPropertyList ()
virtual bool	setProperty (const char *Property, const char *Value)
virtual bool	getProperty (const char *Property, char **Value) const
int	setDVDRegionCode (int RegionCode)
int	setStorageMedium (const char *StorageMedium)
int	getDVDRegionCode () const
const char *	getStorageMedium () const
Protected Member Functions
	cUPnPClassMovie ()
Protected Attributes
int	mDVDRegionCode
	The Region code of the movie (0 - 8).
cString	mStorageMedium
	The storage medium where the movie is stored.
Friends
class	cMediaDatabase
class	cUPnPObjectMediator
class	cUPnPMovieMediator

---

Detailed Description

The UPnP class Movie

This is a UPnP class Movie representation with all its properties.

---

Constructor & Destructor Documentation

cUPnPClassMovie::cUPnPClassMovie

(

)

[protected]

Constructor of a movie

This creates a new instance of a movie

---

Member Function Documentation

int cUPnPClassMovie::getDVDRegionCode

(

)

const [inline]

Get the DVD region code

This returns the DVD region code. For more information, see http://en.wikipedia.org/wiki/DVD_region_code

The integer representation for ALL is 9.

See also:

http://en.wikipedia.org/wiki/DVD_region_code

Returns:

the DVD region code

bool cUPnPClassMovie::getProperty	(	const char *	Property,
		char **	Value
	)			const [virtual]

Gets a property

Returns the value of a specified property. The value is converted into a string.

Returns:

returns

• true, if the property exists
• false, otherwise

Parameters:

	Property	the property which should be returned
	Value	the value of that property

Reimplemented from cUPnPClassVideoItem.

cStringList * cUPnPClassMovie::getPropertyList

(

)

[virtual]

Get the properties of the object

This returns a property list with all the properties which can be obtained or set with getProperty or setProperty.

Returns:

a stringlist with the properties

Reimplemented from cUPnPClassVideoItem.

const char* cUPnPClassMovie::getStorageMedium

(

)

const [inline]

Get the storage medium

This returns the storage medium, where the movie resides.

Returns:

the storage medium

int cUPnPClassMovie::setDVDRegionCode

(

int

RegionCode

)

Sets the DVD region code

For more information on this, see http://en.wikipedia.org/wiki/DVD_region_code

The integer representation for ALL is 9.

See also:

http://en.wikipedia.org/wiki/DVD_region_code

Returns:

returns

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

Parameters:

RegionCode

the region code of this movie

bool cUPnPClassMovie::setProperty	(	const char *	Property,
		const char *	Value
	)			[virtual]

Sets a property

Sets the value of a specified property. The value is converted from string into the propper data type

Returns:

returns

• true, if the property exists
• false, otherwise

Parameters:

	Property	the property which should be set
	Value	the value of that property

Reimplemented from cUPnPClassVideoItem.

int cUPnPClassMovie::setStorageMedium

(

const char *

StorageMedium

)

Sets the storage medium

This will set the storage medium, where the movie resides. Valid media are defined in common.h

See also:

common.h

Returns:

returns

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

Parameters:

StorageMedium

the medium where the movie is located

---

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

• database/object.h
• database/object.cpp