CUPnPPlaylistServices Class Reference
class CUPnPPlaylistServices : public CBase |
A class providing abstract playlist handling services. upnpmusicadapter.lib
- Since
- S60 v3.1
Constructor & Destructor Documentation
CUPnPPlaylistServices()
CUPnPPlaylistServices | ( | ) | [private] |
~CUPnPPlaylistServices()
~CUPnPPlaylistServices | ( | ) | [virtual] |
Member Functions Documentation
AddMediaToPlaylistL(const TDesC &, const TDesC &)
IMPORT_C void | AddMediaToPlaylistL | ( | const TDesC & | aPlaylistId, |
| const TDesC & | aTrackPath |
| ) | |
Adds a file into an existing playlist. The track should be introduced to MPX using CreateTrackL prior to calling this method.
Parameters
const TDesC & aPlaylistId | ID of the playlist |
const TDesC & aTrackPath | path to the track media |
ConstructL()
void | ConstructL | ( | ) | [private] |
CreatePlaylistL(const TDesC &, const MDesCArray &, TDes *)
IMPORT_C void | CreatePlaylistL | ( | const TDesC & | aPlaylistName, |
| const MDesCArray & | aTrackPaths, |
| TDes * | aPlaylistId |
| ) | |
Creates a playlist by given data into the music library. The tracks should be introduced to MPX using CreateTrackL prior to calling this method.
Parameters
const TDesC & aPlaylistName | the name of the playlist |
const MDesCArray & aTrackPaths | array of playlist content file paths |
TDes * aPlaylistId | receives the playlist ID (KMaxPlaylistId) Can also be NULL, if ID is not needed. |
CreateTrackL(const TDesC &, const CUpnpItem &)
IMPORT_C void | CreateTrackL | ( | const TDesC & | aTrackPath, |
| const CUpnpItem & | aTrackMetadata |
| ) | |
Creates a record of a music track into the music library. The media is assumed to exist already.
Parameters
const TDesC & aTrackPath | path to the track media |
const CUpnpItem & aTrackMetadata | the upnp item for track metadata |
DeletePlaylistL(const TDesC &)
IMPORT_C void | DeletePlaylistL | ( | const TDesC & | aPlaylistId | ) | |
Deletes a record of a playlist from the music library. Note that this does not delete the actual media.
Parameters
const TDesC & aPlaylistId | ID of the playlist |
DeleteTrackL(const TDesC &)
IMPORT_C void | DeleteTrackL | ( | const TDesC & | aTrackPath | ) | |
Deletes a record of a music track from the music library. Note that this does not delete the actual media.
Parameters
const TDesC & aTrackPath | the actual file path |
Desc2Id(const TDesC &)
Converts an ID from descriptor form to TMPXItemId form. conversion is guaranteed symmetric to Id2Desc()
Parameters
const TDesC & aDesc | the id as a descriptor |
FetchPlaylistContentL(const TDesC &)
Fetch a playlist content by id
Parameters
const TDesC & aId | playlist id |
FindItemL(TFindCategory, const TDesC &, const TMPXAttributeData *, const TMPXAttributeData *, const TMPXAttributeData *)
Finds a playlist according to given criteria.
GetElementLC(const CUpnpItem &, const TDesC8 &)
Finds an element within CUpnpItem returns the element value converted to unicode, pushed to cleanup stack.
Parameters
const CUpnpItem & aSource | the source CUpnpItem |
const TDesC8 & aSourceField | the element name within source |
Id2Desc(const TMPXItemId &)
Converts an ID from TMPXItemId form to descriptor form. conversion is guaranteed symmetric to Desc2Id()
IsValidPlaylistL(const TDesC &)
IMPORT_C TBool | IsValidPlaylistL | ( | const TDesC & | aPlaylistName | ) | |
Checks if the given playlist exists in the music library. Note: does not check the existence of the actual media
Parameters
const TDesC & aPlaylistName | |
IsValidTrackL(const TDesC &)
IMPORT_C TBool | IsValidTrackL | ( | const TDesC & | aTrackPath | ) | |
Checks if the given track exists in the music library. Note: does not check the existence of the actual media
Parameters
const TDesC & aTrackPath | the actual file path |
ListPlaylistsL(CDesCArray &, CDesCArray &)
Lists all playlists in the music library. Returns a list of playlist ID's and a names. ID can be used to open or modify the playlist.
Parameters
CDesCArray & aPlaylistIds | array to receive playlist ID's |
CDesCArray & aPlaylistNames | array to receive playlist names |
OpenPlaylistL(const TDesC &, CDesCArray &)
IMPORT_C void | OpenPlaylistL | ( | const TDesC & | aPlaylistId, |
| CDesCArray & | aContentMedia |
| ) | |
Retrieves contents of given playlist.
Parameters
const TDesC & aPlaylistId | ID of the playlist |
CDesCArray & aContentMedia | array to receive the content file paths |
Member Enumerations Documentation
Enum TFindCategory
category to be used in FindItemL
Enumerators
ESongs | |
ESongByUri | |
EPlaylists | |
EPlaylistById | |
EPlaylistByTitle | |
Member Data Documentation
MMPXCollectionUtility * iCollectionUtility
Collection utility of MPX framework
TMPXItemId
iCurrentId
ID of item currently processed asynchronously
CUPnPMpxHelper * iMpxHelper
internal helper for some MPX operations
TInt
iStatus
tells if collection plugin exists
TBuf< KTempBufferSize > iTempBuffer
temp buffer used in Id2Desc
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.