Collapse all Symbian^3 Product Developer Library

MUPnPAVBrowsingSession Class Reference

class MUPnPAVBrowsingSession : public MUPnPAVSessionBase

AV Controller browsing session interface.

This class defines the browsing interface of AV Controller. Includes operations to search, browse, copy, create container, delete object and to get search capabilities.

upnpavcontrollerclient.lib

Since: S60 v3.1

Inherits from

MUPnPAVBrowsingSession
- MUPnPAVSessionBase

Public Member Functions
void	BrowseL(const TDesC8 &, const TDesC8 &, TBrowseFlag, TInt, TInt, const TDesC8 &)
void	CancelBrowse()
void	CancelSearch()
void	CreateContainerL(const TDesC8 &, const TDesC8 &, TContainerType)
void	DeleteObjectL(const TDesC8 &)
void	GetSearchCapabilitiesL()
MUPnPAVBrowsingSessionObserver *	Observer()
void	RemoveObserver()
void	SearchL(const TDesC8 &, const TDesC8 &, const TDesC8 &, TInt, TInt, const TDesC8 &)
void	SetObserver(MUPnPAVBrowsingSessionObserver &)

Protected Member Functions
	~MUPnPAVBrowsingSession()

Inherited Functions
	MUPnPAVSessionBase::CancelReserveLocalMSServicesL()
	MUPnPAVSessionBase::Device()const
	MUPnPAVSessionBase::ReleaseLocalMSServicesL()
	MUPnPAVSessionBase::ReserveLocalMSServicesL()
	MUPnPAVSessionBase::~MUPnPAVSessionBase()

Public Member Enumerations
enum	TBrowseFlag { EDirectChildren = 0, EMetadata }
enum	TContainerType { EStorageContainer = 0, EPlaylistContainer }
enum	TFileSharing { EFileIsShared = 0, EFileIsNotShared, EShareBySettings }
enum	TMemoryType { EDefault = 0, EPhone, EMemoryCard, ERAMDrive }

Constructor & Destructor Documentation

~MUPnPAVBrowsingSession()

~MUPnPAVBrowsingSession

(

)

[protected, inline, virtual]

Member Functions Documentation

BrowseL(const TDesC8 &, const TDesC8 &, TBrowseFlag, TInt, TInt, const TDesC8 &)

void	BrowseL	(	const TDesC8 &	aId,
			const TDesC8 &	aFilter,
			TBrowseFlag	aBrowseFlag,
			TInt	aStartIndex,
			TInt	aRequestedCount,
			const TDesC8 &	aSortCriteria
		)	[pure virtual]

Browses the content directory of a given Media Server.

Since: Series 60 3.1

Parameters

const TDesC8 & aId	Container or object id.
const TDesC8 & aFilter	TDesC8& filter
TBrowseFlag aBrowseFlag	Metadata or DirectChildren
TInt aStartIndex	TInt start index
TInt aRequestedCount	TInt requested count
const TDesC8 & aSortCriteria	TDesC8& sort criteria

CancelBrowse()

void

CancelBrowse

(

)

[pure virtual]

Cancels the browse operation (ignores the result set when it is received).

Since: Series 60 3.1

CancelSearch()

void

CancelSearch

(

)

[pure virtual]

Cancels the search operation (ignores the result set when it is received).

Since: Series 60 3.1

CreateContainerL(const TDesC8 &, const TDesC8 &, TContainerType)

void	CreateContainerL	(	const TDesC8 &	aTitle,
			const TDesC8 &	aParentId,
			TContainerType	aContainerType
		)	[pure virtual]

Creates a new container to the target Media Server.

Since: Series 60 3.1

Parameters

const TDesC8 & aTitle	(const TDesC8&) title for the new container
const TDesC8 & aParentId	(const TDesC8&) container ID of the container into which the new container is to be created
TContainerType aContainerType	(TContainerType) type of the new container

DeleteObjectL(const TDesC8 &)

void

DeleteObjectL

(

const TDesC8 &

aId

)

[pure virtual]

Deletes an UPnP item on the target UPnP media server.

Since: Series 60 3.1

Parameters

const TDesC8 & aId

id of an object to be destroyed

GetSearchCapabilitiesL()

void

GetSearchCapabilitiesL

(

)

[pure virtual]

Gets the search capabilities of the Media Server that has been set as the "source device".

Since: Series 60 3.1

Observer()

MUPnPAVBrowsingSessionObserver *

Observer

(

)

const [pure virtual]

Returns the browsing session observer

Since: Series 60 3.1

RemoveObserver()

void

RemoveObserver

(

)

[pure virtual]

Removes the browsing session observer

Since: Series 60 3.1

SearchL(const TDesC8 &, const TDesC8 &, const TDesC8 &, TInt, TInt, const TDesC8 &)

void	SearchL	(	const TDesC8 &	aId,
			const TDesC8 &	aSearchCriteria,
			const TDesC8 &	aFilter,
			TInt	aStartIndex,
			TInt	aRequestedCount,
			const TDesC8 &	aSortCriteria
		)	[pure virtual]

Searches the content directory of a given Media Server.

Since: Series 60 3.1

Parameters

const TDesC8 & aId	container id
const TDesC8 & aSearchCriteria	TDesC8& search criteria
const TDesC8 & aFilter	TDesC8& filter
TInt aStartIndex	TInt start index
TInt aRequestedCount	TInt requested count
const TDesC8 & aSortCriteria	TDesC8& sort criteria

SetObserver(MUPnPAVBrowsingSessionObserver &)

void

SetObserver

(

MUPnPAVBrowsingSessionObserver &

aObserver

)

[pure virtual]

Sets the browsing session observer

Since: Series 60 3.1

Parameters

MUPnPAVBrowsingSessionObserver & aObserver

browsing session observer

Member Enumerations Documentation

Enum TBrowseFlag

Defines the type of browse (metadata or direct children)

Since: Series 60 3.1

Enumerators

EDirectChildren = 0
EMetadata

Enum TContainerType

Defines the container type

Since: Series 60 3.1

Enumerators

EStorageContainer = 0
EPlaylistContainer

Enum TFileSharing

Defines the sharing status of a downloaded item

Since: Series 60 3.1

Enumerators

EFileIsShared = 0
EFileIsNotShared
EShareBySettings

Enum TMemoryType

Defines the download location (default, phone memory, memory card or RAM Drive)

Since: Series 60 3.1

Enumerators

EDefault = 0
EPhone
EMemoryCard
ERAMDrive