cUPnPClassVideoBroadcast Class Reference

#include <object.h>

Inheritance diagram for cUPnPClassVideoBroadcast:

[legend]

Collaboration diagram for cUPnPClassVideoBroadcast:

[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	setIcon (const char *IconURI)
int	setRegion (const char *Region)
int	setChannelNr (int ChannelNr)
int	setChannelName (const char *ChannelName)
const char *	getIcon () const
const char *	getRegion () const
int	getChannelNr () const
const char *	getChannelName () const
Protected Member Functions
	cUPnPClassVideoBroadcast ()
Protected Attributes
cString	mIcon
	The channel icon of the channel.
cString	mRegion
	The region where the channel can be received.
int	mChannelNr
	The channel number.
cString	mChannelName
	The channel name or provider name.
Friends
class	cMediaDatabase
class	cUPnPObjectMediator
class	cUPnPVideoBroadcastMediator

---

Detailed Description

The UPnP class VideoBroadcast

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

---

Constructor & Destructor Documentation

cUPnPClassVideoBroadcast::cUPnPClassVideoBroadcast

(

)

[protected]

Constructor of a video broadcast

This creates a new instance of a video broadcast

---

Member Function Documentation

const char* cUPnPClassVideoBroadcast::getChannelName

(

)

const [inline]

Get the channel name

This returns the channel name or provider name respectively

Returns:

the channel name

int cUPnPClassVideoBroadcast::getChannelNr

(

)

const [inline]

Get the channel number

This returns the channel number

Returns:

the channel number

const char* cUPnPClassVideoBroadcast::getIcon

(

)

const [inline]

Get the channel icon

This returns the channel icon of the channel.

Returns:

the channel icon

bool cUPnPClassVideoBroadcast::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 * cUPnPClassVideoBroadcast::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* cUPnPClassVideoBroadcast::getRegion

(

)

const [inline]

Get the region

This returns the region, where the channel can be received

Returns:

the channel region

int cUPnPClassVideoBroadcast::setChannelName

(

const char *

ChannelName

)

Set the channel name

This sets the channel name or the provider of the channel.

Returns:

returns

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

Parameters:

ChannelName

the channel name

int cUPnPClassVideoBroadcast::setChannelNr

(

int

ChannelNr

)

Set channel number

This sets the channel number, so that it can be used for directly navigation or channel up and down navigation respectively.

Returns:

returns

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

Parameters:

ChannelNr

the channel number

int cUPnPClassVideoBroadcast::setIcon

(

const char *

IconURI

)

Set the channel icon

This sets the channel icon of this channel. The resource must be a valid URI which can be obtained via the internal webserver

Returns:

returns

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

Parameters:

IconURI

the URI to the icon file

bool cUPnPClassVideoBroadcast::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 cUPnPClassVideoBroadcast::setRegion

(

const char *

Region

)

Set the channel region

This sets the region of a channel, where it can be received

Returns:

returns

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

Parameters:

Region

the location where the channel can be received

---

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

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