cUPnPClassVideoItem Class Reference

#include <object.h>

Inheritance diagram for cUPnPClassVideoItem:

Collaboration diagram for cUPnPClassVideoItem:

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 setLongDescription (const char *LongDescription)

int setDescription (const char *Description)

int setPublishers (const char *Publishers)

int setGenre (const char *Genre)

int setLanguage (const char *Language)

int setRelations (const char *Relations)

int setDirectors (const char *Directors)

int setActors (const char *Actors)

int setProducers (const char *Producers)

int setRating (const char *Rating)

const char * getGenre () const

const char * getLongDescription () const

const char * getDescription () const

const char * getPublishers () const

const char * getLanguage () const

const char * getRelations () const

const char * getActors () const

const char * getProducers () const

const char * getDirectors () const

const char * getRating () const

Protected Member Functions

cUPnPClassVideoItem ()

Protected Attributes

cString mGenre

Genre of the video.

cString mDescription

Description.

cString mLongDescription

a longer description

cString mPublishers

CSV of Publishers.

cString mLanguage

RFC 1766 Language code.

cString mRelations

Relation to other contents.

cString mProducers

CSV of Producers.

cString mRating

Rating (for parential control).

cString mActors

CSV of Actors.

cString mDirectors

CSV of Directors.

Friends

class cMediaDatabase

class cUPnPObjectMediator

class cUPnPVideoItemMediator

Detailed Description

The UPnP class VideoItem

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

Constructor & Destructor Documentation

cUPnPClassVideoItem::cUPnPClassVideoItem ( ) [protected]

Constructor of a video item

This creates a new instance of a video item

Member Function Documentation

const char* cUPnPClassVideoItem::getActors ( ) const [inline]

Get the actors

This returns a CSV list of actors in the video

Returns:: a CSV list of actors

const char* cUPnPClassVideoItem::getDescription ( ) const [inline]

Get the description

This returns the description of a video

Returns:: the description of a video

const char* cUPnPClassVideoItem::getDirectors ( ) const [inline]

Get the directors

This returns a CSV list of directors

Returns:: a CSV list of directors

const char* cUPnPClassVideoItem::getGenre ( ) const [inline]

Get the genres

This returns a CSV list of genre

Returns:: the genre of a video

const char* cUPnPClassVideoItem::getLanguage ( ) const [inline]

Get the language

This returns the language of the video

Returns:: the language

const char* cUPnPClassVideoItem::getLongDescription ( ) const [inline]

Get the long description

This returns the long description of a video

Returns:: the long description of a video

const char* cUPnPClassVideoItem::getProducers ( ) const [inline]

Get the producers

This returns a CSV list of producers of a video

Returns:: a CSV list of producers

bool cUPnPClassVideoItem::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 cUPnPClassItem.

Reimplemented in cUPnPClassMovie, and cUPnPClassVideoBroadcast.

cStringList * cUPnPClassVideoItem::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 cUPnPClassItem.

Reimplemented in cUPnPClassMovie, and cUPnPClassVideoBroadcast.

const char* cUPnPClassVideoItem::getPublishers ( ) const [inline]

Get the publishers

This returns a CSV list of publishers of the video

Returns:: a CSV list of publishers

const char* cUPnPClassVideoItem::getRating ( ) const [inline]

Get the rating

This returns the rating used for parental control.

Returns:: the rating of a video

const char* cUPnPClassVideoItem::getRelations ( ) const [inline]

Get the relations

This returns a CSV list of relation URLs.

Returns:: a CSV list of relation URLs

int cUPnPClassVideoItem::setActors ( const char * Actors )

Sets the actors

This sets a CSV list of actors in a video. This usually contain the main actors. However, also other actors appearing in the video can be mentioned here.

Returns:

returns

0, if setting was successful
<0, otherwise

Parameters:

Actors

a CSV list of actors

int cUPnPClassVideoItem::setDescription ( const char * Description )

Set a description

A description may hold short information about the content or the story of a video. Unlike a long description, this contains just a very short brief like a subtitle or the episode title.

Returns:

returns

0, if setting was successful
<0, otherwise

Parameters:

Description

the description of a video

int cUPnPClassVideoItem::setDirectors ( const char * Directors )

Sets the directors

This sets a CSV list of directors.

Returns:

returns

0, if setting was successful
<0, otherwise

Parameters:

Directors

a CSV list of directors

int cUPnPClassVideoItem::setGenre ( const char * Genre )

Set a genre

This is a CSV list of genre of a video. This may be something like "Western" or "SciFi". Actually, there is no standardized rule for a genre name, which results in an ambiguous definition of certain genre, like Thriller and Horror.

Returns:

returns

0, if setting was successful
<0, otherwise

Parameters:

Genre

a CSV list of genre

int cUPnPClassVideoItem::setLanguage ( const char * Language )

Set the language

This sets the language of a video. It is defined by RFC 1766. A valid language definition is "de-DE" or "en-US".

See also:: http://www.ietf.org/rfc/rfc1766.txt

Returns:

returns

0, if setting was successful
<0, otherwise

Parameters:

Language

the language (RFC 1766)

int cUPnPClassVideoItem::setLongDescription ( const char * LongDescription )

Set a long description

A long description may hold information about the content or the story of a video

Returns:

returns

0, if setting was successful
<0, otherwise

Parameters:

LongDescription

the content or story of a video

int cUPnPClassVideoItem::setProducers ( const char * Producers )

Sets the producers

This sets a CSV list of producers of a video. These are the people who are involed in the production of a video

Returns:

returns

0, if setting was successful
<0, otherwise

Parameters:

Producers

a CSV list of producers

bool cUPnPClassVideoItem::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 cUPnPClassItem.

Reimplemented in cUPnPClassMovie, and cUPnPClassVideoBroadcast.

int cUPnPClassVideoItem::setPublishers ( const char * Publishers )

Set the publishers

This is a CSV list of publishers, who distributes the video.

Returns:

returns

0, if setting was successful
<0, otherwise

Parameters:

Publishers

a CSV list of publishers

int cUPnPClassVideoItem::setRating ( const char * Rating )

Sets the rating

This is a rating, which can be used for parential control issues.

See also:: http://en.wikipedia.org/wiki/Motion_picture_rating_system

Returns:

returns

0, if setting was successful
<0, otherwise

Parameters:

Rating

the rating of a video

int cUPnPClassVideoItem::setRelations ( const char * Relations )

Sets a relation URL

This sets a CSV list of relation URLs, where to find additional information about the movie. The URLs may not contain commas and they must be properly escaped as in RFC 2396

See also:: http://www.ietf.org/rfc/rfc2396.txt

Returns:

returns

0, if setting was successful
<0, otherwise

Parameters:

Relations

a CSV list with relations

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

database/object.h
database/object.cpp


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	setLongDescription (const char *LongDescription)
int	setDescription (const char *Description)
int	setPublishers (const char *Publishers)
int	setGenre (const char *Genre)
int	setLanguage (const char *Language)
int	setRelations (const char *Relations)
int	setDirectors (const char *Directors)
int	setActors (const char *Actors)
int	setProducers (const char *Producers)
int	setRating (const char *Rating)
const char *	getGenre () const
const char *	getLongDescription () const
const char *	getDescription () const
const char *	getPublishers () const
const char *	getLanguage () const
const char *	getRelations () const
const char *	getActors () const
const char *	getProducers () const
const char *	getDirectors () const
const char *	getRating () const
Protected Member Functions
	cUPnPClassVideoItem ()
Protected Attributes
cString	mGenre
	Genre of the video.
cString	mDescription
	Description.
cString	mLongDescription
	a longer description
cString	mPublishers
	CSV of Publishers.
cString	mLanguage
	RFC 1766 Language code.
cString	mRelations
	Relation to other contents.
cString	mProducers
	CSV of Producers.
cString	mRating
	Rating (for parential control).
cString	mActors
	CSV of Actors.
cString	mDirectors
	CSV of Directors.
Friends
class	cMediaDatabase
class	cUPnPObjectMediator
class	cUPnPVideoItemMediator