MRemConDatabaseAwareMediaLibraryBrowse Class Reference

#include <remcondatabaseawaremedialibrarybrowse.h>

Link against: remconmediabrowseapi.lib

class MRemConDatabaseAwareMediaLibraryBrowse

Public Member Functions
IMPORT_C void	MrcdamlbFolderDownResult(TUint, TInt)
IMPORT_C void	MrcdamlbFolderItemResult(const TRemConItemUid &, const TDesC8 &, TFolderItemType, TFolderItemPlayable, const TArray< TMediaElementAttribute > &, TInt)
IMPORT_C void	MrcdamlbFolderListing(const TArray< TRemConItem > &, TUint16, TUint)
IMPORT_C void	MrcdamlbFolderUpResult(TUint, TInt)
IMPORT_C void	MrcdamlbGetPathResult(TUint, TUint16, TInt)
IMPORT_C void	MrcdamlbMediaElementItemResult(const TRemConItemUid &, const TDesC8 &, TMediaItemType, const TArray< TMediaElementAttribute > &, TInt)
IMPORT_C void	MrcdamlbMediaLibraryStateChange(TUint16)
IMPORT_C void	MrcdamlbSearchResult(TUint, TUint16, TInt)

Member Function Documentation

MrcdamlbFolderDownResult ( TUint, TInt )

IMPORT_C void	MrcdamlbFolderDownResult	(	TUint	aItemCount,
			TInt	aResult
		)

Called by the client in response to a MrcdamlboFolderDown() call.

Parameters

aItemCount

The number of items present in this folder.

aResult

The result of the MrcdamlboFolderDown() operationKErrNone if the operation was successful.KErrInvalidMediaLibraryStateCookie if the media library state cookie provided does not match the client's state cookieKErrMediaBrowseInvalidDirection if the folder provided is not a valid folder e.g. path A/B/C, the current dirctory is B, and the param provided with MrcdamlboFolderDown()is A, obviously you can not change folder down to A, so A is invalid.KErrMediaBrowseNotADirectory if the UID provided does not refer to a folder item, e.g. it is a media element.KErrInvalidUid if the UID provided is invalid.System wide error code otherwise.

MrcdamlbFolderItemResult ( const TRemConItemUid &, const TDesC8 &, TFolderItemType, TFolderItemPlayable, const TArray< TMediaElementAttribute > &, TInt )

IMPORT_C void	MrcdamlbFolderItemResult	(	const TRemConItemUid &	aFolderID,
			const TDesC8 &	aFolderName,
			TFolderItemType	aFolderType,
			TFolderItemPlayable	aPlayable,
			const TArray< TMediaElementAttribute > &	aAttributes,
			TInt	aResult
		)

Called by the client in response to MrcdamlboGetItem() call in the case the requested item is a folder item.

Parameters
aFolderID	The folder UID.
aFolderName	The folder name. Takes a copy of it.
aFolderType	The folder type.
aPlayable	Indicaties whether the folder is playableKFolderNotPlayable the folder can not be playedKFolderPlayable the folder can be played
aAttributes	The attributes of the folder item requested by MrcdamlboGetItem()
aResult	The result of the MrcdamlboGetItem() operation.KErrNone if the operation was successful.KErrInvalidMediaLibraryStateCookie if the media library state cookie provided does not match the client's state cookie.KErrInvalidUid if the uid of the item requested is invalid, e.g. the client removed the item before the request MrcdamlboGetItem() coming.System wide error code otherwise.

MrcdamlbFolderListing ( const TArray< TRemConItem > &, TUint16, TUint )

IMPORT_C void	MrcdamlbFolderListing	(	const TArray< TRemConItem > &	aFolderListing,
			TUint16	aMediaLibraryStateCookie,
			TUint	aResult
		)

Called by the client in response to a MrcdamlboGetFolderListing() call.

Parameters
aFolderListing	A listing of the items that are in the range requested by the MrcdamlboGetFolderListing() call.
aMediaLibraryStateCookie	The current value of the state cookie.
aResult	The result of the MrcdamlboGetFolderListing() operation.KErrNone if the operation was successful.KErrMediaBrowseInvalidOffset if there is no media available at the offset of the start item, i.e. the start of range provided via MrcdamlboGetFolderListing() is not valid.System wide error code otherwise.

MrcdamlbFolderUpResult ( TUint, TInt )

IMPORT_C void	MrcdamlbFolderUpResult	(	TUint	aItemCount,
			TInt	aResult
		)

Called by the client in response to a MrcdamlboFolderUp call.

Parameters
aItemCount	The number of items present in this folder.
aResult	The result of the MrcdamlboFolderUp operation.KErrNone if the operation was successful.KErrInvalidMediaLibraryStateCookie if the media library state cookie provided does not match the client's state cookieSystem wide error code otherwise.

MrcdamlbGetPathResult ( TUint, TUint16, TInt )

IMPORT_C void	MrcdamlbGetPathResult	(	TUint	aItemCount,
			TUint16	aMediaLibraryStateCookie,
			TInt	aResult
		)

Called by the client in response to a MrcdamlboGetPath() call.

Parameters
aItemCount	The number of items present in this folder.
aMediaLibraryStateCookie	The current value of the state cookie.
aResult	The result of the MrcdamlboGetPath() operationKErrNone if the operation is successful.System wide error code otherwise.

MrcdamlbMediaElementItemResult ( const TRemConItemUid &, const TDesC8 &, TMediaItemType, const TArray< TMediaElementAttribute > &, TInt )

IMPORT_C void	MrcdamlbMediaElementItemResult	(	const TRemConItemUid &	aMediaID,
			const TDesC8 &	aMediaName,
			TMediaItemType	aMediaType,
			const TArray< TMediaElementAttribute > &	aAttributes,
			TInt	aResult
		)

Called by the client in response to MrcdamlboGetItem() call in the case the requested item is a media element item.

Parameters
aMediaID	The media element UID.
aMediaName	The media name. Takes a copy of it.
aMediaType	The media type.
aAttributes	The attributes list. Takes a copy of it.
aResult	The result of the MrcdamlboGetItem() operation.KErrNone if the operation was successful.KErrInvalidMediaLibraryStateCookie if the media library state cookie provided does not match the client's state cookie.KErrInvalidUid if the uid of the item requested is invalid, e.g. the client removed the item before the request MrcdamlboGetItem() coming.System wide error code otherwise.

MrcdamlbMediaLibraryStateChange ( TUint16 )

IMPORT_C void

MrcdamlbMediaLibraryStateChange

(

TUint16

aMediaLibraryStateCookie

)

Called by the client in the case that the state of the media library has changed. This means that the media library state cookie provided prior to this call by the client may no longer be valid. Typical causes for this would be items added or removed from the media library.

This function shall be called by any client any time it believes that media library state cookie has ceased to be valid, for example if the current directory is on removable media, and that media has been removed. That includes clients that are only able to offer state cookie that are limited to one directory.

Parameters
aMediaLibraryStateCookie	The current value of the state cookie which enables state mismatches between the client and the remote controller device to be detected.

MrcdamlbSearchResult ( TUint, TUint16, TInt )

IMPORT_C void	MrcdamlbSearchResult	(	TUint	aNumberItemsFound,
			TUint16	aMediaLibraryStateCookie,
			TInt	aResult
		)

Called by the client in response to a MrcdamlboSearch() call to indicate that a search has completed.

Parameters
aNumberItemsFound	The number of items found by the search.
aMediaLibraryStateCookie	The current of the state cookie.
aResult	The result of the search.KErrNone if the search completed successfullySystem wide error otherwise.