Symbian
Symbian OS Library

SYMBIAN OS V9.3

[Index] [Spacer] [Previous] [Next]



Location: mmfcontrollerpluginresolver.h
Link against: mmfcontrollerframework.lib

Class CMMFPluginSelectionParameters

class CMMFPluginSelectionParameters : public CBase;

Description

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

Derivation

Members

Defined in CMMFPluginSelectionParameters:
EAllowOnlySuppliedMediaIds, EAllowOtherMediaIds, ENoMediaIdMatch, ENoPreferredSupplierMatch, EOnlyPreferredSupplierPluginsReturned, EPreferredSupplierPluginsFirstInList, InterfaceUid(), MediaIdMatchType(), MediaIds(), PreferredSupplier(), PreferredSupplierMatchType(), SetMediaIdsL(), SetPreferredSupplierL(), TMediaIdMatchType, TPreferredSupplierMatchType, ~CMMFPluginSelectionParameters()

Inherited from CBase:
Delete(), Extension_(), operator new()


Construction and destruction


~CMMFPluginSelectionParameters()

virtual ~CMMFPluginSelectionParameters();

Description

Destructor. Resets and destroys all member data.

[Top]


Member functions


SetPreferredSupplierL()

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

Description

Sets the preferred supplier of the plugin.

Parameters

const TDesC &aPreferredSupplier

The preferred supplier of the plugin.

TPreferredSupplierMatchType aMatchType

The type of match to be made.


SetMediaIdsL()

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

Description

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

Parameters

const RArray< TUid > &aMediaIds

An array of the media IDs that the selected plugins must support.

TMediaIdMatchType aMatchType

The type of match to be made.


PreferredSupplier()

IMPORT_C const TDesC &PreferredSupplier() const;

Description

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

Return value

const TDesC &

The preferred supplier


PreferredSupplierMatchType()

IMPORT_C TPreferredSupplierMatchType PreferredSupplierMatchType() const;

Description

Returns the type of preferred supplier match to perform.

Return value

TPreferredSupplierMatchType

The preferred supplier match type.


MediaIds()

IMPORT_C const RArray< TUid > &MediaIds() const;

Description

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

Return value

const RArray< TUid > &

The list of media IDs.


MediaIdMatchType()

IMPORT_C TMediaIdMatchType MediaIdMatchType() const;

Description

Returns the type of preferred supplier match to perform.

Return value

TMediaIdMatchType

The preferred supplier match type.


InterfaceUid()

IMPORT_C TUid InterfaceUid() const;

Description

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

Return value

TUid

The interface uid.

[Top]


Member enumerations


Enum TPreferredSupplierMatchType

TPreferredSupplierMatchType

Description

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

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.


Enum TMediaIdMatchType

TMediaIdMatchType

Description

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

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