Collapse all Symbian^3 Application Developer Library

MMediaCollectionManager Class Reference

class MMediaCollectionManager

Media Collection Manager

Use this class to get Media Collections, create new collections, delete collections, rename collections, add files to collections, remove files from collections.

N/A

Since: S60 3.2

Public Member Functions
	~MMediaCollectionManager ()
void	AddCollectionObserverL ( MMediaCollectionObserver &)
void	AddToCollectionL ( TInt , const MDesCArray &, TBool )
MMediaCollectionInfo *	CollectionInfoByIdLC ( TInt )
TInt	CreateCollectionL (const TDesC &, const TArray < TInt > &, TInt32 )
void	DeleteCollectionL ( TInt )
void	GetCollectionIdByItemL (const TDesC &, RArray < TInt > &)
void	GetCollectionInfosL ( RPointerArray < MMediaCollectionInfo > &)
void	GetCollectionItemArrayL ( TInt , CDesCArray &)
TInt32	GetDriveByIdL ( TInt )
void	RemoveCollectionObserverL ( MMediaCollectionObserver &)
void	RemoveFromAllCollectionsL (const MDesCArray &)
void	RemoveFromCollectionL ( TInt , const MDesCArray &)
void	RenameCollectionL ( TInt , const TDesC &)

Private Member Functions
MMediaCollectionManagerExt *	Extension ()
const MMediaCollectionManagerExt *	Extension ()

Constructor & Destructor Documentation

~MMediaCollectionManager()

~MMediaCollectionManager

(

)

[inline, virtual]

Member Functions Documentation

AddCollectionObserverL(MMediaCollectionObserver &)

void

AddCollectionObserverL

(

MMediaCollectionObserver &

aObserver

)

[pure virtual]

Add collection observer.

Since: 3.2

Parameters

MMediaCollectionObserver & aObserver

AddToCollectionL(TInt, const MDesCArray &, TBool)

void	AddToCollectionL	(	TInt	aId,
			const MDesCArray &	aItemArray,
			TBool	aRemoveFromOtherCollections = ETrue
		)	[pure virtual]

Add item(s) to collection.

Since: 3.2

Parameters

TInt aId	Collection ID If collection doesn't found then function leaves with KErrNotFound
const MDesCArray & aItemArray
TBool aRemoveFromOtherCollections = ETrue	Is item removed from other available collections.

CollectionInfoByIdLC(TInt)

MMediaCollectionInfo *

CollectionInfoByIdLC

(

TInt

aId

)

const [pure virtual]

Return collection info by ID.

Since: 3.2

Parameters

TInt aId

Collection ID

CreateCollectionL(const TDesC &, const TArray< TInt > &, TInt32)

TInt	CreateCollectionL	(	const TDesC &	aName,
			const TArray < TInt > &	aCollectionItemTypes,
			TInt32	aStorage
		)	[pure virtual]

Create new collection.

Since: 3.2

Parameters

const TDesC & aName	Name of the collection
const TArray < TInt > & aCollectionItemTypes	List of media types that are in the collection. Use media types from CLFContentListing.hrh TCLFMediaType. NOTE! that collection manager doesn't check is added item defined mediatype. This is only for client(s) for grouping different type folders.
TInt32 aStorage	In 3.2 See TMediaCollectionProperties NOTE! If given propertie set is not supported then function leaves with KErrNotSupported NOTE! In 5.0 Drive number where the collection is to be created!

DeleteCollectionL(TInt)

void

DeleteCollectionL

(

TInt

aId

)

[pure virtual]

Delete collection. NOTE! this doesn't delete items that are in collection.

Since: 3.2

Parameters

TInt aId

ID of the collection

Extension()

MMediaCollectionManagerExt *

Extension

(

)

[private, inline, virtual]

This member is internal and not intended for use.

Extension()

const MMediaCollectionManagerExt *

Extension

(

)

const [private, inline, virtual]

GetCollectionIdByItemL(const TDesC &, RArray< TInt > &)

void	GetCollectionIdByItemL	(	const TDesC &	aItem,
			RArray < TInt > &	aIdArray
		)	const [pure virtual]

Find collections IDs by item.

Since: 3.2

Parameters

const TDesC & aItem
RArray < TInt > & aIdArray	Possible collection IDs are added to the array

GetCollectionInfosL(RPointerArray< MMediaCollectionInfo > &)

void

GetCollectionInfosL

(

RPointerArray < MMediaCollectionInfo > &

aCollectionInfoArray

)

const [pure virtual]

Return collection info by index.

Since: 3.2

Parameters

RPointerArray < MMediaCollectionInfo > & aCollectionInfoArray

Collection infos are added to this array

GetCollectionItemArrayL(TInt, CDesCArray &)

void	GetCollectionItemArrayL	(	TInt	aId,
			CDesCArray &	aItemArray
		)	const [pure virtual]

Get collection items.

Since: 3.2

Parameters

TInt aId	Collection ID If collection doesn't found then function leaves with KErrNotFound
CDesCArray & aItemArray	Item are added to the array

GetDriveByIdL(TInt)

TInt32

GetDriveByIdL

(

TInt

aId

)

[pure virtual]

Get the drivenumber of the drive where collection is located by collection id

Since: 5.0

Parameters

TInt aId

id of the collection

RemoveCollectionObserverL(MMediaCollectionObserver &)

void

RemoveCollectionObserverL

(

MMediaCollectionObserver &

aObserver

)

[pure virtual]

Remove collection observer.

Since: 3.2

Parameters

MMediaCollectionObserver & aObserver

RemoveFromAllCollectionsL(const MDesCArray &)

void

RemoveFromAllCollectionsL

(

const MDesCArray &

aItemArray

)

[pure virtual]

Remove item(s) from all collections.

Since: 3.2

Parameters

const MDesCArray & aItemArray

RemoveFromCollectionL(TInt, const MDesCArray &)

void	RemoveFromCollectionL	(	TInt	aId,
			const MDesCArray &	aItemArray
		)	[pure virtual]

Remove item(s) from collection.

Since: 3.2

Parameters

TInt aId	Collection ID If collection doesn't found then function leaves with KErrNotFound
const MDesCArray & aItemArray

RenameCollectionL(TInt, const TDesC &)

void	RenameCollectionL	(	TInt	aId,
			const TDesC &	aNewName
		)	[pure virtual]

Rename collection.

Since: 3.2

Parameters

TInt aId	ID of the collection. If collection doesn't found then function leaves with KErrNotFound
const TDesC & aNewName	new name of the collection