Collapse all Symbian^3 Product Developer Library

CUPnPAlbumServices Class Reference

class CUPnPAlbumServices : public CBase

A class providing abstract album (image/video) handling services.

upnpmusicadapter.lib

Since: S60 v3.1

Inherits from

CUPnPAlbumServices
- CBase

Public Member Functions
	~CUPnPAlbumServices()
void	HandleCollectionMediaL(const CMPXMedia &, TInt)
void	HandleCollectionMessage(CMPXMessage *, TInt)
void	HandleOpenL(const CMPXMedia &, TInt, TBool, TInt)
void	HandleOpenL(const CMPXCollectionPlaylist &, TInt)
IMPORT_C TBool	IsValidAlbumL(const TDesC &)
IMPORT_C void	ListAlbumsL(CDesCArray &, CDesCArray &)
IMPORT_C CUPnPAlbumServices *	NewL()
IMPORT_C void	OpenAlbumL(const TDesC &, CDesCArray &)

Private Member Functions
	CUPnPAlbumServices()
void	ConstructL()
TMPXItemId	Desc2Id(const TDesC &)
void	DoHandleCollectionMessageL(CMPXMessage *)
const TDesC &	Id2Desc(const TMPXItemId &)

Inherited Functions
	CBase::CBase()
	CBase::Delete(CBase *)
	CBase::Extension_(TUint,TAny &,TAny )
	CBase::operator new(TUint)
	CBase::operator new(TUint,TAny *)
	CBase::operator new(TUint,TLeave)
	CBase::operator new(TUint,TLeave,TUint)
	CBase::operator new(TUint,TUint)
	CBase::~CBase()

Private Attributes
CDesCArray *	iAlbumIds
CDesCArray *	iAlbumNames
MMPXCollectionUtility *	iCollectionUtility
CMPXMedia *	iMedia
TInt	iStatus
TBuf< KBufferSize >	iTempBuffer
CActiveSchedulerWait *	iWait

Constructor & Destructor Documentation

CUPnPAlbumServices()

CUPnPAlbumServices

(

)

[private]

default constructor

~CUPnPAlbumServices()

~CUPnPAlbumServices

(

)

[virtual]

desctuctor

Member Functions Documentation

ConstructL()

void

ConstructL

(

)

[private]

2nd phase constructor

Desc2Id(const TDesC &)

TMPXItemId

Desc2Id

(

const TDesC &

aDesc

)

[private]

Converts an ID from descriptor form to TMPXItemId form. conversion is guaranteed symmetric to Id2Desc()

Parameters

const TDesC & aDesc

the id as a descriptor

DoHandleCollectionMessageL(CMPXMessage *)

void

DoHandleCollectionMessageL

(

CMPXMessage *

aMsg

)

[private]

Locally handles the corresponding callback

Parameters

CMPXMessage * aMsg

HandleCollectionMediaL(const CMPXMedia &, TInt)

void	HandleCollectionMediaL	(	const CMPXMedia &	aMedia,
			TInt	aError
		)

see MMPXCollectionObserver

Parameters

const CMPXMedia & aMedia
TInt aError

HandleCollectionMessage(CMPXMessage *, TInt)

void	HandleCollectionMessage	(	CMPXMessage *	aMsg,
			TInt	aErr
		)

see MMPXCollectionObserver

Parameters

CMPXMessage * aMsg
TInt aErr

HandleOpenL(const CMPXMedia &, TInt, TBool, TInt)

void	HandleOpenL	(	const CMPXMedia &	aEntries,
			TInt	aIndex,
			TBool	aComplete,
			TInt	aError
		)

see MMPXCollectionObserver

Parameters

const CMPXMedia & aEntries
TInt aIndex
TBool aComplete
TInt aError

HandleOpenL(const CMPXCollectionPlaylist &, TInt)

void	HandleOpenL	(	const CMPXCollectionPlaylist &	aPlaylist,
			TInt	aError
		)

see MMPXCollectionObserver

Parameters

const CMPXCollectionPlaylist & aPlaylist
TInt aError

Id2Desc(const TMPXItemId &)

const TDesC &

Id2Desc

(

const TMPXItemId &

aId

)

[private]

Converts an ID from TMPXItemId form to descriptor form. conversion is guaranteed symmetric to Desc2Id()

Parameters

const TMPXItemId & aId

the id in TMPXItemId form

IsValidAlbumL(const TDesC &)

IMPORT_C TBool

IsValidAlbumL

(

const TDesC &

aAlbumName

)

Checks if the given album exists in the library. Note: does not check the existence of the actual media

Parameters

const TDesC & aAlbumName

name of the album

ListAlbumsL(CDesCArray &, CDesCArray &)

IMPORT_C void	ListAlbumsL	(	CDesCArray &	aAlbumIds,
			CDesCArray &	aAlbumNames
		)

Lists all albums in the library. Returns a list of albums ID's and a names. ID can be used to open or modify the album.

Parameters

CDesCArray & aAlbumIds	array to receive album ID's
CDesCArray & aAlbumNames	array to receive album names

NewL()

IMPORT_C CUPnPAlbumServices *

NewL

(

)

[static]

Static constructor

OpenAlbumL(const TDesC &, CDesCArray &)

IMPORT_C void	OpenAlbumL	(	const TDesC &	aAlbumId,
			CDesCArray &	aContentMedia
		)

Retrieves contents (image/video) of given album.

Parameters

const TDesC & aAlbumId	ID of the album
CDesCArray & aContentMedia	array to receive the content file paths

Member Data Documentation

CDesCArray * iAlbumIds

CDesCArray *

iAlbumIds

[private]

Array for album ids

CDesCArray * iAlbumNames

CDesCArray *

iAlbumNames

[private]

Array for album names

MMPXCollectionUtility * iCollectionUtility

MMPXCollectionUtility *

iCollectionUtility

[private]

Collection utility of MPX framework (Owned)

CMPXMedia * iMedia

CMPXMedia *

iMedia

[private]

Container media (Owned)

TInt iStatus

TInt

iStatus

[private]

for async operation

TBuf< KBufferSize > iTempBuffer

TBuf< KBufferSize >

iTempBuffer

[private]

temp buffer used in Id2Desc

CActiveSchedulerWait * iWait

CActiveSchedulerWait *

iWait

[private]

Scheduler wait loop (Owned)