Symbian^3 Product 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()
voidAddCollectionObserverL(MMediaCollectionObserver &)
voidAddToCollectionL(TInt, const MDesCArray &, TBool)
MMediaCollectionInfo *CollectionInfoByIdLC(TInt)
TInt CreateCollectionL(const TDesC &, const TArray< TInt > &, TInt32)
voidDeleteCollectionL(TInt)
voidGetCollectionIdByItemL(const TDesC &, RArray< TInt > &)
voidGetCollectionInfosL(RPointerArray< MMediaCollectionInfo > &)
voidGetCollectionItemArrayL(TInt, CDesCArray &)
TInt32 GetDriveByIdL(TInt)
voidRemoveCollectionObserverL(MMediaCollectionObserver &)
voidRemoveFromAllCollectionsL(const MDesCArray &)
voidRemoveFromCollectionL(TInt, const MDesCArray &)
voidRenameCollectionL(TInt, const TDesC &)
Private Member Functions
MMediaCollectionManagerExt *Extension()
const MMediaCollectionManagerExt *Extension()

Constructor & Destructor Documentation

~MMediaCollectionManager()

~MMediaCollectionManager()[inline, virtual]

Member Functions Documentation

AddCollectionObserverL(MMediaCollectionObserver &)

voidAddCollectionObserverL(MMediaCollectionObserver &aObserver)[pure virtual]
Add collection observer.
Since
3.2

Parameters

MMediaCollectionObserver & aObserver

AddToCollectionL(TInt, const MDesCArray &, TBool)

voidAddToCollectionL(TIntaId,
const MDesCArray &aItemArray,
TBoolaRemoveFromOtherCollections = ETrue
)[pure virtual]
Add item(s) to collection.
Since
3.2

Parameters

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

CollectionInfoByIdLC(TInt)

MMediaCollectionInfo *CollectionInfoByIdLC(TIntaId)const [pure virtual]
Return collection info by ID.
Since
3.2

Parameters

TInt aIdCollection ID

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

TInt CreateCollectionL(const TDesC &aName,
const TArray< TInt > &aCollectionItemTypes,
TInt32aStorage
)[pure virtual]
Create new collection.
Since
3.2

Parameters

const TDesC & aNameName of the collection
const TArray< TInt > & aCollectionItemTypesList 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 aStorageIn 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)

voidDeleteCollectionL(TIntaId)[pure virtual]
Delete collection. NOTE! this doesn't delete items that are in collection.
Since
3.2

Parameters

TInt aIdID 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 > &)

voidGetCollectionIdByItemL(const TDesC &aItem,
RArray< TInt > &aIdArray
)const [pure virtual]
Find collections IDs by item.
Since
3.2

Parameters

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

GetCollectionInfosL(RPointerArray< MMediaCollectionInfo > &)

voidGetCollectionInfosL(RPointerArray< MMediaCollectionInfo > &aCollectionInfoArray)const [pure virtual]
Return collection info by index.
Since
3.2

Parameters

RPointerArray< MMediaCollectionInfo > & aCollectionInfoArrayCollection infos are added to this array

GetCollectionItemArrayL(TInt, CDesCArray &)

voidGetCollectionItemArrayL(TIntaId,
CDesCArray &aItemArray
)const [pure virtual]
Get collection items.
Since
3.2

Parameters

TInt aIdCollection ID If collection doesn't found then function leaves with KErrNotFound
CDesCArray & aItemArrayItem are added to the array

GetDriveByIdL(TInt)

TInt32 GetDriveByIdL(TIntaId)[pure virtual]
Get the drivenumber of the drive where collection is located by collection id
Since
5.0

Parameters

TInt aIdid of the collection

RemoveCollectionObserverL(MMediaCollectionObserver &)

voidRemoveCollectionObserverL(MMediaCollectionObserver &aObserver)[pure virtual]
Remove collection observer.
Since
3.2

Parameters

MMediaCollectionObserver & aObserver

RemoveFromAllCollectionsL(const MDesCArray &)

voidRemoveFromAllCollectionsL(const MDesCArray &aItemArray)[pure virtual]
Remove item(s) from all collections.
Since
3.2

Parameters

const MDesCArray & aItemArray

RemoveFromCollectionL(TInt, const MDesCArray &)

voidRemoveFromCollectionL(TIntaId,
const MDesCArray &aItemArray
)[pure virtual]
Remove item(s) from collection.
Since
3.2

Parameters

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

RenameCollectionL(TInt, const TDesC &)

voidRenameCollectionL(TIntaId,
const TDesC &aNewName
)[pure virtual]
Rename collection.
Since
3.2

Parameters

TInt aIdID of the collection. If collection doesn't found then function leaves with KErrNotFound
const TDesC & aNewNamenew name of the collection

Copyright ©2010 Nokia Corporation and/or its subsidiary(-ies).
All rights reserved. Unless otherwise stated, these materials are provided under the terms of the Eclipse Public License v1.0.