CMMFPluginSelectionParameters Class Reference

#include <mmf/common/mmfcontrollerpluginresolver.h>

Link against: mmfcontrollerframework.lib

class CMMFPluginSelectionParameters : public CBase, public CBase

Inherits from

CMMFPluginSelectionParameters
- CBase
- CBase

Public Member Enumerations
enum	TMediaIdMatchType { ENoMediaIdMatch, EAllowOtherMediaIds, EAllowOnlySuppliedMediaIds }
enum	TPreferredSupplierMatchType { ENoPreferredSupplierMatch, EPreferredSupplierPluginsFirstInList, EOnlyPreferredSupplierPluginsReturned }

Public Member Functions
virtual	~CMMFPluginSelectionParameters()
IMPORT_C TUid	InterfaceUid()
IMPORT_C TMediaIdMatchType	MediaIdMatchType()
IMPORT_C const RArray< TUid > &	MediaIds()
IMPORT_C const TDesC &	PreferredSupplier()
IMPORT_C TPreferredSupplierMatchType	PreferredSupplierMatchType()
IMPORT_C void	SetMediaIdsL(const RArray< TUid > &, TMediaIdMatchType)
IMPORT_C void	SetPreferredSupplierL(const TDesC &, TPreferredSupplierMatchType)

Protected Member Functions
	CMMFPluginSelectionParameters(TUid)
TBool	CheckMediaIdSupportL(const CMMFPluginImplementationInformation &)

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()

Detailed Description

Contains the parameters used to select mmf plugins from the ECOM registry.

Since: 7.0s

Member Enumeration Documentation

Enum TMediaIdMatchType

Describes the type of media ID match to be performed on the plugins return from the ECOM registry.

Enumerator	Value	Description
ENoMediaIdMatch		No media ID match will be performed.
EAllowOtherMediaIds		All plugins that support the media ID supplied will be returned, even those that support other media IDs. For example, if an audio plugin is requested, plugins that support audio and video will also be returned.
EAllowOnlySuppliedMediaIds		Only plugins that support the exact media IDs supplied will be returned. For example, if an audio plugin is requested, plugins that only support audio will be returned (ie. no audio/video plugins).

Enum TPreferredSupplierMatchType

Describes the type of preferred supplier match to be performed on the plugins return from the ECOM registry.

Enumerator	Value	Description
ENoPreferredSupplierMatch		No preferred supplier match will be performed.
EPreferredSupplierPluginsFirstInList		Plugins from all suppliers will be returned, but those from the preferred supplier will be first in the list.
EOnlyPreferredSupplierPluginsReturned		Only plugins from the preferred supplier will be returned.

Constructor & Destructor Documentation

CMMFPluginSelectionParameters ( TUid )

CMMFPluginSelectionParameters

(

TUid

aPluginInterfaceUid

)

[protected]

Protected constructor.

Defaults to setting the TPreferredSupplierMatchType enum to ENoPreferredSupplierMatch and TMediaIdMatchType to ENoMediaIdMatch.

Parameters
aPluginInterfaceUid	The plugin's interface UID.

~CMMFPluginSelectionParameters ( )

~CMMFPluginSelectionParameters

(

)

[virtual]

Destructor. Resets and destroys all member data.

Since: 7.0s

Member Function Documentation

CheckMediaIdSupportL ( const CMMFPluginImplementationInformation & )

TBool

CheckMediaIdSupportL

(

const CMMFPluginImplementationInformation &

aPlugin

)

const [protected]

Tests whether the specified media is supported by the plugin.

Parameters
aPlugin	The media to test.

Return Value: A boolean indicating if the specified media is supported by the plugin. ETrue if the specified media is supported by the plugin. EFalse if the specified media is not supported by the plugin.

InterfaceUid ( )

IMPORT_C TUid

InterfaceUid

(

)

const

Returns the uid of the interface to be searched for plugin matches.

Since: 7.0s

Return Value: The interface uid.

MediaIdMatchType ( )

IMPORT_C TMediaIdMatchType

MediaIdMatchType

(

)

const

Returns the type of preferred supplier match to perform.

Since: 7.0s

Return Value: The preferred supplier match type.

MediaIds ( )

IMPORT_C const RArray< TUid > &

MediaIds

(

)

const

Returns the list of media IDs that must be supported by the plugin.

Since: 7.0s

Return Value: The list of media IDs.

PreferredSupplier ( )

IMPORT_C const TDesC &

PreferredSupplier

(

)

const

Returns the preferred supplier. If no preferred supplier has been set, a blank string will be returned.

Since: 7.0s

Return Value: The preferred supplier

PreferredSupplierMatchType ( )

IMPORT_C TPreferredSupplierMatchType

PreferredSupplierMatchType

(

)

const

Returns the type of preferred supplier match to perform.

Since: 7.0s

Return Value: The preferred supplier match type.

SetMediaIdsL ( const RArray< TUid > &, TMediaIdMatchType )

IMPORT_C void	SetMediaIdsL	(	const RArray< TUid > &	aMediaIds,
			TMediaIdMatchType	aMatchType
		)

Sets the media IDs that must be supported by the plugin, for example audio, video etc.

Since: 7.0s

Parameters
aMediaIds	An array of the media IDs that the selected plugins must support.
aMatchType	The type of match to be made.

SetPreferredSupplierL ( const TDesC &, TPreferredSupplierMatchType )

IMPORT_C void	SetPreferredSupplierL	(	const TDesC &	aPreferredSupplier,
			TPreferredSupplierMatchType	aMatchType
		)

Sets the preferred supplier of the plugin.

Since: 7.0s

Parameters
aPreferredSupplier	The preferred supplier of the plugin.
aMatchType	The type of match to be made.